This function is used to define the archiving and purging procedures for a table and possibly any associated detail tables, as well as all the tables linked to it in the dictionary and whose cancellation code is set to deletion. Taking for example the archiving formula SOH for the customer order table SORDER, the tables SORDERP, SORDERQ etc are also archived.

These archive formulas are used during the archiving / purging function.

It is a supervisor process, which starting from the archiving formulas and the parameterization, will carryout this archiving and purging. It is however possible to add customization in a process whose name will be identified in a purging formula.

    Prerequisite

    SEEREFERTTO Refer to documentation Implementation

    Screen management

    Entry screen

    Presentation

    The entry of the purging formulas is carried out in a tab.

    Close

     

    Fields

    The following fields are present on this tab :

    Block number 1

    This code identifies a purging formula.

    • Title (field ZDES)

    This text, which should appear on the reports and screens in which the record code can be entered or selected, gives a clear description of the record concerned.

    A short title can also be used for this usage when there is insufficient space.

    Characteristics

    • Short title (field ZDESSHO)

    This text, which should appear on the reports and screens in which the record code can be entered or selected, gives a clear description of the record concerned.

    A short title can also be used for this usage when there is insufficient space.

    An activity code is used to:

    • make optional an element 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.

    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.

    • Module (field MODULE)

    Module belonging to the setup. This field is used to specify whether the screen has to be created in the folder database. It is specified when the module linked to the screen is active in the folder.

    Processings

    • Active (field ENAFLG)

    This check box is used to activate or deactivate the current record without losing its content.

    A deactivated record cannot be used (by calling its code) in other records (documents, setups, etc.) or during mass processings.

    The authorizations for a given function can prohibit the creation of an active record. In this case, the box is cleared by default and it can only be modified by an authorized user or via a signature circuit defined by Workflow.

    • Standard processing (field CTLTRT)

    Optional processes can include miscellaneous sub-programs that will be called during the execution of the archiving . See the characteristics of these sub-programs. The vertical developments must start with X; the specific/custom developments must start with either Y or Z. The update of the specific/custom process does not require protection by activity code.  

    • Specific processing (field SPETRT)

     

    Table Tables

    Tables to be archived and purged.

    It is possible to assign a principal table as well as these detail tables. As a consequence, for a detail table, the principal table with which it is associated will be specified in this field. For a detail table, no other parameter will be entered. A table can be considered as a detail table if its primary key is made up of the primary key of the principal table + an identifier. It is possible to enter up to 20 detail tables per principal table.

    • Company (field CPYFLD)

    These fields (Company, Site and Date) are used to identify the fields in the principal table containing respectively the company, the site, the date. These are the standard criteria to filter the records in the principal table to be archived.

    • Site (field FCYFLD)

     

    • Date (field DATFLD)
    • Formula for creating data to be purged (field FRM)

    This field is used to define the additional filters for a formula to archive the records. The purge function uses this formula when the archiving is not activated by the parameterization.

    Close

     

    Specific Buttons

    The following fields are present on the window opened through this button :

    Block number 1

    • field OBJET

     

    • field CLES

     

    Block number 2

    • From folder (field DOSORG)

    This field is used to define the folder from which the record is going be copied. The possible syntaxes are described in the dedicated appendix.

    • All folders (field TOUDOS)

    This option is used to copy the record to all the folders defined in the dictionary (ADOSSIER table from the current solution).

    • To folder (field DOSDES)

    This field used to define the folder in which the record is going be copied. The possible syntaxes are described in the dedicated appendix.

    Close

    This button is used to copy an archiving formula to another folder Warning, the associated processes are not copied.

    Important remark

    It is important to note that the standard processes are passed on when the archiving or purging condition is not sufficient, and these standard processes must not be changed. Their poorly considered modification can provoke archiving and purging that could place the database stability in danger. It is recommended, if it is necessary to modify the archiving / purging rules, to complete the archiving formula by defining for example more restrictive criteria and to write if necessary the deletion of additional data created in the specific/custom tables in the specific/custom process. (see the methodology).

     

    Menu Bar

    Options / Purge parameters

    Documentation / Paragraphs

    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.

    Documentation / Links

    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.

    Documentation / Generation

    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 generation of the documentation structure from the dictionary (tables ADOCUMENT, ADOCBLB, ADOCCLB).
    • the generation of the documentation from the previous tables.
    • the generation of the field documentation.

    The range suggested by default takes into account the current record but it can be modified upon launch.

    Error messages

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

    Table not defined

    The table entered in the "Linked table" field must have been entered as a table to be processed in the "table" field.

    XXXXXX : Too many lines in this table

    An attempt has been made to enter more than 20 detail tables for a principal table.

    XXXXXX : Field does not exist in table YYYYYYY

    Table YYYYYYY has been linked to a principal table. At least one primary key field for the principal table must exist in the detail table YYYYYYY.

    XXXXXX : Incorrect data type

    Table YYYYYYY has been linked to a principal table. The XXXXX field of the primary key for the principal table exists in the detail table but it is of a different data type.

    Field does not exist in the XXXXXX table

    The field identification fields (company, site, date) must reference a field that exists in the principal table.

    Data type incorrect

    The Company Zone field must reference a zone of the type CPY or FCY.
    The field Site Zone must reference a zone of the type CPY or FCY.
    The field Date Zone must reference a zone of the type date.

     

    Tables used

    SEEREFERTTO Refer to documentation Implementation