SAP SuccessFactors

El conector de SAP SuccessFactors te permite realizar operaciones de inserción, eliminación, actualización y lectura en datos de SAP SuccessFactors.

Antes de comenzar

Antes de usar el conector de SAP SuccessFactors, realiza las siguientes tareas:

• En tu proyecto de Google Cloud, haz lo siguiente:
  • Otorga el rol de IAM roles/connectors.admin al usuario que configura el conector.
  • Otorga los siguientes roles de IAM a la cuenta de servicio que deseas usar para el conector:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Una cuenta de servicio es un tipo de Cuenta de Google especial que representa a un usuario no humano que debe autenticarse y tener autorización para acceder a los datos de las APIs de Google. Si no tienes una cuenta de servicio, debes crear una. Para obtener más información, consulta Crea una cuenta de servicio.

  • Habilita los siguientes servicios:
    • secretmanager.googleapis.com (API de Secret Manager)
    • connectors.googleapis.com (API de conectores)

    Para comprender cómo habilitar servicios, consulta Habilita servicios.

  Si estos servicios o permisos no se habilitaron antes para tu proyecto, se te solicitará que los habilites cuando configures el conector.

Configura el conector

Para configurar el conector, debes crear una conexión a tu fuente de datos (sistema de backend). Una conexión es específica de una fuente de datos. Significa que, si tienes muchas fuentes de datos, debes crear una conexión independiente para cada fuente. Para crear una conexión, sigue estos pasos:

1. En la consola de Cloud, ve a la página Conectores de Integration > Conexiones y, luego, selecciona o crea un proyecto de Google Cloud.

   Ir a la página Conexiones

2. Haz clic en + Crear nuevo para abrir la página Crear conexión.
3. En la sección Ubicación, elige la ubicación para la conexión.
   1. Región: selecciona una ubicación de la lista desplegable.

      Para obtener la lista de todas las regiones compatibles, consulta Ubicaciones.

   2. Haz clic en Siguiente.
4. En la sección Detalles de la conexión, completa lo siguiente:
   1. Connector: Selecciona SAP SuccessFactors en la lista desplegable de conectores disponibles.
   2. Versión del conector: selecciona la versión del conector de la lista desplegable de versiones disponibles.
   3. En el campo Nombre de la conexión, ingresa un nombre para la instancia de conexión.

      Los nombres de las conexiones deben cumplir con los siguientes criterios:

      • Los nombres de las conexiones pueden usar letras, números o guiones.
      • Las letras deben estar en minúsculas.
      • Los nombres de las conexiones deben comenzar con una letra y terminar con una letra o un número.
      • Los nombres de las conexiones no pueden superar los 63 caracteres.
   4. De manera opcional, ingresa una Descripción para la instancia de conexión.
   5. Cuenta de servicio: Selecciona una cuenta de servicio que tenga los roles necesarios.
   6. De manera opcional, configura los parámetros de nodo de conexión:
      • Cantidad mínima de nodos: Ingresa la cantidad mínima de nodos de conexión.
      • Cantidad máxima de nodos: Ingresa la cantidad máxima de nodos de conexión.

      Un nodo es una unidad (o réplica) de una conexión que procesa transacciones. Se requieren más nodos para procesar más transacciones para una conexión y, del mismo modo, se requieren menos para procesar menos transacciones. Para comprender cómo los nodos afectan el precio del conector, consulta Precios de nodos de conexión. Si no ingresas ningún valor, se establecen de forma predeterminada los nodos mínimos en 2 (para una mejor disponibilidad) y los nodos máximos se establecen en 50.

   Nota: Puedes personalizar los valores de los nodos de conexión solo si eres un cliente de pago por uso.
   7. Company Id: Identificador único de tu empresa Esto es necesario para la autenticación.
   8. Formato de datos: el formato de datos en el que se recuperarán los datos. Selecciona ATOM o JSON.
   9. Incluir propiedades de navegación: Es un valor booleano que indica si se deben incluir propiedades de navegación en la ficha de la columna.
   10. Purge Type: PurgeType es un parámetro opcional que determina si se realizará una actualización incremental o completa en una entidad.
   11. Uso de paginación del cliente: Indica si el proveedor de CData ADO.NET para SAP SuccessFactors debe usar o no la paginación del cliente.
   12. Use Display Names: es un valor booleano que determina si se usan o no las etiquetas de SAP.
   13. Use proxy: Indica si se debe usar o no la configuración de proxy del sistema. Esta configuración tiene prioridad sobre otras configuraciones de proxy, por lo que deberá establecer ProxyAutoDetect en FALSE para usar una configuración de proxy personalizada.
   14. Esquema de autenticación de proxy: Es el tipo de autenticación que se usa para autenticarse en el proxy de ProxyServer.
   15. Proxy User: Es un nombre de usuario que se usará para autenticarse en el proxy de ProxyServer.
   16. Contraseña de proxy: Es una contraseña que se usa para autenticarse en el proxy de ProxyServer.
   17. Tipo de SSL de proxy: Es el tipo de SSL que se usa al conectarse al proxy de ProxyServer.
   18. Usar proxy: selecciona esta casilla de verificación a fin de configurar un servidor proxy para la conexión y configurar los siguientes valores:
   • Esquema de autenticación del proxy: Selecciona el tipo de autenticación para autenticar con el servidor proxy. Se admiten los siguientes tipos de autenticación:
     • Básico: Autenticación HTTP básica.
     • Resumen: Autenticación de HTTP de resumen.
   • Usuario de proxy: Un nombre de usuario que se usará para autenticarse con el servidor proxy.
   • Contraseña de proxy: el secreto de Secret Manager de la contraseña del usuario.
   • Tipo de SSL del proxy: el tipo de SSL que se usará para conectarse al servidor del proxy. Se admiten los siguientes tipos de autenticación:
     • Automático: Configuración predeterminada. Si la URL es HTTPS, se usa la opción Túnel. Si la URL es una URL HTTP, se usa la opción NUNCA.
     • Siempre: La conexión siempre está habilitada para SSL.
     • Nunca: La conexión no está habilitada para SSL.
     • Túnel: La conexión se realiza a través de un proxy de túnel. 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 Proxy Server, ingresa los detalles del servidor proxy.
     1. Haz clic en Agregar destino.
     2. Selecciona un Tipo de destino.
        • Dirección del host: Especifica el nombre de host o la dirección IP del destino.

          Si deseas establecer una conexión privada a tu sistema de backend, haz lo siguiente:

          • Crea un adjunto de servicio de PSC.
          • Crea un adjunto de extremo y, luego, ingresa los detalles del adjunto del extremo en el campo Dirección del host.
   19. De forma opcional, haz clic en + AGREGAR ETIQUETA para agregar una etiqueta a la conexión en forma de un par clave-valor.
   20. Haz clic en Siguiente.
5. En la sección Destinos, ingresa los detalles del host remoto (sistema de backend) al que deseas conectarte.
   1. Tipo de destino: Selecciona un Tipo de destino.
      • Selecciona Dirección de host en la lista para especificar el nombre de host o la dirección IP del destino.
      • Si deseas establecer una conexión privada con tus sistemas de backend, selecciona Adjunto de extremo en la lista y, luego, selecciona el adjunto de extremo requerido en la lista Adjunto de extremo.
        Nota: Para comprender cómo crear un adjunto de extremo, consulta Adjunto de servicio de PSC y adjunto de extremo. Después de crear el adjunto de extremo, será visible en la lista Adjunto de extremo.

      Si deseas establecer una conexión pública a tus sistemas de backend con seguridad adicional, puedes considerar configurar direcciones IP de salida estáticas para tus conexiones y, luego, configurar tus reglas de firewall para incluir en la lista de entidades permitidas solo las direcciones IP estáticas específicas.

      Para ingresar destinos adicionales, haz clic en +Agregar destino.

   2. Haz clic en Siguiente.
6. En la sección Autenticación, ingresa los detalles de autenticación.
   1. Selecciona un Tipo de autenticación y, luego, ingresa los detalles relevantes.

      La conexión SAP SuccessFactors admite los siguientes tipos de autenticación:

      • Nombre de usuario y contraseña

   Para comprender cómo configurar estos tipos de autenticación, consulta Configura la autenticación.

   2. Haz clic en Siguiente.
7. Revisa: Revisa tus detalles de conexión y autenticación.
8. Haz clic en Crear.

Configura la autenticación

Ingresa los detalles según la autenticación que desees usar.

• Nombre de usuario y contraseña
  • Username: Nombre de usuario para el conector
  • Password: El Secret de Secret Manager que contiene la contraseña asociada con el conector.
  • Esquema de autenticación: El esquema que se usa para la autenticación

Entidades, operaciones y acciones

Todos los Integration Connectors 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 expone como entidades, operaciones y acciones.

Nota: Puedes ver las entidades, operaciones y acciones de un conector en la tarea de conectores.

• Entidades: Una entidad puede considerarse como un objeto o una colección de propiedades en la aplicación o servicio conectados. La definición de una entidad difiere de conector a conector. Por ejemplo, en un conector de bases de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; en un conector de sistema de mensajería, las colas son las entidades.

  Sin embargo, es posible que un conector no admita o tenga ninguna entidad, en cuyo caso la lista Entities estará vacía.

• Operaciones: Una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:
  • Lista
  • Obtener
  • Crear
  • Actualizar
  • Borrar

  Cuando se selecciona una entidad de la lista disponible, se genera una lista de operaciones disponibles para esa entidad. Para obtener una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea de conectores. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, esas operaciones no admitidas no se enumeran en la lista Operations.

• Acción: Una acción es una función de primera clase que está disponible para la integración mediante la interfaz de Conectores. Una acción te permite realizar cambios en una entidad o entidades y variar de un conector a otro. Por lo general, 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.

Nota: Todas las entidades y acciones tendrán un esquema asociado. Por ejemplo, un esquema de acción tendrá los detalles de los parámetros, como los nombres de los parámetros y su tipo de datos correspondiente. El esquema (metadatos) para entidades y acciones se recupera mediante la conexión en el entorno de ejecución desde tu backend. Si hay actualizaciones en el esquema, esas actualizaciones no se reflejarán automáticamente en tus conexiones existentes. Debes actualizar el esquema de forma manual. Para actualizar el esquema de una conexión, abre la página Detalles de la conexión de la conexión y, luego, haz clic en Actualizar esquema de conexión.

Limitaciones del sistema

El conector de SAP SuccessFactors puede procesar 10 transacciones por segundo, por nodo, y limita cualquier transacción que supere este límite. De forma predeterminada, Integration Connectors asigna 2 nodos (para una mejor disponibilidad) por una conexión.

Para obtener información sobre los límites aplicables a Integration Connectors, consulta Límites.

Nota: La cantidad de nodos de Integration Connectors ajustará la escala de forma automática y dinámica según tu uso. Sin embargo, si deseas reservar capacidad para grandes volúmenes sin esperar el ajuste de escala automático, puedes ajustar el valor mínimo de nodo para una conexión. Se requieren más nodos a fin de procesar más transacciones para una conexión. Por el contrario, se requieren menos nodos si una conexión procesa menos transacciones. Para configurar los valores del nodo, haz lo siguiente:

• Si eres un cliente de pago por uso, configura el valor mínimo y máximo de nodos en la página de edición de conexiones.
• Si eres un cliente basado en una suscripción, comunícate con el equipo de asistencia.

La cantidad máxima de transacciones que un nodo puede controlar dependen de varios factores. Por lo tanto, antes de ajustar la cantidad mínima de nodos para mejorar la capacidad de procesamiento, te recomendamos que verifiques si los sistemas de backend están configurados de manera óptima para manejar el tráfico requerido.

Acciones

En esta sección, se enumeran todas las acciones compatibles con la conexión SuccessFactors.

Acción UpsertEntity

Esta acción te permite insertar y actualizar el registro de una entidad.

Parámetros de entrada de la acción UpsertEntity

Nombre del parámetro	Tipo de datos	Obligatorio	Descripción
entityType	string	Verdadero	Es el tipo de entidad que se insertará y actualizará.
payload	objeto	Verdadero	Actualiza la carga útil 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 la inserción y actualización.

Por ejemplo, para configurar la acción UpsertEntity, consulta Ejemplos.

Ejemplos de acciones

En esta sección, se describe cómo realizar algunas de las acciones en este conector.

Ejemplo: actualiza un registro en una entidad

En el siguiente ejemplo, se actualiza un registro en la entidad PerPersonal.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción UpsertEntity y haz clic en Listo.
3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default 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: actualiza un registro en una entidad

En el siguiente ejemplo, se actualiza un registro en la entidad PaymentInformationDetailV3.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción UpsertEntity y haz clic en Listo.
3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default 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: crea un registro en una entidad

En el siguiente ejemplo, se crea un registro en la entidad TodoEntryV2.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción UpsertEntity y haz clic en Listo.
3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default 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: enumera los registros de una entidad

En este ejemplo, se enumeran los registros de la entidad FOCompany.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona FOCompany de la lista Entity.
3. Selecciona la operación LIST y, luego, haz clic en Listo.
4. En la sección Entrada de tarea de la tarea Conectores, puedes establecer la filterClause según tus necesidades.

   Por ejemplo, si configuras la cláusula de filtro como externalCode='5100' and startDate='1900-01-01 00:00:00', se enumeran solo los registros cuyo externalCode es 5100 y startDate es 1900-01-01 00:00:00.

Ejemplo: Obtén un registro de una entidad

En este ejemplo, se recupera un registro de la entidad User.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona User de la lista Entity.
3. Selecciona la operación GET y, luego, haz clic en Listo.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en EntityId y, luego, ingresa 103032 en el campo Valor predeterminado.

   Aquí, 103032 es la clave primaria de la entidad Users.

Ejemplo: Borra un registro de una entidad

En este ejemplo, se borra un registro de la entidad FOCompany.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona FOCompany de la lista Entity.
3. Selecciona la operación DELETE y, luego, haz clic en Listo.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en entityId y, luego, ingresa 113132 en el campo Valor predeterminado.

   De manera alternativa, si la entidad tiene claves primarias compuestas en lugar de especificar el entityId, puedes establecer la filterClause. Por ejemplo, externalCode='5100' and startDate='1900-01-01 00:00:00'.

Ejemplo: crea un registro en una entidad

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona FOCompany de la lista Entity.
3. Selecciona la operación Create y haz clic en Listo.
4. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default 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: crea un registro en la entidad TimeZone

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona TimeZone de la lista Entity.
3. Selecciona la operación Create y haz clic en Listo.
4. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default 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: actualiza un registro en una entidad

En este ejemplo, se actualiza un registro en la entidad FOCompany.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona FOCompany de la lista Entity.
3. Selecciona la operación Update y haz clic en Listo.
4. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:

   {
   "description": "BestRun India"
   }
   

5. En la sección Entrada de tarea de la tarea Conectores, haz clic en entityId y, luego, ingresa 103032 en el campo Valor predeterminado.

   De manera alternativa, si la entidad tiene claves primarias compuestas en lugar de especificar el entityId, puedes establecer la 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"
}

Usar Terraform para crear conexiones

Puedes usar el recurso de Terraform para crear una conexión nueva.

Si deseas obtener más información para aplicar o quitar una configuración de Terraform, consulta los comandos básicos de Terraform.

Si quieres ver una plantilla de Terraform de muestra para crear conexiones, consulta la plantilla de muestra.

Cuando creas esta conexión con Terraform, debes configurar las siguientes variables en tu archivo de configuración de Terraform:

Nombre del parámetro	Tipo de datos	Obligatorio	Descripción
company_id	STRING	Verdadero	Es el identificador único de tu empresa. Esto es necesario para la autenticación.
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 de CData ADO.NET para SAP SuccessFactors debe usar o no la paginación del cliente.
use_display_names	BOOLEAN	Falso	Es un valor booleano que determina si se usan o no las etiquetas de SAP.
verbosidad	STRING	Falso	El nivel de verbosidad para la conexión varía de 1 a 5. El nivel de verbosidad más alto registrará todos los detalles de la comunicación (solicitud,respuesta y certificados SSL).
proxy_enabled	BOOLEAN	Falso	Selecciona esta casilla de verificación a fin de configurar un servidor proxy para la conexión.
proxy_auth_scheme	ENUM	Falso	El tipo de autenticación que se utiliza para autenticarse en el proxy ProxyServer. Los valores admitidos son: BASIC, DIGEST, NONE.
proxy_user	STRING	Falso	Un nombre de usuario que se usará para autenticarse en el proxy ProxyServer.
proxy_password	SECRET	Falso	Una contraseña que se usará para autenticarse en el proxy ProxyServer.
proxy_ssltype	ENUM	Falso	El tipo de SSL que se usará para conectarse al proxy ProxyServer. Los valores admitidos son AUTO, ALWAYS, NEVER, TUNNEL.

Usa la conexión de SAP SuccessFactors en una integración

Después de crear la conexión, estará disponible en Apigee Integration y Application Integration. Puedes usar la conexión en una integración a través de la tarea Conectores.

• Para comprender cómo crear y usar la tarea Conectores en la integración de Apigee, consulta Tarea Conectores.
• Para comprender cómo crear y usar la tarea Conectores en Application Integration, consulta la Tarea Conectores.

Obtén ayuda de la Comunidad de Google Cloud

Puedes publicar tus preguntas y debatir sobre este conector en la comunidad de Google Cloud en Cloud Forums.

¿Qué sigue?

• Obtén información sobre cómo suspender y reanudar una conexión.
• Aprende a supervisar el uso del conector.
• Aprende a ver los registros del conector.