Skip to content

Latest commit

 

History

History
668 lines (522 loc) · 23.9 KB

sap-ariba-central-invoice-management-64a167d.md

File metadata and controls

668 lines (522 loc) · 23.9 KB

SAP Ariba Central Invoice Management

Follow this procedure to set up SAP Ariba Central Invoice Management as a proxy system.

Prerequisites

Restriction:

This system is available for bundle tenants running on SAP Cloud Identity infrastructure and standalone tenants running on SAP Cloud Identity infrastructure and SAP BTP, Neo environment. Bundle tenants running on Neo environment can use it only through SAP Jam Collaboration and SAP Identity Access Governance bundle options.

You have created an instance and generated a service key for the scim service plan of SAP Ariba Central Invoice Management. This step is automated by the booster Set Up SAP Ariba Central Invoice Management. For more information, see Setting Up Invoice Processing with SAP Ariba Central Invoice Management (4N6) –> Set up Configuration Using Booster in SAP BTP Cockpit.

Note:

Administrators of bundle tenants on Neo environment should enable the Manage OAuth Clients permission, as described in Neo Environment section in Manage Authorizations ↗️.

Context

SAP Ariba Central Invoice Management is an SAP BTP SaaS application running on SAP BTP, Cloud Foundry environment. This application enables central management of supplier invoices from multiple connected systems, such as SAP S/4HANA Cloud systems.

You can use Identity Provisioning to configure SAP Ariba Central Invoice Management as a proxy system in hybrid scenarios. For example, when SAP Ariba Central Invoice Management is exposed as a proxy system, you can connect it to an external identity management system, such as SAP Identity Management, without making a direct connection between both systems. You can provision users to the external backend system, which can trigger CRUD (create, read, update, delete) operations on users back to the SAP Ariba Central Invoice Management.

This scenario supports provisioning users and groups.

Procedure

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

  2. Sign in to the administration console of SAP Cloud Identity Services and navigate to Users & Authorizations > Administrators.

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

    • For Certificate-based authentication, upload the certificate for the technical user of type System, as described in Add System as Administrator and enable the Access Proxy System API permission.

    • For Basic authentication, proceed as follows:

      1. Add an administrator user of type System and configure the basic authentication method for this user.

        If you already have a technical user, skip this step.

      2. Save your changes.

      3. Select your administrator user of type System and enable the Access Proxy System API permission.

      4. Save your changes.

  4. Access the Identity Provisioning UI.

  5. Add SAP Ariba Central Invoice Management as a proxy system. For more information, see Add New Systems.

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

    Enter the URL provided by the service key under the ips-connector field without adding the path information.

    For example: https://eu10.cim.cloud.sap

    ProxyType

    Enter: Internet

    Authentication

    Enter: BasicAuthentication

    User

    Enter the value from the clientid field of the service key.

    Password

    (Credential) Enter the value from the clientsecret field of the service key.

    OAuth2TokenServiceURL

    Enter the OAuth 2.0 Token Service URL. This is the value from the url field of the service key plus /oauth/token

    For example: https://<my tenant>.authentication.eu10.hana.ondemand.com/oauth/token

    (Optional) cim.user.filter

    When specified, only those SAP Ariba Central Invoice Management users matching the filter expression will be read.

    Example: name.familyName eq "Smith" and addresses.country eq "US"

    (Optional) cim.group.filter

    When specified, only those SAP Ariba Central Invoice Management groups matching the filter expression will be read.

    Example: displayName eq "ProjectTeam1"

    (Optional) cim.user.unique.attribute

    If Identity Provisioning tries to provision a user that already exists in the target system (a conflicting user), this property defines the unique attributes by which the existing user will be searched and resolved. The property is not added automatically at system creation.

    Possible values:

    • userName - default value
    • emails[*].value
    • userName,emails[*].value

    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.

    Note:

    The Identity Provisioning implementation of the Proxy System SCIM API (based on the SCIM Query) supports single entity and delta read filtering for users and groups. For more information, see Query Parameters for Proxy System SCIM API.

  7. 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 SAP Ariba Central Invoice Management 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 SAP Ariba Central Invoice Management system. For more information, see:

    Manage Transformations

    User Management (SCIM) for SAP Ariba Central Invoice Management

    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"
      },
      {
        "sourcePath": "$.meta",
        "targetPath": "$.meta",
        "optional": true
      },
      {
        "sourceVariable": "entityBaseLocation",
        "targetPath": "$.meta.location",
        "targetVariable": "entityLocationSourceSystem",
        "functions": [
          {
            "type": "concatString",
            "suffix": "${entityIdSourceSystem}"
          }
        ]
      },
      {
        "sourcePath": "$.schemas",
        "targetPath": "$.schemas",
        "preserveArrayWithSingleElement": true
      },
      {
        "sourcePath": "$.userName",
        "targetPath": "$.userName",
        "correlationAttribute": true
      },
      {
        "sourcePath": "$.externalId",
        "targetPath": "$.externalId",
        "optional": true
      },
      {
        "sourcePath": "$.name.givenName",
        "targetPath": "$.name.givenName",
        "optional": true
      },
      {
        "sourcePath": "$.name.middleName",
        "targetPath": "$.name.middleName",
        "optional": true
      },
      {
        "sourcePath": "$.name.familyName",
        "targetPath": "$.name.familyName",
        "optional": true
      },
      {
        "sourcePath": "$.name.formatted",
        "targetPath": "$.name.formatted",
        "optional": true
      },
      {
        "sourcePath": "$.name.honorificPrefix",
        "targetPath": "$.name.honorificPrefix",
        "optional": true
      },
      {
        "sourcePath": "$.name.honorificSuffix",
        "targetPath": "$.name.honorificSuffix",
        "optional": true
      },
      {
        "sourcePath": "$.emails[*].value",
        "targetPath": "$.emails[?(@.value)]",
        "optional": true,
        "preserveArrayWithSingleElement": true
      },
      {
        "sourcePath": "$.emails[?(@.primary== true)].value",
        "optional": true,
        "correlationAttribute": true
      },
      {
        "sourcePath": "$.active",
        "targetPath": "$.active"
      },
      {
        "sourcePath": "$.userType",
        "targetPath": "$.userType",
        "optional": true
      },
      {
        "sourcePath": "$.locale",
        "targetPath": "$.locale",
        "optional": true
      },
      {
        "sourcePath": "$.timezone",
        "targetPath": "$.timezone",
        "optional": true
      },
      {
        "sourcePath": "$.displayName",
        "targetPath": "$.displayName",
        "optional": true
      },
      {
        "sourcePath": "$.groups",
        "targetPath": "$.groups",
        "optional": true,
        "preserveArrayWithSingleElement": true
      }
    ]
  },
  "group": {
    "scimEntityEndpoint": "Groups",
    "mappings": [
      {
        "sourcePath": "$.id",
        "targetPath": "$.id",
        "targetVariable": "entityIdSourceSystem"
      },
      {
        "sourceVariable": "entityBaseLocation",
        "targetPath": "$.meta.location",
        "targetVariable": "entityLocationSourceSystem",
        "functions": [
          {
            "type": "concatString",
            "suffix": "${entityIdSourceSystem}"
          }
        ]
      },
      {
        "sourcePath": "$.externalId",
        "targetPath": "$.externalId"
      },
      {
        "sourcePath": "$.schemas",
        "targetPath": "$.schemas",
        "preserveArrayWithSingleElement": true
      },
      {
        "sourcePath": "$.displayName",
        "targetPath": "$.displayName"
      },
      {
        "sourcePath": "$.members",
        "targetPath": "$.members",
        "optional": true,
        "preserveArrayWithSingleElement": true
      }
    ]
  }
}

    Code Syntax:

    {
	"user": {
		"scimEntityEndpoint": "Users",
		"mappings": [
			{
				"sourceVariable": "entityIdTargetSystem",
				"targetPath": "$.id"
			},
			{
				"constant": [
					"urn:ietf:params:scim:schemas:core:2.0:User"
				],
				"targetPath": "$.schemas"
			},
			{
				"sourcePath": "$.userName",
				"targetPath": "$.userName"
			},
			{
				"sourcePath": "$.externalId",
				"targetPath": "$.externalId",
				"optional": true
			},
			{
				"sourcePath": "$.name.givenName",
				"targetPath": "$.name.givenName",
				"optional": true
			},
			{
				"sourcePath": "$.name.middleName",
				"targetPath": "$.name.middleName",
				"optional": true
			},
			{
				"sourcePath": "$.name.familyName",
				"targetPath": "$.name.familyName",
				"optional": true
			},
			{
				"sourcePath": "$.name.formatted",
				"targetPath": "$.name.formatted",
				"optional": true
			},
			{
				"sourcePath": "$.name.honorificPrefix",
				"targetPath": "$.name.honorificPrefix",
				"optional": true
			},
			{
				"sourcePath": "$.name.honorificSuffix",
				"targetPath": "$.name.honorificSuffix",
				"optional": true
			},
			{
				"sourcePath": "$.emails",
				"preserveArrayWithSingleElement": true,
				"optional": true,
				"targetPath": "$.emails"
			},
			{
				"sourcePath": "$.active",
				"targetPath": "$.active",
				"optional": true
			},
			{
				"sourcePath": "$.displayName",
				"targetPath": "$.displayName",
				"optional": true
			},
			{
				"sourcePath": "$.nickName",
				"targetPath": "$.nickName",
				"optional": true
			},
			{
				"sourcePath": "$.profileUrl",
				"targetPath": "$.profileUrl",
				"optional": true
			},
			{
				"sourcePath": "$.title",
				"targetPath": "$.title",
				"optional": true
			},
			{
				"sourcePath": "$.userType",
				"targetPath": "$.userType",
				"optional": true
			},
			{
				"sourcePath": "$.preferedLanguage",
				"targetPath": "$.preferredLanguage",
				"optional": true
			},
			{
				"sourcePath": "$.locale",
				"targetPath": "$.locale",
				"optional": true
			},
			{
				"sourcePath": "$.timezone",
				"targetPath": "$.timezone",
				"optional": true
			},
			{
				"constant": "urn:ietf:params:scim:api:messages:2.0:PatchOp",
				"targetPath": "$.schemas[0]",
				"scope": "patchEntity"
			},
			{
				"sourcePath": "$.Operations",
				"preserveArrayWithSingleElement": true,
				"targetPath": "$.Operations",
				"scope": "patchEntity"
			}
		]
	},
	"group": {
		"scimEntityEndpoint": "Groups",
		"mappings": [
			{
				"sourceVariable": "entityIdTargetSystem",
				"targetPath": "$.id"
			},
			{
				"constant": [
					"urn:ietf:params:scim:schemas:core:2.0:Group"
				],
				"targetPath": "$.schemas"
			},
			{
				"sourcePath": "$.externalId",
				"targetPath": "$.externalId",
				"optional": true
			},
			{
				"sourcePath": "$.displayName",
				"targetPath": "$.displayName"
			},
			{
				"sourcePath": "$.members[*].value",
				"preserveArrayWithSingleElement": true,
				"optional": true,
				"targetPath": "$.members[?(@.value)]"
			},
			{
				"sourcePath": "$.Operations",
				"targetPath": "$.Operations",
				"preserveArrayWithSingleElement": true,
				"scope": "patchEntity"
			},
			{
				"sourcePath": "$.schemas",
				"targetPath": "$.schemas",
				"preserveArrayWithSingleElement": true,
				"scope": "patchEntity"
			}
		]
	}
}

  8. 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 PUT.

    • For AUTH_USER and AUTH_PASSWORD, enter the user ID and password of the Identity Authentication technical user for which you have set permission Access Proxy System API.

    • For the SCIM_ASSIGNMENT_METHOD constant, make sure the value is PUT.

    Note:

    For external consumer systems, other than SAP Identity Management, you should also use the PUT 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.

Caution:

Effective September 2020, Shanghai (China) tenants that reside on SAP BTP, Neo environment can be only accessed on the following domain: dispatcher.cn1.platform.sapcloud.cn

So make sure you use the correct domain when you construct your REST API requests.

For example: GET https://ipsproxyabcd12345-xyz789.dispatcher.cn1.platform.sapcloud.cn/ipsproxy/api/v1/scim/bbb111aa-1234-aaaa-7777-1234567abcde/Users/s123456789

To learn more, see: Proxy Systems

Related Information

SAP Ariba Central Invoice Management