# SailPoint SAP Ariba Connector Documentation > SAP Ariba Connector Documentation # Documentation # Connecting SailPoint and SAP Ariba To connect SailPoint with SAP Ariba, perform the following tasks: ## Adding the Source in SailPoint To connect to SailPoint, perform the following steps. Once the connection is made, you can configure it to meet your company's needs. > [!IMPORTANT] > > By default, the provisioning feature is **disabled**, and the connector only supports read-only operations. To support provisioning operations, you must manually enable the feature in the source configuration. **To configure a new source:** 1. Sign in to SailPoint. 2. Go to **Admin \> Connections \> Sources**. 3. Select **Create New**. 4. Search for the connector by entering the name in the search box, and then select **Actions**. 5. In the **Actions** dropdown list, select the setup method: - [**Express Setup**](<#configuring-a-source-using-express-setup>) - Quickly create a read-only connection to your target system by providing minimal configurations and authentication. On completion, aggregation is automatically started. > **Note** > > Express Setup supports Credential Providers. For information on supported credential providers and configuration, refer to [Credential Providers](). For more information, contact your SailPoint Customer Service Manager. - [**Standard Setup**](<#configuring-a-source-using-standard-setup>) - Provide detailed basic configuration to create the source. Once the source is created, continue with source setup. ### Configuring a Source Using Express Setup Express Setup minimizes the initial configuration process so you can quickly connect the application and immediately begin aggregating user account and entitlement data. 1. Review the directions and select **Start Express Setup**. 2. Review the pre-populated **Source Name**, **Source Owner**, and **Description**. To update, select **Edit**. > **Note** > > The source name must be unique. You can change these settings later in the source configuration. 3. Select **Virtual Appliance**. A virtual appliance is a Linux-based virtual machine that connects to your sources and apps using SailPoint APIs, connectors, and integrations. For more information about configuring and deploying virtual appliances, refer to [SailPoint Virtual Appliances](). 4. (Optional) If enabled for your organization, select the **Use a Credential Provider** checkbox to manage the source's authentication using a credential provider. > **Note** > > To add a Credential Provider in SailPoint, go to **Admin \> Connections \> Credential Providers**. For more information about credential providers, refer to [Credential Providers](). 5. Configure the authentication to allow SailPoint to connect to the source. For more information, refer to the **Connection Settings** section. 6. Select **Finish**. After a successful test connection, the system creates your source and prompts you to run an aggregation. - If you want to aggregate now, select **Aggregate**. - To see the latest account aggregation history, go to **Account Management \> Account Aggregation**. - To see the list of aggregated source accounts, go to **Account Management \> Accounts**. - If you want to aggregate later, select **Exit**. This returns you to the **Sources** page. Your new source is listed, but contains no accounts or aggregation history yet. ### Configuring a Source Using Standard Setup Use Standard Setup to configure the connector for full feature support. 1. In the **Source Name** field, enter a unique and descriptive name for your source. Source names cannot exceed 128 characters. 2. In the **Description** field, provide additional details about the source to help distinguish it from similar sources. This field allows a maximum of 2,000 characters. 3. In the **Source Owner** field, begin typing the name of an owner. Matches appear after you type two or more letters. For more information, refer to [Assigning a Source Owner](). 4. Under **Connection Type**, select **Direct Connection** or **Flat File**. - **Direct Connection** - A direct connection fetches data from the **Virtual Appliance Cluster** you choose as the application connector for the source. A direct connection configuration allows for real-time updates. For more information about configuring and deploying virtual appliances, refer to the [Virtual Appliance Reference Guide](). - **Flat File** - Select the flat file if no connector is available, or if another system restricts the connection. This option allows only reading and aggregating data as a generic/delimited application. Provisioning activity is unsupported, and additional configuration pages like connection settings and aggregation settings are unavailable. 5. If you selected **Direct Connection**, in **Virtual Appliance Cluster**, select the virtual appliance cluster that will be used as the application connector for the source. 6. (Optional) Select a governance group to grant its members [source]() or [role]() sub-admin level oversight of the source and its access. For more information, refer to [Creating and Managing Governance Groups](). 7. If this source represents a primary system containing your organization's personnel records, select the **Authoritative Source** checkbox. For more information, refer to [Creating Identity Profiles](). 8. Select **Continue**. The source is created, and you are navigated to the **Source Setup \> Base Configuration** page. Continue to configure your connected source there. ## Base Configuration Provide the base configuration parameters. Information you entered in the Create New Source dialog is automatically entered into the fields in the Base Configuration page. You can edit this information if necessary. 1. Enter a unique name and description for the source. 2. In the **Source Owner** dropdown list, select the identity that owns this source. - To find a source owner, begin entering their name. 3. In the **Virtual Appliance Cluster** dropdown list, select the virtual appliance to use when communicating with your organization's systems. For more information, refer to [SailPoint Virtual Appliances](). 4. (Optional) If enabled for your organization, select the **Use a Credential Provider** checkbox to manage the source's authentication using a credential provider. > **Note** > > To add a credential provider, go to **Admin \> Connections \> Credential Providers**. For more information about credential providers, refer to [Credential Providers](). 5. Configure the authentication to allow SailPoint to connect to the source. Refer to [Connection Settings](<#connection-settings>) for more information. 6. (Optional) In the **Governance Group for Source Management** dropdown list, select a governance group to associate with this source. For more information about governance groups, refer to [Associating Governance Groups with a Source](). 7. (Optional) Choose whether to enable or disable provisioning for the source. Provisioning is disabled by default. - **Enable Provisioning** - Set the toggle to **Enabled** to allow the source to create, update, and deactivate accounts in the connected source system. - **Disable Provisioning** - Set the toggle to **Disabled** to disable provisioning for the source. Disabling provisioning will prevent the creation, updating, or deactivating of accounts on this source. 8. Select **Save**. ## Connection Settings The following information is required for SailPoint to connect and interact with SAP Ariba. > [!NOTE] > > **Screenshot** > > [![Connection Settings]()]() 1. Select **Connection Settings** from the menu. 2. In **Base URL**, enter the host URL of the SAP Cloud Identity Services Tenant. 3. In **System ID**, enter the ID of the SAP IPS Proxy system created for SAP Ariba Applications. You can get the system ID from the URL. For example, `https:///admin/#/proxySystems//` 4. In **Client ID** and **Client Secret**, enter the SAP IPS technical user credentials as mentioned in [Prerequisites](). 5. Select the **Realm Type**: - Select **Parent Realm** to manage general information, additional information and entitlements of the account. - Select **Child Realm** to manage additional information and entitlements of the account. > **Note** > > Select **Manage General Information** to update the general information of accounts created in the child realm. This option is only applicable for the child realm. General Information updates are only allowed in SAP Ariba for users that are directly created in the Child Realm and not replicated from the Parent Realm. ## Review and Test Perform a test to confirm the connection to SailPoint. 1. Go to **Review and Test**. 2. Confirm that the entries in each field are correct. If you note any mistakes, return to the section and make corrections. 3. Select **Test Connection**. ## SailPoint Application Onboarding SailPoint application onboarding enables you to easily onboard new applications and create sources following the successful onboarding of a discovery source. To use this feature, continue to **Discovered Applications** in the SailPoint user interface. For more information, refer to [Application Onboarding]() in the SailPoint SaaS documentation. # Frequently Asked Questions The following are Frequently Asked Questions (FAQs) for this connector. ## Why are deleted or deactivated users excluded from aggregation? **Answer**: The `SCIM API for User and Group Master Data` aligns the delete operation with user deactivation. As outlined in the [SAP Ariba Security Guide](), deactivated users are no longer accessible or visible within the SAP Ariba environment. ## Why does the Disable operation lock the account instead of deactivating it in the Ariba Portal? **Answer**: The status change of a SAP Ariba account depends on the `active` flag of the SCIM API for User and Group Master Data. This flag is mapped to the `lock/unlock` status of the account in the Ariba Procurement Portal. Therefore, the Disable operation from the SailPoint platform locks the user in the Ariba Procurement Portal. To deactivate a user, use the delete operation. It is advised to use the Ariba Procurement Portal UI to reactivate the user if needed. ## Can I manage a parent and child realm in a single source? **Answer**: No. You must create a separate source for each realm (either a parent or a child). # Integrating SailPoint with SAP Ariba > [!NOTE] > > **Integration** > > This is an integration and requires additional licensing or subscriptions to utilize it. For more information, contact your customer success manager. SAP Ariba is a cloud-based procurement solution that enables organizations to streamline their procurement processes. It provides a platform for buying, selling, and managing cash flow for goods and services. SAP Ariba Identity Governance is a new SailPoint SAP Cloud integration that will aggregate and provision users, roles, and groups under parent and child realms of the buyer. > [!NOTE] > > The SAP Ariba Integration has been built using SAP Identity Provisioning Services (IPS). The credentials used to connect to SAP Ariba are SAP Cloud Identity Services Technical User credentials. For more information, refer to [Required Permissions](<#required-permissions>). > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features SailPoint's SAP Ariba connector supports the following features for accounts: - Aggregation - Account - Groups > **Important** > > The SailPoint platform supports case-insensitive native identity. It may cause data overwriting in aggregated accounts if the same User ID (irrespective of upper/lower/mixed case) exists for the same type (enterprise or third party) of user. - Add/Remove Entitlement - Groups - Account Provisioning - Create User - Update User (Attributes) - Disable (Lock account in Ariba portal) - Enable (Unlock account in Ariba portal) - Delete > **Note** > > - SAP Ariba doesn’t allow updating the general information of user accounts in the Child Realms synced from Parent Realm. > - The following are the recommendations by SailPoint to avoid failures in provisioning operations: > > 1. During user creation, use the unique user name (irrespective of upper/lower/mixed case) for all types of users (enterprise or third party) to avoid data overwriting in the SailPoint platform. > 2. If a duplicate user names exist in SAP Ariba realms, you must update the user names to be unique and avoid overwriting in the SailPoint Platform. For more information on features, refer to [Source Features](). ## Supported Managed Systems - SAP Ariba Cloud Solutions (Buyer Module) ## Required Permissions - SAP Ariba Developer Portal (to configure the OAuth Client) - The OAuth client must be created to use Ariba APIs. It can be created by the system user using [Developer Ariba](). - The following APIs must be used by two separate OAuth clients. - SCIM API for User and Group Master Data (for Parent and all Child Realms together) - SAP Identity Provisioning Service (to configure the technical user) - The technical user is required to be created by the tenant administrator. Select the **Access Proxy System API** permission in **Configure Authorizations**. ## Prerequisites - Configure at least one virtual appliance cluster and successfully test the connection. For instructions, refer to the [Virtual Appliance Reference Guide](). - The following set of credentials must be created to configure the IPS Proxy of SAP Ariba and connect to SailPoint to allow it to handle associated identity governance use cases. - Obtain a Bundle Tenant. To get identity provisioning services, refer to [Initial Setup of Bundle Tenants]() in the SAP Help Portal. ### Configure the OAuth Client and APIs #### OAuth Client 1. Sign in to the [SAP Ariba Developer Portal](). 2. Create an app for each relevant API. Allow 12 hours for Ariba to auto-approve API access. - SCIM API for User and Group Master Data for Parent and Child realms in a single application 3. Generate the secret key for the API. #### SCIM API for User and Group Master Data 1. Sign in to the [SAP Ariba Developer Portal](), select **Data Center**, and then select **SAP ID Service SSO**. 2. On the **Create a New Application** page, enter a user friendly **Application Name** and **Description**, then select **Submit**. > **Screenshot** > > [![Create a New Application]()]() 3. Select **Actions \> Request API Access \> SCIM API for User and Group Master Data**. > **Screenshot** > > [![Request API Access]()]() > **Note** > > SCIM API for user and group master data is not made available by SAP directly. After creating the application you must raise an SAP support case to get the API configured for Parent and Child realms in a single application. 4. Once created, go to **Actions \> Generate OAuth Secret**, and copy the OAuth Client Secret. Make note of the **OAuth Client Id**, **Application Key**, and **OAuth Client Secret**. You will enter these into the Proxy Properties to create an IPS proxy application. Next, copy the **AN-ID**, which is required for configuring the SCIM API for aggregation. This can be found in the **Realm(s) used by this Application** section. > **Screenshot** > > [![Copy Client Secret]()]() > **Note** > > In the Realms field under an application, add all the Buyers' Realms in the same configuration to enable IPS Proxy set up per realm. 5. Go to the **Discover** tab and select **Procurement \> SCIM API for User and Group Master Data**. Copy the value of the OAuth Server URL Prefix and append `v2/oauth/token` to it. The OAuth2TokenServiceURL(IPS) will be: `https://{url}/v2/oauth/token` The URL(IPS) will be: `https://{url}` > **Note** > > Don't include `api/mds/v1/prod` in the URL. Make a note of both the OAuth2TokenServiceURL and the URL to use in the IPS configuration. > **Screenshot** > > [![SCIM API]()]() ### Configure the Technical User in SAP Identity Provisioning Service (IPS) 1. To enable basic authentication, sign in to the SAP Cloud Identity Services admin console, and go to **Users and Authorizations \> Administrators**. 2. Add an administrator user of the type `System`, and then provide the name of the user. 3. In **Configure Authorizations**, select the **Access Proxy System API** permission, and then **Save**. 4. Go to **Configure System Authentication \> Secrets \> Add**, and copy the **Client Secret** and **Client ID**. These are the technical user credentials that you will use to communicate with SAP Ariba. ### Configure the SAP Identity Provisioning Service (IPS) Proxy System Use one of the following options to configure the proxy system. It is recommended to use the import file [template](). > [!NOTE] > > Create separate IPS Proxy systems for each of the Buyer Realms. These proxies are required to be used later to setup the connection for target realms. #### Option 1 - Use the import file template 1. Sign in to the SAP Cloud Identity Services admin console. Go to **Identity Provisioning \> Proxy Settings**, and select the **\+Add** button. 2. Download the provided [template](), edit the placeholders with the appropriate property values, and **Save** the changes. 3. Select **Import File**, and browse to the downloaded file. #### Option 2 - Use the manual process 1. Sign in to the SAP Cloud Identity Services admin console. Go to **Identity Provisioning \> Proxy Settings**, and select the **\+Add** button. 2. Enter the following values on the configuration details page. - Type: `SAP Ariba` - System Name: `User defined name` - Description: `User defined description` 3. Select **Save**. 4. Set the read transform to exchange data with the target system in the SCIM2 compliant format. > **Screenshot** > > [![Read Transform]()]() 1. Select **Read Transformation**, and switch to the JSON editor. 2. Select **Edit link**, and replace the transformation content with the provided [data](). 3. Select **Save**. 5. Set the write transform to exchange data with the target system in the SCIM2 compliant format. > **Screenshot** > > [![Write Transform]()]() 1. Select **Write Transformation**, and switch to the JSON editor. 2. Select **Edit link**, and replace the transformation content with the provided [data](). 3. Select **Save**. 6. Select **Properties**. It is mandatory to set properties to configure the proxy connection to target systems. > **Screenshot** > > [![Properties]()]() 7. The following table contains the properties for the SAP Ariba system. Enter the values, and then select **Save**.
Property Name Description and Value
Type Enter HTTP
URL Enter the SCIM API URL for your SAP Ariba application (refer to Configure the OAuth Client and APIs).
ProxyType Enter Internet
Authentication Enter BasicAuthentication
User Enter the OAuth Client ID (refer to Configure the OAuth Client and APIs).
Password (Credential) Enter the OAuth Client Secret (refer to Configure the OAuth Client and APIs).
OAuth2TokenServiceURL Enter the OAuth 2.0 Token Service URL (refer to Configure the OAuth Client and APIs).
ariba.applications.api.key (Credential) Enter your application key (refer to Configure the OAuth Client and APIs).
ariba.applications.realm.id Enter your AN-ID (refer to Configure the OAuth Client and APIs).
(Optional) ariba.applications.group.flatten This property allows or forbids reading nested groups (group structures) from SAP Ariba applications. If enabled (true), group members of type group will be ignored during read in order not to be provisioned to target systems that do not support nested groups. Thus, set it to false only if you are sure that the target system supports nested groups.
  • Default value: false
  • Predefined value (during system creation): true
Important: Set it to false only if you are sure that the target system supports nested groups.
ariba.applications.support.patch.operation This property is automatically added to the system. Default value: true
# Provisioning The SAP Ariba connector supports provisioning, allowing you to create and manage accounts and entitlements in SAP Ariba directly from SailPoint. **Prerequisite:** Your system is configured for provisioning. When SailPoint provisions new accounts to the source, it uses the attributes on the **Create Account** page as instructions or a template for what to include in the account. This page is also referred to as the *provisioning policy*. When new access is granted on a source where a user does not already have an account, SailPoint automatically includes account creation in the provisioning. This applies whether provisioning is started from an access request or from an automated role or lifecycle state assignment. For direct-connect sources, SailPoint automatically creates the account from this configuration. If the source is not configured as a direct-connect source, SailPoint creates and assigns a provisioning task to the source owner and includes the values for the source owner to use in manually creating the account. > [!IMPORTANT] > > This section describes the default **Create Account** configuration. SailPoint recommends that you work with Services to define a provisioning configuration specific to your company's needs. Be sure to verify large changes to the provisioning policy before implementation. Failure to do so might cause provisioning to fail. ## Default Create Account Attributes > [!NOTE] > > The attributes marked with an asterisk (\*) are required attributes. | Account Attribute | Description | | --- | --- | | User Name\* | The user's sign in name or user name. | | Display Name\* | The user's display name. | | Email\* | The user's work email address. | | Manager ID\* | The user's primary supervisor's username. | | Type\* | The type of the user. Select PasswordAdapter1 for Enterprise User, and ThirdPartyUser for Third Party User. | | Global UUID | The user's global uuid. | | Business Phone Number | The user's work phone number. If you enter a phone number, the fax number is mandatory. | | Business Fax Number | The user's fax number. If you enter a fax number, the phone number is mandatory. | | Locale | The user's locale. | | Default Currency | The user's currency. | | Timezone | The user's timezone. | | Deliver To | The user's delivery location. | | Shipping Address | The user's shipping address detail. | | Billing Address | The user's billing address detail. | | Company Code ID | The user's company code `display id`. | | Purchasing Organization ID | The user's purchasing organization `display id`. | | Purchasing Group ID | The user's purchasing group `display id`. | | General Ledger Company Code ID | The user's general ledger account's company code ID. | | General Ledger Account ID | The user's general ledger account `display id`. | | Cost Center Company Code ID | The user's assigned cost center company code ID. | | Cost Center ID | The user's cost center ID. | | Purchasing Unit ID | The purchasing unit associated with the user. | # Schema Reference The application schema is used to configure the objects returned from a connector. > [!NOTE] > > - The **Account Schema** tab is used to define the attributes for each object type in the application being configured. The schema attributes can be defined as **Entitlement** or **Multi-Valued**. Refer to [Managing Source Account Schemas]() for more information. > - The schema attributes that are not present by [default](<#default-account-schema>) must be defined as strings if not specified. The SAP Ariba connector uses the following default correlation and object configurations. ## Default Account Schema Each source supports a variety of details, or attributes, about each user who has an account, such as their name, email address, manager name, and location. The set of account attributes each source stores and how they're organized is known as the account's *schema*. To best represent your data, you can configure sources to use an account schema matching the one you use in the external connector. Refer to [Managing Source Account Schemas]() for more information. ### Default Account Attributes The SAP Ariba connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified. | Attribute Name | Description | | --- | --- | | User Name | The user's sign in name or user name. | | ID | A unique identifier for the user. | | Global UUID | The user's global uuid. | | Active | The user's active status. | | Email | The user's work Email address. | | Manager ID | The user's primary supervisor username. | | Type | The user's type (PasswordAdapter1 = Enterprise User, and ThirdPartyUser = Third Party User). | | Display Name | The user's display name. | | Locale | The user's locale. | | Business Phone Number | The user's work phone number. | | Business Fax Number | The user's fax number. | | Timezone | The user's Timezone. | | Default Currency | The user's currency. | | Company Code ID | The user's company code `display id`. | | Plant ID | The user's plant id `display id`. | | Cost Center Company Code ID | The user's assigned cost center company code ID. | | Cost Center ID | The user's cost center ID. | | General Ledger Company Code ID | The user's general ledger account's company code id. | | General Ledger Account ID | The user's general ledger account `display id`. | | Purchasing Group ID | The user's purchasing group `display id`. | | Purchasing Organization ID | The user's purchasing organization `display id`. | | Billing Address | The user's billing address detail. | | Shipping Address | The user's shipping address detail. | | Deliver To | The user's delivery location. | | Groups | Groups linked to the user through role assignments. | | Purchasing Unit ID | The purchasing unit associated with the user. | ## Default Entitlement Attributes Entitlement attributes define the entitlements, such as groups or roles, that can be assigned to the managed system's user accounts. Refer to [Managing Entitlements]() for more information. > [!CAUTION] > > Changing the attribute marked as the Entitlement ID after aggregating accounts or entitlements can result in duplicate entitlements being created, or access profiles and roles breaking. To avoid this, edit the entitlement schema before performing any aggregations. ### Default Group Attributes The SAP Ariba connector also supports groups. The following attributes must be configured on the managed system and in the SailPoint source schema to manage groups. | Attribute Name | Description | | --- | --- | | ID | A unique identifier for the group. | | Group Name | The group's name. | | Members | The members of the group. | | Child Groups | The child groups of the group. | # Enable Connector Logging This topic provides the steps needed to enable logging on SailPoint using REST APIs. > [!NOTE] > > This topic only applies to VA-based integrations. > [!NOTE] > > The examples provided might not match your configuration. Use the logging levels and logging classes reference at the bottom of the topic to configure your API responses to match your connector. This process is broken up into four steps: 1. Identify the Virtual Appliance (VA) cluster on which you want to enable logging. 2. Get the logging configuration for the existing VA cluster. 3. Update the VA cluster to enable logging levels. 4. Observe logging changes to the logging levels. ### Identify the Virtual Appliance Cluster Select the VA on which you need to enable logging using REST API. If you already know the VA application's `id`, proceed to [Get the Logging Configuration](<#get-the-logging-configuration>). 1. Make the following call to the REST API to return a list of available VA clusters: GET /v3/managed-clusters The REST API returns a response that looks similar to the following: ```json [ { "id": "2c9180866166b5b0016167c32ef31a66", "name": "Development Cluster", "description": "Development Cluster", "clientType": "CCG", "ccgVersion": "373_535_70.2.0", "pinnedConfig": true, "logConfiguration": null }, { "id": "2c9180846a93ce60016ab29f039944de", "name": "Cloud Cluster", "description": "Cloud Cluster", "clientType": "CCG", "ccgVersion": "373_535_70.2.0", "pinnedConfig": true, "logConfiguration": { "clientId": null, "durationMinutes": 60, "expiration": "2020-12-15T19:13:36.079Z", "rootLevel": "DEBUG", "logLevels": { "sailpoint.connector.ADLDAPConnector": "DEBUG" } } } ] ``` > **Note** > > The previous example code shows two VA clusters. One VA cluster has a log configuration and the other does not (refer to the `logConfiguration` value in each returned VA cluster). This is because one of the clusters already has logging enabled. This is just an example configuration, and your environment may not have logging enabled on a cluster. 2. Identify the VA cluster that you want to enable logging on by its name or description and record its `id` attribute. ### Get the Logging Configuration Get your selected VA's cluster logging configuration and identify the values you need to update. 1. Make the following call to the REST API to return the VA cluster's logging configuration. Replace `{id}` with the VA cluster's `id` attribute value recorded earlier. GET /v3/managed-clusters/{id}/log-config - If the VA doesn't have a logging configuration currently set, it returns `204 No Content` as a response. - If the VA has an existing logging configuration, it returns something similar to the following: ```json { "clientId": null, "durationMinutes": 60, "expiration": "2020-12-15T19:13:36.079Z", "rootLevel": "DEBUG", "logLevels": { "sailpoint.connector.ADLDAPConnector": "DEBUG" } } ``` You'll need to configure the following information in the response: - `durationMinutes` is the number of minutes logging should remain enabled. - `rootLevel` is the default level for all logs. For more information, refer to [Logging Levels](<#logging-levels>). - `logLevels` is a map object with logging classes as keys and logging levels as values. - For keys, refer to [Logging Classes](<#logging-classes>) for commonly used logging classes. - For a list of available values, refer to [Logging Levels](<#logging-levels>). ### Update Logging Configuration Update the VA cluster configuration returned by the REST API to update the logging settings as needed. 1. Make the following call to the REST API to update the VA cluster's logging configuration. Replace `{id}` with the VA cluster's `id` attribute value recorded earlier. PUT /v3/managed-clusters/{id}/log-config 2. Submit your configuration changes to the REST API in a JSON body. - If the VA cluster did not already have a logging configuration and you received a `204 No Content` response, you can create a new one. - If the VA returned a configuration, you can edit it to include the changes. The JSON body should be as follows: ```json { "durationMinutes": 60, "rootLevel": "DEBUG", "logLevels": { "sailpoint.connector.ADLDAPConnector": "DEBUG" } } ``` Consider the following as you edit the JSON: - `durationMinutes` is the number of minutes logging should remain enabled. - `rootLevel` is the default level for all logs. For more information, refer to [Logging Levels](<#logging-levels>). - `logLevels` is a map object with logging classes as keys and logging levels as values. - For keys, refer to [Logging Classes](<#logging-classes>) for commonly used logging classes. - For a list of available values, refer to [Logging Levels](<#logging-levels>). If the update was successful, the REST API should return a response similar to the following: ```json { "clientId": null, "durationMinutes": 60, "expiration": "2020-12-15T19:13:36.079Z", "rootLevel": "DEBUG", "logLevels": { "sailpoint.connector.ADLDAPConnector": "DEBUG" } } ``` ### Observe Logging Changes Approximately five minutes after you update the configuration, the VA cluster starts generating log files you can review. You can view the log files in **ccg.log**. ### References The tables in this reference section list information that can be helpful when creating the JSON body you'll use to configure the VA cluster's configuration file. #### Logging Levels | Logging Level | Description | | --- | --- | | ERROR | Designates error events that might still allow the connector to continue. | | WARN | Designates potentially harmful situations. | | INFO | Designates information messages that highlight process at a coarse-grain level. | | DEBUG | Very verbose. Fine grain logging levels used for development and debugging. | | TRACE | Most verbose. Finer grain logging levels than debugging. | #### Logging Classes | Connector | Logging Class | | --- | --- | | Active Directory | sailpoint.connector.ADLDAPConnector sailpoint.connector.LDAPConnector | | AIX | openconnector.connector.unix.AIXConnector openconnector.connector.unix.UnixConnector | | Amazon Web Services | logger.aws.name=openconnector.connector.aws logger.aws.level=trace logger.aws.additivity = false logger.aws.appenderRef.rolling.ref = STDOUT | | Atlassian Suite Cloud | sailpoint.connector.OpenConnectorAdapter openconnector.connector.atlassian.AtlassianConnector | | Atlassian Data Center | sailpoint.connector.OpenConnectorAdapter openconnector.connector.atlassian.AtlassianDataCenterConnector | | Microsoft Entra ID | sailpoint.connector.AzureADConnector | | Box | openconnector.connector.BoxNetConnector sailpoint.connector.OpenConnectorAdapter | | Cerner | openconnector.connector.CernerConnector sailpoint.connector.OpenConnectorAdapter | | Delimited File | logger.DelimitedFileConnector.name = sailpoint.connector.DelimitedFileConnector logger.DelimitedFileConnector.level = debug logger.DelimitedFileConnector.additivity = false logger.DelimitedFileConnector.appenderRef.rolling.ref = STDOUT | | Dropbox | openconnector.connector.DropBoxConnector sailpoint.connector.OpenConnectorAdapter | | Epic | openconnector.connector.EPICConnector sailpoint.connector.OpenConnectorAdapter | | GE Centricity | openconnector.connector.GECentricity sailpoint.connector.OpenConnectorAdapter | | Google Apps / G Suite | openconnector.connector.GoogleAppsDirect sailpoint.connector.OpenConnectorAdapter | | IBM i | openconnector.connector.IBMiConnector | | Lotus Domino | sailpoint.connector.LotusDomino | | JDBC | sailpoint.connector.JDBCConnector | | Sun One LDAP | sailpoint.connector.LDAPConnector | | Linux | openconnector.connector.unix.LinuxConnector sailpoint.connector.OpenConnectorAdapter sailpoint.connector.UnixConnector | | Microsoft Office365 | sailpoint.connector.Office365Connector | | Microsoft SQL Server | sailpoint.connector.mssql.serviceimpl.MSSQLServerConnectorV2 | | Okta | logger.openconnector.name = openconnector.connector.okta.OktaConnector logger.openconnector.level = debug logger.openconnector.additivity = false logger.openconnector.appenderRef.rolling.ref = STDOUT | | Oracle Database | sailpoint.connector.OracleDBConnector sailpoint.connector.JDBCConnector | | Oracle E-Business | sailpoint.connector.OracleEBSConnector sailpoint.connector.JDBCConnector | | Oracle Fusion HCM | openconnector.connector.oraclefusionhcm.OracleFusionHCMConnector sailpoint.connector.OpenConnectorAdapter | | Oracle HCM Cloud | sailpoint.connector.oraclehcmcloud.OracleHCMCloudConnector | | Oracle HRMS | sailpoint.connector.OracleAppsHRMSConnector sailpoint.connector.JDBCConnector | | Oracle Netsuite | openconnector.connector.netsuite.NetsuiteConnector | | PeopleSoft ERP | openconnector.connector.PeopleSoftConnector sailpoint.connector.OpenConnectorAdapter | | PeopleSoft HRMS | sailpoint.connector.PeopleSoftHRMSConnector | | RemedyForce | sailpoint.connector.ForceConnector | | RSA Authentication Manager | openconnector.connector.RSAConnector openconnector.connector.rsa.RSAHTTPClient sailpoint.connector.OpenConnectorAdapter | | Salesforce | sailpoint.connector.ForceConnector | | SAP Concur | openconnector.connector.sapconcur.SAPConcurConnector | | SAP - Direct | sailpoint.connector.SAPConnector sailpoint.connector.SAPInternalConnector | | SAP GRC | logger.SAPGRCConnector.name = sailpoint.connector.sapgrc logger.SAPGRCConnector.level = debug logger.SAPGRCConnector.additivity = false logger.SAPGRCConnector.appenderRef.rolling.ref = STDOUT | | SAP HR/HCM | sailpoint.connector.SAPHRInternalConnector | | SCIM 1.1 | openconnector.connector.SCIMConnector sailpoint.connector.OpenConnectorAdapter | | SCIM 2.0 | openconnector.connector.scim2.SCIM2Connector sailpoint.connector.OpenConnectorAdapter | | ServiceNow | openconnector.connector.servicenow.ServiceNowConnector openconnector.connector.servicenow.ServiceNowRestClient sailpoint.connector.OpenConnectorAdapter | | ServiceNow Service Desk Integration | openconnector.connector.servicedesk.ServiceNowServiceDeskConnector sailpoint.connector.OpenConnectorAdapter | | Siebel | openconnector.connector.SiebelConnector sailpoint.connector.OpenConnectorAdapter | | Snowflake | openconnector.connector.snowflake.SnowflakeConnector sailpoint.connector.OpenConnectorAdapter | | Solaris | openconnector.connector.unix.SolarisConnector openconnector.connector.unix.UnixConnector sailpoint.connector.OpenConnectorAdapter | | SuccessFactors | sailpoint.connector.SuccessFactorsConnector | | Sybase | sailpoint.connector.SybaseDirectConnector sailpoint.connector.JDBCConnector | | Webex | openconnector.connector.Webex sailpoint.connector.OpenConnectorAdapter | | Workday | openconnector.connector.WorkDay sailpoint.connector.OpenConnectorAdapter | | Workday Accounts | openconnector.connector.workdayaccounts openconnector.connector.workdayaccounts.WorkdayAccountsConnector sailpoint.connector.OpenConnectorAdapter | | Web Services | sailpoint.connector.WebServices | | XML | openconnector.connector.XMLConnector sailpoint.connector.OpenConnectorAdapter | | Yammer | openconnector.connector.YammerConnector sailpoint.connector.OpenConnectorAdapter | | Zoom | openconnector.connector.zoom.ZoomConnector sailpoint.connector.OpenConnectorAdapter | # Troubleshooting If you encounter any of the following issues or errors, SailPoint recommends that you follow the guidance provided below to resolve the error before contacting SailPoint Support. For issues or errors that are not addressed in this connector guide, refer to the following resources for troubleshooting information: - [SailPoint Identity Services Documentation]() - [SailPoint Support Knowledge Base]() - [SailPoint Developer Community]() ## Connector Not Reading Additional Attribute Value **Issue**: The connector does not read additional attribute values even though the API returns the value. **Resolution**: Add the following entry key with the path for the attribute as shown in the example below: ```xml ``` ## Only One User Is Displayed After Aggregation **Issue**: Previously created duplicate users (with different letter case) are present in a realm, however, when creating a new user only one user is showing after aggregation. This happens when an ID is already present (irrespective of the letter case) in Ariba realms. **Resolution**: Ensure user values are unique. The SailPoint platform supports unique identities irrespective of the letter case. ## User `xxxxxxxxx` Already Exists Either as Enterprise or a Third Party User Error **Issue**: The following error is displayed: User `xxxxxxxxx` already exists either as Enterprise or a Third Party user. **Resolution**: Ensure user values are unique. The SailPoint platform supports unique identities irrespective of the letter case. # Timeout Errors and Settings Timeout errors might occur when SailPoint is waiting for a response from the Virtual Appliance (VA). These errors are applicable to all connectors and tend to occur during the setup of sources or when sources are down. This document is designed to give specific information that can be used to resolve these errors. Each timeout attribute has a default time value that is listed in seconds or minutes. Increasing the time value may resolve the error as it will allow for longer communication time between the two systems, thus avoiding the timeout error. > [!IMPORTANT] > > Add the necessary attributes or values before performing the "replace" operation, as missing attributes will cause the operation to fail. To increase the communication time, increase the value of the appropriate timeout attribute. Then submit the change to the VA using the SailPoint REST API. > [!NOTE] > > For more information on SailPoint's REST APIs, refer to [Best Practices: REST API Authentication]() and [REST API - Update Source (Partial)]() in the SailPoint Developer Community. ### aggregateTimeout **Description:** This parameter is set for the aggregation timeout, measured in seconds. **Resolution:** Increase the `aggregateTimeout` value gradually to optimize aggregation. Start with 180, then increase to 600, 900, and finally 1800. The maximum value is 3600 seconds. For example: If your current time value is 180 seconds, update the `aggregateTimeout` attribute as follows: ```json [ { "op": "replace", "path": "/connectorAttributes/aggregateTimeout", "value": 600 } ] ``` ### healthCheckTimeout **Description:** This parameter is set for the test connection and health check timeout. **Resolution:** The default value is 30 seconds. If the timeout error continues, increase the value in 15 second increments and try again. For example: If your current time value is 30 seconds, update the `healthCheckTimeout` attribute as follows: ```json [ { "op": "replace", "path": "/connectorAttributes/healthCheckTimeout", "value": 45 } ] ``` ### provisioningTimeout **Description:** This parameter is set for provisioning timeout. **Resolution:** Increase the `provisioningTimeout` value gradually to optimize provisioning. Start with 180, then increase to 360, and finally 600. The maximum value is 600 seconds. For example: If your current time value is 180 seconds, update the `provisioningTimeout` attribute as follows: ```json [ { "op": "replace", "path": "/connectorAttributes/provisioningTimeout", "value": 360 } ] ``` ### timeout **Description:** This parameter is set for pass-through authentication timeout. **Resolution:** The default value is 15 seconds. If the timeout error continues, increase this value in 15 second increments and try again. For example: If your current time value is 15 seconds, update the `timeout` attribute as follows: ```json [ { "op": "replace", "path": "/connectorAttributes/timeout", "value": 30 } ] ``` ### apiTimeout **Description:** This parameter is set for API time tracking; customers can check it using an external tool. **Resolution:** The default value is 60 seconds. If the error continues, increase the value by 15 second increments and try again. For example: If your current time value is 60 seconds, update the `apiTimeout` attribute as follows: ```json [ { "op": "replace", "path": "/connectorAttributes/apiTimeout", "value": "75" } ] ``` ### timeoutInSeconds **Description:** This parameter helps prevent the VA from waiting indefinitely for an API response, ensuring efficient handling of API requests. For example: If your current time value is 30 seconds, update the `timeoutInSeconds` attribute as follows: ```json [ { "op": "replace", "path": "/connectorAttributes/timeoutInSeconds", "value": "15" } ] ```