Generalities

Introduction

When custom/specific developments must be carried out, it is necessary to be organised in order that they survive as long as possible with respect to version changes. This document details how to do this.

The supervisor provides template with which functions can be developed. It is therefore important, when there is process to be developed, to identify which template to use. Any template can be completed by the actions specific to each. Shown below is a description of each template.

OBJect template

OBJect management is the basis of most of the functions of this software package. An OBJect corresponds to the complete management of the records in a table or group of tables (creation, enquiry, modification, deletion should it be required...). For example, the management of customers, the management of invoices, the entry of postings... are implemented in the software in the form of OBJects.

An OBJ presents itself in the form :

    of a window composed of a header screen and one or more tabs located in the right hand section.

    of a selection list located on the left ("browser")

Enquiry template

The enquiry management is used to display a list of records selected from the criteria entered by the user. This template is used to view the results in the form of a graph.

An inquiry presents itself in the form :

    of a window composed of a header screen and one or more tabs located in the lower section.

    of a criteria entry screen

Standard process template

The standard process template, is adapted for the silent procedural processes (example : validation of the accounting documents, automatic shipments). At the start of the execution of the, the template is used to enter the selection criteria in a dialogue box or window or even respond to a confirmation message for the execution of this process. Then, the entry of a principal window can take place. Then, the procedural process is executed.

The standard process template authorises :

    the launch of the process in batch mode

    the generation of a log file

Window entry template

This template is called from a button at the bottom of the screen, a menu, the contextual menu for a field or a function to open an entry or visualisation window. this window can be a full screen window (it is based on the instruction Inpbox); it can be a dialogue box (it is based on the instruction Dlgbox) or it can be a message box (in this case it is based on the instruction Messbox). In the window dictionary, the field AFFICHAGE will indicate the type of box to be opened.

The window can contain :

    a screen or several screen

    the buttons at the bottom of the screen

    the menus (except for a message box)

On the other hand no left list is possible in this template.

This template manages the opening, the entry and the closing of the window as well as the management of the "End" button that is always present. The buttons that can be added, in the parameterization of the window, are to be programmed in their totality.

Selection in table template

The "Selection in table" is adapted to display a chosen window based on the elements of a table. In fact, it replaces the use of the Choose instruction. There is the possibility to apply a selection filter on the records in the table.

Selection in list template

The "Selection in list" template is adapted to display a chosen window based on a list that is contracted (and not on the elements in a table).

Miscellaneous display template

The "Miscellaneous display" template can be chosen for all process that do not open any windows. It is adapted to display a chosen window based on a list that is constructed (and not on the elements in a table).

Report template

This template is called on the printing of a Crystal Report report (just before, the execution of Crystal Report). It can be used to update the data in the X3 database, or even to construct a work table in order to facilitate the process by Crystal Report.

Import template

This template is called during any OBJect import.

Export template

This template is called during any export of an OBJect or the tables.

Archiving - Purging template

This template is called from the menu "Usage/Archiving - Purging". It is used to execute an archiving and/or a purging of all or part of the parameterization. The process is automated for the principal and linked tables. A principal table can have up to 20 linked tables. A table can be linked to a principal table when its primary key start with the primary key of the principal table.

A log file is displayed at the end of the process to indicate the number of archived records and the number of purged records.