Setup Connector Details

In this required step you can configure delimiters (field separators), data formats, date formats, preprocessors, volume thresholds, and success/failure email notifications for connector uploads and downloads.

To set up the connector details, in the Setup fields, configure the field values as described in the following table.

Setup Field Descriptions

Field Name

Description

Delimiter

Delimiter used to separate fields in data transfer. Comma (,) is the default value.

Options are: “,”, “&”, “;”, “\t” “|” “~”

Encoding

Options are ISO-8859-1 and UTF-8. Default value is ISO-8859-1.

Optional for upload connectors only.

Asynchronous?

Asynchronous allows you to send or receive large files later. It's suitable when the upload or download transfer request is complex and takes longer to complete. Valid for uploads and downloads. Options are Yes or No.

Upload Data Format

Specify the format of data in an upload file. Displays for upload connectors only. Options are CSV, XML, or JSON. CSV is the default value. Input is optional.

For CSV upload connectors, XML format isn't applicable, so the option doesn't display. Only CSV and JSON options are applicable, with CSV being the default.

For XML upload connectors, CSV format isn't applicable, so the option doesn't display. Only XML and JSON options are applicable, with XML being default.

For JSON upload connectors, currently there are no preprocessors to convert XML format to JSON format, thus the Upload Data Format field doesn't display.

If the data format is updated, an entry is made in the Modification Log, which you can view on the connector Integration page.

Download Data Format

Specify the format of data in a download file. Valid for CSV download connectors only. Input is optional.

CSV is the default value. Then, depending on the Download Data Format selected, the corresponding post-processor defaults for the connector (CSV to JSON or CSV to XML).

If the data format is updated, an entry is made in the Modification Log, which you can view on the connector Integration page.

Date Format for Date Fields (optional)

Allows you to set the date format at the connector level for all date fields in a connector or connector variant download. The default value is blank.

The date format options are:

mm/dd/yyyy

dd/mm/yyyy

yyyy/mm/dd

yyyymmdd

If the date format isn't changed, then each date field retains the format based on the column definition for that field. If the date format is changed, an entry is made in the Modification Log, which you can view on the connector Integration page.

Enable Delta Compare (optional)

When enabling or editing a connector download, this option allows you to enable and manage the delta compare functionality for supported connector downloads.

Valid options are Yes (enabled) and No (disabled – default value).

If you select Enable Delta Compare Fields, the Define Delta Compare Fields dialog box displays. Initially the delta compare fields option is set to 'All enabled columns Defaulted as Delta Compare fields', meaning all columns will be compared against. You can clear the 'All...' setting and select only the fields that you want to compare against. Then select Update to save the selections or select Cancel to exit the changes.

When enabled, you can configure the download to pull records only when the values of selected fields change.

You define the delta compare fields on the Connector Details page. Click the Actions button to display the Define Delta Compare Fields and Truncate Delta History Table options. For more information, see Connector Integration Details.

Pre-Processors

After selecting an upload data format, the Pre-Processors option allows you to accept data in the format specified in the preprocessor. The options don't display if there are no preprocessors available or if all available preprocessors are added already.

To add a preprocessor, choose +Add Pre-Processor and select an option from the list. For multiple preprocessors, select in the order noted in the setup document from your SAP Fieldglass representative. To remove a pre, choose X next to the entry.

You can view the enabled preprocessors for a connector on the Details tab when viewing the connector details.

Duplicate File Check

When enabling or editing an upload connector, the Duplicate File Check field prevents processing the same file again, which helps prevent performance issues. If the exact file is loaded again, an error displays stating it has already been used.

Displays for upload connectors only. The field is enabled by default. Input is optional.

Set Run Date (GMT) YYYY-MM-DD HH:MM: SS

When enabling a download connector or creating a variant of a download connector, you can set the last run date in the specified format.

This is a mandatory field. The default field value is 6 months before the current date stamp. All records added or modified since the specified dates are processed. If the date specified is greater than a year, a message warns that the download could run into timeout issues because of the volume of records. Future dates aren't supported.

All successful edits to the field create an entry in the modification log.

Email Recipients on Success

Email addresses of recipients to notify on successful file transfers.

Separate multiple addresses by a comma.

Email Recipients on Failure

Email addresses of recipients to notify on failed file transfers.

Separate multiple addresses by a comma.

Email notification preference when no data is downloaded

If a download connector doesn't return any data, this field determines whether email notification is to be sent and to whom. By default, email notification is sent to the recipients included in the Email Recipients on Failure field.

Select one of the following options:
  • Send to recipients included in "Email Recipients On Failure". This is the default value.

  • Send to recipients included in "Email Recipients On Success".

  • Send no email notification.

When this field is changed, an entry is made in the Modification log.

This field and the selected value display on the connector Integrations Detail page.

Max Allow Delete Percentage

Alters the percentage of records that can be deleted from a single bulk-full upload. This is used as a safeguard to prevent unintentional deletions caused by partial files or other errors. 10% is recommended. Input is optional.

The minimum setup required to use the connector is now complete. Proceed as follows:

  • To continue with optional connector setup, choose Next Step.

    • If enabling an upload connector with a version of API, the Header Values setup step opens. To continue, go to Header Values.

    • If enabling a download connector or non-API upload connector, the Security setup step opens. To continue, go to Security.

  • To bypass optional setup, click Next Step until you reach the Finished step. For more information, go to Finished Step.