CData Connector Setup
CData Connector Setup
The CData connector allows you to integrate CData into your data flow by pushing or pulling data from CData. Follow the steps below to connect CData Arc to CData.
Installing the CData Driver
You must install the ADO.NET provider (Windows edition) or JDBC driver (Java edition) for the appropriate data source before connecting to the data source.
Follow these steps to download and run the CData installer for an ADO.NET provider:
Find the the desired data source in the list of CData data sources. Click the tile for a data source to bring up the page for that data source.
Find the top toolbar that lists the available driver types and click the ADO.NET tile.
Click Download on the resulting page.
Download the trial (30 days of full functionality) or the full provider (requires a purchased license). Contact the Arc licensing team at firstname.lastname@example.org to arrange for provider licensing.
Run the downloaded installer.
Restart the Arc server to allow the CData Connector to detect the new provider.
For the CData Connector to recognize a JDBC driver, you must install it and place it in the
lib folder of the Java server hosting Arc.
Find the desired data source in the list of CData data sources. Click the tile for a data source to bring up the page for that data source.
Find the top toolbar that lists the available driver types and click the JDBC tile.
Click Download on the resulting page.
Download the trial (30 days of full functionality) or the full driver (requires a purchased license). Contact the Arc licensing team at email@example.com to arrange for driver licensing.
Extract and run the
setup.jarfile from the downloaded archive.
Navigate to the driver installation directory and find the driver
.lic(license) file inside the
Copy the driver
.licfiles into the
/lib/folder of the Java server hosting Arc.
Restart the Arc server to allow the CData Connector to detect the new driver.
Establish a Connection
To allow CData Arc to use data from CData, you must enter the connection credentials into each instance of the CData connector. Connections to CData can not be re-used across multiple CData connectors.
Follow these steps to establish a connection:
Drag the CData connector into an Arc flow and give it a name.
In the Connection portion of the Settings tab, select your Data Source from the drop-down menu.
- Authentication steps vary depending on the selected data source:
- If connection fields appear, enter the requested information in each one, then click Test Connection to ensure that Arc can connect to CData. If an error occurs, check all fields and try again.
- If a Connect button appears, click it to sign into the driver using OAuth authentication.
- Click Save Changes.
Note: There are also data source-specific authentication and configuration options on the Advanced tab. They are not all described in this documentation, but you can find detailed information for your data source on the Online Help Files page of the CData website.
Select an Action
After establishing a connection to CData, you must choose the action that the CData connector will perform. The table below outlines each action and where it belongs in an Arc flow.
|Action||Description||Position in Flow|
|Upsert||Inserts or updates CData data. By default, if a record already exists in CData, an update is performed on the existing data in CData using the values provided from the input.||End|
|Lookup||Retrieves values from CData and inserts those values into an already-existing Arc message in the flow.
The Lookup Query determines what value the connector will retrieve from CData. It should be formatted as a SQL query against the CData tables.
|Lookup Stored Procedure||Treats data coming into the connector as input for a stored procedure, then inserts the result into an existing Arc message in the flow.
You can click the Show Sample Data button in the Test Lookup modal to provide sample inputs to the selected Stored Procedure and preview the results.
|Select||Retrieves data from CData and brings it into Arc.
You can use the Filter panel to add filters to the Select. These filters function similarly to WHERE clauses in SQL.
|Execute Stored Procedures||Treats data coming into the connector as input for a stored procedure, then passes the result down the flow.
You can click the Show Sample Data button in the Test Execute Stored Procedure modal to provide sample inputs to the selected Stored Procedure and preview the results.
Settings related to the automatic processing of files by the connector.
- Send Whether files arriving at the connector are automatically sent.
- Retry Interval The number of minutes before a failed send is retried.
- Max Attempts The maximum number of times the connector processes the file. Success is measured based on a successful server acknowledgement. If you set this to 0, the connector retries the file indefinitely.
- Receive Whether the connector should automatically query the data source.
- Receive Interval The interval between automatic query attempts.
- Minutes Past the Hour The minutes offset for an hourly schedule. Only applicable when the interval setting above is set to Hourly. For example, if this value is set to 5, the automation service downloads at 1:05, 2:05, 3:05, etc.
- Time The time of day that the attempt should occur. Only applicable when the interval setting above is set to Daily, Weekly, or Monthly.
- Day The day on which the attempt should occur. Only applicable when the interval setting above is set to Weekly or Monthly.
- Minutes The number of minutes to wait before attempting the download. Only applicable when the interval setting above is set to Minute.
- Cron Expression A five-position string representing a cron expression that determines when the attempt should occur. Only applicable when the interval setting above is set to Advanced.
Settings related to the allocation of resources to the connector.
- Max Workers The maximum number of worker threads consumed from the threadpool to process files on this connector. If set, this overrides the default setting on the Settings > Automation page.
- Max Files The maximum number of files sent by each thread assigned to the connector. If set, this overrides the default setting on the Settings > Automation page.
Many of the settings on the Advanced tab are dynamically loaded from the data source you are working with, so they are not covered in this documentation. You can find detailed information for your data source on the Online Help Files page of the CData website.
The options described below are available for all data sources.
- Save to Sent Folder Check this to copy files processed by the connector to the Sent folder for the connector.
- Sent Folder Scheme Instructs the connector to group messages in the Sent folder according to the selected interval. For example, the Weekly option instructs the connector to create a new subfolder each week and store all messages for the week in that folder. The blank setting tells the connector to save all messages directly in the Sent folder. For connectors that process many messages, using subfolders helps keep messsages organized and improves performance.
Settings for connecting to the proxy.
- Proxy Auth Scheme The authentication type to use to authenticate to the proxy.
- Proxy Auto Detect Whether to use the system proxy settings. This takes precedence over other proxy settings, so to use custom proxy settings, set this to False.
- Proxy Exceptions A semicolon-separated list of destination hostnames or IP addresses that are exempt from connecting through the proxy server.
- Proxy Password The password to authenticate to proxy.
- Proxy Port The port the proxy is running on.
- Proxy Server The hostname or IP address of the proxy through which to route HTTP traffic.
- Proxy SSL Type The SSL type to use when connecting to the proxy.
- Proxy User The username to use when connecting to the proxy.
Advanced settings are common settings for connectors that rely on arbitrary database drivers (for example, Database, CData, and API connectors) in order to make connections to various data sources.
- Auto Truncate When enabled, the connector automatically truncates any string or binary column values that are longer than the allowed limit.
- Command Timeout The command execution timeout duration in seconds.
- Last Inserted Id Query Provide a query to execute to retrieve the auto-increased Id for the last inserted record.
- Log Level The verbosity of logs generated by the connector. When you request support, set this to Debug.
- Local File Scheme A scheme for assigning filenames to messages that are output by the connector. You can use the following macros to reference contextual information:
%ConnectorId%, %Filename%, %FilenameNoExt%, %Ext%, %ShortDate%, %LongDate%, %RegexFilename%, %DateFormat%, %Header%.
For example: %FilenameNoExt%_%ShortDate%%Ext%
- Log Messages When checked, the connector keeps a copy of the message next to the logs for the message in the Logs directory. If you disable this, you might not be able to download a copy of the file from the Input or Output tabs.
- Max Failed Records The maximum number of records that are allowed to fail during insertion to allow processing to continue. The default value of 0 means that any errors cause the input message to be marked as an Error, and any uncommitted transactions are rolled back. A value of -1 means that all errors are ignored and the connector continues attempting to insert subsequent records. A positive value means that the connector continues attempting to insert records until the threshold is reached.
- Output File Format The format in which output data is represented. The default value (XML) causes the connector to output an XML file for every record that is processed, while optionally combining multiple records into a single data structure (depending on the value of Max Records). The CSV and TSV options output data in their respective file formats. This option is not available for complex table structures that include child tables.
- Process Changes Interval Unit Applicable to Select action only. When Use column columnname for processing new or changed records is checked in the Advanced portion of the Select Configuration section of the Settings tab, this controls how to interpret the Process Changes Interval setting (for example, Hours, Days, or Weeks). See Only Process New or Changed Records for details on this and the following two settings.
- Process Changes Interval When Use column columnname for processing new or changed records is checked on the Select Configuration section of the Settings tab, this controls how much historical data Arc attempts to process on the first attempt. For example, keeping the default of 180 (Days) means Arc only attempts to process data that has been created or modified in the last 180 days.
- Reset History Resets the cache stored when Use column columnname for processing new or changed records is checked.
- Batch Input Size The maximum number of queries in a batch if batches are supported by the data source.
- Batch Size The maximum number of batch messages in a batch group.
- Max Records The maximum number of records to include in a single output message. Use -1 to indicate that all output records should be put in a single file, and use 0 to indicate that the connector can decide based on the configured Output File Format. By default, XML outputs one record per file, and flat file formats include all records in one file.
- Transaction Size The maximum number of queries in a transaction.
- Processing Delay The amount of time (in seconds) by which the processing of files placed in the Input folder is delayed. This is a legacy setting. Best practice is to use a File connector to manage local file systems instead of this setting.
- Log Subfolder Scheme Instructs the connector to group files in the
Logsfolder according to the selected interval. For example, the Weekly option instructs the connector to create a new subfolder each week and store all logs for the week in that folder. The blank setting tells the connector to save all logs directly in the
Logsfolder. For connectors that process many transactions, using subfolders can help keep logs organized and improve performance.
Miscellaneous settings are for specific use cases.
- Other Settings Enables you to configure hidden connector settings in a semicolon-separated list (for example,
setting1=value1;setting2=value2). Normal connector use cases and functionality should not require the use of these settings.