Functions
This function is used to list all the functions in the software database called from a menu. A function can correspond to either a menu or a process.
Prerequisite
Refer to documentation Implementation
Screen management
The definition of a function is made on 2 tabs : one tab is used for the general information and the other for the identification of the action.
Header
Presentation
The header is used to identify the function.
Close
Fields
The following fields are present on this tab :
| Indicate the function code. The codes starting with "GES" are automatically generated by the object management supervisor. |
| 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
Tab General
Presentation
This tab is used to give the general characteristics of the function.
Close
Fields
The following fields are present on this tab :
Characteristics
| When a function is created, it is indispensable to reference it in a menu, in order that this function can be called. The menus are parameterized by user, but a reference user exists, called ADMIN, but whose name is modifiable using the parameter ADMUSR.. These menus contain all the functions and can serve as a template during the creation of the menus. Therefore a reference menu for where the function is found is defined here. The top menu in the standard menu tree structure is called GENE ; all functions must be referenced, whether in this menu GENE, or in another menu itself accessible via the menu GENE. The following constrains exist :
The menu title is the text (translatable) that will actually appear in the user menu to describe the function. |
| Indicate the rank where the function will appear in the menu above. In a menu the functions are sorted by rank in ascending order. |
| Indicate the title that will appear in the ADMIN user menu. |
Block number 2
| Specify the module that uses this function. If the function is using several modules, indicate "supervisor". |
| If this field is not assigned, the function will always be active and will generate a menu line for the user ADMIN. If this field corresponds to an inactive activity code, the function will not be active. If this field starts with an X, Y or Z, the folder validation does not update the function. |
| Indicate the type of function : process or sub-menu. |
| The process, if it is entered, corresponds to :
For a function of the process type, the method recommended is to enter the action, if it is not of the type "miscellaneous process", rather than enter the process directly. |
Authorizations
| When the function is linked to an object, the field "Object access type" is automatically set. It is used to propose the following 3 codes in the functional authorizations : C (Creation), M (Modification), S (Deletion). |
| When the "site authorization" field is set, it allows the detailing of the functional authorizations by site or group of sites. |
Miscellaneous
| This check box is used to make the function executable even if the folder has been set to the "mono-module" ; that is to say it does not authorize any function or the module. A folder is set to mono-module by an exclusive function. |
| Title for the parameter GFLAG=#; this title will be displayed, in the "menu profile", for the entry of thus parameter, for this function. |
| These two fields are used to define the name of the two report codes that can be called by the functions Print file and List file. These codes being stored in the following varables :GREPORT1 and GREPORT2. In the standard way, the Print function relates to the current record (the function is not in principal available if there is no current record), whilst the List function is available in all cases. In the case of a function linked to the object, the supervisor manages these buttons (activation, de-activation, execution). For all the other functions, the developer in the function is assumed to manage the call to these two reports, as well as the activation. |
|
|
|
Table Options
|
|
| This table is used to define the options codes (up to a maximum of 20) in the form of a letter and associated comment. The lower case letters are reserved for specific/custom developments. On each functional authorization, this letter can be selected or not in order to add the options to the function. On the execution of a function, the supervisor loads the global variable GUSRAUZ(n) with the authorized option codes; n is the index that indicates the breakdown of the authorizations by site. The developer can link a section of their process with the presence or not of an option code in this variable. |
| Indicate the title of the option corresponding to the code on the same line. This title will be displayed in the user profile when entering the access rights. |
| This field makes it possible to define a function that will govern the access to this parameter. This makes it possible to avoid access authorization errors. For example : The button 'Validation' for the function GESBIC 'BP customer invoices' corresponds to the function BPCVAL. It is therefore possible to control access to the button according to the authorizations defined in the function BPCVAL. |
| This activity code governs the presence or not, of the option in the function. |
Table Variables
|
|
| This table is used to define a list of global variables that must be assigned in order to give a calling process a more specific context. These variables are initialized by the function, when the process is called from the menu. |
| Specify the value to be assigned to the variable of the same line. Be careful to respect its type (no control is carried out). |
| This activity code makes it possible to protect the variable during a folder update. |
Close
Tab Action
Presentation
This tab is used to identify the action to be executed.
Close
Fields
The following fields are present on this tab :
Block number 1
| The action that will be executed at the launch of the function is defined here. The action must exist in the dictionary and must not be of the type "miscellaneous process". If this is the case, the unction must not call the function but must call the process directly ; to do this the name of the process must be entered in the first tab. |
|
|
| possibility to enter the values for the action parameters. |
Close
Reports
By default, the following reports are associated to the function :
AFONCTION : Functions
This can be changed by a different setup.
Menu Bar
Option / Context of formula assistant
Used to access by tunnel on the function "formula assistant context".
Option / Function validation
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 :
Function code format incorrect (5 characters max)
For a function of the type menu, the function code must not exceed 5 characters.
Incorrect value
It is prohibited to associate a function of the type process with a general menu GENE.
It is prohibited to associate a function of the type menu to itself.
Mandatory field
In a function of the type process, the action code (see the process name) must be entered.
Modification impossible
When standard activity code is present, it is not possible to delete it.
Incorrect option / Incorrect option line n° xxx
In a function linked to the object, the option codes C, M and D are reserved for the supervisor.
Record non-existent
In the options table, the function when it is entered, must exist in the dictionary.