Detailed Field Information Related Information Examples & Tutorials

Import Record Definition

An Import Specification requires at least one record type definition. This tells the import program which record type you are importing. You can specify additional record types as necessary.

Multiple record types are often used when working with Collect! interoffice files, and in some more complex imports from large institutions.

Within each record definition, you specify the fields to be loaded into the record. Each field can have various attributes on importing, and you can set conditionals, default values, multiplication factors and other useful details.

Record

Press F2 to pick from the list of available record types. Typically, you will import only one record type at a time. Most likely, this will be the Debtor record, but you can also import transactions, contacts and notes.

The records will be attached to the correct Debtor, provided that you have included a key identifier (such as the Debtor's name) with the contact, transaction or note record being imported.

warning.gif WARNING: Do not change record types after you have defined fields. This will cause the import to fail if you try to run it.

Top of page.

Note

This is for your use.

Top of page.

Identifier

This is used in conjunction with the Import Field Specification form field, Lines After Identifier.

Use this to trigger importing the current record type. The record will only be imported if this identifier is found in the file you import.

This is usually used in fixed length files. You specify the offset from the left margin, and the size of the identifier. In comma delimited files, the first field is assumed to be the record identifier.

When you specify an identifier, Import will skip any lines that don't have that identifier at that location in the line read from the import data file. When the identifier is found on a line, Import starts loading the fields specified in the import record definition.

Each field can be on the same line as the identifier, or it could be one or more lines below the identifier. This feature lets you import from a wide variety of files, including files that were originally designed as printed reports. Use the Lines After Identifier field on the Import Field Specification form.

If you are importing multiple record types, there should be a record identifier on each line to tell the system which record type the line pertains to. However, in some cases (some note files, for instance) it is not necessary.

In the Collect! Inter Office file format, record types are identified on the first field of each line.

Top of page.

End Of Line ID

This is the identifier used to mark the end of a specific record type started by the Identifier field.

Top of page.

Offset

This indicates that the record Identifier begins on the nth character of the line. This is used only for Fixed Length format files. Note that the first character on the line is offset 0.

Top of page.

EOL Offset

This indicates that the End Of Line identifier begins on the nth character of the line. This is used only for Fixed Length format files. Note that the first character on the line is offset 0.

Top of page.

Length

This indicates the length in characters of the record identifier. It is used only on Fixed Length format files.

Top of page.

Skip Lines Before

This tells the import that the identifier is located n lines above the actual data being imported. This will typically be used when defining formats for reports generated by external accounting programs.

Top of page.

After

This tells Import to skip n lines after the record has been imported before it attempts to import another record. Typically, it is used as above.

Top of page.

Options

Selecting this displays the Import Record Options form where you can set additional key values for fixed length file importing and exporting. Press F1 when the form is displayed for more details.

Top of page.

Fields

The list of Import Field Specifications list contains the fields being imported on this line. Press F5 to display the Import Field Specification form for the currently selected item in the list.

tip.gif To fill a field with a fixed value when you Import, check the Default Value field in the Import Field Specification.

Top of page.

Order Of Field Types

The order of the field types may be important, depending on the type of file you are importing. For instance, a *.csv file has a very particular ordering of fields, whereas a comma-delimited text file can be scanned in any order necessary.

Top of page.

Help

Press this button for help on the Import Record Definition form and links to related topics.

Top of page.

Delete

Select this to delete the record definition that is displayed. You will be prompted to confirm the delete process.

Top of page.

New

Select this to display a blank form where you can enter another record definition for this import.

Top of page.

Cancel

Select this button to ignore any changes you may have made and then return to the previous form.

Top of page.

OK

Selecting this button will save any data you have entered and return you to the previous form.

<<

Selecting this button will take you back to another record.

>>

Selecting this button will take you forward to another record.

Top of page.

See Also

- File Format Specification
- How To Use Import/Export
- Import Menu
- Export Menu
- Import Field Definitions
- Import/Export Topics

Top of page.

Was this page helpful? Do you have any comments on this document? Can we make it better? If so how may we improve this page.

Please click this link to send us your comments: helpinfo@collect.org