INTERFACE CONFIGURATION & SCHEDULER

Use this screen to configure and schedule an integration process. You can use this screen to set up parameter records for specific interfaces to be run at scheduled intervals.  The interface applications use the data entered in this screen to identify the target and source databases and control how the interfaces are executed. 

Use this screen to configure and schedule the following interfaces:

The interfaces shown twice in the list above refer to the direction in which the data is moving.  For example, the first CRM/GovWin Integration in the list refers to data that is flowing from Costpoint to GovWin, the second CRM/GovWin Integration refers to data that is flowing from GovWin to Costpoint.  The direction of the data is dependent on the Interface ID that is selected.

You must install the interface and set up any individual interface configuration screens before you set up the data in this screen.  Use the screen documentation for individual interfaces to determine which additional screens are required.  Data contained in the installation and in the configuration screens automatically displays in this screen once you have selected the Interface ID.  You can schedule the interface process to be executed once you have entered all the required data in this screen.

After you populate the interface, parameter, and object configuration data in the main screen and the Interface Instance Configuration subtask, save the record. Your Company ID, which is assigned to your Costpoint User ID, determines the data to which you and other Costpoint users have access. Costpoint users who are assigned to a different company will not be able to access the saved record.

Interfaces

Use the fields in this group box to enter the Interface ID for the interface for which you want to create a parameter record. Once the Interface ID has been entered, the data in the Source Type, Target, Description, Version, Control Map, and Dispatch Map automatically displays.

Interface ID, Description

Enter, or use to select, the interface ID for this parameter record. The interface IDs that are available for selection are system-defined and depend on the integration systems installed at your site. The following Interface ID and descriptions are currently available:

The Description field directly below the Interface ID field is automatically populated after you have entered the Interface ID.  It cannot be changed.

Source Type

This non-editable field defaults with the interface's source type, either DB (Database) or FILE (Data File). This field is automatically populated after you have entered the interface ID in the Interface ID field.

Use the Interface Instance Configuration and Interface Instance Source/Target Definition subtasks to set up additional connectivity and processing settings.

Target Type

This non-editable field defaults with the interface's target type, either DB (Database) or FILE (Data File). This field is automatically populated after you have entered the interface ID in the Interface ID field.

Use the Interface Instance Configuration and Interface Instance Source/Target Definition subtasks to set up additional connectivity and processing settings.

Version

This field displays the version of the Interface ID that you are processing. This field is automatically populated after you have entered the interface ID in the Interface ID field.

Control Map

This non-editable field defaults with the main integration control map name for the interface being defined. This field is automatically populated after you have entered the interface ID in the Interface ID field.

Dispatch Map

This non-editable field defaults with the main integration dispatch map name for the interface being defined. This field is automatically populated after you have entered the interface ID in the Interface ID field.

Interface Instances

Use the fields in this group box to enter an Instance ID and view the status of the interface.

Instance ID

Enter an Interface instance ID containing up to 30 alphanumeric characters in this field. You cannot change the data in this field once you save the record. The Instance ID characterizes the settings for this interface parameter record. The record that you save will be available only to other users with the same company ID.

Status

This field displays the status of the interface instance after the integration process has been executed via the AI Engine. The field will be blank if the interface instance completed successfully.  If an interface instance fails, an F will display. If the interface process fails, you can clear this field and re-run the process.

Options

Use the fields in this group box to select options for this interface.

Active

Select this check box to enable the interface instance. You must select this check box to process data for the current interface instance ID record.

Audit On

Select this check box to enable audit processing for the current interface instance ID record. If you select this check box, the Audit field will be set to Y (Yes) for all lines in the Instance Objects table window. 

Trace On

Select this check box to enable data tracing for the current interface instance ID record.  If you select this check box, the Trace field will be set to Y (Yes) for all lines in the Instance Objects table window.

If you enable the Audit and Trace capabilities, the system will record detailed information about the integration environment and execution into log files.  The Trace capability adversely affects the application's performance because additional processing is required to capture the necessary detailed information.

Configuration

This button is enabled after you have entered a valid Interface ID and Instance ID. Click this button to open the Instance Configuration subtask.

Instance Objects

Use this table window to view and edit selected fields of the interface object(s) rows that are available to be processed for the current interface ID. Once you enter values in the Interface ID and Instance ID fields, this table window populates with the interface's system-defined object ID rows. You can include or exclude specific objects from the given process and override the default processing settings for each line. You can also override default primary and/or secondary email addresses for each Object ID line (if the line still exists in the Interface Instance Configuration subtask).

Object ID, Description, Sequence

These non-editable fields display the Object ID, Description, and Object Sequence number from the Object Master table.

PARM ID Required

This non-editable field displays the supplemental parameter-required flag from the Object Master table. If this field is Y (Yes), you must populate the PARM ID field.

PARM ID

Enter, or use to select, a valid parameter ID for this Object ID row. This parameter ID must already exist in the Object Supplemental Parameter table (that is, the screen in which the parameter was originally saved). This is a required field if the PARM ID Required field is Y (Yes).

Active

Enter Y (Yes) to enable the Object ID or N (No) to disable it. This field defaults to N for all lines when you first populate the table window.

Record Warnings

Enter Y (Yes) to record warning messages for the selected Object ID, or enter N (No) to disable them. This field defaults to N for all lines when you first populate the table window.  The warnings will be recorded in a warnings report that is sent to the users specified in the Primary Email Address and Secondary Email Address fields.

Allow Additions

Enter Y (Yes) in this field to allow new records to be added to the target system for the selected Object ID when you execute this interface instance. Enter N (No) to prevent new records from being added for this Object ID. This field defaults to Y when you populate this table window for a new record.

Allow Changes

Enter Y (Yes) in this field to allow existing records to be changed in the target system for the selected Object ID when you execute this interface instance. Enter N (No) to prevent existing records from being changed for this Object ID. This field defaults to Y when you populate this table window for a new record.

Primary Email

Enter Y (Yes) to have interface information sent to the Primary Email Address; enter N (No) to prevent interface information from being sent to the Primary Email Address. This field will default to Y if you populate this table window for a new record, as the Primary Send To check box is selected in the Interface Instance Configuration subtask. You can change the value in this field for each Object ID row.

Primary Email Address

Enter the primary email address in this field. This will be a required field if the Primary Email field is Y (Yes). This field will default with the primary email address from the Interface Instance Configuration subtask (if the Send To check box is selected in the Primary group box, and the Primary Email field is Y for the Object ID row). You can change the value in this field for each Object ID row.

Secondary Email

Enter Y (Yes) to send interface information to the Secondary Email Address; enter N (No) to prevent interface information from being sent to the Secondary Email Address. This field will default to Y if you populate this table window for a new record, as the Secondary Send To check box is selected in the Interface Instance Configuration subtask. You can change the value in this field for each Object ID row.

Secondary Email Address

Enter the secondary email address in this field. This will be a required field if the Secondary Email field is Y (Yes). This field will default with the secondary email address from the Interface Instance Configuration subtask (if the Send To check box is selected in the Secondary group box and the Secondary Email field is Y for the Object ID row). You can change the value in this field for each Object ID row.

Email settings and addresses default from the Interface Instance Configuration settings and can be overridden for individual objects as needed.

Audit

Enter Y (Yes) to enable audit processing for the selected Object ID row; enter N (No) to disable audit processing for the selected Object ID row. This field defaults to N (No) for all lines when you first populate the table window. Selecting the Audit On check box (either in this screen or in the Interface Instance Configuration subtask) will set this field to Y (Yes) for all Object ID rows in this table window. 

Trace

Enter Y (Yes) to enable data tracing for the selected Object ID row; enter N (No) to disable data tracing for the selected Object ID row. This field defaults to N for all lines when you first populate the table window. Selecting the Trace On check box (either in this screen or in the Interface Instance Configuration subtask) will set this field to Y for all Object ID rows in this table window.

Last processed

This non-editable field displays the last date on which this object instance was successfully processed.

Audit and Trace capabilities default from the Interface Instance Configuration settings and can be overridden for individual objects as needed.

Prep Map, EVM Map, OTM Map, FTM Map

These fields display the underlying functional units (that is, logic, mapping, and so on) that the integration process uses to process the interface instance.