# SailPoint Oracle EPM Cloud Connector Documentation > Oracle EPM Cloud Connector Documentation # Documentation # Connecting SailPoint and Oracle EPM Cloud To connect SailPoint with Oracle EPM Cloud, 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 **Configure**. 5. In the **Source Name** field, enter a unique and descriptive name for your source. Source names cannot exceed 128 characters. 6. 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. 7. 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](). 8. 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. 9. 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. 10. (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](). 11. 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](). 12. 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 Oracle EPM Cloud. > [!NOTE] > > **Screenshot** > > [![Connection Settings]()]() > > [![Connection Settings]()]() 1. Select **Connection Settings** from the menu. 2. Enter the EPM service name into the **Oracle Cloud Service Name** field. > **Important** > > The desired service name must match the name of the Oracle Cloud service in Identity Domain Cloud Service (IDCS) platform. The incorrect service name may cause into false aggregation without any error shown during connection. 3. Enter the Identity Cloud Domain (IDCS) URL into the **Identity Cloud Service URL** field. If there is a forward slash '/' present at the end of the URL, you must remove it. 4. Enter the EPM application URL (that is associated with the service entered in the above step) into the **System URL** field. If there is a forward slash '/' present at the end of the URL, you must remove it. 5. Enter the name of the service user into the **User Name** field. 6. Select the Grant Type as **JWT Bearer Token**. 7. Enter the **Client ID** of the third party integration application created in IDCS (as mentioned in [Prerequisites]()). 8. Enter the **Client Secret** of the third party integration application created in IDCS (as mentioned in [Prerequisites]()). 9. Enter the alias of the certificate into the **Certificate Alias** field. 10. Enter the **Certificate** (public key) as a single string. To copy the **Certificate** into a single string you must remove each new line (\\n) character before pasting it into the field. 11. Enter the **Private Key** as a single string. To copy the **Private Key** into a single string you must remove each new line (\\n) character before pasting it into the field. 12. Enable **Aggregate All EPM Entitlements** to use Interop REST-based roles/groups aggregation. If disabled, legacy/report-based catalogs are used. 13. 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 EPM Cloud > [!NOTE] > > **Integration** > > This is an integration and requires additional licensing or subscriptions to utilize it. For more information, contact your customer success manager. Oracle Enterprise Performance Management (EPM) Cloud integration with SailPoint helps in the governance of accounts, roles & groups. End-to-end account management capabilities provide deep governance and visibility into the organization's health. - The Oracle EPM Cloud connector uses the Oracle REST APIs. > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features The Oracle EPM Cloud connector supports the following features: > [!NOTE] > > Before you can use any of the following items marked with an asterisk (\*), SailPoint must activate the feature for your site. - Aggregation - Aggregate users - Aggregate Roles & Groups as Entitlement - The PredefinedRole, ApplicationRole, Group, and IDCSGroup are the group objects. > **Note** > > - The system supports aggregation of directly & indirectly (via IDCS groups) assigned predefined roles. > - To use Interop REST-based roles/groups aggregation, enable **Aggregate All EPM Entitlements** in the application configuration. If disabled, legacy/report-based catalogs are used. - \*Provision the accounts - Create, Update, Delete > **Note** > > - To create an EPM account, it is mandatory to assign predefined roles and/or IDCS Groups to a user. > - The system supports the **Update** account attributes operation only for First Name, Last Name, and Email. - Add / Remove Entitlement - \*Access Certifications (certification of entitlements connected to accounts) For more information on features, refer to [Source Features](). ## Supported Managed Systems The Oracle EPM Cloud connector supports the following versions and modules: **Version** - Oracle Identity Cloud Service - 23.2.92-2301160723 and later - Enterprise Performance Management Cloud - 23.02.85 and later **Modules** - Planning - Financial Consolidation and Close (FCCS) - Account Reconciliation (AR) - Narrative Reporting (NR) ## Prerequisites - Configure at least one [virtual appliance (VA) cluster]() and successfully test the connection. - It is mandatory to create a Service User with the following roles assigned: - Identity Domain Administrator - to access Oracle Identity Cloud Service (IDCS) APIs. - Service Administrator - to access Enterprise Performance Management (EPM) module specific APIs. > **Note** > > Assign the Service Administrator role of the desired EPM modules. - You must set up an IDCS Client application to establish Oracle integration with SailPoint and perform all the operations. - You must add the Signing Certificate as Trusted Partner Certificate and also import the same into the IDCS Client Application. ### Create a Service User in Oracle Identity Cloud Service (IDCS) The Oracle EPM Cloud system requires a service user with a specifically configured service role to connect with SailPoint. **Create Service User** 1. Go to the **Users** menu in Identity Cloud Service portal. 2. Select **Add (+)** to add service user details. 1. Enter the user's **First Name** (optional) and mandatory fields **Last Name** and **User Name/Email**. 2. Alternatively, you may choose to use the separate **User Name** and **Email fields**. 3. Select **Finish** to create the user. **Assign Identity Domain Administrator Role to Service User** 1. Go to the **Security** menu in Identity Cloud Service portal. 2. Select the **Administrators** submenu, and then select the **Identity Domain Administrator** option. 3. Select **Add (+)** and search for the Service User name which was created above to add as an Identity Domain Administrator. **Assign Service Administrator Role to Service User** 1. Go to the **Oracle Cloud Services** menu in Identity Cloud Service portal. 2. Select your EPM cloud service instance(s). 3. Select the **Application Roles** menu and ensure the Service Administrator role is listed. 4. In the **Service Administrator** role, select the hamburger icon to **Assign Users**. 5. Search for and select the created service user. Select **OK** to assign Service Administrator role of the selected EPM Service instance to the service user. > [!NOTE] > > - The **Service Administrator** role of multiple EPM Services can be assigned to the Service User by repeating the same steps mentioned above. > - The created service user in IDCS must login, at minimum, to applicable EPM service accounts in order to enable the access to the specific service related REST APIs. ### Create Signing Certificate and Keys 1. **Pre-requisites**: Java JDK8 or later must be preinstalled. 2. Open the terminal / command prompt on the machine (/local) and navigate to the directory where you wish to create the Private/Public keys. 3. Run the following commands one by one (use appropriate pass-codes and pass-phrases where necessary): 1. **To generate self-signed key pair**: ```text keytool -genkey -keyalg RSA -alias assert3 -keystore sampleKeystore.jks -storepass Sailpoint@123 -validity 365 -keysize 2048 ``` Input the appropriate information: ```text What is your first and last name? [Unknown]: Test User What is the name of your organizational unit? [Unknown]: Sailpoint What is the name of your organization? [Unknown]: Sailpoint What is the name of your City or Locality? [Unknown]: Pune What is the name of your State or Province? [Unknown]: Maharashtra What is the two-letter country code for this unit? [Unknown]: IN Is CN=Test User, OU=Sailpoint, O=Sailpoint, L=Pune, ST=Maharashtra, C=IN correct? [no]: yes Enter key password for Sailpoint@123 (RETURN if same as keystore password): Re-enter new password: Sailpoint@123 Warning: The JKS keystore uses a proprietary format. It is recommended to migrate to PKCS12 which is an industry standard format using "keytool -importkeystore -srckeystore sampleKeystore.jks -destkeystore sampleKeystore.jks -deststoretype pkcs12". ``` This command will create a unique keystore on the machine, for example *sampleKeystore.jks* 2. **To export the public key for signing the JWT assertion**: ```text keytool -exportcert -alias assert3 -file assert3.cer -keystore sampleKeystore.jks -storepass Sailpoint@123 ``` This command will create a public key on the machine, for example *assert3.cer* 3. **To convert the keystore to P12 format**: ```text keytool -importkeystore -srckeystore sampleKeystore.jks -srcstorepass Sailpoint@123 -srckeypass Sailpoint@123 -srcalias assert3 -destalias assert3 -destkeystore assert3.p12 -deststoretype PKCS12 -deststorepass Sailpoint@123 -destkeypass Sailpoint@123 ``` This will create the pkcs12 encoded public key, for example *assert3.p12* 4. **To export the private key from the P12 keystore**: ```text openssl pkcs12 -in assert3.p12 -nodes -nocerts -out private3_key.pem ``` This command will create the private key using P12 formatted keystore, for example *private3\_key.pem* ```text Enter Import Password: Sailpoint@123 MAC verified OK ``` 5. **To extract the private key & public key in a single text file**: ```text openssl pkcs12 -in assert3.p12 -out keys_out.txt -nodes ``` This command will extract the private and public key in text file, for example *key\_out.txt* ```text Enter Import Password: Sailpoint@123 MAC verified OK Enter PEM pass phrase: Sailpoint@123 Verifying - Enter PEM pass phrase: Sailpoint@123 ``` ### Add the Certificate as the Trusted Partner Certificate 1. In the Identity Domain Cloud Service (IDCS), expand the **Navigation Drawer**, select **Settings**, and then **Partner Settings** to open the **Trusted Partner Certificates** page. 2. On the **Trusted Partner Certificates** page in the **Partner Certificates** section, select **Import**. 3. On the **Import** window add the **Alias** (name) of the certificate and select **Browse** to import it from the local machine. > **Note** > > It is recommended to keep the alias of the certificate in IDCS the same as the alias used while creating the certificate on the local machine. 4. Select **Import** and confirm the certificate is imported successfully with the correct **Alias**, showing both the **SHA-1 Thumbprint** and **SHA-256 Thumbprint**, the **Certificate Start Date**, and the **Certificate End Date**. ### Create IDCS Client Application **Prerequisites**: - You must have the **Cloud Service Platform** Identity Domain Cloud Service (IDCS). - You must have the **Role** of Identity Domain Administrator. - Enable the **Is Refresh Token Allowed** option for Oracle Identity Cloud Service. - Specify the **Primary Audience**, **Secondary Audience**, and associated scope for the target EPM Cloud Service tenant (instance). **Configure OAuth for the EPM Cloud Service Tenant** Go to **Oracle Cloud \> Identity & Security \> Domains \> \[domain\] {OracleIdentityCloudService} \> Oracle cloud services \> \[EPM Cloud Service Tenant\] \> OAuth configuration**. 1. Select **Edit** on the **OAuth configuration** page. 2. Configure application APIs that require OAuth protection and set the desired **Access token expiration (seconds)** value. 3. Select the **Allow token refresh** toggle and set **Refresh token expiration in seconds**. 4. Set **Primary audience** to: ```text urn:opc:serviceInstanceID= ``` 5. Select the **Add secondary audience** toggle. 6. In **Secondary audience**, enter the EPM application base URL only. For example: ```text https://.epm.us-ashburn-1.ocs.oraclecloud.com ``` 7. Add scope as the mandatory and only value: ```text urn:opc:resource:consumer::all ``` 8. Under **Client Configuration**, in **Allowed grant types**, select **Client credentials**. 9. Set **Client type** to **Confidential**. 10. Under **Token issuance policy**, set **Authorized resources** to **Specific**. 11. Verify **App roles** include the following: - Identity Domain Administrator - User Administrator - Me - Cloud Gate - User Viewer **Create the Integrated Application** 1. Go to **Oracle Cloud \> Identity & Security \> Domains \> \[domain\] {OracleIdentityCloudService} \> Integrated applications**. 2. Select **Add application**. 3. Select **Confidential Application**, and then select **Launch workflow**. 4. Enter the **Name** and **Description** for the confidential application, and then select **Submit**. 5. Under **Integrated applications**, open the application you created. 6. On the **OAuth configuration** page under **Resource server configuration**, select **Edit OAuth configuration**. 7. Configure the APIs to protect with OAuth and set the desired **Access token expiration (seconds)** value. 1. Select the **Allow token refresh** toggle and set **Refresh token expiration in seconds**. 2. Set **Primary audience** to the EPM tenant base URL only. For example: ```text https://.epm.us-ashburn-1.ocs.oraclecloud.com ``` 8. Under **Client Configuration**, select **Configure this application as a client now**. In **Allowed grant types**, select **Client credentials** and **JWT assertion**. 1. Set **Client type** to **Confidential**. 2. Upload the valid certificate and its alias with **Allowed operations** set to **On behalf of** and **Client IP address** set to **Anywhere**. 3. Under **Token issuance policy**, set **Authorized resources** to **Specific**. Select the **Add resources** toggle. 4. Add the mandatory scope for your tenant. The value must match the following format: ```text urn:opc:serviceInstanceID=urn:opc:resource:consumer::all ``` 5. Verify **App roles** include the following: - Identity Domain Administrator - Service Administrator - Me # Machine Account Attributes Machine account attributes are used in provisioning configurations for machine accounts. After you have [created the required machine account subtypes](), you can use the machine account attributes to provision machine accounts in your SailPoint tenant. Refer to [Machine Identity Security Overview]() for more information. # Provisioning The Oracle EPM Cloud connector supports provisioning, allowing you to create and manage accounts and entitlements in Oracle EPM Cloud 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 | Attribute Name | Description | | --- | --- | | User Login | A unique identifier for the user to authenticate with the service provider directly. This is a mandatory attribute. | | First Name | The first name of the user. | | Last Name | The last name of the user. This is a mandatory attribute. | | Email | The primary email address of the user. This is a mandatory attribute. | # 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 EPM Cloud 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 | | --- | --- | | ID | Account | | ID | PredefinedRole | | Role Name | ApplicationRole | | Group Name | Group | | ID | IDCSGroup | ### Default Account Attributes The Oracle EPM Cloud 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 | | --- | --- | | ID | A unique identifier for the user resource in Oracle Applications Cloud. This is an Account ID which must not be changed. | | User Login | The login name of the user, usually the name or email. | | First Name | The first name of the user. | | Last Name | The last name of the user. | | Email | The primary email address of the user. | | PredefinedRoles | The list of pre-defined roles assigned to the user. | | ApplicationRoles | The list of application roles assigned to the user. | | Groups | The list of direct groups assigned to the user. | | IDCSGroups | The list of IDCS groups assigned to the user on the EPM application. | ## 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 EPM Cloud connector also supports groups. The following attributes must be configured on the managed system and in the SailPoint source schema to manage groups. #### Default EPM Group Attributes The Oracle EPM Cloud 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 | | --- | --- | | Group Name | The display name for the group resource in Oracle EPM Cloud. This is an Account ID which must not be changed. | #### Default IDCS Group Attributes | Attribute Name | Description | | --- | --- | | ID | A unique identifier for the IDCS group resource in Identity Cloud Service for EPM. This is an Account ID which must not be changed. | | Name | The display name for the group resource in Identity Cloud Service for EPM. | | Predefined Roles | The list of Predefined Roles assigned to the IDCS Group for the EPM application | ### Default Role Attributes The Oracle EPM Cloud connector supports roles. The following attributes must be configured on the managed system and in the SailPoint source schema to manage roles. #### Default Predefined Role Attributes The Oracle EPM Cloud connector supports roles. The following attributes must be configured on the managed system and in the SailPoint source schema to manage roles. | Attribute Name | Description | | --- | --- | | ID | A unique identifier for the pre-defined role resource in Oracle EPM Cloud. This is an Identity Attribute which must not be changed. | | Role Name | The display name for the pre-defined role resource in Oracle EPM Cloud. | #### Default Application Role Attributes | Attribute Name | Description | | --- | --- | | Role Name | The display name for the application role resource in Oracle EPM Cloud. This is an Account ID which must not be changed. | # Migrate VA-based Source to a SaaS Source Some sources that are connected to virtual appliance (VA) clusters can be migrated to SaaS connections. This ensures data (users and entitlements) remain intact and can maintains your source configurations like access profiles, roles, password settings, and correlation configurations when switching from a VA cluster to a SaaS connection. To migrate a source from a VA-based source to a SaaS source, you will provide configuration details on a draft version of the source before publishing the source. > [!NOTE] > > - You must have an Admin or Source Admin user level to migrate a source. > - Steps for Migration of VA-based Source to a SaaS Source are applicable for all EPM cloud connectors. A draft version of the source is created. As your migration process is in progress the live source will continue to work as it is. - For more information on the Oracle EPM Cloud AR SaaS connector, refer to the [Oracle EPM Cloud AR SaaS Supported Features](). - For more information on the Oracle EPM Cloud FCCS SaaS connector, refer to the [Oracle EPM Cloud FCCS SaaS Supported Features](). - For more information on the Oracle EPM Cloud NR SaaS connector, refer to the [Oracle EPM Cloud NR SaaS Supported Features](). - For more information on the Oracle EPM Cloud Planning SaaS connector, refer to the [Oracle EPM Cloud Planning SaaS Supported Features](). ## Important Considerations Before Migrating - You do not need to edit additional configurations (other than connection credentials) to migrate the source. - If your source migration is in progress, please do not make any configuration changes to your live source as those can be overwritten once you apply the migration your draft version. - Once you've gone ahead with your migration, it can't be rolled back. Your source is permanently migrated to a SaaS source. - Any preview operations or configuration changes on the draft source will not impact the live source until you apply the migration. ## Migrating Sources To migrate your source, complete the following: 1. Go to **Admin \> Connections \> Sources**. 2. Select or edit the VA-based source you want to migrate. 3. Open the source configuration, and select **Migrate to SaaS**. 4. When prompted, select **Continue**. A draft version of the source is created. The live source will continue to work. 5. Select **Connection Settings**. 6. Re-enter encrypted configuration details. For example, you might need to re-enter the Client Secret, Password, Refresh Token, Personal Access Token (PAT), or Certificates to migrate from the VA cluster to the SaaS connection. > **Important** > > Avoid editing the other configuration options in the draft source. 7. Select **Review and Test**. 8. Select **Test Connection**. 9. (Optional) Select **Accounts**. If you successfully tested your connection in **Review and Test**, you can select **Preview** to display a subset of accounts from the application that will be mapped to SailPoint identities. This can help ensure you are accurately connecting identity data from the application with SailPoint identities. 10. (Optional) Select **Entitlements**. If you successfully tested your connection in **Review and Test** and your source type supports entitlement type configuration, you can select **Preview** to view a preview of entitlements using the current configuration settings. 11. When you've finished reviewing your changes and successfully tested your connection, select **Apply Migration**. Your changes will be applied to the live source and the draft source will be deleted. ## Viewing Source Migration Status You can view the status and creation date of draft sources. 1. Go to **Admin \> Connections \> Sources \> Source Migration Status**. 2. Select **Source Migration Status**. 3. To view or edit the draft source, select **Actions** ![]() **\> Preview** on the draft source. 4. To delete the draft source, select **Actions** ![]() **\> Delete** on the draft source. # 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]() ## Invalid Configuration Exception (OAuth Token Audience Issue) ```text [InvalidConfigurationException] The user do not have sufficient permissions to perform action... ``` **Root cause**: Oracle changed the secondary audience and scopes: [REST API authentication with OAuth 2](). **Resolution**: Configure the EPM Cloud service tenant and integrated applications as described in Create IDCS Client Application. ## Full Account Aggregation Isn't Aggregating All of the Users **Resolution**: Use the HTTP PATCH method to enable the `useApprolesExtension` attribute in the source xml with the value = true. Retry account aggregation. ## Group Aggregation Does Not Fetch Application Roles **Resolution**: The application roles might not be fetched in the group aggregation if the connection between the Oracle EPM Cloud system and SailPoint is slow. Following attributes can be added in the application debug page to retry and to read the Application roles. ```text Key=retryWaitTime Value=30 Key=maxRetryCount Value=3 ``` The retryWaitTime is in seconds, and the default value is 5 seconds. maxRetryCount default value is 3. ## Inactive Users Are Not Aggregated with Full Account Aggregation. **Resolution**: Oracle EPM cloud connector aggregates active users only because user can only be disabled from IDCS system. Once it is disabled, the link from EPM is disappeared. ## JWT Token Error. Invalid User Assertion: Token Has Invalid Issue Time. ```text Exception in JWT token generation : {"error":"invalid_grant","error_description":"Invalid user assertion: Token has invalid issue time.","ecid":"Iq^nO1ten10000000"} ``` **Resolution**: The issue arises if the VAs in the cluster have different times, or if the timezone of Oracle differs from the VA. Check the time of each VA by using sudo timedatectl on the VA. If any VAs have different times, then your infrastructure team must fix the time on the machine. Additionally, ensure the VA timezone and Oracle timezone is the same. ## Schemas 2.0 Error ```text {"schemas":["urn:ietf:params:scim:api:messages:2.0:Error","urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"],"detail":"You are not allowed to perform any actions on this page.","status":"401","urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error":{"messageId":"error.common.common.accessDenied"}} ``` **Resolution**: Ensure the service user created has logged in at least once to the target EPM Cloud Service before using it for SailPoint integration. ## Illegal Base64 Error ```text Illegal base64 character 20 ``` **Resolution**: Ensure the certificate or private key entered is a single string without any new line characters. ## JWT Token Unknown Host Error ```text Exception in JWT token generation : java.net.UnknownHostException: : nodename nor servname provided, or not known ``` **Resolution**: Enter the valid IDCS/System URL to authenticate the required resources. ## JWT Token Invalid Client Error ```text Exception in JWT token generation : {"error":"invalid_client","error_description":"Client authentication failed.","ecid":"L^PYG08YA20000000"} ``` **Resolution**: Ensure the entered Client ID and Client Secret are correct and refer to the correct client application that is created in IDCS for SailPoint integration. ## JWT Assertion Creation Failed Could Not Parse Certificate Error ```text [ ConnectorException ] [ Error details ] JWT Assertion creation failed. Could not parse certificate: java.io.IOException: Empty input ``` **Resolution**: Ensure the entered certificate is correct or copied correctly before entering it into the field. ## Not Enough Valid Bits Error ```text Last unit does not have enough valid bits ``` **Resolution**: Ensure the entered certificate is correct or copied correctly before entering it into the field. ## Input Byte Array Error ```text Input byte array has wrong 4-byte ending unit ``` **Resolution**: Ensure the entered private key is correct or copied correctly before entering it into the field. ## JWT Assertion Creation Failed Java Security InvalidKey Error ```text [ ConnectorException ] [ Error details ] JWT Assertion creation failed. java.security.InvalidKeyException: IOException : DerInputStream.getLength(): lengthTag=55, too big. ``` **Resolution**: Ensure the entered private key is correct or copied correctly before entering it into the field. ## Exception While Fetching Groups Error ```text Exception while fetching groups assigned to users ``` **Resolution**: Ensure the entered EPM System URL is correct. ## Error While Fetching User Error ```text User 'id' does not have an EPM account or it has been removed ``` **Resolution**: Ensure the user has a direct predefined role or at least one IDCS Group assigned to the user. ## Exception During Entitlement Assignments ```text Error 404--Not Found

Error 404--Not Found

From RFC 2068 Hypertext Transfer Protocol -- HTTP/1.1:

10.4.5 404 Not Found

The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent.

If the server does not wish to make this information available to the client, the status code 403 (Forbidden) can be used instead. The 410 (Gone) status code SHOULD be used if the server knows, through some internally configurable mechanism, that an old resource is permanently unavailable and has no forwarding address.

``` **Resolution**: Ensure there is not a forward slash '/' at the end of the base URL in the source configuration page. ## Exception While Removing Entitlement for User ```text ["Request to remove all assigned IDCS entitlements of the user was rejected","because this will result in deleting the user. 'Delete' the user to achieve the same behaviour."] ``` **Resolution**: Ensure there is at least one predefined role or IDCS group present when removing entitlements. ## Extra Application Roles Are Added While Provisioning Predefined Roles. An Application Role (Data Integration - Create) is getting added. **Resolution**: Ensure when we assign Service Administrator predefined role then there are some inherited application roles are added to user. The role addition is mechanism present at oracle end. # 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" } ] ```