This function makes it possible to define a group of linked tables (either directly or through cascade) by links of type (1,1) or (1,N) to a main table supposed to be on line.

Such a data model can then be used:

  • in a Workflow rule, either because it features the only available context to describe the tables to be scanned (case of a rule of Manual type, where the model is compulsory), or to enrich the triggering context (case of the other types).
  • in an allocation rule, where the model is compulsory. It defines the group of tables containing the fields on which the user allocation rule is based. The data model associated to a Workflow rule and the data model associated to the allocation rule must be absolutely identical.
  • in a ZPL report, in order to describe the data extraction logic to print thumbnails.
  • in a setup model, in order to describe the setup data to extract or to copy.
  • in the description of the data to index by a search engine.

Note that this function is considered as part of the development, even if it is used as support to part of the parameters. Any record created by this function must thus be safeguarded by an activity code.

Prerequisite

SEEREFERTTO Refer to documentation Implementation

Screen management

Header

Block number 1

Model code (field MODELE)

Code identifying the current record.

Description (field ZINTIT)
Active (field ENAFLG)

Select this check box to activate the current record.

Disabled records keep their content and setup but cannot be used by recalling their code:

  • On other records such as documents and settings
  • On mass processes

The authorizations for a given function can prohibit the creation of an active record. In this case, the check box is disabled by default. It can only be modified by an authorized user or through a signature workflow.

Characteristics

Activity code (field CODACT)

An activity code is used to:

  • Make an element optional in the dictionary if the value associated with the activity code is null
  • Identify the specific/custom elements if they are marked with a code starting with X, Y, or Z
  • Size a maximum number of lines when the activity code marks elements from a grid

If the activity code is disabled:

  • The marked element will not be useable
  • The associated code will not be generated nor activated
Module (field MODULE)

Select a module for the setup.

Use this field to specify if the screen has to be created in the folder database. This is the case when the module linked to the screen is active on the folder.

Properties

Setup templates (field FLGAPH)

Specifies that the data template is linked to the setup template.

Workflow (field FLGWRK)

Specifies that the data template is linked to a workflow.

Deliverable definition (field FLGADLV)
Node (API) (field FLGNODE)

Entry screen

The definition screen shows the whole tree structure of the tables to run through, these tables all being directly or indirectly linked to the main table. The grid lines define the successive joins to be performed in order to have available the whole context on line.

It must be noted that conditions can be added to filter the linked lines. It is important to note that these conditions are not taken into account for indexation. the conditions linked to the data to index must be defined in the corresponding tab.

Block number 1

Main table (field TABREF)

It identifies the main table from which other tables are read via direct links or through cascade. This table is supposed to be on line if the model is used in a Workflow rule of the Manual type. In the case of a Manual Workflow, it belongs to the join that is open and run through upon Workflow execution.
Node name (field ANODNAM)
Package name (API) (field APACKNAM)
Ref. Data model (API) (field FLGREFAWM)

Grid

Linked table (field TABLNK)

It identifies the table linked to the table of origin.
Abbrev. (field ABRLNK)

It corresponds to the abbreviation under which the linked table is open.

If this field is not populated, the default abbreviation of the table is used. It is particularly useful to enter an abbreviation if the table appears several times in the grid, since several linked lines in the same table need to be on line simultaneously.
Origin table (field TABORI)

It identifies the main table at the origin of the link described on the current line. It may be the main table, or one of the linked tables on the previous lines.
Abbrev. (field ABRORI)

It corresponds to the abbreviation under which the linked table is open.

If this field is not populated, the default abbreviation of the table is used. It is particularly useful to enter an abbreviation if the table appears several times in the grid, since several linked lines in the same table need to be on line simultaneously.
Key (field CLELNK)

It defines the table key code used to read the linked lines. By default, the first key of the table is used.
Type (field TYPLNK)

This type takes on one of the two following values:

  • 1,1 : it means that for each line in the table of origin, only one line in the linked table is read (this line is defined by the key expression).
  • 1,N: in this case, several lines in the linked tables can be read. They are defined by the key expression, that can be incomplete if it is divided into several parts (those lines whose entered key elements correspond to the given value are run through).
Link expression (field EXPLNK)

This field is defined as one or more calculated expressions separated by a semi colon. Each expression is evaluated, and the result used to identify the value of the key used to perform the join. When multiple joins are authorized, only the first elements of the key can be given.

In the expressions, constants can be used, as well as fields coming from the tables previously defined in the link list.
Selection expression (field EXPSEL)

This selection formula is applied on the table defined in the Linked tablecolumn, and allows to filter that data in the template Caution, these conditions are not applied for the indexation process. The syntax is the script syntax of Sage X3 used in the Filter instructions.
Node name (field ANODLNK)
Property name (API) (field APROPLNK)
Package name (API) (field APACKLNK)
Mutable reference or collection (field AISMUTABLE)

Tab Miscellaneous

This tab is used to define the characteristics specific to the data model, according to the use.

Workflow

Company field (field FLDCPY)

This field defines the current company, from the Workflow rule viewpoint. In this way, when the allocation rule is available by company, the proper rule is used depending on the value of the field.
Site field (field FLDFCY)

This field defines a current site, which enables the current company to be derived from it (if it is not defined in the company field), from the Workflow rule viewpoint. In this way, when the allocation rule is available by company, the proper rule is selected depending on the value of the field.

Setup templates

Legislation field (field FLDLEG)

This field is used to filter the records related to a legislation during the patch creation or the patch integration carried out by the ACOPAPH function (patch templates).

Grid Options

Option title (field AZOPTLIB)
Option code (field OPTCOD)
Option condition (field OPTCND)
Error message (field AZOPTERR)

Specific Buttons

This is used to copy the current record into another folder.

Block number 1

field OBJET
field CLES

Block number 2

From folder (field DOSORG)

Use this field to define the folder from which the record will be copied. The possible syntaxes are described in the Dedicated appendix.
All folders (field TOUDOS)

Use this option to copy the record to all the folders defined in the dictionary (ADOSSIER table of the current solution).
To folder (field DOSDES)

Use this field to define the folder to which the record will be copied. The possible syntaxes are described in the Dedicated appendix.