Sales Cloud – Analytics & AI

Follow this procedure to set up Sales Cloud – Analytics & AI as a proxy system.

Prerequisites

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

Context

Create a SCIM 2.0 proxy connector for Sales Cloud – Analytics & AI to execute hybrid scenarios. That means, it can provision its entities to another (external) back-end system by request, and then can continue executing CRUD operations back to the SCAAI system, whenever the external back end requests such. This scenario supports provisioning users and user assignments to groups.

Procedure

Open your subaccount in SAP BTP cockpit (valid for OAuth authentication to the Identity Provisioning proxy system).

Note

If you have a bundle tenant, then in the cockpit → Neo → Overview, you can see the Global account, which SAP provides for your bundle in the corresponding Identity Provisioning region. Then, in the global account, you can see your subaccount, where the Identity Provisioning is enabled as a service for the bundle. The display name of the subaccount starts with SAP_BUNDLE.
Create a technical user with the necessary authorizations. It will later be used by the external consumer to connect to Identity Provisioning.
- For Certificate-based authentication, follow the procedure in Manage Certificates for Inbound Connection → SAP BTP, Neo Environment
- For OAuth authentication, proceed as follows:
  1. Go to Security OAuth Clients and choose Register New Client.
  2. From the Subscription combo box, select <provider_subaccount>/ipsproxy.
  3. From the Authorization Grant combo box, select Client Credentials.
  4. In the Secret field, enter a password (client secret) and remember it. You will need it later, for the repository configuration in the external system.
  5. Copy/paste and save (in a notepad) the generated Client ID. You will need it later, too.
  6. From the left-side navigation, choose Subscriptions Java Applications ipsproxy .
  7. From the left-side navigation, choose Roles IPS_PROXY_USER.
  8. Choose Assign and enter oauth_client_<client_ID>.
    
    For <client_ID>, enter the one you have saved in the previous main step.
Access the Identity Provisioning UI.
- Access Identity Provisioning UI of Bundle Tenants
- Access Identity Provisioning UI of Standalone Tenants
Add Sales Cloud – Analytics & AI as a proxy system. For more information, see Add New Systems.

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

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)sales.cloud.analytics_ai.group.filter	Enter a group filter criteria, according to the API syntax of SCAAI. For example: displayName eq "first_group"
(Optional)sales.cloud.analytics_ai.user.filter	Enter a user filter criteria, according to the API syntax of SCAAI. For example: externalId eq "John123"

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

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 proxy 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.

Default read and write transformations:

Tip

The proxy Read Transformation is used when the external client application (for example, SAP Identity Management) makes initial load. That is, executing GET requests to the resource endpoints (/Users or /Groups) to retrieve the corresponding entities of the particular type. The external client application can also execute GET requests to a single resource endpoint (querying a single resource is supported). In this case, the proxy system acts as a source one.

The proxy Write Transformation is used when the external application manages the entities in the proxy system – creates new entities, updates existing ones, or deletes existing ones. In this case, the proxy system acts as a target one.

However, after a Create or Update operation is performed on the proxy system, the Read Transformation is applied to the result, so that the created or updated entity is sent back to the external application. This behavior demonstrates that the proxy Read Transformation is used for write cases, as well.

Read Transformation	Write Transformation
Code Syntax { "user": { "scimEntityEndpoint": "Users", "mappings": [ { "sourcePath": "$.id", "targetPath": "$.id", "targetVariable": "entityIdSourceSystem" }, { "sourceVariable": "entityBaseLocation", "targetVariable": "entityLocationSourceSystem", "targetPath": "$.meta.location", "functions": [ { "type": "concatString", "suffix": "${entityIdSourceSystem}" } ] }, { "sourcePath": "$.schemas", "preserveArrayWithSingleElement": true, "targetPath": "$.schemas" }, { "sourcePath": "$.userName", "targetPath": "$.userName", "correlationAttribute": true }, { "sourcePath": "$.groups", "targetPath": "$.groups", "preserveArrayWithSingleElement": true, "optional" : true }, { "type": "remove", "targetPath": "$.groups[].display" }, { "type": "remove", "targetPath": "$.groups[].ref" } ] }, "group": { "scimEntityEndpoint": "Groups", "mappings": [ { "sourcePath": "$.id", "targetPath": "$.id", "targetVariable": "entityIdSourceSystem" }, { "sourceVariable": "entityBaseLocation", "targetVariable": "entityLocationSourceSystem", "targetPath": "$.meta.location", "functions": [ { "type": "concatString", "suffix": "${entityIdSourceSystem}" } ] }, { "constant": "urn:ietf:params:scim:schemas:core:2.0:Group", "targetPath": "$.schemas[0]" }, { "sourcePath": "$.displayName", "targetPath": "$.displayName" }, { "optional": true, "preserveArrayWithSingleElement": true, "sourcePath": "$.members", "targetPath": "$.members" }, { "type": "remove", "targetPath": "$.members[].$ref" }, { "type": "remove", "targetPath": "$.members[].display" } ] } }	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" } ], "scimEntityEndpoint": "Users" }, "group": { "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)]" } ], "scimEntityEndpoint": "Groups" } }

Read Transformation

Write Transformation

Code Syntax

{
  "user": {
    "scimEntityEndpoint": "Users",
    "mappings": [
      {
        "sourcePath": "$.id",
        "targetPath": "$.id",
        "targetVariable": "entityIdSourceSystem"
      },
      {
        "sourceVariable": "entityBaseLocation",
        "targetVariable": "entityLocationSourceSystem",
        "targetPath": "$.meta.location",
        "functions": [
          {
            "type": "concatString",
            "suffix": "${entityIdSourceSystem}"
          }
        ]
      },
      {
        "sourcePath": "$.schemas",
        "preserveArrayWithSingleElement": true,
        "targetPath": "$.schemas"
      },
      {
        "sourcePath": "$.userName",
        "targetPath": "$.userName",
        "correlationAttribute": true
      },
      {
        "sourcePath": "$.groups",
        "targetPath": "$.groups",
        "preserveArrayWithSingleElement": true,
        "optional" : true
      },
      {
        "type": "remove",
        "targetPath": "$.groups[*].display"
      },
      {
        "type": "remove",
        "targetPath": "$.groups[*].ref"
      }
    ]
  },
  "group": {
    "scimEntityEndpoint": "Groups",
    "mappings": [
      {
        "sourcePath": "$.id",
        "targetPath": "$.id",
        "targetVariable": "entityIdSourceSystem"
      },
      {
        "sourceVariable": "entityBaseLocation",
        "targetVariable": "entityLocationSourceSystem",
        "targetPath": "$.meta.location",
        "functions": [
          {
            "type": "concatString",
            "suffix": "${entityIdSourceSystem}"
          }
        ]
      },
      {
        "constant": "urn:ietf:params:scim:schemas:core:2.0:Group",
        "targetPath": "$.schemas[0]"
      },
      {
        "sourcePath": "$.displayName",
        "targetPath": "$.displayName"
      },
      {
        "optional": true,
        "preserveArrayWithSingleElement": true,
        "sourcePath": "$.members",
        "targetPath": "$.members"
      },
      {
        "type": "remove",
        "targetPath": "$.members[*].$ref"
      },
      {
        "type": "remove",
        "targetPath": "$.members[*].display"
      }
    ]
  }
}

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"
            }
        ],
        "scimEntityEndpoint": "Users"
    },
    "group": {
        "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)]"
            }
        ],
        "scimEntityEndpoint": "Groups"
    }
}

If you want the users and groups in SCAAI to have the same IDs as the respective users and groups in the external back-end system, modify the Write Transformation mappings as follows:

{
    "user": {
        "mappings": [
            {
                "sourcePath": "$.id",
                "targetPath": "$.externalId"
            },
...

    "group": {
        "mappings": [
            {
                "sourcePath": "$.id",
                "targetPath": "$.externalId"
            },
...

}

Connect the external consumer to Identity Provisioning with the technical user you have created in step 2.
If the external consumer system is SAP Identity Management, you can export the newly created proxy system as a SCIM repository from Identity Provisioning and import it in SAP Identity Management. This will create a SCIM repository in SAP Identity Management where most of the repository constants will be automatically filled in. You need to provide the technical user credentials that you have set up in step 2 and the SCIM assignment method as described below:
- For AUTH_USER and AUTH_PASSWORD, enter your client ID and secret.
- For the SCIM_ASSIGNMENT_METHOD constant, make sure the value is PATCH.
Note

For external consumer systems, other than SAP Identity Management, you should also use the PATCH method for modifying entities.

Next Steps

When a proxy system is connected to an external backend system (in the case of SAP Identity Management this means the exported CSV file is imported into the Identity Management Admin UI and a repository is configured), you can start managing the users and groups into this external system. Usually, the first operation is the initial load of the existing entities into your external system. When this load has finished, changes in the external system, such as creating new users or updating existing ones, can trigger CRUD requests back to the proxy system.

To see an example with SAP Identity Management, see Hybrid Scenario: SAP Identity Management → sections Next Steps and Future Identity Lifecycle.