# SailPoint Oracle ERP Siebel Connector Documentation > Oracle ERP Siebel Connector Documentation # Documentation # Connecting SailPoint and Oracle ERP Siebel To connect SailPoint with Oracle ERP Siebel, 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. Drag and drop the required files into the **Upload Files** box, or upload them from your computer. > **Warning** > > Ensure that the file you upload is not vulnerable or malicious. The following Siebel .jar files are required to upload in the VA cluster: - `Siebel.jar` and `SiebelJI_.jar` For example, for Siebel CRM with the English language, the following two .jar files are required: - `Siebel.jar` - `SiebelJI_enu.jar` The Siebel .jar files are available in the `SIEBEL_INSTALLATION_DIRECTORY/siebsrvr/CLASSES` directory. > **Note** > > Don't upload .jar files for multiple versions of the Siebel server. 9. Select **Save**. ## Connection Settings Provide the information required to connect to the Siebel server. > [!NOTE] > > **Screenshot** > > [![Connection Settings]()]() 1. Select **Connection Settings** from the menu. 2. Enter the **Hostname** where the Siebel server is installed. 3. Enter the listening port number for the **Siebel Connection Broker Port**. 4. Enter the **User Name** and **Password** for the target system user account that you want to use for operations. 5. Enter the Siebel **Enterprise Name**. For example, `SBA_82`. 6. Enter the name of the **Siebel Application Object Manager**. For example, `SCCObjMgr`. 7. Select an **Application Language** from the list. The Siebel Object Manager displays in the selected language. The connector supports the following languages: - English (default) - Brazilian Portuguese - French - German - Italian - Japanese - Korean - Simplified Chinese - Spanish - Traditional Chinese 8. Select **Save**. ## Aggregation Settings Configure settings related to account aggregation. > [!NOTE] > > **Screenshot** > > [![Aggregation Settings]()]() 1. Set the **Aggregation Timeout** in seconds. The default value is 900 seconds (15 minutes). 2. Select **Save**. ## Advanced Settings Configure the account and entitlement components, networking, and additional behavioral connection settings. > [!NOTE] > > **Screenshot** > > [![Advanced Settings]()]() [![Advanced Settings continued]()]() [![Primary Dummy Position ID example]()]() [![Advanced Settings continued]()]() 1. Set the **Account Components**: - Provide the **Business Object** name. The default value is Employee. - Provide the **Business Component** name. The default value is Employee. 2. Set the **Entitlement Components**: - Provide the **Business Object** name. The default value is Position. - Provide the **Business Component** name. The default value is Position. 3. Enter the **Primary Dummy Position ID** to replace existing primary and secondary positions if you execute an action to remove all positions from a user. 4. Select the **Transport Protocol** used when SailPoint connects to the Siebel server. By default, SailPoint uses TCP/IP. 5. Select the **Encryption** method SailPoint uses when transferring data with the Siebel Server. By default, SailPoint uses no encryption. You can select RSA encryption if needed as per your requirement. 6. Select whether SailPoint uses data **Compression** when transferring data with the Siebel server. By default, SailPoint compresses the data with ZLIB data compression. 7. In **Enable Status**, enter the value to be provisioned as the status for the Enable operation. This overwrites the default value of `Active`. 8. In **Disable Status**, enter the value to be provisioned as the status for the Disable operation. This overwrites the default value of `Terminated`. 9. In **Retry Error List**, enter any errors which may occur during aggregation that would prompt your system to retry the aggregation process. Type the error into the field and then press **Enter** on your keyboard to save it. Saved errors are displayed below the field. To remove errors, select the **X** next to their name. 10. In **Active Status List**, enter the statuses for an account to be considered Active. 11. In **Invalid Records Error Code List**, enter a list of error records that are considered false positive. 12. Select **Save**. ## 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. # Integrating SailPoint with Oracle ERP Siebel The Oracle ERP Siebel connector manages entities in Oracle's Siebel Customer Relationship Management (CRM) system. Here, the employee roles are managed as accounts and position objects are referred to as account groups. By default, the Oracle ERP Siebel connector uses the employee Siebel business component of the employee Siebel business object for account provisioning. For account and group provisioning, the integration module uses the position business component of the position business object. You can configure the integration module to manage other Siebel business objects or components in account and account group provisioning. The integration module manages both single and multi-valued attributes of the Siebel system. You can modify the integration module schema to manage attributes other than the schema that comes with integration module. > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features > [!NOTE] > > Before you can use any of the following items marked with an asterisk (\*), SailPoint must activate the feature for your site. The Oracle ERP Siebel connector supports the following features: - Load Siebel Accounts - \*Provision Siebel Accounts - \*Access Certifications (certification of entitlements connected to accounts) - \*Password management - Delete Accounts - Manages Positions and Responsibilities as Account-Groups For more information on features, refer to [Source Features](). ### Password Management If Password Management is enabled for your organization, you can change the password for a user of the source. After enabling password management on the source, be aware of the following: - The password policy defined in SailPoint applies to accounts on this source. - If you change the password for an application connected to this source, the change will automatically be made to the source itself. For more information on configuring password management, refer to [Password Management Overview](). ## Prerequisites - Configure at least one virtual appliance cluster and successfully test the connection. For more information, refer to the [Virtual Appliance Reference Guide](). - You must upload the Siebel server .jar files for the source to work correctly. For more information, refer to [Base Configuration](). - The following are the minimum required components that must be in a running state for the connector to work properly: - Call Center Object Manager (ENU) - Server Manager - Siebel Connection Broker ## Supported Managed Systems The Oracle ERP Siebel connector supports the following versions of Siebel's CRM Managed System: - Siebel CRM version 17.0.0.0 (IP 2017) along with patches 18.X, 19.X, 20.X, 21.X, 22.X, 23.X and 24.X - Siebel CRM version 16.0.0.0 (IP 2016) ## Required Permissions The Oracle ERP Siebel connector requires Siebel administrator credentials to accomplish provisioning tasks. The administrator user name and password configured for Oracle ERP Siebel must be assigned sufficient privileges within Siebel to create new records and to update existing records for the specified business component. By default, the Oracle ERP Siebel source manages **Employee** and **Position** business components. The SADMIN user, which is created during the Siebel server installation, is one example of administrator. > [!NOTE] > > A responsibility named "Siebel Administrator" assigned to this user gives access to all views. # Machine Account Attributes ## Machine Account Provisioning Attributes Machine account creation uses its own set of attributes on the Create Machine Account profile. Use the following table to map each attribute to its data type, requirement status, default generator, and description. | Attribute | Type | Required | Generator | Description | | --- | --- | --- | --- | --- | | Login Name | string | Yes | Static | The login name of the machine account. Enter a unique login name. | | First Name | string | No | Static | The first name of the machine account. | | Last Name | string | No | Static | The last name of the machine account. | | Primary Position Id | string | No | Disable | The primary position ID of the machine account. | | Responsibility | string | No | Disable | A multi-value attribute that contains the list of responsibilities assigned to the machine account. | | Password | secret | No | Disable | The password of the machine account. | | Verify Password | secret | No | Disable | Verification of the machine account password. | | Job Title | string | No | None | The job title of the machine account. | | Employee Type Code | string | No | None | The user type code of the machine account. Use this attribute to set an application-specific classification in Siebel. | For more information, refer to [Machine Identity Security Overview](). ### Classification The Classification attribute is used to identify and categorize the account as a machine account. - **Attribute name** - UserType - **Value** - Communication, Reference, Service, System # Multiple Group Entitlements with Pre-existing Source For pre-existing Oracle ERP Siebel sources, perform the following steps to start using the Multiple Group Entitlements with your current sources. 1. Use the [createSchema]() API to create new group schema for your source. The following is an example for API body content for adding Responsibilities to an existing source: Here, id refers to the actual source ID. ```json { "id": "2c91808429864c0180279a6340ba7", "name": "Responsibility", "nativeObjectType": "responsibility", "identityAttribute": "Name", "displayAttribute": "Name", "features": [ "PROVISIONING" ], "attributes": [ { "name": "Id", "type": "STRING", "schema": null, "description": "Unique Identifier for Responsibility", "isMulti": false, "isEntitlement": false, "isGroup": false }, { "name": "Name", "type": "STRING", "schema": null, "description": "Name of Responsibility", "isMulti": false, "isEntitlement": false, "isGroup": false }, { "name": "Description", "type": "STRING", "schema": null, "description": "Description for Responsibility", "isMulti": false, "isEntitlement": false, "isGroup": false }, { "name": "Organization", "type": "STRING", "schema": null, "description": "Organization of Responsibility", "isMulti": false, "isEntitlement": false, "isGroup": false }, { "name": "Primary Organization", "type": "STRING", "schema": null, "description": "Primary Organization of Responsibility", "isMulti": false, "isEntitlement": false, "isGroup": false }, { "name": "Primary Organization Id", "type": "STRING", "schema": null, "description": "Primary organization ID of Responsibility", "isMulti": false, "isEntitlement": false, "isGroup": false }, { "name": "Primary Organization.DS Updated", "type": "STRING", "schema": null, "description": "Primary Organization.DS Updated of Responsibility", "isMulti": false, "isEntitlement": false, "isGroup": false }, { "name": "Mod Id", "type": "STRING", "schema": null, "description": "Mod ID of Responsibility", "isMulti": false, "isEntitlement": false, "isGroup": false }, { "name": "Access Type", "type": "STRING", "schema": null, "description": "Access type of Responsibility", "isMulti": false, "isEntitlement": false, "isGroup": false }, { "name": "Created", "type": "STRING", "schema": null, "description": "Created date of Responsibility", "isMulti": false, "isEntitlement": false, "isGroup": false }, { "name": "Created By", "type": "STRING", "schema": null, "description": "Responsibility created by", "isMulti": false, "isEntitlement": false, "isGroup": false }, { "name": "Updated", "type": "STRING", "schema": null, "description": "Updated date of Responsibility", "isMulti": false, "isEntitlement": false, "isGroup": false } ] } ``` 2. Update the account schema with the following steps: 1. Get the account schema using [getSchema]() API. 2. Copy the schema to a file and search for the attribute corresponding to the group schema that is added in the previous step. 3. Add or update the following two properties for the attribute found in the previous step. ```json "isGroup": true, "isEntitlement": true, "schema": { "type": "CONNECTOR_SCHEMA", "id": "", "name": "" } ``` 4. Add the schema modified in the previous step to the payload to update the account schema in the source using [replaceSchema]() API. # Provisioning The Oracle ERP Siebel connector supports provisioning, allowing you to create and manage accounts and entitlements in Oracle ERP Siebel 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 | Account Attribute | Generator | Description | | --- | --- | --- | | Login Name | Identity Attribute | The login name of the SailPoint user. | | First Name | Identity Attribute | The first name of the SailPoint user. | | Last Name | Identity Attribute | The last name of the SailPoint user. | | Primary Position Id | Disable | The employee's primary position ID. | | Responsibility | Disable | A multi-value attribute that contains a list of all the employee's responsibilities. | | Password | Disable | The employee account password. | | Verify Password | Disable | Verification of the employee account password. | | Job Title | Disable | The title of the job. | | Employee Type Code | Disable | The code of the user type. | # 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 Oracle ERP Siebel 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 ID SailPoint requires that certain attributes remain in your configuration. These attributes are referred to as *account IDs*. > [!CAUTION] > > Changing the attribute marked as the account ID after aggregating accounts can result in duplicate accounts being created. To avoid this, either reset the accounts on this source before editing the account ID attribute or edit the account ID attribute before aggregating accounts. > > To resolve issues caused by changing account IDs, reconfigure them to their default values. The following table lists the default account IDs for this connector: | Account ID | Schema Object Type | | --- | --- | | Login Name | Account | | Id | Group | ### Default Account Attributes The Oracle ERP Siebel 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 | | --- | --- | | Login Name | The employee's login name. | | First Name | The employee's first name. | | Last Name | The employee's last name. | | Position | A multi-value attribute that contains a list of all positions assigned to the employee. | | Primary Position Id | The employee's primary position ID. | | Responsibility | A multi-value attribute that contains a list of all responsibilities of the employee. | | Primary Responsibility Id | The employee's primary responsibility ID. | | Division | The employee's organizational division. | | Employment Status | The employee's employment status. | | Street Address | The employee's street address. | | Job Title | The employee's job title. | | Phone Number | The employee's phone number. | | Fax Number | The employee's fax number. | | Hire Date | The employee's hire date. | | Alias | The employee's alias. | | State | The employee's state. | | Availability Status | The employee's availability status. | | ManagerLogin | The employee's manager login. | ## 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 Oracle ERP Siebel 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 | The unique ID for the position entity. | | Name | The name of the position. | | Last Name | The last name of the employee in this position. | | Division | The division of the position. | | Role | The role of the position. | | Start Date | The start date for allocation of the position to the employee. Referred to by the last name. | | Position Type | The type of position. | | Parent Position Id | The ID number associated with the parent position | ### Default Responsibility Attributes | Attribute Name | Description | | --- | --- | | Id | Unique Identifier for responsibility. | | Name | Name of responsibility. | | Description | Description of responsibility. | | Organization | Organization of responsibility. | | Primary Organization | Primary organization of responsibility. | | Primary Organization Id | Primary organization ID of responsibility. | | Primary Organization.DS Updated | Primary Organization.DS updated of responsibility. | | Mod Id | Mod ID of responsibility. | | Access Type | Access type of responsibility. | | Created | Created date of responsibility. | | Created By | Responsibility created by. | | Updated | Updated date of responsibility. | # 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]() ## There is a connection issue if you upload a .jar file that is not correct for the specific version of the Siebel server **Resolution**: Upload the correct Siebel server .jar file. ## After configuring the Siebel source, if a VA cluster changes, the test connection fails with an error message ```text [ ConnectorException ] [ Error details ] com/siebel/data/SiebelException ``` **Resolution**: Upload the correct Siebel server .jar files in the source for the changed VA. ## You receive an error in the Add/ Remove Entitlement operation if the primary position ID is not present in the Access Request ```text Can not remove primary Position from User Account ``` The operation is aborted with a message such as: ```text Aborting task operation ``` **Resolution**: Ensure that the primary position is present in the entitlement list. # 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" } ] ```