Connector Integration Details

The connector Integration page allows you to view and edit the configuration specifications of your company's connectors.

The connector Integration page is a complete self-servicing tool that provides a centralized location for viewing and editing connector specifications using a tabbed interface.

To view the detailed specifications of a connector, choose the Connectors tile on the dashboard, and on Connector List page, choose a connector.

At the top of the page, you can view the Connector Name, Status (On or Off), and the Activity (Upload or Download). You can also select the Edit button to open the connector in the Setup Wizard and change any details, or click the Enable/Disable button to change the status of the connector.

Connector Actions

You can invoke actions on connectors using the command buttons under the Actions tab on the right side of the page. The available actions are visible based on the connector type (upload or download) and status (enabled or disabled).

Connector Actions

Action

Description

Edit Last Run Date

To edit the last run date for a connector download, in the Actions list, choose Edit Last Run Date. The Edit Last Run Date (timezone) dialog box opens. Enter a new value in the Last Run Date field, and then choose Update.

You can also edit the last run date when enabling a connector download or when creating a variant of connector download.

For more information, see Edit Last Run Date

Create Variant

Allows you to create a variant (copy) of an enabled connector. All fields are populated from the original connector and you can make changes as needed in the Setup Wizard.

For more information, see Create Variant.

Define Delta Compare Fields

For connector downloads only, this option displays after you enable or edit a connector download and select the Enable Delta Compare option. (Not all downloads support this feature.)

Allows you to configure the download to pull records only when the values of the selected fields change. Select Define Delta Compare Fields to select the fields.

When Delta Compare fields are defined, the connector's Details page displays the fields in the bottom half of the page.

For more information, see Setup Connector Details.

Truncate Delta History Table

When a download connector has 'Enable Delta Compare' enabled, a Delta History table is created and every time the download runs, it looks at this history table to compare and only pull records for which the selected field values have changed. If needed, you can truncate the Delta History Table so there is no data history to compare and thereby pull all the records.

For example, a download is configured to pull worker records only if there's a change in a particular field. If 10 workers were downloaded in the last run and there's no change in that particular field for any worker, then the next run won't have any records. However, if the Delta History table is truncated, then all records meeting the connector logic will download in the next run. And then subsequent runs will compare with the history table and pull only those that have that field value changed.

Invoking this option displays a confirmation dialog box with the message, 'Truncating the Delta History Table will impact download results'. Select Truncate to invoke the action or Cancel to exit the action.

An entry is made in the Modification Log when any Delta Compare functionality is modified.

Tabbed Views

Connector specifications display on tabs that are visible based on the connector type (upload or download) and status (enabled or disabled).

The following table describes tab names, descriptions, and related actions on the page.

Tab Name

Description

Details

The Details tab is the default view that displays for all connectors. When viewing connector details, the tab displays all configuration information defined for the connector in the setup wizard.

Some of the details include connector name, last run date/time, company code, status, activity (upload or download), custom connector name (if applicable), connector setup details, upload record limit, and pre-processors (the first processor listed is the default).

When the connector is enabled, the View Guide hyperlink allows you to download the Connector Specification document.

Upload Column Transform

The Upload Column Transform tab displays for enabled upload connectors that are configured with upload column transform details. The tab displays the transformed column name, enabled template name (if applicable), standard column name, file column name, default value (if applicable), and whether it will be skipped on subsequent updates after the initial run.

To edit or add upload column transform details, choose Edit at the top of the page. The setup wizard opens. Navigate to the Customize > Upload Column Transform section, and then make the changes. For more information, see Configure Column Transforms for Connector Uploads.

Connectivity

The Connectivity tab allows you to monitor the file transfer methods and integration activity for connectors with SFTP or web services configured.

Subscriptions

Each subscription displays the subscription name and status. To view the processing details for a subscription, select the subscription name. Information displays on the following tabs:
  • The Details tab displays the selected subscription name, end point name, parameters, subscriber, and notification email (if defined), and delivery times.

  • The Modification Log tab displays activity related to when the subscription was created, edited, enabled, and disabled, including when disabled because of a disabled connector or end point. Each log entry includes the activity, activity time, reason, and person responsible for the modification.

If the connector is enabled, the Run Now button allows you to trigger a one-time run to test the subscription (the subscription and end point must be enabled). To run the subscription now, choose Run Now. The Confirmation dialog box opens. Choose Yes to confirm the action. The subscription runs once in the background. If the subscription run is successful, a confirmation message displays. You can view the subscription details in the Integration Audit Trail tab on the Connector Integration page.

The Status column displays the status of the subscription, either active or inactive.

Web Services

For web services, the Partner Details section displays the virtual person name (username), license, and status, either enabled or disabled, for each web service configured.

To edit or add connectivity details, choose Edit on the Details page to open the setup wizard. Navigate to the Connectivity > Transfer Method section, and then make the changes. For more information, see Connectivity Transfer Method Step.

Enabled Fields

The Enabled Fields tab displays for enabled download connectors. The tab displays the column (field) name, module, type (default, new, custom field enabled by ID or custom field enabled by name), and description.

To edit and customize enabled fields, choose Edit on the Details page to open the setup wizard. Navigate to the Customize > Configure Fields section, and then make the changes. You can add/remove native and/or custom fields, combine custom fields, rename individual field names, and apply templates to modify the data in the file. For more information, see Customize Step.

Customizations

The Customizations tab displays for standard download connectors. The tab displays any custom features defined for the connector.

Under the Custom Columns List (for definitions) or Custom Conditions List (for clauses), choose View to display the full definition and clause values.

Under Enabled Feature Details, choose Disable to delete the custom feature details. A confirmation dialog box displays. Choose OK to disable the feature. An entry is made in the modification log. You can always re-enable the custom feature from the Available Custom Features tab.

Available Custom Features

The Available Custom Features tab displays for enabled download connectors. The tab displays all custom features that are available for the company to configure.

To enable a custom feature, select the custom feature on the Details page, and then choose Enable Custom Feature. Confirm the action in the Confirmation dialog box.

To disable a custom feature, select an enabled custom feature on the Details page, and then choose Disable Custom Feature. Confirm the action in the Confirmation dialog box. You can always re-enable the custom feature.

If no custom features are available, the table is empty. For information on how to configure custom features in the setup wizard, see Configure Custom Features for Connector Downloads.

Integration Audit Trail

The Integration Audit Trail tab displays for all enabled and disabled connector types. The tab displays combined details from the subscription, integration, and data transport, as applicable to the connector in view.

You can also navigate to this tab and view real-time activity from Connector List page, by choosing the value hyperlink in the Last Run Date or Run Count column.

Modification Log

The Modification Log tab displays for all enabled and disabled connectors. The tab displays a log of all changes that a CM or Company Admin made to a connector. Each log entry includes the activity date and time, reason for the modification, and person responsible for the modification.