SAP SuccessFactors
El conector de SAP SuccessFactors te permite realizar operaciones de inserción, eliminación, actualización y lectura en los datos de SAP SuccessFactors.
Antes de empezar
Antes de usar el conector de SAP SuccessFactors, haz lo siguiente:
- En tu proyecto de Google Cloud:
- Asegúrate de que la conectividad de red esté configurada. Para obtener información sobre los patrones de red, consulta Conectividad de red.
- Concede el rol de gestión de identidades y accesos roles/connectors.admin al usuario que configure el conector.
- Concede los siguientes roles de gestión de identidades y accesos a la cuenta de servicio que quieras usar para el conector:
roles/secretmanager.viewer
roles/secretmanager.secretAccessor
Una cuenta de servicio es un tipo especial de cuenta de Google diseñada para representar a un usuario no humano que necesita autenticarse y disponer de autorización para acceder a los datos de las APIs de Google. Si no tienes una cuenta de servicio, debes crearla. El conector y la cuenta de servicio deben pertenecer al mismo proyecto. Para obtener más información, consulta el artículo Crear una cuenta de servicio.
- Habilita los siguientes servicios:
secretmanager.googleapis.com
(API Secret Manager)connectors.googleapis.com
(API Connectors)
Para saber cómo habilitar servicios, consulta Habilitar servicios.
Si estos servicios o permisos no se han habilitado en tu proyecto anteriormente, se te pedirá que los habilites al configurar el conector.
- Para crear una cuenta de SuccessFactors de pago con un ID de SAP, consulta el artículo Guía de inicio rápido de SAP SuccessFactors.
Configurar el conector
Una conexión es específica de una fuente de datos. Esto significa que, si tiene muchas fuentes de datos, debe crear una conexión independiente para cada una de ellas. Para crear una conexión, sigue estos pasos:
- En la consola de Cloud, ve a la página Integration Connectors > Connections (Conectores de integración > Conexiones) y, a continuación, selecciona o crea un proyecto de Google Cloud.
- Haga clic en + Crear para abrir la página Crear conexión.
- En la sección Ubicación, elige la ubicación de la conexión.
- Región: selecciona una ubicación de la lista desplegable.
Para ver la lista de todas las regiones admitidas, consulta Ubicaciones.
- Haz clic en Siguiente.
- Región: selecciona una ubicación de la lista desplegable.
- En la sección Detalles de la conexión, haz lo siguiente:
- Conector: selecciona SAP SuccessFactors en la lista desplegable de conectores disponibles.
- Versión del conector: seleccione la versión del conector en la lista desplegable de versiones disponibles.
- En el campo Connection Name (Nombre de conexión), introduce un nombre para la instancia de conexión.
Los nombres de las conexiones deben cumplir los siguientes criterios:
- Los nombres de conexión pueden contener letras, números o guiones.
- Las letras deben estar en minúsculas.
- Los nombres de conexión deben empezar por una letra y terminar por una letra o un número.
- Los nombres de conexión no pueden tener más de 49 caracteres.
- Si quiere, puede introducir una Descripción para la instancia de conexión.
- También puedes habilitar Registro en la nube y, a continuación, seleccionar un nivel de registro. De forma predeterminada, el nivel de registro es
Error
. - Cuenta de servicio: selecciona una cuenta de servicio que tenga los roles necesarios.
- Si quieres, configura los ajustes del nodo de conexión:
- Número mínimo de nodos: introduce el número mínimo de nodos de conexión.
- Número máximo de nodos: introduce el número máximo de nodos de conexión.
Un nodo es una unidad (o réplica) de una conexión que procesa transacciones. Se necesitan más nodos para procesar más transacciones en una conexión y, a la inversa, se necesitan menos nodos para procesar menos transacciones. Para saber cómo influyen los nodos en el precio de tu conector, consulta la sección Precios de los nodos de conexión. Si no introduces ningún valor, de forma predeterminada, el número mínimo de nodos se establece en 2 (para mejorar la disponibilidad) y el máximo en 50.
- ID de empresa: identificador único de su empresa. Es necesario para autenticarte.
- Formato de datos: el formato de datos en el que se recuperarán los datos. Selecciona ATOM o JSON.
- Incluir propiedades de navegación: valor booleano que indica si se deben incluir propiedades de navegación en la lista de columnas.
- Purge Type: PurgeType es un parámetro opcional que determina si se realizará una actualización incremental o completa en una entidad.
- Usar paginación del lado del cliente: indica si el proveedor CData ADO.NET para SAP SuccessFactors debe usar la paginación del lado del cliente.
- Usar nombres visibles: valor booleano que determina si se deben usar etiquetas de SAP.
- Usar proxy: indica si se debe usar la configuración de proxy del sistema. Tiene prioridad sobre otros ajustes de proxy, por lo que tendrás que definir ProxyAutoDetect como FALSE para usar ajustes de proxy personalizados.
- Esquema de autenticación de proxy: el tipo de autenticación que se debe usar para autenticar el proxy ProxyServer.
- Usuario del proxy: nombre de usuario que se usará para autenticar el proxy ProxyServer.
- Contraseña del proxy: contraseña que se usará para autenticar el proxy ProxyServer.
- Tipo de SSL de proxy: el tipo de SSL que se debe usar al conectarse al proxy ProxyServer.
- (Opcional) En la sección Configuración avanzada, marca la casilla Usar proxy para configurar un servidor proxy para la conexión y define los siguientes valores:
-
Esquema de autenticación de proxy: selecciona el tipo de autenticación para autenticarte con el servidor proxy. Se admiten los siguientes tipos de autenticación:
- Básica: autenticación HTTP básica.
- Digest: autenticación HTTP Digest.
- Usuario proxy: nombre de usuario que se usará para autenticar el servidor proxy.
- Contraseña de proxy: el secreto de Secret Manager de la contraseña del usuario.
-
Tipo de SSL de proxy: el tipo de SSL que se debe usar al conectarse al servidor proxy. Se admiten los siguientes tipos de autenticación:
- Automático: es el ajuste predeterminado. Si la URL es una URL HTTPS, se usa la opción Tunnel. Si la URL es una URL HTTP, se usa la opción NUNCA.
- Siempre: la conexión siempre tiene habilitado SSL.
- Nunca: la conexión no tiene habilitado el protocolo SSL.
- Túnel: la conexión se realiza a través de un proxy de tunelización. El servidor proxy abre una conexión con el host remoto y el tráfico fluye de un lado a otro a través del proxy.
- En la sección Servidor proxy, introduce los detalles del servidor proxy.
- Haga clic en + Añadir destino.
- Selecciona un Tipo de destino.
- Dirección de host: especifica el nombre de host o la dirección IP del destino.
Si quieres establecer una conexión privada con tu sistema backend, haz lo siguiente:
- Crea una vinculación de servicio de PSC.
- Crea un endpoint attachment y, a continuación, introduce los detalles del endpoint attachment en el campo Host address (Dirección de host).
- Dirección de host: especifica el nombre de host o la dirección IP del destino.
- También puedes hacer clic en + AÑADIR ETIQUETA para añadir una etiqueta a la conexión en forma de par clave-valor.
- Haz clic en Siguiente.
- En la sección Destinations (Destinos), introduce los detalles del host remoto (sistema backend) al que quieras conectarte.
- Tipo de destino: selecciona un Tipo de destino.
- Para especificar el nombre de host o la dirección IP de destino, selecciona Dirección de host y introduce la dirección en el campo Host 1.
- Para establecer una conexión privada, selecciona Endpoint attachment (Endpoint adjunto) y elige el adjunto que quieras de la lista Endpoint Attachment (Endpoint adjunto).
Si quieres establecer una conexión pública con tus sistemas backend con seguridad adicional, puedes configurar direcciones IP de salida estáticas para tus conexiones y, a continuación, configurar las reglas de tu cortafuegos para que solo se permitan las direcciones IP estáticas específicas.
Para introducir más destinos, haz clic en +Añadir destino.
- Haz clic en Siguiente.
- Tipo de destino: selecciona un Tipo de destino.
-
En la sección Autenticación, introduce los detalles de autenticación.
- Seleccione un Tipo de autenticación e introduzca los detalles pertinentes.
La conexión de SAP SuccessFactors admite los siguientes tipos de autenticación:
- Nombre de usuario y contraseña
- Haz clic en Siguiente.
Para saber cómo configurar estos tipos de autenticación, consulta Configurar la autenticación.
- Seleccione un Tipo de autenticación e introduzca los detalles pertinentes.
- Revisar: revisa los detalles de la conexión y la autenticación.
- Haz clic en Crear.
Configurar la autenticación
Introduce los detalles en función de la autenticación que quieras usar.
-
Nombre de usuario y contraseña
- Nombre de usuario: nombre de usuario del conector.
- Contraseña: secreto de Secret Manager que contiene la contraseña asociada al conector.
- Esquema de autenticación: el esquema usado para la autenticación.
Ejemplo de tipo de conexión de autenticación básica
En la siguiente tabla se muestran los valores de configuración de ejemplo del tipo de conexión de autenticación básica. Consulta la interfaz de creación de conexiones de la consola para saber cuáles son los campos obligatorios y opcionales.
Nombre del campo | Valor de muestra |
---|---|
Región | us-central1 |
Conector | SAP SuccessFactors |
Versión del conector | 1 |
Nombre de la conexión | sapsf-basicauth-conn |
Descripción | Conexión de SuccessFactors |
Cuenta de servicio | SERVICE_ACCOUNT_NAME@developer.gserviceaccount.com |
ID de empresa | SFPART068178 |
Dirección del host | https://HOST_NAME.successfactors.eu/ |
Nombre de usuario | sfadmin |
Contraseña | CONTRASEÑA |
Esquema de autenticación | Básico |
Entidades, operaciones y acciones
Todos los conectores de integración proporcionan una capa de abstracción para los objetos de la aplicación conectada. Solo puedes acceder a los objetos de una aplicación a través de esta abstracción. La abstracción se te muestra como entidades, operaciones y acciones.
- Entidad: una entidad se puede considerar como un objeto o un conjunto de propiedades en la aplicación o el servicio conectados. La definición de una entidad varía de un conector a otro. Por ejemplo, en un conector de base de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; y en un conector de sistema de mensajería, las colas son las entidades.
Sin embargo, es posible que un conector no admita o no tenga ninguna entidad. En ese caso, la lista
Entities
estará vacía. - Operación: una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:
Al seleccionar una entidad de la lista disponible, se genera una lista de operaciones disponibles para la entidad. Para ver una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea Connectors. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, esas operaciones no admitidas no se mostrarán en la lista
Operations
. - Acción: una acción es una función de primera clase que se pone a disposición de la integración
a través de la interfaz del conector. Una acción te permite hacer cambios en una o varias entidades y varía de un conector a otro. Normalmente, una acción tendrá algunos parámetros de entrada y un parámetro de salida. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista
Actions
estará vacía.
Limitaciones del sistema
El conector de SAP SuccessFactors puede procesar 10 transacciones por segundo por nodo y limita las transacciones que superen este límite. De forma predeterminada, Integration Connectors asigna 2 nodos (para mejorar la disponibilidad) a una conexión.
Para obtener información sobre los límites aplicables a Integration Connectors, consulta Límites.
Acciones
En esta sección se enumeran todas las acciones admitidas por la conexión de SuccessFactors.
Acción UpsertEntity
Esta acción te permite insertar o actualizar un registro de una entidad.
Parámetros de entrada de la acción UpsertEntity
Nombre del parámetro | Tipo de datos | Obligatorio | Descripción |
---|---|---|---|
entityType | cadena | Verdadero | Tipo de entidad que se va a insertar o actualizar. |
carga útil | objeto | Verdadero | Carga útil de inserción o actualización en formato JSON. |
Parámetros de salida de la acción UpsertEntity
Esta acción devuelve el estado 200 (OK) con un cuerpo de respuesta que indica todos los resultados de Upsert.
Para ver un ejemplo de cómo configurar la acción UpsertEntity
, consulta Ejemplos.
Ejemplos de acciones
En esta sección se describe cómo realizar algunas de las acciones de este conector.
Ejemplo: actualizar un registro de la entidad PerPersonal
En el siguiente ejemplo se actualiza un registro de la entidad PerPersonal
.
- En el cuadro de diálogo
Configure connector task
, haz clic enActions
. - Seleccione la acción
UpsertEntity
y, a continuación, haga clic en Hecho. - En la sección Entrada de tarea de la tarea Conectores, haz clic en
connectorInputPayload
y, a continuación, introduce un valor similar al siguiente en el campoDefault Value
:{ "entityType": "PerPersonal", "payload": { "personIdExternal": "109031", "startDate": "1800-01-01 00:00:00.0", "firstName": "John", "lastName": "Job", "nationality": "IND" } }
Si la acción se realiza correctamente, el campo connectorOutputPayload
de la tarea del conector tendrá un valor similar al siguiente:
[{ "personIdExternal": "109031", "startDate": "1989-12-31 23:00:00.0" }]
Ejemplo: actualizar un registro de la entidad PaymentInformationDetailV3
En el siguiente ejemplo se actualiza un registro de la entidad PaymentInformationDetailV3
.
- En el cuadro de diálogo
Configure connector task
, haz clic enActions
. - Seleccione la acción
UpsertEntity
y, a continuación, haga clic en Hecho. - En la sección Entrada de tarea de la tarea Conectores, haz clic en
connectorInputPayload
y, a continuación, introduce un valor similar al siguiente en el campoDefault Value
:{ "entityType": "PaymentInformationDetailV3", "payload": { "PaymentInformationV3_effectiveStartDate": "2015-01-21 00:00:00.0", "PaymentInformationV3_worker": "82096", "externalCode": 563.0, "currency": "EUR" } }
Si la acción se realiza correctamente, el campo connectorOutputPayload
de la tarea del conector tendrá un valor similar al siguiente:
[{ "externalCode": 563.0, "PaymentInformationV3_effectiveStartDate": "2015-01-20 23:00:00.0", "PaymentInformationV3_worker": "82096" }]
Ejemplo: Crear un registro en una entidad
En el siguiente ejemplo se crea un registro en la entidad TodoEntryV2
.
- En el cuadro de diálogo
Configure connector task
, haz clic enActions
. - Seleccione la acción
UpsertEntity
y, a continuación, haga clic en Hecho. - En la sección Entrada de tarea de la tarea Conectores, haz clic en
connectorInputPayload
y, a continuación, introduce un valor similar al siguiente en el campoDefault Value
:{ "entityType": "TodoEntryV2", "payload": { "todoEntryName": "Finish Your Tasks", "status": 1.0, "categoryId": "41", "LinkeduserNav": { "__metadata": { "uri": "https://apisalesdemo2.successfactors.eu/odata/v2/User('613577712')", "type": "SFOData.User" } } } }
Si la ejecución de la acción se realiza correctamente, el campo connectorOutputPayload
de la tarea del conector tendrá un valor similar al siguiente:
[{ "todoEntryId": 221443.0 }]
Ejemplos de entidades
Ejemplo: listar los registros de una entidad
En este ejemplo se muestran los registros de la entidad FOCompany
.
- En el cuadro de diálogo
Configure connector task
, haz clic enEntities
. - Selecciona
FOCompany
en la listaEntity
. - Selecciona la operación
LIST
y, a continuación, haz clic en Hecho. - En la sección Entrada de tarea de la tarea Conectores, puede definir el filterClause según sus necesidades.
Por ejemplo, si se define la cláusula de filtro como
externalCode='5100' and startDate='1900-01-01 00:00:00'
, solo se mostrarán los registros cuyo externalCode sea 5100 y cuyo startDate sea 1900-01-01 00:00:00.
Ejemplo: obtener un registro de una entidad
En este ejemplo, se obtiene un registro de la entidad User
.
- En el cuadro de diálogo
Configure connector task
, haz clic enEntities
. - Selecciona
User
en la listaEntity
. - Selecciona la operación
GET
y, a continuación, haz clic en Hecho. - En la sección Entrada de tarea de la tarea Conectores, haga clic en EntityId y, a continuación, introduzca
103032
en el campo Valor predeterminado.En este caso,
103032
es la clave principal de la entidadUsers
.
Ejemplo: eliminar un registro de una entidad
En este ejemplo se elimina un registro de la entidad FOCompany
.
- En el cuadro de diálogo
Configure connector task
, haz clic enEntities
. - Selecciona
FOCompany
en la listaEntity
. - Selecciona la operación
DELETE
y, a continuación, haz clic en Hecho. - En la sección Entrada de tarea de la tarea Conectores, haga clic en entityId y, a continuación, introduzca
113132
en el campo Valor predeterminado.Si la entidad tiene claves primarias compuestas en lugar de especificar el entityId, puedes definir el filterClause. Por ejemplo,
externalCode='5100' and startDate='1900-01-01 00:00:00'
.
Ejemplo: Crear un registro en una entidad
- En el cuadro de diálogo
Configure connector task
, haz clic enEntities
. - Selecciona
FOCompany
en la listaEntity
. - Selecciona la operación
Create
y, a continuación, haz clic en Hecho. - En la sección Entrada de tarea de la tarea Conectores, haz clic en
connectorInputPayload
y, a continuación, introduce un valor similar al siguiente en el campoDefault Value
:{ "externalCode": "1000", "startDate": "1900-01-01 00:00:00.0", "standardHours": 40.0, "status": "I", "currency": "EUR", "country": "DEU" }
Si la integración se realiza correctamente, el campo
connectorOutputPayload
de la tarea del conector tendrá un valor similar al siguiente:{ "externalCode": "1000", "startDate": "1900-01-01 00:00:00.0" }
Ejemplo: crear un registro en la entidad TimeZone
- En el cuadro de diálogo
Configure connector task
, haz clic enEntities
. - Selecciona
TimeZone
en la listaEntity
. - Selecciona la operación
Create
y, a continuación, haz clic en Hecho. - En la sección Entrada de tarea de la tarea Conectores, haz clic en
connectorInputPayload
y, a continuación, introduce un valor similar al siguiente en el campoDefault Value
:{ "effectiveStartDate": "2023-08-16 00:00:00.0", "externalCode": "10013", "effectiveStatus": "A", "utcDstOffset": "UTC+01:00", "utcOffset": "+0100" }
Si la integración se realiza correctamente, el campo
connectorOutputPayload
de la tarea del conector tendrá un valor similar al siguiente:{ "effectiveStartDate": "2023-08-16 00:00:00.0", "externalCode": "10013" }
Ejemplo: actualizar un registro de una entidad
En este ejemplo se actualiza un registro de la entidad FOCompany
.
- En el cuadro de diálogo
Configure connector task
, haz clic enEntities
. - Selecciona
FOCompany
en la listaEntity
. - Selecciona la operación
Update
y, a continuación, haz clic en Hecho. - En la sección Entrada de tarea de la tarea Conectores, haz clic en
connectorInputPayload
y, a continuación, introduce un valor similar al siguiente en el campoDefault Value
:{ "description": "BestRun India" }
- En la sección Entrada de tarea de la tarea Conectores, haga clic en entityId y, a continuación, introduzca
103032
en el campo Valor predeterminado.Si la entidad tiene claves primarias compuestas en lugar de especificar el entityId, puedes definir el filterClause. Por ejemplo,
externalCode='5100' and startDate='1900-01-01 00:00:00'
.
Si la integración se realiza correctamente, el campo connectorOutputPayload
de la tarea del conector tendrá un valor similar al siguiente:
{ "externalCode": "5100", "startDate": "1900-01-01 00:00:00.0" }
Crear conexiones con Terraform
Puedes usar el recurso de Terraform para crear una conexión.
Para saber cómo aplicar o quitar una configuración de Terraform, consulta Comandos básicos de Terraform.
Para ver una plantilla de Terraform de ejemplo para crear una conexión, consulta la plantilla de ejemplo.
Cuando crees esta conexión con Terraform, debes definir las siguientes variables en el archivo de configuración de Terraform:
Nombre del parámetro | Tipo de datos | Obligatorio | Descripción |
---|---|---|---|
company_id | STRING | Verdadero | Identificador único de su empresa. Es necesario para autenticarte. |
purge_type | STRING | Falso | PurgeType es un parámetro opcional que determina si se realizará una actualización incremental o completa en una entidad. |
use_client_side_paging | BOOLEAN | Falso | Indica si el proveedor CData ADO.NET para SAP SuccessFactors debe usar la paginación del lado del cliente. |
use_display_names | BOOLEAN | Falso | Valor booleano que determina si se deben usar etiquetas de SAP. |
verbosidad | STRING | Falso | Nivel de detalle de la conexión, que varía de 1 a 5. Si el nivel de verbosidad es más alto, se registrarán todos los detalles de la comunicación (solicitud, respuesta y certificados SSL). |
proxy_enabled | BOOLEAN | Falso | Seleccione esta casilla para configurar un servidor proxy para la conexión. |
proxy_auth_scheme | ENUM | Falso | Tipo de autenticación que se usará para autenticar el proxy ProxyServer. Los valores posibles son: BASIC, DIGEST y NONE. |
proxy_user | STRING | Falso | Nombre de usuario que se usará para autenticar el proxy ProxyServer. |
proxy_password | SECRET | Falso | Contraseña que se usará para autenticarse en el proxy ProxyServer. |
proxy_ssltype | ENUM | Falso | El tipo de SSL que se debe usar al conectarse al proxy ProxyServer. Los valores admitidos son AUTO, ALWAYS, NEVER y TUNNEL. |
Usar la conexión de SAP SuccessFactors en una integración
Una vez que hayas creado la conexión, estará disponible tanto en Apigee Integration como en Application Integration. Puedes usar la conexión en una integración a través de la tarea Conectores.
- Para saber cómo crear y usar la tarea Conectores en la integración de Apigee, consulta Tarea Conectores.
- Para saber cómo crear y usar la tarea Conectores en Application Integration, consulta Tarea Conectores.
Obtener ayuda de la comunidad de Google Cloud
Puedes publicar tus preguntas y hablar sobre este conector en la comunidad de Google Cloud, en los foros de Cloud.Siguientes pasos
- Consulta cómo suspender y reanudar una conexión.
- Consulta cómo monitorizar el uso de los conectores.
- Consulta cómo ver los registros de conectores.