# SailPoint CallRail Connector Documentation > CallRail Connector Documentation # Documentation # Connecting SailPoint and CallRail To connect SailPoint with CallRail, 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 The following information is required to connect and interact with CallRail. > [!NOTE] > > **Screenshot** > > [![Connection Settings]()]() 1. To find the **Account ID**, go to **CallRail \> My Account \> Account**. The dashboard's URL will contain the ID. For example, https:\\//app.callrail.com/analytics/a/{**Account ID**}/home 2. Create the **API Key** from the CallRail System. 3. Select **Save**. ## Aggregation Settings > [!NOTE] > > **Screenshot** > > [![Aggregation Settings]()]() > [!NOTE] > > **Screenshot** > > [![Aggregation Settings]()]() 1. Enter the filter statements for **Account Filter** and **Company Filter**. Details are as follows: ### Account Filter Results returned will include only the objects that match the search term. Multiple search terms are not supported. The search term will match in the following attributes: - `first_name` - `last_name` - `email` Account Filter examples: - email@example.com - This will search the email in the `first_name`,`last_name`, and `email` attributes. If the searched term is found, the result will be the specific data of the user. - Alex - This will search for the name Alex in the `first_name`, `last_name`, and `email` attributes. If the searched term is found, the result will be the specific data of the user. ### Company Filter Results returned will include only the objects that match the search term. Multiple search terms are not supported. The search term will match in the following attribute: - `name` Company Filter example: sample company - This will search the sample company name in the `name` attribute. If the searched term is found, the result will be the specific data of the company. 1. Select **Aggregate Inactive Users** if you wish to include inactive users in the account aggregation. 2. Enter the **Page Size** for account and company aggregation. The default value is 100, and the maximum value is 250. 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 CallRail CallRail is a marketing platform for businesses that rely on quality phone calls, leads, and new customers to grow and succeed. CallRail is a service that tracks and manages your phone leads, helping businesses to determine which marketing campaigns are driving quality leads. The CallRail source offers governance of the users in the CallRail system. This includes aggregation, provisioning, and the management of entitlements at the account level. This document is designed to give specific information about the requirements and fields needed to successfully configure an instance of the CallRail source. > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features The CallRail source supports the following features: - Aggregation of Accounts - Aggregation of Entitlements (companies) - Get Account - Provisioning - Create Account - Add/Remove Entitlement - Update Account - Delete Account - Access Certifications (Certifications of entitlements connected to the accounts) > **Note** > > The CallRail source manages one specific account present within CallRail. Single account aggregation/read account is supported for users with an active state. Active state users are those who have accepted the invitation email after account creation. ## Prerequisites The following Prerequisites are required: 1. To connect with the CallRail system you will need to get an **Account ID** and **API Key**. These will be used to identify and authenticate your application. ## Required Permissions The user must have the **admin** role to access all APIs for users and companies. **Administrators** have complete access to every company in your account. These users are identified by the role `admin`. # Machine Account Attributes ## Machine Account Provisioning Attributes The following table lists the attributes in the machine account creation template, including the generator and description for each attribute. | Attribute | Generator | Description | | --- | --- | --- | | first\_name | Static | First name of the account | | last\_name | Static | Last name of the account | | email | Static | Email of the account | | role | Static | Role of the account | For more information, refer to [Machine Identity Security Overview](). # Provisioning The CallRail connector supports provisioning, allowing you to create and manage accounts and entitlements in CallRail 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 | | --- | --- | --- | | first\_name | Identity Attribute - First Name (firstname) | The user’s first name. | | last\_name | Identity Attribute - Last Name (lastname) | The user’s last name. | | email | Identity Attribute - Work Email | The email address the user will use to sign in to CallRail and receive call or text message notifications. | | role | static (reporting) | The level of access the user should have to your CallRail Account or Companies (either “admin”, “reporting”, or “manager”). When creating profiles, any of the roles can pass with a static value.(The reporting role will be attached by default). | > [!NOTE] > > A newly created account will remain in a “Pending User” state, and will be disabled in SailPoint. # 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 CallRail 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 CallRail source, the default correlation mapping is: | Account Attribute | Operation | Identity Attribute | | --- | --- | --- | | email | Equals | Work Email (email) | | name | Equals | Name (name) | ## 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 CallRail 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 user's unique ID. | | email | The user's email address. | | first\_name | The user's first name. | | last\_name | The user's last name. | | name | The user's full name. | | role | The user's role. | | created\_at | The time and date when the user was originally created. | | accepted | True if the user has accepted their invitation. | ## 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. | Attribute Name | Description | | --- | --- | | id | The company's unique ID. | | name | The company's display name. | | status | Indicates whether the company is currently “active” or “disabled”. | | time\_zone | The company's local timezone. | | created\_at | Time and date when the company was originally created. | | disabled\_at | The date and time the company was disabled in UTC (ISO 8601 format). If the company is still enabled, this value will be null. | | dni\_active | Indicates whether or not the company has the Javascript Snippet enabled.This field will be null if the Javascript Snippet has never been installed. | | callscore\_enabled | Indicates whether or not the company has CallScore enabled. | | lead\_scoring\_enabled | Indicates whether or not the company has manual lead scoring enabled. | | swap\_cookie\_duration | Cookie duration length in number of days (30, 60, 90, or 365). Visitors who clear their cookies, return after the cookie expires, or use a different web browser will be treated as new visitors. | | callscribe\_enabled | Indicates whether or not the company has Transcripts and Call Highlights enabled. | | form\_capture | Indicates whether the company has the external form capture feature enabled. | # 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](). ## Aggregation of a single account fails `Unable to get account on source CallRail [source]. Possibly it has been deleted.` This error displays if the user is in a disabled state because they did **not** accept their invitation from CallRail after account creation. Aggregations performed on disabled users cause aggregation to fail. **Resolution**: Ensure the user accepts the CallRail invitation for activation. ## Account update fails with 404 Not Found `[ConnectorError] 404 ERR_BAD_REQUEST, Request failed with status code 404, Not Found, {"error":"not found"}` This error displays if the user is in a disabled state because they did **not** accept their invitation from CallRail after account creation. Account updates performed on disabled users cause updates to fail. **Resolution**: Ensure the user accepts the CallRail invitation for activation.