Import Definition

The Import Definition form applies to the Import Data feature which allows you to import external data into the application. With the Import Definition form you can identify and map the external source data to various transaction names in order to populate the tables that are mapped to those transaction names.

See Also:

Detail Forms

Import Definition Field Descriptions

Find an Import Definition Record

Validate

Schedule Immediately

IMPORT_FILES Service

 

Detail Forms

From the Import Definition form, you can access the forms listed in the table below.

Form Name

Description

Import Source

The Import Source form is used to create Import Names and identify the source data that can be imported via the IMPORT_FILES service. To open this form, click the Import Name quick link.

Creating the Import Source is the first step in the Import Data Feature. Once you identify the Import Source, you associate the source data with the context and Field Names on the Import Definition form.

Destination Records

The Destination Records tab is used to associate source data with Context Names (i.e., Transaction Names) for the purpose of importing external flat file data, converting it into XML files and populating the tables the context names are associated with. For example, the Context Name PERSON is associated with the person table (i.e., Employee form).

Once you identify the Context Name you want to use, you must use the Source Fields tab to identify how the field names will be populated. See Import Context Names for a list of the mandatory fields that must be included in the import based its context.

Record Value Map

The Record Value Map tab applies to Destination Records. It is used to assign a value to a context field name. This means that source data will not be used to populate the field names you indicate. Instead, the IMPORT_FILES service will apply the value to the context field when it creates the new context records.

Source Fields

The Source Fields tab is used to associate source data with specific field names that belong to the tables that are associated with the record names you select.

Each context has a set of destination field names that you can associate the source data with. See Import Context Names for a list of the mandatory fields that must be included in the import based its context.

Field Map

The Field Map applies to Source Fields. The Field Map tab is used to associate source data with more than one field name.

Field Format

The Field Format tab applies to Source Fields. It is used to format source data before it is converted to XML via the IMPORT_FILES service. A source field can have 0 or more formats. The format listed first on the Field Format tab is applied first.

Field Translation

The Field Translation tab applies to Source Fields. It allows you to identify specific values in the source data that can be translated/converted to the value you specify in the Destination Value field. When the data is imported, the identified source values will be converted to the destination values. The destination value will display in the output data.

 

Import Definition Field Descriptions

The fields at the top of the Import Definition form – Import Type, Import Name, and Instance Name – are used to add an import definition, lookup an import definition, and run an import definition.

Import Type

Use this field to lookup an Import Definition record by its type. The available options are:

CSV - The values in the source file are character-separated. Each record is a single line and the individual fields in the record are separated by the same character (typically a comma).

FIXED - A fixed width file. Each field in the file has a fixed start and end position.

XML - File format is XML.

WS – The file format is based on the BCOREXML format.

WSOAGIS – The file format is based on OAGIS standards. These imports are used to import data from an external system like Solumina into Shop Floor Time.

Import Name

The Import Name field is used to add, lookup, and maintain the Import Definition records.

When you select an Import Type, the Import Name field displays a list of the Import Definition records with the specified type.

If you click the quick link button next to the Import Name field, you can Add, Lookup, or Maintain your Import Definition records using the Import Source pop-up form.

Instance Name

Use this field to select which instance of the IMPORT_FILES service will run when you click the Schedule Immediately button.

 

Find an Import Definition Record

  1. Click Main Menu > Configuration > Interfaces > Import Definition.

  2. If you know the name of the Import Definition record, click the quick link button next to the Import Name field and select Lookup from the pop-up menu. Select the record on the Import Source pop-up form and click OK.

  3. If you do not know the name of the Import Definition record, select the Import Type of record you want to view. Then select the Import Name.

    Once you have selected your Import Type and Import Name, the Import Definition record will display in the Destination Records, Source Fields, and other tab forms.

 

Validate

The Validate button at the top of the Import Definition form allows you to verify that the Import Definition configuration is correct. The system will check that the mandatory mapped fields are included (these fields are defined in the Source Fields and Record Value Map tabs). If a field is missing, an error message will display.

 

Schedule Immediately

When you click the Schedule Immediately button, the IMPORT_FILES service (if enabled) will run immediately using the Instance Name you select at the top of the form. The service will run for the Import Name you have selected in the Import Name field. The service will import data according to the records configured on the Import Definition form. The start of the data will be imported according to the record that is listed in the first row on the Source Fields form.

If the Import Type is FIXED:

The service will import the data located at the beginning of the source file and continue until the character field has been filled according to the Fixed Length field. If a second record exists on the Import Definition form, the service will import data starting with the next available character and continue until the character field has been filled according to the Fixed Length field in the second record. The service will continue with this sequence for all the records using the same Import Name.

Note: If you have configured lines to be skipped, the data located in those lines will not apply.

If the Import Type is CSV:

The service will import the data that is listed before the first character separator for the first Import Definition  record. If a second Import Definition records exist, the service will import the data located between the first and second separator. The service will continue with this sequence for all the records using the same Import Name.

Note: If you have configured lines to be skipped, the data located in those lines will not apply.

You can view the status of the service on the Service Monitor form.

 

IMPORT_FILES Service

The IMPORT_FILES service imports source data, converts it to XML, and populates the tables associated with the selected context names. The raw XML records can be viewed on the In XML Queue Detail form. The service populates the tables that apply to the Context Names you defined. For example, when source data is mapped to the PERSON context, the service imports the data and populates the person table. The Service Parameters for the IMPORT_FILES service can be viewed/modified on the Service Parameters tab on the Service Instance form.

Once enabled, you can run the IMPORT_FILES service in any of the following ways:

  1. Run the service immediately by pressing the Schedule Immediately button on the Import Definition form. The service will run for the selected Instance Name and Import Name. The service can only run for one Import Name via the Schedule Immediately button.

  2. Run the service immediately via the Service Monitor form. The service will run for all the enabled Import Names you have selected to run in the Service Parameters for the IMPORT_FILES service.

  3. Schedule the service to run on a regular basis via the Service Schedule form. The service will run for all the enabled Import Names you have selected to run in the Service Parameters for the IMPORT_FILES service.