Configuration node descriptions
<AtHocDataIntegration>
: This is the root node of the configuration file. All other nodes must be kept inside this node.<systemSettings>
: This is the node where you can specify general settings that are used by the User Sync Client. The <systemSettings> node has following sub nodes:- <tempDataPath>: Specifies the temporary path to store logs and interim files.
- <deleteInterimFiles>: Indicates whether to delete interim files after integration.
- <proxy>: Used to configure proxy settings. The User Sync Client needs to access Web API URLs hosted on the cloud (for cloud deployments) to successfully run the synchronization. If the organization policy requires the use of a proxy server for outbound connections, you can configure those settings here. The <proxy> node has following sub nodes:
- <url>: The URL of the proxy server provided to you by your organization administrator.
- <port>: The port number used for the proxy server provided to you by your organization administrator.
- <username>: The username for the proxy server user account. This username is provided to you by your organization administrator.
- <password isEncrypted=”false”>: The password for the proxy server user account, provided to you by your organization administrator.
- <useMailService>: This node is used to configure an SMTP mail server for sending status emails. The <useMailService> node has following sub nodes:
- <smtpServer>: Mail server address, provided to you by your organization administrator.
- <username>: Username for the mail server used to send an email.
- <password>: Password for the mail server used to send an email.
- <recipient>: Semicolon-separated list of intended email recipients.
- <fromAddress>: Email address used to send email.
- <fromName>: Name that appears as the sender of an email.
<integrations>
: The <integrations> node contains integration sections that consist of configurations for the data adapter, processor, and synchronizer.<integration>
: The <integration> node has following sub nodes:
- <dataAdapter>: The <dataAdapter> node contains data adapter-specific configuration.
- The “assembly” attribute specifies the .NET assembly where the data adapter is located.
- The “class” attribute specifies the full class name of the data adapter.
- The optional “outputFile” attribute specifies the name of the XML file that the data adapter exports data to.
- <dataProcessor>: The <dataProcessor> node contains data processor-specific configuration.
- The “assembly” attribute specifies the .NET assembly where the data processor is located.
- The “class” attribute specifies the full class name of the data processor.
- The optional “inputFile” attribute specifies the file the data processor reads data from.
- The optional “outputFile” attribute specifies the file the data processor exports data to.
- <dataSynchronizer>: The <dataSynchronizer> node contains data synchronizer-specific configuration.
- The “assembly” attribute specifies the .NET assembly where the data synchronizer is located.
- The “class” attribute specifies the full class name of the data synchronizer.
- The optional “inputFile” attribute specifies the file the data synchronizer reads data from.
The “inputFile” and “outputFile” attributes are useful for testing a configuration but are not recommended for production. These attributes can specify a relative or absolute path. If the attributes are not specified, the User Sync Client generates file names based on the timestamp and places the files in the temporary data folder or it uses the filename from the previous step.
Configure multiple integration sections to synchronize data from multiple sources.