After you have installed the Adaptive Data Agent Service Manager on your PC, you must configure it. The initial screen of the Service Manager appears:
The Service Internet Connection field shows the status of your Internet connection. If the status is other than a bright green “Healthy,” you may need to click Refresh to re-establish the connection to the specified server. If this doesn’t work, you may need to test your Internet connection or configure the network connection information.
Be sure that port 443 is open. The Adaptive Data Agent Service Manager uses this port for communication. Make sure the *.adaptiveplanning.com domains are whitelisted for your network. See Data Residency Requirements and Domain Whitelisting for more information.
To test your Internet connection in the Adaptive Data Agent Service Manager:
- From the Setup tab on the Adaptive Data Agent Service Manager screen, click Diagnose & Configure Network Options.
The Agent Service Network Settings screen appears, as shown below.
From the Settings tab on the Agent Service Network Settings screen, you can test Internet access for your service user account and your user account. You can optionally enter proxy server information.
Click Update Proxy Settings to save any changes to the proxy server info.
Click the Cluster URLs tab.
The Agent Service Network Settings screen appears, as shown below.
The bottom of the Cluster URLs tab contains the Adaptive Gateway Server URL and Adaptive Gateway Geography fields. These fields are automatically determined when agents are provisioned.
If the Recommended Actions field indicates a gateway geography conflict, the Switch Geography button becomes enabled to the right of the Adaptive Gateway Geography field. Contact Adaptive Insights support before modifying the cluster gateway URLs.
You can enter the URL for an appliance cluster base if you’re running Discovery as an appliance in a custom cluster. You can also set the URLs for Adaptive Insights server information.
- Click Set as Required for this Cluster to save a change to the cluster base URL, click Apply Cluster Settings to save changes to the Adaptive Insights server information, or click Restore Defaults to restore the default values. You can also close the screen to exit without making changes.
When you have completed the network settings, the Service Internet Connection field on the Settings tab should now show as “healthy.” You may need to click Refresh again to use the new information you entered in the Agent Service Network Settings tabs.
After you have established the network connection, you can continue configuring the Adaptive Data Agent Service Manager.
To configure the Adaptive Data Agent Service Manager:
Click the Service Info & Options tab on the Adaptive Data Agent Service Manager screen.
The Service Info & Options tab appears:
Make entries in the fields as follows:
- Remote Access URL (Host Hint): This display-only field shows the URL that uniquely identifies the gateway used by the Adaptive Data Agent Service Manager to connect with the Adaptive Integration server. This is for ID purposes only.
- Data Agent Service Id: This display-only field uniquely identifies the specific agent service. (When the agent service ID is appended to the remote access URL, the resulting URL gives the exact URL for addressing the specific Adaptive Data Agent service.)
- Max Disk Storage per Agent (MB): Enter the disk storage in megabytes to budget for storing the information extracted by each agent. Enter -1 to leave this value unlimited.
- Number of Kettle Job Runners: Enter the number of Kettle job runners allowed on this computer.
- Max Memory per Job Runner (MB): Enter the maximum memory in megabytes per job runner.
- Max Temp Disk Size per Job Runner (MB): Enter the maximum temporary disk size in megabytes per job runner. Enter -1 to leave this value unlimited.
- Trusted Tenants: Enter the tenants who can create new agents on this computer over the Internet without logging on to the computer. You can optionally check the Users from any Tenant can create Agents on this PC (not recommended) option, but this may not let you control access to your data.
- Restrict Job Runner Access to Files: This box is checked by default. It restricts access to the file system to files directly under control of the data agent. Uncheck the box in cases where you want to access files in other locations within the file system.
- Verbose Logging: Check this box to use verbose logging.
- Log all Comms: Check this box to include log entries for all database and network communication from the Adaptive Data Agent Service Manager and the agents.
- Scrub Non-printing characters: Check this box to remove or transform illegal XML characters and unwanted characters from input text streams. You can use a scrubbingRules.txt file to remove additional characters you do not want in the stream. Remove Specified Characters from Input Text Streams in JDBC and Microsoft Dynamics GP
- Click Show Data Agent Service Log to display the log files. This information can be helpful for troubleshooting connection problems.
- Click Apply Data Agent Service Settings to apply any changes to the information on this tab.
Remove Specified Characters from Input Text Streams in JDBC and Microsoft Dynamics GP
When a Data Agent loads data via a JDBC data source or Microsoft Dynamics GP data source the data is written to the local hard disk as XML. This XML text from a data source may contain control characters such as:
- TAB (0x9)
- New Line (0xA)
- Carriage Return (0xD)
- Other non-printing characters
Data Agents copy data into these XML files without encoding. If control characters in the source data are out of the XML character range, errors get thrown.
To remove or transform illegal XML characters and unwanted characters from input text streams from JDBC and Microsoft Dynamics GP data sources:
- Create a text file named
C:\Program Files\Adaptive Data Agent.
- List all specified characters and in the
scrubbingRules.txtfile, with each line containing the old character and the new value separated by "=". Leave the new value empty if you just want to get rid of the character. Each character must be represent by its Unicode value. A line starting with a # is treated as a comment.
scrubbingRules.txt file content:
#Tab, New Line and CR
Open the Adaptive Agent Service Manager.
Go to the Service Info & Options tab and check Scrub Non-printing Characters.
Click Apply Data Agent Service Settings.
If the checkbox "Scrub Non-printing Characters" is selected, all illegal XML characters are removed from the input data, even if they are not listed in scrubbingRules.txt.
Restart the windows service Adaptive Data Agent.
For Scripted Data Sources the setting Scrub Non-printing Characters has no effect. Scripting can be used to remove/transform characters as needed.