Skip to content

Latest commit

 

History

History
337 lines (233 loc) · 10.1 KB

sales-cloud-analytics-ai-7197402.md

File metadata and controls

337 lines (233 loc) · 10.1 KB

Sales Cloud – Analytics & AI

Follow this procedure to set up a target connector for Sales Cloud – Analytics & AI.

You have technical user credentials for an Sales Cloud – Analytics & AI (in short, SCAAI) system with read and write access permissions.

Context

After fulfilling the prerequisites, follow the procedure to add a target system for Sales Cloud – Analytics & AI to write users and user assignments to groups. This target system consumes SCIM 2.0 API provided by SCAAI.

Procedure

  1. Access the Identity Provisioning UI.

  2. Sign in to the administration console of SAP Cloud Identity Services and navigate to Identity Provisioning > Target Systems.

  3. Add Sales Cloud – Analytics & AI as a target system. For more information, see Add New Systems.

  4. Choose the Properties tab to configure the connection settings for your system.

    Note:

    If your tenant is running on SAP BTP, Neo environment, you can create a connectivity destination in your subaccount in the SAP BTP cockpit, and then select it from the Destination Name combo box in your Identity Provisioning User Interface.

    If one and the same property exists both in the cockpit and in the Properties tab, the value set in the Properties tab is considered with higher priority.

    We recommend that you use the Properties tab. Use a connectivity destination only if you need to reuse one and the same configuration for multiple provisioning systems.

    Mandatory Properties

    Property Name

    Value

    Type

    Enter: HTTP

    URL

    Specify the URL to the SCIM API portal of your SCAAI system.

    ProxyType

    Enter: Internet

    Authentication

    Enter: BasicAuthentication

    User

    Enter the user for your SCAAI system.

    Password

    (Credential) Enter the password for your SCAAI user.

    OAuth2TokenServiceURL

    Enter the URL to the OAuth2 token service.

    If not sure about the exact URL, ask your SCAAI administrator.

    (Optional) ips.delete.threshold.groups

    Use this property to control the number of groups to be deleted in a target system by defining a threshold. This will prevent you from accidentally deleting a huge number of groups, for example by adding a filter or condition.

    For more information, see: List of Properties

    (Optional) ips.delete.threshold.users

    Use this property to control the number of users to be deleted in a target system by defining a threshold. This will prevent you from accidentally deleting a huge number of users, for example by adding a filter or condition.

    For more information, see: List of Properties

    To learn what additional properties are relevant to this system, see List of Properties. You can use the main search, or filter properties by the Name or System Type columns.

    Exemplary destination:

    Type=HTTP

    Authentication=BasicAuthentication

    ProxyType=Internet

    URL=http://myscaai:8080/scim\_services

    User=MySCAAIUser

    Password=************

    OAuth2TokenServiceURL=http://myscaai:8080/gateway\_services/api/auth/ips/token

  5. (Optional) Configure the transformations.

    Transformations are used to map the user attributes from the data model of the source system to the data model of the target system, and the other way around. The Identity Provisioning offers a default transformation for the Sales Cloud – Analytics & AI target system, whose settings are displayed under the Transformations tab after saving its initial configuration.

    You can change the default transformation mapping rules to reflect your current setup of entities in your Sales Cloud – Analytics & AI. For more information, see: Manage Transformations

    Mapping logic – The behavior of the default transformation logic is to map all attributes from the internal SCIM representation to the target entity. The Identity Provisioning takes a user's original userName (from the source system) and assigns it as a user ID in the target SCAAI system. Analogically, the Identity Provisioning takes a group's original displayName and assigns it as a group ID in SCAAI.

    Default transformation:

    Code Syntax:

    
    {
        "user": {
            "mappings": [
                {
                    "sourceVariable": "entityIdTargetSystem",
                    "targetPath": "$.id"
                },
                {
                    "sourcePath": "$.userName",
                    "targetPath": "$.externalId"
                },
                {
                    "constant": "urn:ietf:params:scim:schemas:core:2.0:User",
                    "targetPath": "$.schemas[0]"
                },
                {
                    "sourcePath": "$.userName",
                    "targetPath": "$.userName"
                }
            ]
        },
        "group": {
            "skipOperations": [
                "delete"
            ],
            "mappings": [
                {
                    "sourceVariable": "entityIdTargetSystem",
                    "targetPath": "$.id"
                },
                {
                    "sourcePath": "$.displayName",
                    "targetPath": "$.externalId"
                },
                {
                    "constant": "urn:ietf:params:scim:schemas:core:2.0:Group",
                    "targetPath": "$.schemas[0]"
                },
                {
                    "sourcePath": "$.displayName",
                    "targetPath": "$.displayName"
                },
                {
                    "sourcePath": "$.members[*].value",
                    "preserveArrayWithSingleElement": true,
                    "optional": true,
                    "targetPath": "$.members[?(@.value)]",
                    "functions": [
                        {
                            "function": "resolveEntityIds"
                        }
                    ]
                }
            ]
        }
    }
    
    

    If you want the users and groups in SCAAI to have the same IDs as the respective users and groups in the source system, modify the transformation mappings as follows:

    • In the source system:

      
      {
          "user": {
              "mappings": [
                  {
                      "sourcePath": "$.id",
                      "targetPath": "$.id",
                      "correlationAttribute": true
                  },
      ...
      
          "group": {
              "mappings": [
                  {
                      "sourcePath": "$.id",
                      "targetPath": "$.id"
                  },
      ...
      
      }
      
    • In the SCAAI target system:

      
      {
          "user": {
              "mappings": [
                  {
                      "sourcePath": "$.id",
                      "targetPath": "$.externalId"
                  },
      ...
      
          "group": {
              "mappings": [
                  {
                      "sourcePath": "$.id",
                      "targetPath": "$.externalId"
                  },
      ...
      
      }
      
  6. Now, add a source system from which to read users. Choose from: Source Systems

  • Before starting a provisioning job, you can first subscribe for e-mail notifications from the source system you use in your scenario. This way, you will be notified by e-mail about eventual failed entities during the jobs. For more information, see Manage Job Notifications.
  • Now, start an identity provisioning job. For more information, see Monitor Provisioning Job Logs.