# SailPoint SAP Fieldglass Connector Documentation > SAP Fieldglass Connector Documentation # Documentation # Connecting SailPoint and SAP Fieldglass To connect SailPoint with SAP Fieldglass, perform the following tasks: ## Adding the Source in SailPoint To connect to SailPoint, perform the following steps. Once the connection is made, you can configure it to meet your company's needs. > [!IMPORTANT] > > By default, the provisioning feature is **disabled**, and the connector only supports read-only operations. To support provisioning operations, you must manually enable the feature in the source configuration. **To configure a new source:** 1. Sign in to SailPoint. 2. Go to **Admin \> Connections \> Sources**. 3. Select **Create New**. 4. Search for the connector by entering the name in the search box, and then select **Actions**. 5. In the **Actions** dropdown list, select the setup method: - [**Express Setup**](<#configuring-a-source-using-express-setup>) - Quickly create a read-only connection to your target system by providing minimal configurations and authentication. On completion, aggregation is automatically started. > **Note** > > Express Setup supports Credential Providers. For information on supported credential providers and configuration, refer to [Credential Providers](). For more information, contact your SailPoint Customer Service Manager. - [**Standard Setup**](<#configuring-a-source-using-standard-setup>) - Provide detailed basic configuration to create the source. Once the source is created, continue with source setup. ### Configuring a Source Using Express Setup Express Setup minimizes the initial configuration process so you can quickly connect the application and immediately begin aggregating user account and entitlement data. 1. Review the directions and select **Start Express Setup**. 2. Review the pre-populated **Source Name**, **Source Owner**, and **Description**. To update, select **Edit**. > **Note** > > The source name must be unique. You can change these settings later in the source configuration. 3. Select **Virtual Appliance**. A virtual appliance is a Linux-based virtual machine that connects to your sources and apps using SailPoint APIs, connectors, and integrations. For more information about configuring and deploying virtual appliances, refer to [SailPoint Virtual Appliances](). 4. (Optional) If enabled for your organization, select the **Use a Credential Provider** checkbox to manage the source's authentication using a credential provider. > **Note** > > To add a Credential Provider in SailPoint, go to **Admin \> Connections \> Credential Providers**. For more information about credential providers, refer to [Credential Providers](). 5. Configure the authentication to allow SailPoint to connect to the source. For more information, refer to the **Connection Settings** section. 6. Select **Finish**. After a successful test connection, the system creates your source and prompts you to run an aggregation. - If you want to aggregate now, select **Aggregate**. - To see the latest account aggregation history, go to **Account Management \> Account Aggregation**. - To see the list of aggregated source accounts, go to **Account Management \> Accounts**. - If you want to aggregate later, select **Exit**. This returns you to the **Sources** page. Your new source is listed, but contains no accounts or aggregation history yet. ### Configuring a Source Using Standard Setup Use Standard Setup to configure the connector for full feature support. 1. In the **Source Name** field, enter a unique and descriptive name for your source. Source names cannot exceed 128 characters. 2. In the **Description** field, provide additional details about the source to help distinguish it from similar sources. This field allows a maximum of 2,000 characters. 3. In the **Source Owner** field, begin typing the name of an owner. Matches appear after you type two or more letters. For more information, refer to [Assigning a Source Owner](). 4. Under **Connection Type**, select **Direct Connection** or **Flat File**. - **Direct Connection** - A direct connection fetches data from the **Virtual Appliance Cluster** you choose as the application connector for the source. A direct connection configuration allows for real-time updates. For more information about configuring and deploying virtual appliances, refer to the [Virtual Appliance Reference Guide](). - **Flat File** - Select the flat file if no connector is available, or if another system restricts the connection. This option allows only reading and aggregating data as a generic/delimited application. Provisioning activity is unsupported, and additional configuration pages like connection settings and aggregation settings are unavailable. 5. If you selected **Direct Connection**, in **Virtual Appliance Cluster**, select the virtual appliance cluster that will be used as the application connector for the source. 6. (Optional) Select a governance group to grant its members [source]() or [role]() sub-admin level oversight of the source and its access. For more information, refer to [Creating and Managing Governance Groups](). 7. If this source represents a primary system containing your organization's personnel records, select the **Authoritative Source** checkbox. For more information, refer to [Creating Identity Profiles](). 8. Select **Continue**. The source is created, and you are navigated to the **Source Setup \> Base Configuration** page. Continue to configure your connected source there. ## Base Configuration Provide the base configuration parameters. Information you entered in the Create New Source dialog is automatically entered into the fields in the Base Configuration page. You can edit this information if necessary. 1. Enter a unique name and description for the source. 2. In the **Source Owner** dropdown list, select the identity that owns this source. - To find a source owner, begin entering their name. 3. In the **Virtual Appliance Cluster** dropdown list, select the virtual appliance to use when communicating with your organization's systems. For more information, refer to [SailPoint Virtual Appliances](). 4. (Optional) If enabled for your organization, select the **Use a Credential Provider** checkbox to manage the source's authentication using a credential provider. > **Note** > > To add a credential provider, go to **Admin \> Connections \> Credential Providers**. For more information about credential providers, refer to [Credential Providers](). 5. Configure the authentication to allow SailPoint to connect to the source. Refer to [Connection Settings](<#connection-settings>) for more information. 6. (Optional) In the **Governance Group for Source Management** dropdown list, select a governance group to associate with this source. For more information about governance groups, refer to [Associating Governance Groups with a Source](). 7. (Optional) Choose whether to enable or disable provisioning for the source. Provisioning is disabled by default. - **Enable Provisioning** - Set the toggle to **Enabled** to allow the source to create, update, and deactivate accounts in the connected source system. - **Disable Provisioning** - Set the toggle to **Disabled** to disable provisioning for the source. Disabling provisioning will prevent the creation, updating, or deactivating of accounts on this source. 8. Select **Save**. ## Connection Settings > [!NOTE] > > **Screenshot** > > [![Connection Settings]()]() 1. Select **Connection Settings** from the menu. 2. Enter the SAP Fieldglass base URL in **Host URL**. 3. Enter the **Username** and **Password** of the SAP Fieldglass account. 4. Enter the **Application Key** from the SAP Fieldglass application. 5. Select **Save**. ## Aggregation Settings > [!NOTE] > > **Screenshot** > > [![Aggregation Settings]()]() [![Aggregation Settings]()]() [![Aggregation Settings]()]() 1. Select **Aggregation Settings** from the menu. 2. Enter the **User Report ID**, the **Worker Report ID**, and the **Single Worker Report ID**. 3. Enable **Aggregate Future Workers** to include users with future hire dates in account aggregation. 4. In **Future Workers Offset**, enter the number of days ahead (in the future) of the current date to aggregate future worker accounts. 5. Enable **Aggregate Terminated Workers** to include terminated workers in account aggregation. 6. In **Terminate Workers Offset**, enter the number of days prior to the current date to aggregate terminated worker accounts. 7. Enter a **PageSize** as the number of records that you can fetch in one request. The default page size is 50. The maximum value is 350. 8. Select **Save**. ## Provisioning Settings > [!NOTE] > > **Screenshot** > > [![Provisioning Settings]()]() 1. Select **Provisioning Settings** from the menu. 2. Enter the **Connector Integration Variant** name. 3. 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 SAP Fieldglass > [!NOTE] > > **Integration** > > This is an integration and requires additional licensing or subscriptions to utilize it. For more information, contact your customer success manager. SAP Fieldglass is a Vendor Management System (VMS) that helps manage a contingent workforce and buyer company users. It helps businesses manage flexible workforces better, faster, and with more efficient control. It increases productivity by streamlining processes such as assignment management, contingent workforce management, services procurement, and worker profile management. The SAP Fieldglass cloud integration with SailPoint's connector provides Identity Governance on buyer company users such as hiring managers, permanent employees of the buyer company, program management office users, and workers provided by Fieldglass. The integration also supports enforcing policies and permissions for granting and revoking access to buyer identities. > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features The SAP Fieldglass connector supports the following features: > [!IMPORTANT] > > 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 Workers - Aggregate Roles defined in the Fieldglass system - Add / Remove Entitlement - \*Provision the accounts (users) - Create, Update - Enable/Disable - \*Access Certifications (certification of entitlements connected to accounts) ## Privilege Classification SailPoint Privilege Classification helps organizations systematically categorize and manage the privilege levels of entitlements within their sources. By classifying entitlements as high, medium, or low, administrators can better understand the potential risk and impact associated with specific access rights. This allows automatic assignment of privilege levels based on system recommendations, custom-defined criteria, or a same level across all entitlements. | Privilege Level | Description | | --- | --- | | High | Administrative level access to accounts | | Medium | Administrative level access for a specific role or function | | Low | Only basic access of data | > [!NOTE] > > To manage Privilege Classification, users must have administrative roles such as Org Admin, Source Admin or Source Sub-Admin. For more information, refer to [Managing Privilege Classification](). > [!NOTE] > > **Example** > > [![Recommended Privilege Level - High]()]() > > [![Recommended Privilege Level - Medium]()]() ## Prerequisites You must set up a Client Application to establish SAP Fieldglass integration with SailPoint and perform all the operations. The client application uses the OAuth 2.0 client credentials to request a new access token as the initial step of accessing protected resources of SAP Fieldglass services. - Configure at least one virtual appliance cluster and successfully test the connection. For more information, refer to the [Virtual Appliance Reference Guide](). ### Create the X-Application Key > [!NOTE] > > **Screenshot** > > [![Create the X-Application Key]()]() [![Create the X-Application Key]()]() 1. Sign in to Fieldglass with **Buyer** credentials. 2. Go to the linked accounts of the signed-in user as **Configuration Manager**. 3. Select the **API Application Key** tile. 4. Select **New**. 5. Enter your **Application Name** and **Description**. 6. Select **Create**. You will now see the details as **UserName** (Client ID), **Password** (Client Secret), **Application Key**, and **Application Name**. 7. Select **New** to create a new Web service for the created **Application Key**. 8. Set the Status as **Enabled**. 9. Select **Save**. ### Create the Report > [!IMPORTANT] > > You will need *Analytics* access for creating and updating the Fieldglass reports. > [!NOTE] > > The report creation steps are the same for all Fieldglass modules. In our case we need Buyer and Worker modules for report creation. 1. Create a report folder named *SailPoint* to maintain reports needed for the Fieldglass source. In SAP Fieldglass, go to **Admin Configuration \> Reports \> Report Folder** and create the *SailPoint* folder. Folders created under the SailPoint folder are used to associate reports to user roles. > **Screenshot** > > [![Create report folder]()]() 2. From the home page, select the **Analytics** button, and then select **Create Report**. 3. Select the desired reporting category. For example: User, Worker, etc. A report template based on your selection will appear. You will need to create three reports: - User Report - Worker Report - Single Worker Report #### User Report Settings 1. For **User Report Settings**, select **Edit Report \> ASC** > **Screenshot** > > [![User Report Settings]()]() 2. Set the report filters as shown in the following screenshot. > **Screenshot** > > [![Report filters]()]() 3. Select **Details**, and then select the **JSON** radio button. > **Screenshot** > > [![Report details]()]() 4. Select the **Visibility** settings. > **Screenshot** > > [![Report visibility]()]() #### Single Worker Report Settings > [!NOTE] > > The following fields, filters, and details are required for each report creation of the Worker Report and Single Worker Report. This information is needed for worker data aggregation. 1. For **Worker Report Settings**, select **Edit Report \> ASC**. > **Screenshot** > > [![Worker report settings]()]() [![Worker report settings]()]() 2. The **SP Consolidated Worker ID** is a custom field. It must be created using the **Add Formula** link on the report creation page with the following details. > **Screenshot** > > [![Worker ID formula]()]() [![Worker ID formula]()]() #### Worker Report Settings 1. For **Worker Report Settings**, select **Edit Report \> ASC**. > **Screenshot** > > [![Worker report settings]()]() [![Worker report settings]()]() 2. Create two more fields. - **SP Worker Start date**. Formula: ```text [Worker | Details | Worker Start Date] ``` > **Screenshot** > > [![Worker start date]()]() - **SP Worker End Date** Formula: ```text ISBLANK([Worker | Details | Worker End Date],"12/31/9999") ``` > **Screenshot** > > [![Worker end date]()]() 3. Select **Validate** to validate the formula. 4. The following filters are mandatory to fetch the workers' report. However, users can change the values of the filters according to their requirements. The date format in User Preferences must be set to MM/DD/YYYY. > **Screenshot** > > [![Worker report filters]()]() 5. Select **Details**, and then select the **JSON** radio button. > **Screenshot** > > [![Worker report details]()]() 6. Select the **Visibility** settings. > **Screenshot** > > [![Report visibility]()]() 7. Templates can be modified based on the requestors' needs. From the **Fields** side bar, any field can be added to the current template via the drag and drop method. The columns can be reordered and renamed, and the values can be sorted in ascending or descending order. Filters can be applied regarding time or a specific status on the report. > **Note** > > - Remember that the template filters differ based on the reporting category selected earlier. > - **SP Worker End Date** and **SP Worker Start Date** will be overridden with the current date when aggregation executes. Additionally, if the **Future** or **Terminated offset** is configured. then it is used along with the current date to fetch the worker records. 8. Once the report has been configured, give it a name and choose the desired output format. 9. Select the **Show More Configuration** link, and set the **API Enabled** option to **Yes**. 10. **Save** the report. #### How to obtain the ID of the Report You will need the ID of the created report to provide in **Aggregation Settings** for the user and worker configurations. 1. Select your report name from the list. 2. Select the **Edit** option 3. The link url will contain the ID of the report > **Screenshot** > > [![Report ID]()]() ### Create the Connector Integration 1. Sign in with Configuration Manager access to the SAP Fieldglass portal. 2. Go to **Connectors** integration tools. 3. Search and open the **User Upload** connector from the connector list. 4. Select **Actions** and then select the **Create Variant** option to set the connector integration variant for provisioning. 5. Select **Start**, and then go to the **Enable** step. Enter the new connector name and select the values as shown below, then select **Next**. > **Screenshot** > > [![Create connector integration - enable]()]() 6. Enter the **Setup** details as shown below. > **Screenshot** > > [![Create connector integration - setup]()]() 7. Keep the default value as-is on the **Header Values** window. 8. In the **Security** window, change the value for the **Sensitive Data** and **Enable connector to be used through user interface? (optional)** fields. > **Screenshot** > > [![Create connector integration - security]()]() 9. Keep the default settings as-is in the **Configure Column Transformation** window and the **Connectivity** window. > **Screenshot** > > [![Create connector integration - connectivity]()]() 10. Select **Next** to finish. 11. Use the variant name created in the **Connector Integration Variant** field for the source. ### Configure Additional Attributes via Report This configuration is needed when you want to GET or SET the attributes other than those included out-of-the-box. #### SAP Fieldglass Configuration 1. In SAP Fieldglass, go to the existing **User Report** and select **Edit**. 2. Go to **Fields \> Name** and enter the name you want to search for. 3. Select the magnifying glass to perform the search. > **Screenshot** > > [![Configure additional attributes via report]()]() 4. Drag and drop fields from the navigation pane into the Columns area to add it (as a column) to your report. 5. Select **Save**. #### Connector Configuration 1. Add the new schema attribute by going to the **Source \> Schema Attribute \> New Schema Attribute**. 2. Add the attribute you need and then select **Save**. 3. Add the json mapping for the attribute under the \ via rest api to the source. For example, ```text example entry for currency field ``` ### Configure Additional Attributes with SCIM SailPoint supports SCIM for some additional attributes. You can configure them by performing the following steps: 1. Add the new schema attribute by going to **Source \> Schemas \> Add New Schema Attribute**. The attribute must have a complex name. For example, addresses.work.primary.locality 2. Add the json path for the attribute under the key "jsonPathMapping" For example, `` ## Required Permissions The SAP Fieldglass Service user must have the following two roles assigned to perform connector operations: - Configuration Manager - Administrator # Machine Account Attributes ## Machine Account Provisioning Attributes Machine account creation uses the same source attributes as standard account creation. For the complete list of supported attributes and their descriptions, refer to [Provisioning Policy Attributes](). For more information, refer to [Machine Identity Security Overview](). # Provisioning The SAP Fieldglass connector supports provisioning, allowing you to create and manage accounts and entitlements in SAP Fieldglass 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. > [!NOTE] > > - Create and Update Account is applicable for Buyer users only. > - Provisioning Operations are applicable for Buyer users only. ## Default Create Account Attributes | Account Attribute | Description | | --- | --- | | Login Name | A unique identifier for the user. This is a mandatory attribute. | | First Name | The first name of the user. | | Last Name | The last name of the user. | | Display Name | The display name of the user. | | Login Authentication Type | The login authentication type. | | Manager | The id of the user. | | Division | The primary business unit of the user. | ## Update Account Attributes > [!NOTE] > > There are no mandatory parameters for Update Account. The following is a list of supported attributes that are verified. ### Provisioning Policy Attributes | Account Attribute | Description | | --- | --- | | First Name | The first name of the user. | | Last Name | The first, middle, and last name of the user. | | Email | The email address of the user. | | Manager | The user's supervisor's Id. | | Division | The primary business unit of the user. | | Login Auth Type | The login authentication type of the user. Currently we are supporting 'Password' only. | ### Additional OOTB Attributes | Account Attribute | Description | | --- | --- | | Employee ID | The employee number of the user. | | Phone Number | The phone number of the user. | | Deactivation Date | The deactivation date of the user. | | Street Address | The address of the user (Address 1 field of SAP Fieldglass). | | Country | The country of the user. The country should be updated along with the street address. | | Postal Code | The postal code of the user. | | Job Title | The job title of the user. | | TimeZone | The timezone of the user. | ### Additional Attributes | Account Attribute | Description | | --- | --- | | Currency | The currency of the user. | | Mobile Number | The mobile number of the user. | | Language | The language preference of the user. | | City | The city of the user. | | Cost Center Access\* | The cost center the user has access to. \*Add the display name of this attribute in the schema as well as in report's display name field. | | Site Access\* | The site the user has access to. \*Add the display name of this attribute in the schema as well as in report's display name field. | | Business Unit Access\* | The business unit the user has access to. \*Add the display name of this attribute in the schema as well as in report's display name field. | > [!NOTE] > > - For information on the configuration of additional attributes, refer to [Configure Additional Attributes via Report]() and [Configure Additional Attributes with SCIM](). > - SCIM configuration for attributes is supported with SCIM API. # Schema Reference The application schema is used to configure the objects returned from a connector. > [!NOTE] > > - The **Account Schema** tab is used to define the attributes for each object type in the application being configured. The schema attributes can be defined as **Entitlement** or **Multi-Valued**. Refer to [Managing Source Account Schemas]() for more information. > - The schema attributes that are not present by [default](<#default-account-schema>) must be defined as strings if not specified. The SAP Fieldglass connector uses the following default correlation and object configurations. ## Default Account Schema Each source supports a variety of details, or attributes, about each user who has an account, such as their name, email address, manager name, and location. The set of account attributes each source stores and how they're organized is known as the account's *schema*. To best represent your data, you can configure sources to use an account schema matching the one you use in the external connector. Refer to [Managing Source Account Schemas]() for more information. ### Default Account Attributes The SAP Fieldglass 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. | | Login Name | The user's login name or user name. | | Active | The user's active status. | | First Name | The user's first name. | | Last Name | The user's last name. | | Display Name | The user's display name. | | Formatted Name | The user's formatted name. | | User Type | The type of user. | | Email | The user's work email address. | | Manager | The primary manager of the user. | | Country | The user's Country, expressed as a two-letter country code. | | Postal Code | The user's ZIP or postal code. | | Region | The user's state or region. | | Street Address | The user's street name. | | Phone Number | The user's primary phone number. | | Timezone | The user's timezone. | | Deactivation Date | The user's termination/end date. | | Employee ID | The user's employee number. | | Organization | The user's organization. | | Job Title | The user's job title. | | Cost Center | The user's cost center. | | Division | The user's primary business unit. | | Legal Entity | The user's legal entity. | | Login Authentication Type | The user's login authentication type. | | Universally Unique Identifier | The user's universally unique identifier. | #### Worker Specific Attributes | Attribute Name | Description | | --- | --- | | Worker currency | The worker's currency. | | Worker ID | The worker's ID. | | Worker Work Order Id | The worker's work order ID. | | Worker Work Order Start Date | The worker's work order start date. | | Worker Work Order End Date | The worker's work order end date. | | Worker Start Date | The worker's start date. | | Worker End Date | The worker's end date. | | Worker Type | The worker's type. | | Worker External Reference ID | The worker's external reference ID. | | Supplier Name | The worker's supplier name. | | Future Actions | Information about Future Worker in JSON format. | ## 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 Role Attributes The SAP Fieldglass connector supports roles. The following attributes must be configured on the managed system and in the SailPoint source schema to manage roles. #### Primary Role | Attribute Name | Description | | --- | --- | | ID | A unique identifier for the role. | | Display Name | The role's full name. | #### Additional Role | Attribute Name | Description | | --- | --- | | ID | A unique identifier for the role. | | Display Name | The role's full name. | # 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. 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 SAP Fieldglass SaaS connector, refer to the [SAP Fieldglass 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]() ## Warning while Performing Provisioning Operations `Record 1:warning:The Display Name specified is already in use by another person in your company. Please specify a different value.` **Resolution**: Ensure the user's Display Name is unique. If it isn't unique you must update it from the Fieldglass managed system. ## Error - Text 'Date' could not be parsed: Invalid value for MonthOfYear (valid values 1 - 12): 13s This error typically occurs when the date format is incorrect. **Resolution**: Ensure that the User Preferences date format is set to MM/DD/YYYY. To update the date format, follow these steps: 1. Log in to the Fieldglass system using Configuration Manager credentials. 2. Click on the User icon, then select My Preferences. 3. Click Edit, and update the Date Format to MM/DD/YYYY. 4. Save the changes. ## Worker Status Attribute is not fetched during aggregation By default, the SAP Fieldglass connector does not fetch the Worker Status attribute during aggregation for Workers. **Resolution**: To fetch the Worker Status attribute, update the source.xml configuration file as follows: 1. Add the following mapping under jsonPathMappingForReports: ```text ``` 2. Add the Worker Status attribute to the schema section: ```text Whether record is Closed or Open ``` After making these updates to source.xml, re-execute the aggregation to fetch the Worker Status attribute for Worker records. ## During the Create operation, validation for the userName attribute may fail when the SAP Fieldglass Feature (FF) is active and SSO is enabled in SAP Fieldglass. This occurs because SAP Fieldglass automatically appends the Company ID to the userName, causing it to differ from the value requested in the provisioning plan. As a result, the connector-level validation fails. > [!NOTE] > > When the connector-level validation is bypassed, the platform-level validation ensures that the create operation executes correctly without any adverse impact on connector functionality. **Resolution**: To bypass the connector-level validation in such cases, perform the following steps: 1. Go to the application's debug page. 2. Add the following attribute: ```text ``` 3. Save the configuration and retry the create operation. # 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" } ] ```