# HealthStream CredentialStream Connector > SailPoint HealthStream CredentialStream SaaS Connector Documentation # Documentation # Configuring HealthStream CredentialStream for Integration This section describes the configurations that must be performed to support the following features: ## Aggregation of Custom Attributes The HealthStream CredentialStream connector source supports aggregation of additional attributes from the following APIs: - Demographics All - Demographics Facilities - Demographics Credentials - Demographics Organization - Demographics Specialties - Screen Extender/Demographics To add additional attributes, complete the following: 1. Add the attribute name in the Account schema. 2. Apply the appropriate JSON path query for the attribute on this page. For example: > **Screenshot** > > [![JSON Path Example]()]() > [!NOTE] > > - Custom Attribute should not have same name as out of the box connector attribute > - Out-of-the-box connector attribute will not be respected in JSON Path Mapping > - For Screen Extender name of attribute should be in format `__Screen_Ext` ## Filter by Custom Criteria HealthStream CredentialStream Connector also supports filtering based on custom attribute, to leverage this functionality perform the following steps: 1. Add the attribute name in the Account Schema. 2. Apply appropriate JSON path query for the attribute in the JSON Path Schema Mapping section Specify the exclusion field and its corresponding values in the "Exclude Provider by Custom Criteria" field > [!NOTE] > > **Screenshot** > > [![Filter by Custom Criteria]()]() > [!NOTE] > > - Aggregation of records Based on Custom Criteria is only supported for the attribute that are part of Screen Extender/Demographics API > - Null value is not supported as custom criteria > - Multiple Attributes with corresponding values can be added, it will be considered as an OR logic between them i.e. Provider will be skipped if it satisfy any one of the conditions # Connecting SailPoint and HealthStream CredentialStream To connect SailPoint with HealthStream CredentialStream, 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. ## 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. (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](). 4. Configure the authentication to allow SailPoint to connect to the source. Refer to [Connection Settings](<#connection-settings>) for more information. 5. (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](). 6. (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. 7. Select **Save**. ## Connection Settings Configure a direct connection between SailPoint and the HealthStream CredentialStream connector. > [!NOTE] > > **Screenshot** > > [![Connection Settings]()]() 1. Enter the **Access Key** required to authenticate the managed system. 2. Enter the **Client ID** and **Client Secret** for the application. ## Aggregation Settings Use the settings available in **Aggregation Settings** to adjust aggregation processes as required for your organization. > [!NOTE] > > **Screenshot** > > [![Aggregation Settings]()]() - Enable **Exclude Provider by Status** to remove providers from aggregation processes based on a defined set of statuses. Then define which statuses should be excluded from aggregation by selecting them from the list. - Enable **Exclude Provider by Custom Criteria** to remove providers from aggregation processes based on a specific criteria. Then, in **Exclusion Field**, define the **Exclusion Field Name** and corresponding **Value** the connector should use to exclude providers from aggregation processes. - Select **Save**. ## Additional Settings > [!NOTE] > > **Screenshot** > > [![Additional Settings]()]() 1. In the **Page Size**, 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 500. 2. In the **Connection Timeout in Minutes** field, enter the time span after which a connection attempt terminates. 3. Select **Save**. ## JSON Path Attribute Mapping The HealthStream CredentialStream connector can aggregate new attributes in addition to the default attributes already in the account schema. To add additional attributes follow the below given steps as mentioned: > [!NOTE] > > **Screenshot** > > [![JSON Path Attribute Mapping]()]() 1. Add the attribute name in the Account Schema. 2. Apply appropriate JSON path query for the attribute in the JSON Path Schema Mapping section ## 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 HealthStream CredentialStream The SailPoint HealthStream CredentialStream connector extends a deep level of management of your Provider data in the HealthStream system along with Facilities, Specialties, and Credentials/Licenses information. > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features The SailPoint HealthStream CredentialStream connector supports the following features: #### Account Management - Aggregate and Refresh Provider Accounts - Aggregation of Custom Attributes associated with Providers - Aggregation of Records based on Provider Status in Facilities - Aggregation of Records Based on Custom Criteria ## Prerequisites Before you configure your HealthStream CredentialStream connector, you must consider the following prerequisite items. - You should contact HealthStream (HealthStream CredentialStream) to obtain a **Client ID** and **Client Secret** with the necessary permissions for read-only access to the `"Verity Connect"` API resource. > [!IMPORTANT] > > To receive assistance from SailPoint Support, you may need to provide access to your HealthStream CredentialStream test or development environment. # 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 HealthStream CredentialStream 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 HealthStream CredentialStream source, the default correlation mapping is: | Account Attribute | Operation | Identity Attribute | | --- | --- | --- | | Dr\_Id | Equals | Username | | Email | 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 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 | | --- | --- | | Dr\_Id | Account | ### Default Account Attributes The HealthStream CredentialStream 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 | | --- | --- | | Dr\_Id | ID of the Provider. This is an Identity Attribute which must not be changed. For more information, refer [Account ID](). | | FirstName | Legal first name of the provider. | | LastName | Legal last name of the provider. | | MiddleName | MiddleName of the provider. | | CellPhone | CellPhone of the provider. | | Fax | Fax of the provider. | | Email | Email of the provider. | | AppModuleEmail | AppModuleEmail. | | PrimaryTitles\_Code | PrimaryTitles of the provider. | | Facilities Information | Facilities Information of the provider. | | Credential License Information | License information of provider. | | Specialties Information | Specialties Information of the provider. | # 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]().