# SailPoint Workiva Connector Documentation > Workiva Connector Documentation # Documentation # Connecting SailPoint and Workiva To connect SailPoint with Workiva, 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. (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](). 4. Configure the authentication to allow SailPoint to connect to the source. For more information, refer to the **Connection Settings** section. 5. 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. (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](). 5. 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](). 6. Select **Continue**. The source is created, and you are navigated to the **Source Setup \> Base Configuration** page. Continue to configure your connected source there. ## Connection Settings To configure connection settings, complete the following: > [!NOTE] > > **Screenshot** > > [![Connection Settings]()]() 1. Enter the **Host URL** for the source. 2. Select the **Authentication Type** used by the Workiva system, then enter the supporting authentication credentials. - **Basic Authentication** - **API Token** 3. Enter the **Username** to log into the Workiva user account. 4. Enter the **Password** to log into the Workiva user account. 5. Enter the **Connection Timeout** as the duration of inactivity the connector allows before terminating its connection to the source. The default is 1 minute. 6. Select **Save**. ## Aggregation Settings Use the settings available in **Aggregation Settings** to adjust aggregation processes as required for your organization. For more information about aggregation, refer to [Loading Account Data](). > [!NOTE] > > **Screenshot** > > [![Aggregation Settings]()]() 1. In the **Page Size** field, enter the number of records to aggregate in a single page when iterating over large datasets. You can set from 1 to 1000. The default is 50 records. 2. In the **Account Filter** field, enter account filter conditions to define the scope of the account aggregation process. For example: active eq "true" 3. In the **Group Filter** field, enter group filter conditions to define the scope of the group aggregation process. For example: displayName eq "developers" 4. Select **Save**. ## Provisioning Settings Configure settings for provisioning operations between the connector and the source. > [!NOTE] > > **Screenshot** > > [![Provisioning Settings]()]() > [!NOTE] > > When adding a user to a Workspace Group or Workspace Role, ensure they are a member of the associated Workspace. If not, the provisioning will fail. 1. Select **Add User to Workspace** checkbox to allow the Workiva connector to automatically add the user to the associated workspace before proceeding. 2. In the **Operation Delay** in Seconds field, enter the time duration that all provisioning operations are held during the user creation process. The default is 5 seconds. 3. Select **Save**. ## JSON Path Mapping The Workiva connector will aggregate the attributes associated with the primary work relationship and corresponding assignments based on the dates. In order to change this behavior, specify the attribute value as specified below in JSON Path Mapping. This will enable the customer to fetch the work relationship and Job Information as per their requirement. > [!NOTE] > > **Screenshot** > > [![JSON Path Mapping]()]() 1. Select **Add Another** to add a new entry. 2. In the **Schema Attribute** field, enter the attribute name. Then, in the **JSON Path** field, enter the JSON path associated with the attribute. 3. Select **Save** after you have added all the attributes. ## 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 Workiva The SailPoint Workiva connector provides governance capabilities for Workiva users. These capabilities encompass aggregation, user provisioning, as well as the addition or removal of entitlements at the account level. > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features The Workiva connector supports the following features: - Full Account Aggregation - Single Account Aggregation (Refresh or Get Account) - Manage Workiva Workspace, Workspace Role, Workspace Group and Organization Role as Entitlements - Full Entitlement Aggregation - Provisioning Operations - Create and Update Account Provisioning - Enable or Disable - Add Entitlement(s) - Remove Entitlement(s) ## Prerequisites - The Workiva Application is set-up in your IT environment. ## Supported Managed Systems The Workiva connector supports the following managed systems: - Workiva Cloud Application 3.57.179 onwards. ## Required Permissions - A service account for managing the source needs to be created by following the document provided by Workiva below: [Manage and provision users with SCIM](). - To ensure proper functionality and access, the service account must be assigned the following organization roles: - Org User Admin - Org Workspace Admin - Org Security Admin - Org Chain Security Admin For More information, refer to the following Workiva documentation link- [Update an organization role]() # Provisioning The Workiva connector supports provisioning, allowing you to create and manage accounts and entitlements in Workiva directly from SailPoint. **Prerequisite:** Your system is configured for provisioning. When SailPoint provisions new accounts to the source, it uses the attributes on the **Create Account** page as instructions or a template for what to include in the account. This page is also referred to as the *provisioning policy*. When new access is granted on a source where a user does not already have an account, SailPoint automatically includes account creation in the provisioning. This applies whether provisioning is started from an access request or from an automated role or lifecycle state assignment. For direct-connect sources, SailPoint automatically creates the account from this configuration. If the source is not configured as a direct-connect source, SailPoint creates and assigns a provisioning task to the source owner and includes the values for the source owner to use in manually creating the account. > [!IMPORTANT] > > This section describes the default **Create Account** configuration. SailPoint recommends that you work with Services to define a provisioning configuration specific to your company's needs. Be sure to verify large changes to the provisioning policy before implementation. Failure to do so might cause provisioning to fail. ## Default Create Account Attributes | Account Attribute | Generator | Description | | --- | --- | --- | | emails.work.primary.value | Identity Attribute | The email address value. | | name.givenName | Identity Attribute | The first name of user. | | name.familyName | Identity Attribute | The family name of the user. | | userName | Identity Attribute | The username for operations. | | active | Static | The active status of user. | # Schema Reference The application schema is used to configure the objects returned from a connector. > [!NOTE] > > - The **Account Schema** tab is used to define the attributes for each object type in the application being configured. The schema attributes can be defined as **Entitlement** or **Multi-Valued**. Refer to [Managing Source Account Schemas]() for more information. > - The schema attributes that are not present by [default](<#default-account-schema>) must be defined as strings if not specified. The Workiva connector uses the following default correlation and object configurations. ## Default Correlation Configuration Before you aggregate accounts from this source, you can map account attributes with their corresponding identity attributes based on your requirements. You can customize the correlation configuration. Refer to [Assigning Source Accounts to Identities]() for more information. When you first create the Workiva source, the default correlation mapping is: | Account Attribute | Operation | Identity Attribute | | --- | --- | --- | | UserName | Equals | name | | emails.work.primary.value | Equals | Work Email | ## 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 Workiva 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 | The unique identifier for the user. | | userName | The unique identifier for the user is typically used by the user to directly authenticate to Workiva. | | name.formatted | The full name of the user. | | name.familyName | The family name of the user. | | name.givenName | The given name of the user. | | displayName | The name of the user, suitable for display to end-users. | | Title | The user's title, such as 'Vice President'. | | active | A Boolean value indicating the user's administrative status. | | emails.work.primary.display | A human-readable name, primarily used for display purposes. | | emails.work.secondary.display | A human-readable name, primarily used for display purposes. | | emails.work.primary.value | The email address value. | | emails.work.secondary.value | The email address value. | | emails.home.primary.display | A human-readable name, primarily used for display purposes. | | emails.home.secondary.display | A human-readable name, primarily used for display purposes. | | emails.home.primary.value | Email address value. | | emails.home.secondary.value | The email address value. | | emails.other.primary.display | A human-readable name, primarily used for display purposes. | | emails.other.secondary.display | A human-readable name, primarily used for display purposes. | | emails.other.primary.value | The email address value. | | emails.other.secondary.value | The email address value. | | groups | A list of groups to which the user belongs, either through direct membership, through nested groups, or dynamically calculated. | | locale | Used to indicate the User's default location for purposes of localizing items such as currency, date time format, numerical representations, etc. | | nickName | The casual way to address the user in real life. | | phoneNumbers.work.primary.display | A human-readable name, primarily used for display purposes. | | phoneNumbers.work.secondary.display | A human-readable name, primarily used for display purposes. | | phoneNumbers.work.primary.value | Phone number of the user. | | phoneNumbers.work.secondary.value | Phone number of the user. | | phoneNumbers.home.primary.display | A human-readable name, primarily used for display purposes. | | phoneNumbers.home.secondary.display | A human-readable name, primarily used for display purposes. | | phoneNumbers.home.primary.value | The phone number of the user. | | phoneNumbers.home.secondary.value | The phone number of the user. | | phoneNumbers.mobile.primary.display | A human-readable name, primarily used for display purposes. | | phoneNumbers.mobile.secondary.display | A human-readable name, primarily used for display purposes. | | phoneNumbers.mobile.primary.value | The phone number of the user. | | phoneNumbers.mobile.secondary.value | Phone number of the user. | | preferredLanguage | Indicates the user's preferred written or spoken language. Generally used for selecting a localized user interface. For example, 'en\_US' specifies the language English and country US | | timezone | The user's time zone in the 'Olson' timezone database format; for example, 'America/Los\_Angeles'. | ## Default Entitlement Attributes Entitlement attributes define the entitlements, such as groups or roles, that can be assigned to the managed system's user accounts. Refer to [Managing Entitlements]() for more information. > [!CAUTION] > > Changing the attribute marked as the Entitlement ID after aggregating accounts or entitlements can result in duplicate entitlements being created, or access profiles and roles breaking. To avoid this, edit the entitlement schema before performing any aggregations. ### Default Group Attributes The Workiva connector also supports groups. The following attributes must be configured on the managed system and in the SailPoint source schema to manage groups. | Attribute Name | Description | | --- | --- | | id | The unique identifier of the group. | | displayName | A human-readable name for the group. | | members | A list of members of the group. | | location | The URL of group. | # 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]() ## Debug Logs For information about managing additional source settings, including debug logging and downloading connector logs, refer to [Managing Additional Settings](). ## java.net.SocketTimeoutException: Read timed out during provisioning of workspaces The following error might occur when you provision workspaces or group memberships: ```text java.net.SocketTimeoutException: Read timed out Command timed out ``` **Resolution** - Increase the connection and provisioning timeout values: 1. Increase `customTimeout` from the default of 1 minute to 3 minutes. If the error continues, increase the value to 5 minutes. This setting controls how long the connector waits for Workiva to respond to each SCIM API request during test connection, aggregation, and provisioning. 2. Set `provisioningTimeout` to a value in seconds that is at least as long as `customTimeout`. Start with 180 seconds, then increase the value to 360 and finally 600 if needed. The maximum value is 600 seconds. For example, use the following request to set `customTimeout` to 3 minutes and add a `provisioningTimeout` value of 180 seconds: ```json [ { "op": "replace", "path": "/connectorAttributes/customTimeout", "value": "3" }, { "op": "add", "path": "/connectorAttributes/provisioningTimeout", "value": 180 } ] ``` > [!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.