SAP SuccessFactors

Le connecteur SAP SuccessFactors vous permet d'effectuer des opérations d'insertion, de suppression, de mise à jour et de lecture sur des données SAP SuccessFactors.

Avant de commencer

Avant d'utiliser le connecteur SAP SuccessFactors, effectuez les tâches suivantes :

  • Dans votre projet Google Cloud :
    • Assurez-vous que la connectivité réseau est configurée. Pour en savoir plus sur les schémas de réseau, consultez Connectivité réseau.
    • Attribuez le rôle IAM roles/connectors.admin à l'utilisateur qui configure le connecteur.
    • Attribuez les rôles IAM suivants au compte de service que vous souhaitez utiliser pour le connecteur :
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Un compte de service est un type spécial de compte Google destiné à représenter un utilisateur non humain qui doit s'authentifier et obtenir les autorisations permettant d'accéder aux données des API Google. Si vous ne possédez pas de compte de service, vous devez en créer un. Pour en savoir plus, consultez Créer un compte de service.

    • Activez les services suivants :
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Pour savoir comment activer des services, consultez Activer des services.

    Si ces services ou autorisations n'ont pas encore été activés pour votre projet, vous êtes invité à les activer au moment de configurer le connecteur.

  • Pour créer un compte SuccessFactors payant à l'aide d'un ID SAP, consultez le guide de démarrage rapide avec SAP SuccessFactors.

Configurer le connecteur

Une connexion est propre à une source de données. Cela signifie que si vous disposez de nombreuses sources de données, vous devez créer une connexion distincte pour chacune d'elles. Pour créer une connexion, procédez comme suit :

  1. Dans la console Cloud, accédez à la page Connecteurs d'intégration > Connexions, puis sélectionnez ou créez un projet Google Cloud.

    Accéder à la page "Connexions"

  2. Cliquez sur + Créer pour ouvrir la page Créer une connexion.
  3. Dans la section Emplacement, choisissez l'emplacement de la connexion.
    1. Région : sélectionnez un emplacement dans la liste déroulante.

      Pour obtenir la liste de toutes les régions disponibles, consultez Emplacements.

    2. Cliquez sur Suivant.
  4. Dans la section Détails de connexion, procédez comme suit :
    1. Connecteur : sélectionnez SuccessFactors dans la liste déroulante des connecteurs disponibles.
    2. Version du connecteur : sélectionnez la version du connecteur dans la liste déroulante des versions disponibles.
    3. Dans le champ Nom de connexion, indiquez le nom de l'instance de connexion.

      Les noms de connexion doivent répondre aux critères suivants :

      • Ils peuvent contenir des lettres, des chiffres ou des traits d'union.
      • Les lettres doivent être en minuscules.
      • Ils doivent commencer par une lettre et se terminer par une lettre ou un chiffre.
      • Ils ne peuvent pas dépasser 49 caractères.
    4. (Facultatif) Saisissez une description de l'instance de connexion.
    5. (Facultatif) Activez Cloud Logging, puis sélectionnez un niveau de journalisation. Par défaut, le niveau de journalisation est défini sur Error.
    6. Compte de service : sélectionnez un compte de service disposant des rôles requis.
    7. (Facultatif) Configurez les paramètres des nœuds de connexion :

      • Nombre minimal de nœuds : saisissez le nombre minimal de nœuds de connexion.
      • Nombre maximal de nœuds : saisissez le nombre maximal de nœuds de connexion.

      Un nœud est une unité (ou instance répliquée) de connexion qui traite des transactions. Pour traiter davantage de transactions pour une connexion, vous devez disposer de plus de nœuds. À l'inverse, moins de nœuds sont nécessaires si une connexion traite moins de transactions. Pour comprendre comment les nœuds affectent la tarification de votre connecteur, consultez Tarifs des nœuds de connexion. Si vous ne saisissez aucune valeur, le nombre minimal de nœuds est défini par défaut sur 2 (pour améliorer la disponibilité) et le nombre maximal de nœuds sur 50.

    8. ID de l'entreprise : identifiant unique de votre entreprise. Il est obligatoire pour l'authentification.
    9. Format de données : format dans lequel extraire les données. Sélectionnez ATOM ou JSON.
    10. Inclure les propriétés de navigation : valeur booléenne indiquant si les propriétés de navigation doivent être incluses dans la liste des colonnes.
    11. Type de suppression définitive : PurgeType est un paramètre facultatif qui détermine si une mise à jour incrémentielle ou complète sera effectuée sur une entité.
    12. Utiliser la pagination côté client : indique si le fournisseur CData ADO.NET pour SAP SuccessFactors doit utiliser la pagination côté client.
    13. Utiliser les noms à afficher : valeur booléenne déterminant si les étiquettes SAP doivent être utilisées ou non.
    14. Utiliser un proxy : indique si les paramètres proxy du système doivent être utilisés ou non. Cette option prévaut sur les autres paramètres proxy. Vous devez donc définir ProxyAutoDetect sur "FALSE" pour utiliser des paramètres proxy personnalisés.
    15. Schéma d'authentification du proxy : type d'authentification à utiliser pour s'authentifier auprès du proxy ProxyServer.
    16. Utilisateur du proxy : nom d'utilisateur permettant de s'authentifier auprès du proxy ProxyServer.
    17. Mot de passe du proxy : mot de passe à utiliser pour s'authentifier auprès du proxy ProxyServer.
    18. Type SSL du proxy : type SSL à utiliser pour se connecter au proxy ProxyServer.
    19. (Facultatif) Dans la section Paramètres avancés, cochez la case Utiliser un proxy pour configurer un serveur proxy pour la connexion et configurez les valeurs suivantes :
      • Schéma d'authentification du proxy : sélectionnez le type d'authentification pour l'authentification auprès du serveur proxy. Les types d'authentification suivants sont compatibles :
        • De base : authentification HTTP de base.
        • Digest : authentification HTTP Digest.
      • Utilisateur du proxy : nom d'utilisateur permettant de s'authentifier auprès du serveur proxy.
      • Mot de passe du proxy : secret Secret Manager du mot de passe de l'utilisateur.
      • Type SSL du proxy : type SSL à utiliser pour se connecter au serveur proxy. Les types d'authentification suivants sont compatibles :
        • Auto : paramètre par défaut. Dans le cas d'une URL HTTPS, l'option "Tunnel" est utilisée. Dans le cas d'une URL HTTP, l'option "Jamais" est utilisée.
        • Toujours : le protocole SSL est toujours activé pour la connexion.
        • Jamais : le protocole SSL n'est pas activé pour la connexion.
        • Tunnel : la connexion s'effectue avec un proxy de tunnelisation. Le serveur proxy ouvre une connexion à l'hôte distant et le trafic transite par le proxy.
      • Dans la section Serveur proxy, saisissez les détails du serveur proxy.
        1. Cliquez sur + Ajouter une destination.
        2. Sélectionnez un type de destination.
          • Adresse de l'hôte : spécifiez le nom d'hôte ou l'adresse IP de la destination.

            Si vous souhaitez établir une connexion privée à votre système backend, procédez comme suit :

    20. (Facultatif) Cliquez sur + AJOUTER UNE ÉTIQUETTE pour ajouter une étiquette à la connexion sous la forme d'une paire clé/valeur.
    21. Cliquez sur Suivant.
  5. Dans la section Destinations, saisissez des informations sur l'hôte distant (système backend) auquel vous souhaitez vous connecter.
    1. Type de destination : sélectionnez un type de destination.
      • Pour spécifier le nom d'hôte ou l'adresse IP de la destination, sélectionnez Adresse de l'hôte, puis saisissez l'adresse dans le champ Hôte 1.
      • Pour établir une connexion privée, sélectionnez Rattachement de point de terminaison, puis choisissez le rattachement requis dans la liste Rattachement de point de terminaison.

      Si vous souhaitez établir une connexion publique à vos systèmes backend avec une sécurité supplémentaire, vous pouvez envisager de configurer des adresses IP sortantes statiques pour vos connexions, puis de configurer vos règles de pare-feu pour ajouter à la liste d'autorisation uniquement les adresses IP statiques spécifiques.

      Pour saisir d'autres destinations, cliquez sur + Ajouter une destination.

    2. Cliquez sur Suivant.
  6. Dans la section Authentification, saisissez les informations d'authentification.
    1. Sélectionnez un type d'authentification, puis saisissez les informations appropriées.

      Le type d'authentification suivant est compatible avec la connexion SAP SuccessFactors :

      • Nom d'utilisateur et mot de passe

      2. Pour savoir comment configurer ce type d'authentification, consultez Configurer l'authentification.

    2. Cliquez sur Suivant.
  7. Vérifier : vérifiez vos informations de connexion et d'authentification.
  8. Cliquez sur Créer.

Configurer l'authentification

Saisissez les informations en fonction de l'authentification que vous souhaitez utiliser.

  • Nom d'utilisateur et mot de passe
    • Nom d'utilisateur : nom d'utilisateur pour le connecteur
    • Mot de passe : secret Secret Manager contenant le mot de passe associé au connecteur
    • Schéma d'authentification : schéma utilisé pour l'authentification

Exemple de type de connexion avec authentification de base

Le tableau suivant présente des exemples de valeurs de configuration pour le type de connexion avec authentification de base. Consultez l'interface de création de connexion dans la console pour connaître les champs obligatoires et facultatifs.

Nom du champ Exemple de valeur
Région us-central1
Connecteur SAP SuccessFactors
Version du connecteur 1
Nom de connexion sapsf-basicauth-conn
Description Connexion SuccessFactors
Compte de service SERVICE_ACCOUNT_NAME@developer.gserviceaccount.com
ID de l'entreprise SFPART068178
Adresse de l'hôte https://HOST_NAME.successfactors.eu/
Nom d'utilisateur sfadmin
Mot de passe PASSWORD
Schéma d'authentification De base

Entités, opérations et actions

Tous les connecteurs Integration Connectors fournissent une couche d'abstraction pour les objets de l'application connectée. Vous ne pouvez accéder aux objets d'une application que par le biais de cette abstraction. L'abstraction vous est présentée en tant qu'entités, opérations et actions.

  • Entité : une entité peut être considérée comme un objet ou un ensemble de propriétés dans l'application ou le service connectés. La définition d'une entité diffère d'un connecteur à l'autre. Par exemple, dans un connecteur de base de données, les tables sont les entités, alors que dans un connecteur de serveur de fichiers, ce sont les dossiers, et dans un connecteur de système de messagerie, ce sont les files d'attente.

    Toutefois, il est possible qu'un connecteur n'accepte ou ne possède aucune entité. Dans ce cas, la liste Entities est vide.

  • Opération : une opération est l'activité que vous pouvez effectuer sur une entité. Voici les opérations possibles :

    Lorsque vous sélectionnez une entité dans la liste proposée, cela génère une liste d'opérations disponibles pour l'entité. Pour obtenir une description détaillée des opérations, consultez les opérations d'entité de la tâche "Connecteurs". Cependant, si un connecteur n'accepte pas l'une des opérations d'entité, cette opération non compatible ne figure pas dans la liste Operations.

  • Action : une action est une fonction de première classe mise à la disposition de l'intégration par le biais de l'interface du connecteur. Une action vous permet de modifier une ou plusieurs entités, et varie d'un connecteur à l'autre. Normalement, une action comporte des paramètres d'entrée et un paramètre de sortie. Toutefois, il est possible qu'un connecteur n'accepte aucune action, auquel cas la liste Actions est vide.

Limites du système

Le connecteur SAP SuccessFactors peut traiter 10 transactions par seconde et par nœud, et limite les transactions au-delà de ce seuil. Par défaut, Integration Connectors alloue deux nœuds (pour améliorer la disponibilité) à une connexion.

Pour en savoir plus sur les limites applicables à Integration Connectors, consultez Limites.

Actions

Cette section liste toutes les actions compatibles avec la connexion SuccessFactors.

Action UpsertEntity

Cette action vous permet de faire un upsert sur un enregistrement pour une entité.

Paramètres d'entrée de l'action UpsertEntity

Nom du paramètre Type de données Obligatoire Description
entityType chaîne Oui Type d'entité qui doit faire l'objet d'un upsert.
payload objet Oui Upsert sur la charge utile au format JSON.

Paramètres de sortie de l'action UpsertEntity

Cette action renvoie l'état 200 (OK) avec un corps de réponse indiquant tous les résultats de l'upsert.

Pour obtenir des exemples de configuration de l'action UpsertEntity, consultez Exemples.

Exemples d'actions

Cette section explique comment effectuer certaines actions dans ce connecteur.

Exemple : Mettre à jour un enregistrement dans l'entité PerPersonal

L'exemple suivant met à jour un enregistrement dans l'entité PerPersonal.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action UpsertEntity, puis cliquez sur OK.
  3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
"entityType": "PerPersonal",
"payload": {
  "personIdExternal": "109031",
  "startDate": "1800-01-01 00:00:00.0",
  "firstName": "John",
  "lastName": "Job",
  "nationality": "IND"
  }
}

    4. Si l'action aboutit, le champ connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

    [{
  "personIdExternal": "109031",
  "startDate": "1989-12-31 23:00:00.0"
}]

Exemple : Mettre à jour un enregistrement dans l'entité PaymentInformationDetailV3

L'exemple suivant met à jour un enregistrement dans l'entité PaymentInformationDetailV3.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action UpsertEntity, puis cliquez sur OK.
  3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
  "entityType": "PaymentInformationDetailV3",
  "payload": {
    "PaymentInformationV3_effectiveStartDate": "2015-01-21 00:00:00.0",
    "PaymentInformationV3_worker": "82096",
    "externalCode": 563.0,
    "currency": "EUR"
  }
}

    4. Si l'action aboutit, le champ connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

    [{
  "externalCode": 563.0,
  "PaymentInformationV3_effectiveStartDate": "2015-01-20 23:00:00.0",
  "PaymentInformationV3_worker": "82096"
}]

Exemple : Créer un enregistrement dans une entité

L'exemple suivant crée un enregistrement dans l'entité TodoEntryV2.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action UpsertEntity, puis cliquez sur OK.
  3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ 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"
      }
    }
  }
}

    4. Si l'action aboutit, le champ connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

    [{
  "todoEntryId": 221443.0
}]

Exemples d'entités

Exemple : Lister les enregistrements d'une entité

Cet exemple liste les enregistrements de l'entité FOCompany.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez FOCompany dans la liste Entity.
  3. Sélectionnez l'opération LIST, puis cliquez sur OK.
  4. Dans la section Entrée de la tâche de la tâche Connecteurs, vous pouvez définir filterClause selon vos besoins.

    Par exemple, si vous définissez la clause de filtre sur externalCode='5100' and startDate='1900-01-01 00:00:00', vous ne voyez que les enregistrements dont l'externalCode est 5100 et la startDate est 1900-01-01 00:00:00.

Exemple : Récupérer un enregistrement à partir d'une entité

Cet exemple récupère un enregistrement de l'entité User.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez User dans la liste Entity.
  3. Sélectionnez l'opération GET, puis cliquez sur OK.
  4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur EntityId, puis saisissez 103032 dans le champ Valeur par défaut.

    Ici, 103032 est la clé primaire de l'entité Users.

Exemple : Supprimer un enregistrement d'une entité

Cet exemple supprime un enregistrement de l'entité FOCompany.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez FOCompany dans la liste Entity.
  3. Sélectionnez l'opération DELETE, puis cliquez sur OK.
  4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur entityId, puis saisissez 113132 dans le champ Valeur par défaut.

    Si l'entité comporte des clés primaires composites, vous pouvez définir filterClause au lieu de spécifier entityId. Par exemple : externalCode='5100' and startDate='1900-01-01 00:00:00'.

Exemple : Créer un enregistrement dans une entité

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez FOCompany dans la liste Entity.
  3. Sélectionnez l'opération Create, puis cliquez sur OK.
  4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
"externalCode": "1000",
"startDate": "1900-01-01 00:00:00.0",
"standardHours": 40.0,
"status": "I",
"currency": "EUR",
"country": "DEU"
}

    Si l'intégration aboutit, le champ connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

    {
"externalCode": "1000",
"startDate": "1900-01-01 00:00:00.0"
}

Exemple : Créer un enregistrement dans l'entité TimeZone

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez TimeZone dans la liste Entity.
  3. Sélectionnez l'opération Create, puis cliquez sur OK.
  4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
"effectiveStartDate": "2023-08-16 00:00:00.0",
"externalCode": "10013",
"effectiveStatus": "A",
"utcDstOffset": "UTC+01:00",
"utcOffset": "+0100"
}

    Si l'intégration aboutit, le champ connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

    {
"effectiveStartDate": "2023-08-16 00:00:00.0",
"externalCode": "10013"
}

Exemple : Mettre à jour un enregistrement dans une entité

Cet exemple met à jour un enregistrement dans l'entité FOCompany.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez FOCompany dans la liste Entity.
  3. Sélectionnez l'opération Update, puis cliquez sur OK.
  4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
"description": "BestRun India"
}
  5. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur entityId, puis saisissez 103032 dans le champ Valeur par défaut.

    Si l'entité comporte des clés primaires composites, vous pouvez définir filterClause au lieu de spécifier entityId. Par exemple : externalCode='5100' and startDate='1900-01-01 00:00:00'.

    6. Si l'intégration aboutit, le champ connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

    {
"externalCode": "5100",
"startDate": "1900-01-01 00:00:00.0"
}

Créer des connexions à l'aide de Terraform

Vous pouvez utiliser la ressource Terraform pour créer une connexion.

Pour savoir comment appliquer ou supprimer une configuration Terraform, consultez Commandes Terraform de base.

Pour afficher un exemple de modèle Terraform permettant de créer une connexion, consultez Exemple de modèle.

Lorsque vous créez cette connexion à l'aide de Terraform, vous devez définir les variables suivantes dans votre fichier de configuration Terraform :

Nom du paramètre Type de données Obligatoire Description
company_id CHAÎNE Oui Identifiant unique de votre entreprise. Il est obligatoire pour l'authentification.
purge_type CHAÎNE Non PurgeType est un paramètre facultatif qui détermine si une mise à jour incrémentielle ou complète sera effectuée sur une entité.
use_client_side_paging BOOLÉEN Non Indique si le fournisseur CData ADO.NET pour SAP SuccessFactors doit utiliser la pagination côté client.
use_display_names BOOLEAN False Valeur booléenne déterminant si les étiquettes SAP doivent être utilisées ou non.
verbosity CHAÎNE Non Niveau de verbosité de la connexion, compris entre 1 et 5. Un niveau de verbosité plus élevé consigne tous les détails de la communication (requête, réponse et certificats SSL).
proxy_enabled BOOLEAN False Cochez cette case afin de configurer un serveur proxy pour la connexion.
proxy_auth_scheme ENUM False Type d'authentification à utiliser pour s'authentifier auprès du proxy ProxyServer. Valeurs acceptées : BASIC, DIGEST et NONE.
proxy_user STRING False Nom d'utilisateur permettant de s'authentifier auprès du proxy ProxyServer.
proxy_password SECRET False Mot de passe à utiliser pour s'authentifier auprès du proxy ProxyServer.
proxy_ssltype ENUM False Type SSL à utiliser pour se connecter au proxy ProxyServer. Valeurs acceptées : AUTO, ALWAYS, NEVER et TUNNEL.

Utiliser la connexion à SAP SuccessFactors dans une intégration

Une fois la connexion créée, elle devient disponible dans Apigee Integration et Application Integration. Vous pouvez utiliser la connexion dans une intégration au moyen de la tâche "Connecteurs".

  • Pour savoir comment créer et utiliser la tâche "Connecteurs" dans Apigee Integration, consultez Tâche "Connecteurs".
  • Pour savoir comment créer et utiliser la tâche "Connecteurs" dans Application Integration, consultez Tâche "Connecteurs".

Demander de l'aide à la communauté Google Cloud

Vous pouvez publier vos questions et discuter de ce connecteur sur les forums Cloud de la communauté Google Cloud.

Étapes suivantes