Import Profile Action Class Details

The system contains several generic actions classes from which to select. These generic classes can help you build an import tailored to your business needs:

Generic Action Class

Description

Generic Create/Update

Options include:

  • Create new record when a record does not exist.

  • Update existing record when match found using <selection>. Users provide the field from the import to try to match.

Auto-Create Only

No specific options. Displays the following message: New records will always be generated when running the import.

Use this action class imports such as Journal Entry records when the ID for the record being created is not supplied because Eclipse generates the ID and no existing records can be updated through the import.

The system does not update records with this action class, but only creates new ones.

Create (ID-specified)

Options include the Field ID to use as the record ID when created new records for <selection>. This selection allows new record creation, but the ID of the record is included in the import for the selected field.

Update Only

Options include the Field ID to match against when updated records for <selection>. This selection only allows for updating existing records when matching on a specific field.

Journal Entry Action Classes

For Journal Entries, review the following details about how the system handles journal entry imports.

Consider the Journal Entry spreadsheet: if the first two fields listed are Journal Date and Journal Description. These are header level fields needed once for the Journal Entry. They can be gathered one of two ways. Either you can have columns for them in the spreadsheet, as stated, or you can map them to Constant Values in the Field Map and leave them out of the spreadsheet entirely.

Note: If you do include these fields in the spreadsheet, they are only needed on the first row. Once they are specified, all subsequent rows can be left blank because they are ignored by the import.

Action Class Technical Details

The following details display when you click the icon in Import Maintenance. The Import Processing Routine is the Pick BASIC program on the Host system. This program must conform to certain criteria in order to be considered valid by Solar.

The program must:

Consider the following parameter requirements:

Parameter

Description / Detail

FIELD.VALUES

Should contain an @AM array of data from a single row of the import file. The first value mark for each attribute will contain the Field ID (specified on this screen) and the second value mark will contain the associated data from the import file.

ACTIONS

An @AM array containing the text value of the actions selected by the user.

CALL.ID

Will indicate whether this is the first call, last call or intermediate call to this program. Allows the program to write to a temporary file if necessary and know when the last call is being made, meaning all rows of the import file have been evaluated.

PROC.STATUS

Integer indicating the result of the call to the processing routine:

  • 1 -> Record Created

  • 2 -> Record Updated

  • 999 -> Error Generated

  • Other -> Status Unknown!

ERR.MSG

A text-generated error message that will be displayed in a table describing the error on the current row.

TEMPFILE.NM

If a temporary file is being used, this will be the file name for that file. This allows the import program to know how to delete the TEMPFILE to clean up after itself.

TEMPFILE

If a temporary file is being used, this will be the file handle for that file. This allows the import program to save a list of information in case a single record will be created for multiple rows of data from the import.

TMP.ID

The ID of the record in the temporary file.

Possible Error Codes relating to Import Processing Routine: