Microapps

Integrate SAP Ariba

Integrate with SAP Ariba to review and approve requisition requests without requiring any additional logins.

Note:

We provide two SAP Ariba integration templates for your use. We recommend using the newer HTTP integration for most use-cases. The HTTP integration provides more power to configure the cached data structure.

For a comprehensive list of out-of-the-box SAP Ariba microapps, see Use SAP Ariba microapps.

Review prerequisites

You need these values to add the HTTP integration in Citrix Workspace Microapps:

  • Base URL: https://openapi.ariba.com/api/approval/v1/prod
  • Token URL: https://api.ariba.com/v2/oauth/token
  • Client ID: The client ID is the string representing client registration information unique to the authorization server. This is called OAuth Client ID in SAP. See Collect the OAuth Client ID and Application Key.
  • Client Secret: The client secret is a unique string issued when setting up the target application integration. This is issues by SAP.
  • Ariba APIkey: Refered to as the Application key, this replaces a variable in the scripting process. See Collect the OAuth Client ID and Application Key.
  • Ariba Realm: Replaces a variable in the scripting process. If you need to find this, contact your SAP admin to confirm your Realm ID.
  • Ariba lastChangeId: Specifies the last change received in the previous response. The response includes all changes since this one. For example, use 1 if you want to load all changes from the beginning.

Note:

It is recommended that you always use OAuth 2.0 as your service authentication method where available. OAuth 2.0 ensures that your integration meets the maximum security compliance with your configured microapp.

  • Your organization must be in United States or Europe.
  • You must have a current license for an SAP Ariba Solution or an Ariba Network Solution component.
  • You must have an SAP Ariba Open APIs Administrator Account. Your organization’s SAP Ariba Administrator can request access to the SAP Ariba Open APIs Developer Portal from one of the following links:

  • Configure Citrix Gateway to support single sign-on for SAP Ariba so that once users log in they are automatically logged in again without having to enter their credentials a second time. Follow the instructions in Ariba Single Sign-on Configuration. For more information about configuring SSO, see Citrix Gateway Service.

Set up the SAP Ariba integration

  1. Log in to https://developer.ariba.com/api/ with an administrator account.
  2. On the welcome page, select Create application.
  3. To create a new application, enter an Application Name and Description, and select Submit.

    Your application is sent to the SAP Ariba Open APIs Team for approval.

Collect the OAuth Client ID and Application Key

After your application is approved (described in section above), you receive an email with the OAuth secret token. The SAP Ariba Open APIs Team sets up and enables the back end with your Ariba Realm ID.

Note:

You cannot proceed until you receive the approval email.

  1. Log in and go to the Manage Applications page.
  2. Select the application your created.
  3. Copy the OAuth Client ID and Application key.
  4. Save them in a secure place for later use when you add the integration to Citrix Workspace Microapps.

Add the integration to Citrix Microapps

Follow these steps to set up the SAP Ariba HTTP integration. The authentication options are preselected. Ensure that these options are selected as you complete the process. We recommend using this newer HTTP integration for most use-cases. The HTTP integration provides more power to configure the cached data structure.

Follow these steps:

  1. From the Microapp Integrations page, select Add New Integration, and Add a new integration from Citrix-provided templates.
  2. Choose the SAP Ariba tile under Integrations.
  3. Enter an Integration name for the integration.
  4. Enter Connector parameters.
    • Enter the instance Base URL: https://openapi.ariba.com/api/approval/v1/prod
    • Select an Icon for the integration from the Icon Library, or leave this as the default Jira icon.
  5. Enter the Ariba APIkey. This application key replaces a variable in the scripting process. See Collect the OAuth Client ID and Application Key.
  6. Enter the Ariba Realm. The Ariba realm Id replaces a variable in the scripting process. If you need to find this, contact your SAP admin to confirm your Realm ID.
  7. Enter the Ariba lastChangeId. Specifies the last change received in the previous response. The response includes all changes since this one. For example, use 1 if you want to load all changes from the beginning.
  8. Under Service authentication, select OAuth 2.0 from the Authentication method menu and complete the authentication details. The authentication options are preselected. Ensure that these options are selected as you complete the process. Use the OAuth 2.0 security protocol to generate request/authorization tokens for delegated access. It is recommended that you always use OAuth 2.0 as your service authentication method where available. OAuth 2.0 ensures that your integration meets the maximum security compliance with your configured microapp.

    1. Select Client Credentials from the Grant type flow menu.
    2. Enter client_credentials for Grant type value.
    3. Select Authorization header from the Token authorization menu.
    4. Select URL encoded form from the Token content type menu.
    5. Enter the Token URL: https://api.ariba.com/v2/oauth/token
    6. Enter your Client ID. The client ID is the string representing client registration information unique to the authorization server. You collect this and the secret when you configure the OAuth server. See Collect the OAuth Client ID and Application Key.
    7. Enter your Client secret. The client secret is a unique string issued when setting up the target application integration. See Collect the OAuth Client ID and Application Key.
  9. Enable the Request rate limiting toggle. Enter 3 for Number of requests and 1 second for Time interval.
  10. In the Request Timeout field, enter 120.
  11. (Optional) Enable Logging toggle to keep 24 hours of logging for support purposes.
  12. Select Save to proceed.

You are now ready to set and run your first data synchronization. For complete information about synchronization rules, synchronization that does not meet its schedule and veto rules, see Synchronize data.

For more details of API endpoints and table entities, see Ariba connector specifications.

Use Ariba microapps

Existing application integrations come with out-of-the-box microapps. Start with these microapps and customize them for your needs.

Our SAP Ariba integration comes with the following preconfigured out-of-the-box microapps:

Requisition Approval: View requisitions with details that are pending approval, and an action to approve.

Notification or Page Use-case workflows
Pending Approval notification When a new purchase requisition is awaiting approval, the approver receives a notification.
Pending Next Approval notification When a new purchase requisition is awaiting next level approval, the next approver receives a notification.
Requisition Created notification When a new requisition is created, the requisition submitter receives a notification with details.
Requisition Changed notification When the status of a new purchase requisition is changed, the requisition submitter receives a notification.
Approval Request page Provides a searchable list of requests awaiting approval and a link to more details.
Requisition Detail Approver page Provides a detailed view of a requisition with actions to Approve and Deny the request.
Requisition Detail Requestor page Provides a detailed view of a requisition to the requester.

Add the Legacy SAP Ariba integration

Add the SAP Ariba integration to Citrix Workspace Microapps to connect to your application. This delivers out-of-the-box microapps with pre-configured notifications and actions which are ready to use within your Workspace. After you set up this integration in SAP Ariba, you will need these artifacts to add the integration in Citrix Workspace Microapps:

  • API URL
  • OAuth Token URL
  • OAuth Client ID
  • OAuth Client Secret
  • Application Key
  • Realm ID

Follow these steps:

  1. From the Microapps overview page, select Get Started.

    The Manage Integrations page opens.

  2. Select Add New Integration, and Add a new integration from Citrix-provided templates.
  3. Choose the Ariba tile.
  4. Enter a name for the integration.

    Ariba connector parameters, API URL, OAth Token URL, OAth Client ID, OAuth Client Secret, Application Key, Realm ID

  5. Enter the Connector parameters that you collected in the previous procedures.
    • Enter your API URL and OAuth Token URL credentials for your target systems service authentication.
    • Enter your OAuth Client ID and Client Secret.
    • Enter your Application Key and Realm ID.
    • Toggle Sandbox if you require your data to load into a sandbox environment.
    • Enter a value for Request rate limit, max requests/s to Ariba services. This field is mandatory and determines the number of calls per second. Speak with your Ariba representative about limits for your instance to configure the value properly. We recommend 10 calls/second or less as an initial safe rate if the rate limit is not known. Zero can be used to fully disable all limitations. However, too high of a request rate can result in access denial.
    • Select a value for Change id, where full synchronization begins. When full synchronization starts limiting the amount of data loading, older changes are skipped during full synchronization. Leave this value empty to load everything.
    • (Optional) Enable Ignore 400 Bad Request response during synchronization toggle to recover from 400 Bad Request response errors. If any Ariba records are deleted during synchronization, the Ariba API returns an error as the data requested does not exist anymore. A warning is generated in the log.
  6. Select Add.

The Microapp Integrations page opens with your added integration and its microapps. From here you can add another integration, continue setting up your out-of-the-box microapps, or create a new microapp for this integration.

You are now ready to set and run your first data synchronization. As a large quantity of data can be pulled from your integrated application to the Microapps platform, we recommend you use the Table page to filter entities for your first data synchronization to speed up synchronization. For more information, see Verify needed entities. For complete information about synchronization rules, synchronization that does not meet its schedule and veto rules, see Synchronize data.

For more details of API endpoints and table entities, see Ariba connector specifications.

Legacy SAP Ariba microapps

Existing application integrations come with out-of-the-box microapps. Start with these microapps and customize them for your needs.

Our Legacy SAP Ariba integration comes with the following preconfigured out-of-the-box microapps:

Requisition Approval: View requisitions with details that are pending approval, and an action to approve.

Notification or Page Use-case workflows
Pending Approval (change) notification When details of a purchase requisition awaiting approval are changed, the approver receives a notification.
Pending Approval (new) notification When a new purchase requisition is awaiting approval, the approver receives a notification.
Requisition Change notification When the status of a new purchase requisition is changed, the user receives a notification.
Requisition Created notification When a new purchase requisition is created (meaning submitted or being composed), the user receives a notification.
Approval Requests page Provides a personalized list of approval requests and a link to more details.
Requisition Detail page Provides a detailed view of a requisition and an actionable approval button.
Integrate SAP Ariba