Usage > Interfaces > Templates 

This screen concerns the management of the interfaces between Warehousing and L3. It defines a model describing in detail those fields to be transmitted to L3 when files are used.

Several models of a similar nature can be described and called depending on the site/depositor and/or the temporary use of a model instead of another.

Each interface has its own template, designed based on our experience with level 3 exchanges. This template is the one defined; however, it can be modified by adding or deleting data.

Prerequisite

SEEREFERTTO Refer to documentation Implementation

Screen management

The definition of templates is performed on two tabs.

It is strongly recommended to copy the templates so as to keep track of the standard templates.

Header

Presentation

Name of the template to be defined. Use a simple coding system based on the structure, for example: Site + Name of the interface.

Close

 

Fields

The following fields are present on this tab :

 Table code on 20 characters, numeric or alphanumeric according to the table type. In this latter case, the format is not controlled on the entry. Also, all non numeric characters are not taken into account. In addition, only the decimal point (".") serves as a separator : the comma is not taken into account.

  • Description (field ITIDESAXX)

 

  • Active (field ENAFLG)

Select or clear this check box to respectively enable or disable the Sort code.

  • If the check box is selected: you can apply the Sort code to a wave or preparation area.
  • If the check box is cleared: you cannot use the Sort code. If you try to use it, you will receive an error message explaining that the code cannot be used.

Close

 

Tab General

Presentation

Interface

Code of the interface linked to the template: these codes correspond to standard Warehousing GX interfaces, being:
ITM: Product interface
EIN: Expected input Interface
XEIN: Receipt report
INP: Direct Input Interface
XINP: Put-away report
DLO: Delivery Order (DO) Interface
XDLO: Picking report
XCRR: Carriage report
XSHP: Shipment report
XEND: DO end
EDH: Carrier EDI Interface
BOM: Assembly Order Interface
XBOM: Assembling report
XAJM: Assembling report
XISO: Stock image
XINV: Logistical preinvoice (GEOPLO module)
INISKO: Stock initialization
INISLO: Location assignments

Structure

Specify the type of file to be sent, using ranges or a fixed length.   If ranges are used, the "field separator" splits fields when moving from one to the other. This "field delimiter" is used on alphanumerical fields to specify the start and end of these fields.
Whether the field has a "fixed length" or is "delimited" by ranges, you need to enter the record separator in order to easily identify movements from a header to a line for instance.

Transcoding information is used to specify the required type of characters in a list of values, to select one of the four date formats (DDMMYY, DDMMYYYY, YYMMDD, YYYYMMDD), the required local menu type and a decimal separator for numerical fields.
The Blank field symbol is used to define characters for: using default transaction values in creation mode; keeping the information modified in the warehouse in modification mode.

Tables of the Identifier block are displayed depending on the interface chosen for the template.
A free code must be set up so it can be used later on during the definition of fields, making it possible to identify the fields of the various tables.

ITM: Product interface (ITM / ITMCTR / ATEXTRA)
EIN: Interface Expected Input (EINPUTH / EINPUTL)
XEIN: Input report (EINPUTH / RECEIPTH / RECEIPTL / EINPUTL)
INP: Direct input interface (INPUTH / INPUTL)
XINP: Put-away report (INPUTH / INPUTL / SERIALNBR)
DLO: Delivery Order Interface (DLVORDERH / DLVORDERL)
XDLO: Picking report (DLVORDERH / DLVORDERL / PARCEL / UNITSHIP)
XSHP: Shipment report (CARNOTE / QUAYMGT / TRANSNOTE / DLVORDERH / DLVORDERL / DELIVERY / UNITSHIP / PARCEL / OUTPUTM / SERIALNBR)
XCRR: Transportation report (CARNOTE / QUAYMGT / TRANSNOTE / DELIVERY / PARCEL / UNITSHIP)
XEND: DO end (DLVORDERH / DLVORDERL)
EDH: Carrier EDI interface (EDIHIS)
BOM: Assembly order interface (BOMORDERH / BOMORDERL)
XBOM: Assembly report (BOMORDERH / BOMORDERL / BOMMVT)
XAJM: Adjustment report (ADJUSTM / SERIALNBR)
XINV: Logistical preinvoice - GEOPLO module (INVOICEH / INVOICEL)
XISO: Stock image (INTSKO)
INISKO: Stock initialization (ADJUSTM / SERIALNBR)
INISLO: Location assignments (SLOT)

Note on the "XML" option for the file type:
This option is used to manage an interface in XML format. The tag names used are defined for each flag table ('Level' column) and at the level of each field (last column called 'Tag').

Example of XML file for the EIN interface (expected inputs): Let us consider the following level definition
Table EINPUTH = Lev. "H", Table EINPUTL = Lev. "L" and tags on fields (ACTION = ACTION, SITE  = FCY)
The file would be:
<E>                                          (1st EA)
    <ACTION>1</ACTION>
    <FCY>EBO</FCY>
……
    <L>                                      (1st EA line)
          <ACTION>1</ACTION>
          <LINREF>0001<\LINREF>
……
    </L>
    <L>                                      (2nd EA line)
           <ACTION>1</ACTION>
          <LINREF>0002<\LINREF>
……
    </L>
<\E>                                        (End 1st EA)
<E>                                         (2nd EA)
……
<\E>

Close

 

Fields

The following fields are present on this tab :

Interface

Code of the interface on which the template is based.

Structure

  • File type (field TYPFIL)

It defines the structure used to manage the data in the file to be imported or exported. For further information, refer to the corresponding paragraph.

  • Field separator (field SEPFLD)

It defines the separator between two fields.

To enter a non-printable character, it is necessary to enter a '\' (back slash) followed by 3 numbers representing the ascii code of the character in decimal base.

  • Record separator (field SEPREC)

It defines the separator between two records (data groups).

To enter a non-printable character, it is necessary to enter a '\' (back slash) followed by 3 numbers representing the ascii code of the character in decimal base.

The following is often used :

  • the line feed character (\010), which corresponds to the end of the line in text files in Unix
  • the combination of the two characters carriage return, line feed (\013\010)n which corresponds to the end of the line in Windows text files.
  • Field delimiter (field FLDLIM)

It defines the separator between two fields.

To enter a non-printable character, it is necessary to enter a '\' (back slash) followed by 3 numbers representing the ascii code of the character in decimal base.

  • File format (field CODDBA)

It defines the structure used to manage the data in the file to be imported or exported. For further information, refer to the corresponding paragraph.

Transcoding

  • Character set (field OPTCHA)

When the ascii character set is being used, it is possible to use various standardized formats :

  • The ISO 8859 code (which is also Adonix internal set when using the ascii format)
  • The IBM PC code
  • The ASCII 7 bits code (without accents : The accentuated letters are converted into the corresponding minuscule.)
  • Date format (field OPTDAT)

It defines how the date type fields are coded (order and number of characters for the year). 

Only the order of characters and the number of characters in the year can be specified. Upon import, any separation characters between fields are filtered; in this way, the dates in the form 29-05-59 or 09/04/1991 are correctly decoded.

The decoding sub-program takes into account the engine adxdcs variable, documented via the DCS setup that is found in the general parameters in order to define the manner in which a year is decoded over two characters. DCS represents the "pivot" year that defines the century change.

For instance, if DCS is set to 1940, any year made up of two numbers less than or equal to 40 will be considered to be part of the 21st century and any year greater than 40 will be considered to be part of the 20th century. It will therefore be possible to express the years between 1940 and 2039 with two numbers.

The AAAA-MM-JJ format is kept only for XML exports.

  • field LIBDAT

 

  • Local menu format (field OPTMNL)

The fields of type "local menu" are stored under the form of a number representing their rank in the table.

According to the value of this field the template will export (or expect to find in import).

  • 0 : 0 : in this case, the choice is in the form of a number that indicates the rank of the menu in the table : 1 for the first choice, 2 for the second etc. This also corresponds to the internal format under which the local menu is stored in the database.
  • 1 : 1 : the choice is entered using the code (on one character) associated with each choice of local menu. This code is not visible in local menu management. It can be defined in the development functions in message management : there is the possibility to enter this internal code (which is only used for that purpose, unlike for earlier character versions, when it was used as an entry accelerator).
  • n : (n>1) the first n characters of the label displayed in entry. When using this option, the search algorithm searches for the first character, then the second and so on, until a single corresponding title exists. Thus if a search is carried out to find CHQ in a local menu where the titles are Cash, Transfer, Check, Draft, Bank/credit card, the algorithm will find Check (the only title whose first two letters correspond).

Taking into account the fact that the local menu titles are only the labels used in display, the value stored in the database being the rank in the table, it is entirely possible to change the title of the local menus at the time of an import, in order for the search algorithm to operate correctly. However be aware that the fact of changing the local menu titles can only be made in single user mode, also it is not designed for regular or automatic transfers.

  • field LIBMNL

 

  • Decimal separator (field SEPDEC)

It defines the decimal separator used for numbers. If this field is empty, the system will consider that the decimal separator is '.' (full stop).

  • Empty field symbol (field FLDSYM)

When integrating an interface upon modification, the fields containing this symbol will not be updated.

  • CR+LF symbol (field RTNSYM)

 

Grid Identifiers

  • Level (field FLGLEV)

It defines the group's overlapping level. Level 1 is the main level, a N+1 level defines a sub-level of the preceding N level.

 

  • Code (field FLGREC)

This indicator grid defines the structure of the record groups. Refer to the corresponding paragraph.

  • Length (field RECLEN)

In the case of a file with fixed length, it is necessary to indicate the number of characters for each record.

Close

 

Tab Fields

Presentation

Depending on the interface template chosen to define the template, as you browse down the table, lines are incremented in relation to the interface table.

The set up code is used to insert lines of the defined tables.
Each template definition and each table change within the template must begin with the two following lines:
the "$" action code in the "fields" zone with the value Create/Modify/Delete/Read (values 1, 2, 3 or 4),
the separation code "/" indicating the start of the recording and used to link this recording to an interface table. For example: 'H' (header), 'L' (line linked to a header), 'P' for associated parcels.

The next lines are free, however, it will useful to continue with the "site" and "depositor" lines.

The "position", "length" and "format" fields are calculated by the system upon creation, provided the template has been defined as a "fixed length" file. The length can be restricted or extended with no specific limit (caution: data can be truncated in the process). The minimum length of a line cannot be lower than the position of the last character of the last field.

The template structure can be modified: adding or deleting a field within the same table of the template is quite possible. The positions of the framework should simply be recalculated via right click on the mouse ("Position adjustment", to by performed systematically in case of template modification).

When modifying a header, lines do not need to be impacted.

It is not necessary to include all the tables of the interface in the template.

Close

 

Fields

The following fields are present on this tab :

Grid

  • No. (field NUMLIG)

 

  • Code (field TYP)

This field is only entered if the group indicator grid in the previous tab is not empty. It is used to attach the information to be exported or imported to a group of data.

 

  • Field (field FLD)

Code of the field selected in the table used in this template.

  • Description (field COM)

 

  • Position (field LOC)

The storage location can be entered manually, or be automatically assigned, depending on the type of location associated with

the product and based on the stock transaction setup.

  • Length (field LNG)

This field determines the length of the field for a sequential file.

  • Format (field FMT)

This column is only entered if the format is fixed length. For numeric amounts, the format entered is defined in the form of nnn or nnn.mmm, remembering that these numbers can be prefixed by < or > (left or right framing being completed with zeros, the right alignment must be used by default), prefixed or suffixed by the character + (mandatory sign before/after the number), and prefixed by the character * (the decimal separator must not appear). The grid below displays examples of the formatting for a given amount (the spaces are replaced here by #).

Format

Amount

Result of the formatting

7.2

123.456

####123.45

7.2

-123.456

### -123.45

>7.2

123.456

0000123.45

>7.2

-123.456

-000123.45

<7.2

123.456

123.45####

<7.2

-123.456

- 123.45###

6.2+

123.456

###123.45+

>6 .2+

123.456

000123.45+

<6.2+

-123.456

123.45-###

For an alphanumeric format, the only formatting directives that are possible are < or > (left or right alignment, remembering that the character strings are completed with spaces).

  • Tag (field BAL)

This field is used when imports/exports are carried out under the XML format.

Indeed, when a XML file is created, some more information are required, especially in order to create a XSD file describing the structure of the XML file and then, to control its validity with syntax check tools integrated to the different ETL software.

This field defines the code of the tag describing the field exported in the template, as it appears in the XML file.

Close

 

Action icon

Adjustment of positions

 

Close

 

Menu Bar

Used to copy templates from the same folder of from different folders.

Error messages

In addition to the generic error messages, the following messages can appear during the entry :

Template XX: Record does not exist
The entered template is not defined in the table of templates.

File name: mandatory field.
The file name has not been entered.

Inconsistent length and position
For a fixed length file, the field positions cannot overlap.

Value out of range
The maximum length of a record is 3,000 characters.

Non-existent field
The template field must be a table field

Tables used

SEEREFERTTO Refer to documentation Implementation