In this form you describe a version of a standard, that is, the format of an exchange file that will be applied to an interface.
General information
- Version: Identifier of the version. Must be unique for a given standard.
- Name: Name of the version. If necessary, specify the difference from the previous version.
- Active: If this box is not checked, the version cannot apply to the standard.
- Standard: Standard to which the version belongs.
- Separator: Symbol(s) separating the fields within a record.
- Header lines: Number of header lines to be ignored, without counting the automatic header.
- Automatic header: To be checked if the header line containing the interface and external system code is present in the file.
List of records
This list contains the various types of data lines in the file.
A record must correspond to an object in an integration object, from among those of the interface for which the version is intended.
Creation of records
It is strongly advised that records be created using the "Search integration objects" option on the creation menu
.
Next, you simply need to:
- delete secondary records and the fields you do not use,
- change the record prefix and the field order,
- if applicable, add a field to enable updating of the existing elements (e.g. WO::code).
Description of records
- Creating a record: Prefix of the line for identifying its contents.
In some cases, it may be necessary not to use a prefix (see Type "Primary without prefix").
- Name: Comments relating to the contents of the line.
- Type: Indicate whether the data type is "Primary," "Secondary" or "Primary without prefix."
- Object alias: Alias of the object to which the line corresponds.
- Parent record: Principle line on which the current line depends.
- Collection alias: To be specified for collection type objects. Example: wo_processes for the operations of a work order.
- Icon
or
: Opens the conversions and controls form for the record.
Type
A secondary data item depends on a primary data item which must be defined first.
For example, if the file contains work orders and their operations, the work orders lines are primary and the operation lines are secondary.
The case "Primary without prefix" is useful if the exchange flow (import or export) comprises a single record type and there is no need to distinguish these records with a prefix.
An example would be files containing one line per work order, with no associated secondary lines.
This type without prefix should thus be used only if the data exchanged are homogeneous and in a single format.
List of fields
This list contains the fields, or columns, that form a record of the file.
A field must correspond to an attribute in the integration object.
- Sequence: Column number of the field on the line.
- Attribute alias: Alias of the attribute in the integration object.
- Suffix the alias of ::code if it corresponds to an object referenced by its code, or ::id if is referenced by its identifier.
- The alias of a field to be ignored does not matter.
- Name: Describes the contents of the field.
- Value type: To be filled in in the case of a format conversion to allow the application to apply it correctly.
- To be ignored: Check this box if the field does not correspond to any data in CARL Source.
- Fixed length: To be filled in only if the standard describes a fixed position file. This is the size of the field, which determines the position of the next field.
The line prefix has a length of 20 as default. This number can be modified in the dictionary, RECORD object, rowName attribute, "No. of chars" property."
- Order numbers must be assigned from 1 to n without duplicates or breaks in the sequence.
- All aliases must be different in a given record.