# SailPoint Sybase (SAP ASE) Connector Documentation

> Sybase (SAP ASE) Connector Documentation

# Documentation

# Connecting SailPoint and Sybase (SAP ASE)

To connect SailPoint with Sybase (SAP ASE), 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](<https://documentation.sailpoint.com/saas/help/sources/index.html#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](<https://documentation.sailpoint.com/saas/help/va/index.html>).
   - **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](<https://documentation.sailpoint.com/saas/help/common/users/user_levels.html#source-sub-admin-user-level>) or [role](<https://documentation.sailpoint.com/saas/help/common/users/user_levels.html#role-sub-admin-user-level>) sub-admin level oversight of the source and its access. For more information, refer to [Creating and Managing Governance Groups](<https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html>).
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](<https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html>).
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](<https://documentation.sailpoint.com/saas/help/va/index.html>).
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](<https://documentation.sailpoint.com/connectors/help/credential_providers.html>).
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](<https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html#associating-a-governance-group-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.

   Upload the `jconn4.jar` file. The current file and upload history are listed below the box. Refer to [Prerequisites](<https://documentation.sailpoint.com/connectors/sap/sybase_ase/va/help/index.html#prerequisites>) for information on acquiring the `jconn4.jar` file.

   > **Note**
   >
   > You must download the library from a trusted source and validate the authenticity of the download location by inspecting valid SSL/TLS certificates. You must also validate the authenticity of the library by inspecting digital signatures or validating checksums when that information is available.
9. Select **Save**.

## Connection Settings

Configure the connection between SailPoint and your Sybase (SAP ASE) source.

> [!NOTE]
>
> **Screenshot**
>
> [![Connection Settings](<https://documentation.sailpoint.com/connectors/sap/sybase_ase/va/help/img/sy_conn1.png>)](<https://documentation.sailpoint.com/connectors/sap/sybase_ase/va/help/img/sy_conn1.png>) [![Connection Settings](<https://documentation.sailpoint.com/connectors/sap/sybase_ase/va/help/img/sy_conn2.png>)](<https://documentation.sailpoint.com/connectors/sap/sybase_ase/va/help/img/sy_conn2.png>)

1. Enter the Sybase (SAP ASE) administrator's user ID into the **Service Account** field.
2. Enter the Sybase (SAP ASE) administrator's password into the **Password** field.
3. Enter the Sybase SAP ASE server address into the **URL** field.
4. Enter the name of the driver class supported by JDBC Type 4 into the **Driver Class** field.

   For example, in the case of `jconn2.jar`, use the following driver class:

   `com.sybase.jdbc2.jdbc.SybDataSource`
5. Enter the list of databases you want SailPoint to include during aggregation as a comma-separated list into the **Include Databases** field.
6. Enter the list of databases you want SailPoint to ignore during aggregation as a comma-separated list into the **Exclude Databases** field.
7. In the **Additional Connection Parameters** field, enter the parameters to be passed in the form of key value pair.

   If you need to specify multiple parameters, press Enter after adding each value.

   For example:

   `<truststorefileparameter>=<pathoftruststore>` `<truststoretypeparameter>=<truststoretype>`
8. Select **Save**.

## Additional Settings

Additional settings contain options to set the **Page Size** and enable **Is Minimum Permission User** for aggregation.

> [!NOTE]
>
> **Screenshot**
>
> [![Additional Settings](<https://documentation.sailpoint.com/connectors/sap/sybase_ase/va/help/img/sy_add.png>)](<https://documentation.sailpoint.com/connectors/sap/sybase_ase/va/help/img/sy_add.png>)

1. Set the number of rows ResultSet should display in the Page Size field. The source's **Page Size** limits the maximum number of results that the ResultSet displays
2. Check the box to enable Is Minimum Permission User.

   - Enable the feature to confirm that the Sybase (SAP ASE) administrator has at least the minimum required permissions. For more information, see [Granular Permissions Not Installed on SAP ASE](<https://documentation.sailpoint.com/connectors/sap/sybase_ase/va/help/index.html#granular-permissions-not-installed-on-sap-ase>).
   - If you leave it disabled, the Sybase (SAP ASE) administrator user must have the `mon_role` to complete the aggregation successfully.

     To optimize performance, the administrator user you configure should have higher permissions. By default, performance optimization is enabled.
3. Select **Save**.

## SSL Connection

The Sybase (SAP ASE) source supports SSL encyption.

To enable SSL encryption in the Sybase (SAP ASE) connector:

1. Import the SSL certificates from the Sybase SAP ASE server to `/home/sailpoint/certificates` directory on the source VA.
2. Restart the CCG with the following command:

   `sudo systemctl restart ccg`
3. In configuration of Sybase SAP ASE source config for the URL field, use the following URL:

   `jdbc:sybase:Tds:<HOST>:<PORT>/?ENABLE_SSL=true`

## 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](<https://documentation.sailpoint.com/saas/help/ai/app_onboarding/index.html>) in the SailPoint SaaS documentation.

# Integrating SailPoint with Sybase (SAP ASE)

> [!NOTE]
>
> **Integration**
>
> This is an integration and requires additional licensing or subscriptions to utilize it. For more information, contact your customer success manager.

*SAP Adaptive Server Enterprise SAP ASE is the new name for the formerly named Sybase Adaptive Server Enterprise (Sybase ASE).*

This document is designed to give specific information about the requirements and field definitions needed to get a working instance of a Sybase SAP ASE connector.

> [!NOTE]
>
> To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes](<https://community.sailpoint.com/release-notes/saas>) page.

## Supported Features

The SailPoint Sybase SAP ASE Connector provides support for the following features:

- Accounts
- \*Password Management
- \*Provisioning
- \*Access Certifications (certification of entitlements connected to accounts)
- Delete Account

For more information on features, refer to [Source Features](<https://community.sailpoint.com/knowledge/Identity-Security-Cloud-Source-Features>).

> [!NOTE]
>
> Before you can use any item above marked with an asterisk (\*), SailPoint must activate the feature for your site. Please open a support ticket for assistance.

The Sybase SAP ASE source in SailPoint supports the following group and entitlement objects:

| Source Objects | Supported Operation |
| --- | --- |
| Roles as group objects | Read only |
| Aliases, Database\_groups, and Roles as entitlement objects | Add or remove entitlements |

### 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](<https://documentation.sailpoint.com/saas/help/pwd/index.html>).

## Supported Managed Systems

Following versions of ASE are supported by the SailPoint SAP ASE Connector:

- SAP ASE 16.1
- SAP ASE 16.0
- SAP ASE 15.7
- SAP HADR (High Availability Disaster Recovery) SAP ASE 16.0 SP03

## Prerequisites

Ensure you've met the following prerequisites before deploying the SailPoint Sybase SAP ASE connector:

- Configure at least one virtual appliance cluster and successfully test the connection. For more information, refer to the [Virtual Appliance Reference Guide](<https://documentation.sailpoint.com/saas/help/va/index.html>).
- Identify or create a service account on the Sybase (SAP ASE) system.
- Download and install a custom SAP ASE JDBC driver, which is required for the proper functionality of SailPoint SAP ASE Connector. For example, `jconn4.jar`. The `jconn4.jar` driver is now part of the SDK for SAP Adaptive Server Enterprise (Sybase ASE).

  To download the required driver:

  1. Go to the [SAP Marketplace](<https://store.sap.com/dcp/>).
  2. In the **Search** field at the top of the page, enter "SCN Adaptive Server Enterprise SDK".

     A list of downloads is displays.
  3. Download the package appropriate to your version.

## Administrator Permissions

You must have access to an administrator account on Sybase SAP ASE system with the following minimum permissions to create a service account:

- SSO\_ROLE (System Security Officer)
- SA\_ROLE (System Administrator Role)
- Permission to run the following commands during aggregation:

  - `CREATE USER <USER_NAME> IDENTIFIED BY <PASSWORD>`
  - `GRANT select on master..sysloginroles to <USER_NAME>`
  - `GRANT select on master..sysrvroles to <USER_NAME>`

Respective administrator permissions must be provided by an SA or administrator-level login user for the following operations:

- Test Connection
- Aggregation
- Provisioning

### Test Connection

Configure the permissions to test the connection to the SAP Sybase database. Access to all databases must be granted to this user.

1. Set the enable granular permissions configuration parameter to `1` as follows in the application debug page:

   ```sql
   sp_configure enable_granular_permissions, 1
   ```
2. Log in using administrator credentials and create a new user on the managed system using the following command, where `loginame` is the login user on SAP ASE, `password` is the user-provided password, and `username` is the corresponding Database User:

   ```sql
   use [databaseName]
   go
   sp_addlogin [loginname],[password]
   go
   sp_adduser [username]
   go
   ```

   > **Note**
   >
   > Grant access to all databases to the newly created user.

### Aggregation

Configure user permissions for aggregation operations.

1. Create the role and assign it to a login user:

   ```sql
   create role [rolename]
   go
   grant role [rolename] to [loginname]
   go
   ```
2. Activate the role:

   ```sql
   exec sp_modifylogin '[loginname]', 'add default role', '[rolename]'
   go
   ```
3. Assign the following privileges to role. The service account must have associated user on respective databases to fetch aliases:

   ```sql
   grant select on master..sysloginroles to [rolename]
   go
   grant select on master..syssrvroles to [rolename]
   go
   grant select on master..syslogins to [rolename]
   go
   grant select on sysusers to [rolename]
   go
   grant select on master..sysdatabases to [rolename]
   go
   grant select on sysroles to [rolename]
   go
   grant select on sysalternates to [rolename]
   go
   grant manage security configuration to [rolename]
   go
   ```

### Provisioning

1. Users require the following permissions to perform provisioning operations:

   ```sql
   go
   grant manage any login to [rolename]
   go
   grant manage server to [rolename]
   go
   grant manage roles to [rolename]
   go
   grant change password to [rolename]
   go
   ```
2. Configure user permissions to conduct database-related operations (add/remove user, add/remove database group, add/drop alias):

   **Prerequisite**: Service account must have associated user on respective databases and dbo must have **manage database permissions** privilege.

   ```sql
   use [databaseName]
   go
   grant manage database permissions to [username]
   go
   use [databaseName]
   go
   grant manage any user to [username]
   go
   ```

### Granular Permissions Not Installed on SAP ASE

This section describes the minimum permissions required for the Sybase (SAP ASE) administrator user when the **Granular Permissions** module is not installed on SAP ASE (`sp_configure enable_granular_permissions, 0`).

Respective administrator permissions must be provided for the following operations:

- Test Connection
- Aggregation
- Provisioning

The minimum Administrative Account permission required to be granted for provisioning is **SSO\_ROLE (System Security Officer)**. The following scripts must be used to create minimum permission user and role. These permissions must be run by a SA or administrator-level login user.

1. Log in using administrator credentials and create a new user on managed system using the following command:

   ```sql
   sp_addlogin [loginname],[password]
   go
   ```
2. Add a database user:

   ```sql
   use [databaseName]
   go
   sp_adduser [loginname], [databseUserName]
   go
   ```
3. Grant read-only access to the newly created user using the following command:

   ```sql
   grant select on master..sysloginroles to [username]
   grant select on master..syssrvroles to [username]
   ```

   > **Note**
   >
   > To access user-defined databases, create an account on that database as follows:
   >
   > Query to create Database user:
   >
   > ```sql
   > use [databaseName]
   > go
   > sp_adduser [username], [databaseUserName]
   > go
   > ```

# Machine Account Attributes

## Machine Account Provisioning Attributes

Use the following table to map each machine account attribute to its display name, data type, requirement status, and usage notes.

| Field (name) | Type | Required | Notes |
| --- | --- | --- | --- |
| name | string | Yes | Display name of the machine account . |
| is\_platform\_access\_only | boolean | Yes | This flag is required to create the account as an App User rather than a standard human user. Default static value is true. |
| space\_amount | long | No | Space allocated to the user. Default static value is 5 |
| unlimited | string | No | Default static value is No. |
| status | boolean | No | Indicates if the user is enabled or disabled. Default value is disable. |

For additional details about machine account implementation, refer to the [Machine Identity Security Overview](<https://documentation.sailpoint.com/saas/help/machine/index.html#implementing-without-application-data>).

# Provisioning

The Sybase (SAP ASE) connector supports provisioning, allowing you to create and manage accounts and entitlements in Sybase (SAP ASE) directly from SailPoint.

**Prerequisite:** Your system is configured for provisioning.

When SailPoint provisions new accounts to the source, it uses the attributes on the **Create Account** page as instructions or a template for what to include in the account. This page is also referred to as the *provisioning policy*.

When new access is granted on a source where a user does not already have an account, SailPoint automatically includes account creation in the provisioning. This applies whether provisioning is started from an access request or from an automated role or lifecycle state assignment.

For direct-connect sources, SailPoint automatically creates the account from this configuration. If the source is not configured as a direct-connect source, SailPoint creates and assigns a provisioning task to the source owner and includes the values for the source owner to use in manually creating the account.

> [!IMPORTANT]
>
> This section describes the default **Create Account** configuration. SailPoint recommends that you work with Services to define a provisioning configuration specific to your company's needs. Be sure to verify large changes to the provisioning policy before implementation. Failure to do so might cause provisioning to fail.

## Default Create Account Attributes

> [!NOTE]
>
> Attributes marked with an asterisk (\*) are mandatory.

| Account Attribute | Generator | Description |
| --- | --- | --- |
| native\_identity\* | Create Unique Account ID | This generator uses the value in the **Pattern Used** field to generate a unique DN for the new account |
| password\* | Create Password | This generator creates an initial password for the new account that matches the password policy assigned to the associated Sybase SAP ASE source in SailPoint. |
| password\_expiration\_interval | Disable | The user password expiration interval expressed in days. You can set this from 0 to 32767 days. |
| default\_database | Disable | The default user database |
| default\_language | Disable | The default language |
| full\_name | Disable | The full name of a user |

## Provision Password Expiration Interval Attribute

If the **Password\_Expiration\_Interval** attribute is not part of Create Profile, then use the following API to update the **Create Profile** form.

1. Get the JSON response:

   Method: `GET`

   URL: `https://{url}/api/accountProfile/get/<source_id>?usage=Create`
2. Copy the JSON response from the above API and use it as an input for the following API.

   ```text
   Method: Post
   URL: https://{url}/api/accountProfile/update/<source_id>?usage=Create
   Content-Type: application/json
   Body:

   {
       "attributes": {},
       "isRequired": false,
       "name": "password_expiration_interval",
       "transform": null,
       "type": "string"
   }
   ```

# 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](<https://documentation.sailpoint.com/saas/help/accounts/schema.html>) for more information.
> - The schema attributes that are not present by [default](<#default-account-schema>) must be defined as strings if not specified.

The Sybase (SAP ASE) 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](<https://documentation.sailpoint.com/saas/help/accounts/schema.html>) 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 |
| --- | --- |
| native\_identity | Account |
| native\_identity | Group |
| native\_identity | Database Groups |

### Default Account Attributes

The Sybase (SAP ASE) 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 |
| --- | --- |
| name | Login user name. |
| server\_user\_id | Server User ID. |
| default\_database | Default database. For example: master |
| default\_language | Default language. For example: us\_english |
| full\_name | Full name of login user. |
| create\_date | Date on which login user is created. |
| password\_chg\_date | Date on which password got changed. |
| last\_login\_date | Last login date of the user. |
| native\_identity | An attribute which acts like a primary key during aggregation. This is an Account ID which must not be changed. |
| status | Status of login user, such as enable/disable. |
| roles | Roles associated with login user. |
| database\_groups | Database groups. |
| password\_expiration\_interval | Password Expiration Interval frequency in days |
| expire\_login | Expire Login of the system. |
| password\_expired | Password has expired for user. |
| aliases | Aliases associated with login user. |

## Custom Attributes

Perform the following to support the custom attributes:

1. Click Add attribute button to add the custom attribute name in the schema.
2. Add the following lines in the application debug page:

   ```text
   <entry key = "customAttribute" >
       <value>
          <List>
              <String>custom1</String>
              <String>custom2</String>
          </List>
       </value>
   </entry>
   ```

## 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](<https://documentation.sailpoint.com/saas/help/access/entitlements.html>) 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 Sybase (SAP ASE) connector also supports groups. The following attributes must be configured on the managed system and in the SailPoint source schema to manage groups.

#### Group Object Type = Groups

| Attribute Name | Description |
| --- | --- |
| server\_role\_id | ID of the server Role. |
| native\_identity | An attribute which acts like a primary key during aggregation. This is an Account ID which must not be changed. |
| name | Name of the Role. |
| password\_chg\_date | Date on which password got changed. |
| member\_roles | Roles which are present under the hierarchy of the main role. |

#### Group Object Type = Database Groups

| Attribute Name | Description |
| --- | --- |
| Group\_name | Database Group Name. |
| native\_identity | An attribute which acts like a primary key during aggregation. This is an Account ID which must not be changed. |
| Group\_id | Database Group ID. |

# 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](<https://documentation.sailpoint.com/saas/help/index.html>)
- [SailPoint Support Knowledge Base](<https://support.sailpoint.com/csm?id=kb_view2&amp;kb_id=05ff44289f011200550bf7b6077fcfa3>)
- [SailPoint Developer Community](<https://developer.sailpoint.com/>)

SailPoint recommends that on the managed target system, the server name and database name must not be the same.

# 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](<https://developer.sailpoint.com/docs/api/authentication/>) and [REST API - Update Source (Partial)](<https://developer.sailpoint.com/docs/api/update-source-v-1/>) 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"
    }
]
```