Refer to documentation Implementation
The table definition is made with the help of three tabs : a general tab, a field definition tab and the index definition tab.
Presentation
Close
Fields
The following fields are present on this tab :
| The table code must be composed of 1 to 10 characters (letters or numbers but must start with a letter). It is the unique identifier for all the table abbreviations of the data dictionary. The Adonix reserved words are prohibited. |
| The abbreviation for a table must be composed of 1 to 3 characters (letters or numbers but it must start with a letter). It is the unique identifier for all the table abbreviations of the data dictionary. The Adonix reserved words are prohibited. |
| Destined notably to figure in the reports and the screens in which the record code can be entered or selected. This text is used to give a clear description to the record concerned. |
Close
Presentation
Located in this tab is the general information relative to the table and its management.
Close
Fields
The following fields are present on this tab :
Characteristics
| The Activity Code and the Module that are used to identify if the table described in the dictionary must be created in the database of the folder. It is if the two conditions set out below are achieved simultaneously :
A table with an assigned activity code starting with X, Y, or Z, is considered to be specific/custom and in no case affected by a version change (these activity codes can be placed at the line level). In addition, there is a dependence between the modules :
|
|   |
Table management
| Base type for which the table must be generated. The "Folder" base type is used to indicate to the program for the management of folders to generate the table in the base type entered in the folder record for all the files of the folder. In certain exceptional cases (in particular if it is an external table) there is the possibility to add another parameter. |
| This check box is to be set if there is a requirement to access a table for a v140 folder from a v130 folder. In this case, the structure of this table must be respect the limits for version 130 (no clob, nor blob...). Note : the inverse is possible without specify in the dictionary (access to a table 130 from a v140 folder). |
| The number of records field is used to define the size of the table in the database. This field is used to size the table being created or modified. This value is entered on the creation of the folder for each table created, from the result of the evaluation of the sizing formula. This formula itself uses variables where the values are entered in the folder parameters. During the revalidation of a folder, the number of records is re-evaluated, but the result of the calculation is only re-written in this field if it is greater than the value found in the table ; thus, it is possible to modify this value, increase the size of the table and this value will be recovered in the case of folder revalidation. If however, it is decreased in size, it will be taken into account immediately if the table is manually validated with the help of the corresponding button, but once a revalidation of the folder is carried out, the calculated value that is greatest, will be used in place of the entered value. This behaviour has been defined for security reasons : for performance reasons and ease of use, it is in fact better to over size a table rather than under size it. It is not necessary to protect the modification of this field with an activity code. |
| This check box is used to define the method used, in Crystal Report, for the translated texts in this table.
It is a parameterization field that does not require an activity code to protect it. Needs to be in coherence with the technique used in the Crystal report linked to the table. For new texts to be translated, it is advised to check this box, to use the view method and thus not overload the sequential files. |
| This check box is used by the return to zero utility for the movements, which is used to re-zero the movements in a folder (which is used to guard the "fixed" data - products, business partners, accounts, BOMs.... -arising from an entry deleting the movements, documents, invoices, stock movements, WO... - linked by example to a test of a real startup). When this box is checked, the re-zero utility erases all the lines in the table. One of these flags is found in each field (when a field must be reset to zero without the table being emptied). |
| This check box is used to restrict the access to the data table within the folder owning the table and certain authorized folders. This notion is identical for the view. A modification of this field requires a revalidation of the table, to be taken into account in the database.
The authorized folders are :
It should be noted that this check box is not updated by patch : the security strategy for the table being considered as parameterization. On the validation of the table, the fact that this check box is checked provokes the creation of a configuration file (extension .cfg) with the following code :
If other manual directives exist in the configuration file, they are of course respected. The directives can be in effect added by update of the Configuration file section in the corresponding tab of the table management). |
Folder management
| This field is used to class the tables according to a typology used by the folder management. It can take the following values:
|
| It determines if the creation of the table implies a transfer of the data between the reference folder and the folder to be created during the creation of the folder. This parameter can take the following values :
|
| The copy option is attached to the copy type in the case of a conditional copy. A distinction is then made for several sub-groups of tables where the data, forming a coherent entity, can be copied from the reference folder during the initialization of the generated folder if the user requires it. |
|
| Internal usage for the industrialization of a version. This parameter can take the following values :
|
Specific columns
| These fields are used to enter the name of the two fields in the table. They are used to identify the fields that have a title present in the table. This information is used to give an automatic display of the title of a record where the key is known (screen management, cancellations, code changes...) |
|   |
|   |
|   |
|   |
|   |
Close
Presentation
This tab is used to define all the fields in the table in a scrolling grid.
In each table, it is possible to use fields whose name is standardized and which will automatically be updated if they exist by object management. The fields are the following :
CREDAT and UPDDAT are respectively the creation and last update dates.
CRETIM and UPDTIM are respectively the creation and last update times.
CREUSR and UPDUSR are the user codes who carried out respectively the record creation and its last update.
EXPNUM is a sequential number used to date the records with respect to the import/export module (that makes it possible to only export that which has been updated since the last export).
A sixth field can also be inserted in each table. This field is called ENAFLG and it corresponds to an active/inactive flag. If the table in question is managed by an object and that a data type is associated with this fields, the following controls will be made of the fields of this type :
the standard selection window for the object called by the selection key will automatically filter inactive records.
an error message will prevent the direct entry by its inactive key code.
This is of course not valid for the management of the object itself (if not, it would not be possible to reactivate the records rendered temporarily inactive).
Close
Fields
The following fields are present on this tab :
|   |
| In this column the field name for the table is defined as it will be expressed in the software (a field with the name NOMCHAMP defined in an ABV abbreviation table can be accessed using the syntax [F:ABV]NOMCHAMP ). For custom/specific fields, the field name must start with X_, Y_ or Z_. In the database, each zone corresponds to one or more fields (according to whether or not the zone is sized : the corresponding fields are called NOMCHAMP_0, NOMCHAMP_1, NOMCHAMP_2…) To enter and display the corresponding field on a screen, it is given the same name in the screen dictionary and the screen and the table will be used simultaneously in object management. |
| The field type is defined here, which characterize the entry format (numeric, any characters, date...) and the coherence controls (reference to a table for example). The principal generic types that exist : A : Alphanumeric |
| Defines the local menu number associated with the field defined on the line. When a field is of the type local menu (from 1 to 255) corresponding to the rank of a title in a table named local menu, stored in the messages table APLSTD. On entry or on display, the following are displayed according to the choices made in the user interface :
The interest of this type of entry is that the list of choices is displayed in the user connection language. Each local menu number characterises the list of available titles. For example, the local menu 1 corresponds to the choice No / Yes in this order. In this particular case, the user interface can also be a check box. |
| Used to define the length of a field when this field uses a generic data type where the length is not fixed. This is notably the case for the types A and DCB. |
| An activity code is used to:
In this way, if the activity code is disabled, the marked element will not be useable, and the associated code (if any) will neither be generated nor can be activated. |
| Dimension of the field in the table. The dimension can also be assigned as a function of the activity code. |
| Title for the field over three lengths : short title being limited to 12 characters, normal title at 20 characters and the long title at 35 characters. These titles are translatable texts and they are stored in a dedicated table, ATEXTE. When a new text is entered, after creation of a section, a window appears whose title is Text. There is then a choice between the following three options :
When in modification mode for a text already entered there is also an additional choice of displaying in the window, where the title is presented Text nnn (nnn being its number). Indeed, it is then possible to modify the text whose number is given, to conform with the text that is being entered (this modification is made wherever the corresponding text is used, once the corresponding screens have been revalidated). In addition, it is possible to call, using the right button on the mouse, the Abbreviation function that is used to select one of the standardised abbreviations defined when a title is too long (the use of abbreviations must be avoided as far as possible to facilitate the readability of the screens). |
| Title for the field over three lengths : short title being limited to 12 characters, normal title at 20 characters and the long title at 35 characters. These titles are translatable texts and they are stored in a dedicated table, ATEXTE. When a new text is entered, after creation of a section, a window appears whose title is Text. There is then a choice between the following three options :
When in modification mode for a text already entered there is also an additional choice of displaying in the window, where the title is presented Text nnn (nnn being its number). Indeed, it is then possible to modify the text whose number is given, to conform with the text that is being entered (this modification is made wherever the corresponding text is used, once the corresponding screens have been revalidated). In addition, it is possible to call, using the right button on the mouse, the Abbreviation function that is used to select one of the standardised abbreviations defined when a title is too long (the use of abbreviations must be avoided as far as possible to facilitate the readability of the screens). |
| Title for the field over three lengths : short title being limited to 12 characters, normal title at 20 characters and the long title at 35 characters. These titles are translatable texts and they are stored in a dedicated table, ATEXTE. When a new text is entered, after creation of a section, a window appears whose title is Text. There is then a choice between the following three options :
When in modification mode for a text already entered there is also an additional choice of displaying in the window, where the title is presented Text nnn (nnn being its number). Indeed, it is then possible to modify the text whose number is given, to conform with the text that is being entered (this modification is made wherever the corresponding text is used, once the corresponding screens have been revalidated). In addition, it is possible to call, using the right button on the mouse, the Abbreviation function that is used to select one of the standardised abbreviations defined when a title is too long (the use of abbreviations must be avoided as far as possible to facilitate the readability of the screens). |
| These options are realized by characters that can be concatenated when several options are required. It is possible to choose these options thanks to a selection window. A detailed description for all the possible options is available. |
| Code for a table linked to that modified by means of the current field. For the data types making reference to an object, this field is assigned automatically.
|
| This field is only entered if a linked table has been specified. If this field is not assigned, the link is made directly from the field in the current line (which supposes that the primary linked table key is not the only component). In the case where the primary key possesses several components the link expression must be indicated under the form : comp1;comp2;comp;... where comp1,comp2, comp3,... are the components of the key.
|
|
| During the cancellation of a line in the linked table (source table), a particular action can be carried out on the table that is currently being modified or created (destination table). This action is defined by the code below :
|
| This field is used to indicate if the coherence verification utility must verify the link. |
| The field Mandatory is used to define if the field can be empty or if it is mandatory that it contains a value (not empty). An empty field may be a string with an empty length, a null numeric value, a local menu value equal to zero (no choice carried out) or an empty date [0/0/0]. When the field is a key in a table, if the cancellation control is set to the RTZ value, the link cannot be mandatory (because the cancellation can erase the value of the key field) : the Mandatory field is then automatically set to No. |
| This field makes it possible to zero the field in the utility"Folder - return to zero". |
Close
Presentation
This tab is used to define the different indexes defined in the table.
Close
Fields
The following fields are present on this tab :
Table Index
|   |
| This field corresponds to the name under which the index is known in the database. A standard is used in all the tables in the application : it consists of naming the keys by using the abbreviation for the table, followed by 0 for the principal key, by 1 for the second key, etc.... For the specific/customization, start this code with one of the following three letters : X,Y or Z. |
| This is where the list of fields that make up the index are entered. The fields are separated by a '+' if there are several fields (for example, in the sites table FACILITY there is a key whose definition is LEGCPY+FCY). A descending sort field is preceded with the sign "-" (warning, it is used in the left list). The first field that makes up the index is without a sign and is therefore ascending. |
| This column is used to define whether the key can or cannot accept homonyms. |
|   |
| If this field is not assigned, the index will always be present. If this field corresponds to an inactive activity code, the index will not be generated. It is possible to add a specific/custom key by an activity code starting with X, Y or Z. |
Configuration file
| A text describing the technical configuration of the table in the database is entered in this section. This text is recorded in a file "name.cfg" in the FIL directory for the application. This file is used by the "valfil" instruction. View the dedicated technical annex for more information. |
Close
Presentation
This tab is used to create the parameterization that is then used to log, by means of automatically generated database triggers, the insertions, deletions and modifications carried out on a table, by storing if necessary, the before and after values on particular fields. The modification of the record is logged on the condition that one of the conditions on the fields has been verified.
The "triggers" technique is used to log the operations even if they are carried out by a program other than Adonix.
The information in this tab is considered as being parameterization. The standard is not shipped with any audit parameterization. This tab is therefore reserved for customization. No protection is required by activity code X, Y or Z.
The information in this tab is taken into account by the re-validation of the table.
The audit is globally set by the activity code AUDIT.
This log is stored in two dedicated tables (AUDITH and AUDITL). It can simply be viewed or give rise to automated notifications by means of the Workflow.
Cannot be audited :
The SUBTRIGGER process contains the description of the triggers as a function of the database. The SPETRIGGER process is reserved for customization in order to personalize their description (if required).
The results of the audit can be viewed by its inquiries :
Close
Fields
The following fields are present on this tab :
Type of audit
| These three check boxes are used to define the operations to be logged for the records in the table :
Note : |
|   |
|   |
Functions
| makes it possible to have an automated notification by Workflow. A Workflow batch task triggers a Workflow event for each line of the AUDITH table where the Workflow status is "to be processed", then update the status to "processed". |
| It is used for the incremental synchonization of the BI facts table. It is only active if the activity code ABI is active. Update by the generation of the dataware as a function of the update type planned for the facts table. In the BI synchronization rules, if a facts table is updated by incremental synchronization from a X3DIAM table, this table is flagged "AUDIT BI". |
Tracking key
| One of the keys for the table is specified here. It is preferable that it is without homonym, to facilitate the identification of the record in the read of the audit. If this field is not entered, the primary key is used. |
Table Fields audited
| List of fields to be audited. Do not enter this grid, if a log of only the operations carried out on a record is required, without a log of the contents of the fields. There will be a log for a modified record, if at least one of the conditions on the fields is verified by the new values of the field ; whilst on the creation or deletion of the record, there will systematically be a log. |
|   |
|   |
|   |
Close
Functions accessed by right click on the grid
The existing limits when a table is created. The limits are the following :
By default, the following reports are associated to the function :
DICOX3 : Table dictionary
ATABLIST : List of tables
This can be changed by a different setup.
The following fields are present on the window opened through this button : Block number 1
Block number 2
Close This button is used to copy the table structure to another folder. Warning, only the table description in the dictionary is recopied : the table is not created in the target folder (it will be necessary to validate this description so that the table can be created). The data in the table is not recopied... |
This button is used to delete the data in a table without deleting the table itself. A confirmation is required, this operation being irreversible. |
This function is used to display, in an information box :
This function is used to access the documentation management on the first paragraph of the documentation (if there is one) associated to the current record.
This function is used to access the links management. It is used to define the links between the current and other records (for example the links between functions and setups). These links are specific to the documentation and are used to load the generation of documentation structures.
This menu is used to launch a documentation generation. The generation can also be launched from the [Generation] button at the bottom of the window.
Three types of generation can be launched one by one or simultaneously:
The range suggested by default takes into account the current record but it can be modified upon launch.
In addition to the generic error messages, the following messages can appear during the entry :
A table has bee created without defining at least one field.
As a minimum one index is required in each table.
The title field entered in the first tab does not exist in the list of fields in the second tab.
Abbreviations in the folder must be unique. This message is displayed if an attempt is made to create a table with an abbreviation used by another table.
warning message, when an attempt is made to enter an abbreviation on a table that exists already for a view. It is effectively recommended that unique abbreviations are used.
An attempt has been made to use the ‘"’ character in a title (this character is prohibited).
In one of the fields a title has been entered in the general tab for a field that is not defined in the field tab.
the length is incorrect as a function of the internal type of the field.
The length field has an incorrect value (too large, or empty for example).
An attempt has been made to enter an option that does not exist in the Option column associated with a field in the table.
The link expression is syntaxically incorrect.
An attempt has been made to define the same index twice in a table.
A field has been referenced in an index that does not exist in the list of fields.
An attempt has been made to use a dimensioned field in an index (this is prohibited).
There is a limit of 512 columns taking into account the field sizes.
There is a limit of 255 columns. Here the dimensions do not count.
It is the size of the record.
Under SQL, the limit is 8060 bytes
Under Oracle, there is no limit, but under Adonix the limit is 32 K.
The size of an index cannot exceed 256 characters.
There is a limit of 16 fields per key.
An attempt has been made to check the "Translatable text generation" box where the principal table managed by the object does not contain a field of the type AXX, AX1, AX2 or AX3.
Warning message. The modification of the "Translatable text generation" check box determines the method chosen for the printing of the translated texts in the Crystal report reports using this table. By modifying this box, the user is specifying that they are changing the method and it is imperative to modify the reports associated with this table. It is therefore recommended that this field is not modified.
During the table revalidation (by the validation tool) other errors are likely to appear. These errors can be viewed in the form of a log file. Amongst the errors likely to appear are the following :