Development > Script dictionary > Actions > Actions 

This function is used to define the actions that can be used in the screens, in the data types for the actions on the fields, in the windows for the buttons at the bottom of the screen or the menus and in the functions.

An action generally triggers a supervisor process called "Model" to which it is possible to attach a functional process.

A certain number of actions can be linked together (up to a maximum of 5).

Prerequisite

SEEREFERTTO Refer to documentation Implementation

Screen management

Header

Presentation

The header is used to identify the action.

Close

 

Fields

The following fields are present on this tab :

Specify the action code to be defined.

  • Description (field ZINTITA)

Enter the description of the relevant record.

This long description is used as a title in screens and reports.

Close

 

Tab General

Presentation

The general information relative to the action is found in this tab.

Close

 

Fields

The following fields are present on this tab :

Characteristics

The validation of the ADONIX folder does not update the actions where the activity code begins with X Y or Z.

  • Module (field MODULE)

Specify the module using this action. If the action is used by several modules, indicate "Supervisor".

  • Template (field TYP)

This field is important because it is used to identify the process to be launched on the execution of this action. See the development detail. At this level, the possible values are as follows :

  Object management
Inquiry
  Standard process(can be launched in batch mode)
  Window entry
  Selection from a list (selection window)
  Selection from a table (selection window)
  Miscellaneous display (called from a functional sub-program by Gosub)

  Miscellaneous process(called from a functional sub-program by Call)

The "miscellaneous process" is used to directly launch a functional process without using a template ; this type of action cannot be called from a function.

Block number 2

  • Button title (field ZINTITC)

The title is displayed in the contextual menu of the field in which this action is placed.

Identifying the inquiry to be entered in a template action "Inquiry".

  • Type (field TYPUTI)

 

Parameters

This field serves to identify the principal entry window for the "Window entry" of "Standard process" templates.

Block number 6

  • First entry (field PARAM3)

To be entered for a "Standard process" template. Is it an initial entry ? and what type ? The possible values are as follows :

 No initial entry

  Confirmation Yes / No (message making it possible to confirm execution of this action )
  Dialogue box (restricted window entry : buttons limited to "OK" and "END", no menus, a single screen).
  Window entry (window entry by the template "Window entry").
  Selection of the list (selection window)
  Selection of the table (selection window)

To be entered if the initial entry is :
  Dialogue box
  Window entry

Block number 7

  • Standard script (field CODTRT)

Standard process in which the Adonix development describes the supervisor model or sub-program additions. See the development detail.

  • Subprograms (field SUBPRG)

This field can be entered in an action of the type "Miscellaneous process". There is no supervisor process associated with this action, only with this sub-program. It is defined either in the standard process, or in the specific/custom process.

A single sub-program is executed : This is the specific/custom if the process exists, if not it is the standard. The addition of a customization to a standard action of the type "Miscellaneous process" is then cancelled and replaced.

Block number 8

  • Specific script (field SPETRT)

Specific/custom process in which the customization writes the supervisor template or sub-program additions. The update of a specific/custom process does not require protection with an activity code.  

See the development detail.

  • Expression (field INSTRU)

This field can be entered in an action of the type "Miscellaneous process". It can appear as an addition to the sub-program. In this case, it will be executed following the sub-program.

  • Action identifier (field PARAM5)

This is used to identify one or more actions from a process, by the following variables :

  • TABLE for an action of the type "Table selection"
  • LISTE for an action of the type "List selection"
  • TRAIT for an action of the type "Miscellaneous display"

Block number 9

This field is used to specify another dictionary action. In this way there is the possibility to link up to 5 actions. In this case, the values of the parameters for all these actions are to be entered at the launch. The actions linked in this way can be from a different template.

If the principal action is placed in a field, there is the possibility to not execute the linked actions by setting the mkstat variable.

If the principal action is placed in a button at the bottom of the screen or in a menu, there is the possibility to not execute the linked actions by setting the variable OK = 0 in the action BEFORE NEXT.

Accessibility

  • Workflow (field AMSFLG)

Flag that is used to authorize or not this action in workflow. This authorization is only allowed for an action of the type "Miscellaneous process". This flag is is checked in particular on creation of a workflow rule.

  • Batch (field ABTFLG)

Flag that is used to authorize or not this action in batch mode. This authorization is only allowed for an action of the type "Standard process". This flag is checked in particular on creation of a batch task.

  • Public (field PUBFLG)

This flag indicates that this element is published. It can therefore be re-used by the custom/specific. An associated documentation is available.

  • Batch mandatory in WEB (field NOWEB)

If this flag is set, the said action will not be carried out in interactive mode, but in Customer/Server mode, and not on Web versions (Native Web, Web services). This helps prevent heavy processings in interactive mode in Web version.

Description

  • field TEXTE

Text loading the PRE "presentation" paragraph, in the record help. In the documentation management, the record help is identified by :

  • documentation type = ACT
  • documentation code = name of the action

Close

 

Tab Parameter Definitions

Presentation

The information related to all the action parameters is found here.

Close

 

Fields

The following fields are present on this tab :

Block number 1

  • Current field (field TYPACT)

When this field is checked, the first parameter is considered as being the current field. If this action is placed in a field, the first parameter is entered automatically by the value of the current field ; It therefore does not appear in the list of parameters to be entered in the field in the screen dictionary.

  • Action before/after field (field PARAM6)

Possibility to add a process before and/or after an Object, Inquiry, Standard process, Entry window template, when this action is placed in the contextual menu for a field. This makes it possible to prepare a context (for example assign the variable GCONSULT) before executing an action and/or starting by example, a display after the action.

The "before" action code is the name of the label preceded by A. The "after" action code is the name of the label preceded with B.

Example : if the action is linked to the button 2 of the field CHP, the before and after labels will be AB2_CHP and BB2_CHP. It must be programmed in the $ACTION label of the standard or specific/custom process.

Grid

  • No. (field NUMLIG)

 

parameter codes for the action.

The order in which the parameter codes should be entered in the grid is very important : It must correspond with the order in which the parameters have been entered in the sub-program that allows the execution of the action.

Each parameter must have been declared in the parameters dictionary. Before creating this parameter code, verify that it doesn't exist already under another code in order to avoid redundancies. The selection key allows you to obtain the list.

  • Parameter type (field TYPPAR)

Indicate the nature of the parameter : char, integer, decimal etc. This information can only be entered during the creation of the parameter, in the parameter dictionary.

Warning ! A parameter of the type clob/bob can only be used in an action in one of the following two cases :

  • In an action of the type "Miscellaneous process", on all the parameters,
  • In any other action and only if the box "Current field" is checked in the first parameter.
  • Argument type (field ADRVAL)

It indicates how the parameter is passed.

          by address ( a variable is necessary to pass the parameter. On exiting the sub-program, the value of any modified parameter is returned to the calling process).

          by value ( the parameter is passed by a variable or by a constant. On exiting the sub-program, the value of the parameter even if it is modified is not returned to the calling process).

Close

 

Reports

By default, the following reports are associated with this function :

 ACTION : Action dictionary

This can be changed using a different setup.

Specific Buttons

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

Block number 1

  • field OBJET

 

  • field CLES

 

Block number 2

  • From folder (field DOSORG)

Indicate 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)

Indicate 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 the definition of the action to another folder. Warning, the associated processes are not copied.

Menu Bar

Documentation / Paragraphs

This choice of menu allows to zoom to the documentation management, on the first documentation paragraph (if it exists) related to the current record.

Documentation / Links

This choice of menu allows to zoom on the dictionary link management function. This function allows to establish links between the current record and other records (for example links between functions and parameters). These links, dedicated for documentation purpose, allows the generation of documentation structure.

Documentation / Generation

This choice of menu allows to generate the documentation. Three types of generation can be separately or simultaneously started :

  • the generation of the structure of documentation from dictionary (tables ADOCUMENT, ADOCBLB, ADOCCLB).
  • the generation of the documentation itself from the previous table (they have been normally completed after the first generation).
  • the field help documentation generation.

The ranges and parameter proposed by default are defaulted according ti the current record, but they can be changed during the execution.

Error messages

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

Mandatory field

The principal window is mandatory for an action of the type "Entry window".

Tables used

SEEREFERTTO Refer to documentation Implementation