# SailPoint Jack Henry Connector Documentation > Jack Henry Connector Documentation # Documentation # Connecting SailPoint and Jack Henry To connect SailPoint with Episys, perform the following tasks: ## Adding the Source in SailPoint To connect to SailPoint, perform the following steps. Once the connection is made, you can configure it to meet your company's needs. > [!IMPORTANT] > > By default, the provisioning feature is **disabled**, and the connector only supports read-only operations. To support provisioning operations, you must manually enable the feature in the source configuration. **To configure a new source:** 1. Sign in to SailPoint. 2. Go to **Admin \> Connections \> Sources**. 3. Select **Create New**. 4. Search for the connector by entering the name in the search box, and then select **Configure**. 5. In the **Source Name** field, enter a unique and descriptive name for your source. Source names cannot exceed 128 characters. 6. In the **Description** field, provide additional details about the source to help distinguish it from similar sources. This field allows a maximum of 2,000 characters. 7. In the **Source Owner** field, begin typing the name of an owner. Matches appear after you type two or more letters. For more information, refer to [Assigning a Source Owner](). 8. Under **Connection Type**, select **Direct Connection** or **Flat File**. - **Direct Connection** - A direct connection fetches data from the **Virtual Appliance Cluster** you choose as the application connector for the source. A direct connection configuration allows for real-time updates. For more information about configuring and deploying virtual appliances, refer to the [Virtual Appliance Reference Guide](). - **Flat File** - Select the flat file if no connector is available, or if another system restricts the connection. This option allows only reading and aggregating data as a generic/delimited application. Provisioning activity is unsupported, and additional configuration pages like connection settings and aggregation settings are unavailable. 9. If you selected **Direct Connection**, in **Virtual Appliance Cluster**, select the virtual appliance cluster that will be used as the application connector for the source. 10. (Optional) Select a governance group to grant its members [source]() or [role]() sub-admin level oversight of the source and its access. For more information, refer to [Creating and Managing Governance Groups](). 11. If this source represents a primary system containing your organization's personnel records, select the **Authoritative Source** checkbox. For more information, refer to [Creating Identity Profiles](). 12. Select **Continue**. The source is created, and you are navigated to the **Source Setup \> Base Configuration** page. Continue to configure your connected source there. ## Authentication Settings Perform the following steps to configure the required fields and authenticate the source: > [!NOTE] > > **Screenshot** > > [![Authentication Settings]()]() 1. In the **Connection Timeout** field, choose an entry (in minutes) for the timeout of the connection. By default, it is one minute. 2. (Optional) If you are using Symitar version 2024 or later, select **Use Symitar Version 2024**. This feature enables the connector to support the API URL format supported by version 2024 and later. > **Note** > > When you enable this feature, the connector doesn't support Symitar versions prior to version 2024. 3. In the **API URL** field, enter the API URL of the SymXchange instance that contains the web services SymXchange version. Ensure that the SymXchange port mentioned in the URL is opened in the firewall. 4. In the **Password** field, enter the administrator password required to authenticate the SymXchange instance. 5. In the **Device Type** field, enter the device type assigned to the SymXchange instance. 6. In the **Device Number** field, enter the device number assigned to the SymXchange instance. 7. In the **File Name** field, enter the file name of the powerON script that returns user data. Ensure that the powerON script has been imported on the SymXchange server. 8. Select **Save**. ## Aggregation Settings For more information about aggregation, refer to [Loading Account Data](). > [!NOTE] > > **Screenshot** > > [![Aggregation Settings]()]() Perform the following steps to set up aggregation filters: 1. To aggregate inactive user records along with active users, toggle **Include Inactive Users** accordingly. 2. To aggregate frozen user records along with active users, toggle **Include Frozen Users** accordingly. 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. # Configure a Custom SOAP Header The connector uses a default SOAP header for normal operations. However, if your system requires a custom SOAP configuration, you can configure one using the `customSoapActionHeader` parameter. To configure a custom SOAP header, add the following to the source configuration using SailPoint's 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. ```json "customSoapActionHeader": { "testConnection" : "", "accountAggregation": "", "getObject" : "", "updateUserID": "" } ``` # Integrating SailPoint with Jack Henry Jack Henry has multiple products and SailPoint integrates with Episys. SailPoint uses SymXchange to access the Episys database. SymXchange is a web service interface that provides first- and third-party applications access to the Episys database. Connecting SailPoint to your Jack Henry allows the connector to handle the following entities from Episys: - Users - PrivilegeGroup > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features The Jack Henry connector supports the following features: ### Account Management - Aggregation - Filter accounts based on status (Inactive and Frozen) - Add and remove entitlement (Privilege Group) - Enable or disable user accounts - Update of the following attributes: | Attribute | Values | | --- | --- | | User\_Name | | | User\_ActiveMode | The integer values for user types are as follows: 0 - Active, 1 - Inactive, 2 - Frozen | | User\_Email | | | User\_Title | | | User\_Type | The integer values for user types are as follows: 0 - Employee, 1 - Member | ### Entitlement Management - Aggregation ## Prerequisites - Configure at least one virtual appliance cluster and successfully test the connection. For more information, refer to the [Virtual Appliance Reference Guide](). - Jack Henry communicates with the Episys database through SymXchange, hence SymXchange instance must be configured on the Episys host. - Required ports for the SymXchange web services communication must be opened at the firewall. - To fetch users, the connector invokes a powerON script deployed on the Episys Quest Console. The default script returns all users on the Episys database in JSON format. Download the powerON script from the [SailPoint Developer Community]() and install it on the Episys Quest Console. Refer to Episys documentation for information on installing a powerON script. The following is an example of the script response: ```json { "users":[ { "Number":"0000", "ActiveMode":"0", "Name":"DEFAULT TELLER", "JobTitle":"", "Type":"0", "Email":"", "Location":"", "RecordChangeDate":"04/24/10", "PrivilegeGroup":[0,0,0,0........,0] }, { "Number":"0001", "ActiveMode":"0", "Name":"VAULT", "JobTitle":"TEST_ADMIIN_DEMO", "Type":"0", "Email":"Test_email_update_demo@sp.com", "Location":"PUNE", "RecordChangeDate":"04/24/10", "PrivilegeGroup":[0,0,0,0........,0] } ] } ``` ### Supported Objects - Users - Privilege Group ## Required Permissions The connector supports authentication using an administrative password (AdministrativeCredentials). The administrative password is set in the SymXchange Client Parameters. ### Jack Henry Symitar 2019 The administrator must have read/write permission on the following web services for Jack Henry Symitar 2019: - `https://********/SymXchange/2019.01/episysinformation?wsdl` - `https://********/SymXchange/2019.01/poweron?wsdl` - `https://********/SymXchange/2019.01/user?wsdl` ### Jack Henry Symitar 2024 The administrator must have read/write permission on the following web services for Jack Henry Symitar 2024: - `https://********/SymXchange/information?wsdl` - `https://********/SymXchange/poweron?wsdl` - `https://********/SymXchange/user?wsdl` # 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 Jack Henry connector uses the following default correlation and object configurations. The application schema is used to configure the objects returned from a connector. This connector supports the following object types: - **Account**: Account objects are used when building identity link objects. - **Group**: The group schema is used when building AccountGroup objects that hold entitlements shared across identities. ## 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. ### 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 | | --- | --- | | User\_Number | Account | | Id | Group | ### Default Account Attributes The Jack Henry 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 | | --- | --- | | User\_Number | User number. This is the Account ID and must not be modified. | | User\_Name | Name of the user. | | User\_ActiveMode | User status (Active, Inactive, Frozen). | | User\_Email | Email address of the user. | | User\_JobTitle | Job title of the user. | | User\_Type | Options for the user type in the corporate interface. | | User\_PrivilegeGroup | Defines if the user is a member of one or more of the 999 corresponding privilege groups. | ## 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 Jack Henry 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 | PrivilegeGroup ID. This is the Account ID for group objects and must not be modified. | | Name | PrivilegeGroup name. | ## Additional Schema Attributes - Existing PowerOn scripts on Jack Henry which are used to fetch users must not be modified. Doing so requires connector change to parse the response. - Schema Attribute names are prefixed by `User_` in the returned response. - Add a new schema attribute to pull attribute from returned response. For example, to fetch **Location** from the following response, add `User_Location` in the schema attribute: ```json {"users":[ {"Number":"0001", "ActiveMode":"0", "Name":"VAULT", "JobTitle":"TEST_ADMIIN_DEMO", "Type":"0", "Email":"Test_email_update_demo@sp.com", "Location":"PUNE", "RecordChangeDate":"04/24/10", "PrivilegeGroup":[ 1,0,1,1,0,0,1,0,0,0,0,0,0,1,1,1,1,1,1,1,....,0] } ] } ``` - Update of additional schema attribute is not supported. - Additional schema attribute for Groups is not supported. # 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]() ## Account Aggregation Error The following error is returned by the Symitar server when the output lines after script execution exceeds the set the `Maximum Specfile lines` attribute in the client parameters. The max `Maximum Specfile lines` can be set to 10,000. ```text More specfile lines were output than could be returned in the response ``` **Resolution:** 1. Check on your Symitar system to see if the `Maximum Specfile lines` lines are set to the maximum value. 2. Even after setting the max value for the above attribute Symitar may return above error. In this case, powerOn script deployed on the system must be split to return smaller chunk of users. Refer to the following section. **How to split powerOn script to return smaller chunk of users** Splitting of the powerOn script depends on the number of users present on the system and the privilege group assigned to each user. This process assumes that the script deployed on the system is `Sailpoint_Fetch_User_PowerOn_Script`, and it is returning all the users present on the system i.e. 0-9499. 1. Create three more scripts with the same name preceded by the number in sequence and copy the content of the script `Sailpoint_Fetch_User_PowerOn_Script` in each of the following script: - Sailpoint\_Fetch\_User\_PowerOn\_Script\_2 - Sailpoint\_Fetch\_User\_PowerOn\_Script\_3 - Sailpoint\_Fetch\_User\_PowerOn\_Script\_4 2. Edit each script by modifying line number 90 to return a smaller unique chunk of users as follows: - Sailpoint\_Fetch\_User\_PowerOn\_Script - FOR I = 0 TO 2500 - Sailpoint\_Fetch\_User\_PowerOn\_Script\_2 - FOR I = 2501 TO 5000 - Sailpoint\_Fetch\_User\_PowerOn\_Script\_3 - FOR I = 5001 TO 7500 - Sailpoint\_Fetch\_User\_PowerOn\_Script\_4 - FOR I = 7501 TO 9499 Deploy each script on Symitar, and aggregation must correctly work. ## Symitar Service Is Not Exposed Directly Due to some organizational requirements, the Symitar service needs to be hidden. If you use an intermediate custom proxy service between SailPoint and the Symitar service to hide it, configure a custom SOAPAction header. **Resolution:** Configure the `custom_soap_action_header` in the connector attributes if you need a different SOAPAction header for all operations in Jack Henry. For example: - XML ```text ``` - JSON ```json { "op": "update", "path": "/connectorAttributes/custom_soap_action_header", "value": "http://www.symxchange.generated.symitar.com/poweron/executePowerOn" } ``` ## Namespace Error You receive an error message similar to the following: ```text Namespace prefix has not been declared ``` **Resolution:** Ignore namespace checking. To ignore namespace checking, update the `ignoreNamespacesPrefix` parameter as follows using SailPoint REST APIs: ```json { "op": "update", "path": "/connectorAttributes/ignoreNamespacesPrefix", "value": "true" } ``` > [!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. # 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" } ] ```