Refer to documentation Implementation
Presentation
The header contains information identifying the class.
Close
Fields
The following fields are present on this tab :
|
|
Close
Presentation
This section displays the main information on the representation.
Facets grid
It defines the list of facets that are supported for the representation. Detail, Edit, Query, Lookup, and Summary.
Managed behaviors grid
It describes the behaviors managed for the representation.
Collections grid
It describes collections defined at representation level. The collections that have been defined in the class should be declared if:
Scripts grid
It lists:
- The scripts and codes of the methods defined by the developer.
- The scripts in which $PROPERTIES and $METHODS labels are available for development partners who wish to add their own code associated with supervisor events (especially for CRUD - Create, Read, Update and Delete - management).
Close
Fields
The following fields are present on this tab :
General
|
|
|
Functions
|
|
Characteristics
|
| Technical module to which the representation is associated. |
Type
|
|
Grid Facets
|
|
Grid Managed behaviors
|
|
Grid Collections
|
|
| Collection description. |
| This field defines how the property array is allocated in memory instances. Can be 0, 1, or Maximum. |
| Activity code If entered, this activity code must be a sizing code. It is used to define the maximum size of the collection, on the basis of the activity code value. The memory allocation process is now dynamic: it is no longer necessary to increase the memory used to store the documents during the processing. |
| Maximum size of the collection. The maximum size is mandatory only when the collection is used by properties and not by an instance.
|
|
|
|
|
|
Grid Scripts
| Standard
Vertical
Specific
|
|
| Order in which the $METHODS and $PROPERTIES labels are called in the event. |
| Code used to protect the script during the standard patching process if the code starts with X, Y, or Z, or to activate/deactivate the call to the script. |
Close
Action icon
Presentation
This section describes proprieties defined at the representation level. The proprieties defined at the class level must not be listed.
Properties grid
It lists the properties and relative information.
Keys grid
It lists the key segments corresponding to the line selected in the Properties grid (if the property type is linked to a table [version 6 technology] or a persistent class).
Parameters grid
It contains the list of the parameters of a property, according to the current line in the Properties grid, if the type of the property has rules requiring additional parameters. You then need to enter a value to call the appropriate rule and parameters, based on the context.
Close
Fields
The following fields are present on this tab :
Grid Properties
|
|
|
|
|
| Number of the local menu if the internal type of the data type in the previous field is "Local menu" ("M"). The numbers define all the available values of the property (for example, 1 is the local menu No / Yes). |
|
|
| Collection code. If there is only one property, this code does not need to be entered. Otherwise, it refers to one of the collections defined in this function. It might then be either an array of children references (header / lines structure) or a denormalized array stored in several columns of a database. |
| When the data type is a CLOB or BLOB, the Table of the lob and Lob field fields are managed by the supervisor. These fields describe in which table and column the rich media element is stored. Based on the table used, the Key grid will be filled so that the join can be performed by giving the value of the key. If the data type is not managed by the supervisor, a program will manage the join and no information can be entered in these two fields. |
|   |
| Displays the content type associated to the data type. |
|
|
| Defines a property used when the control table depends on another table. |
|
|
Grid Keys
| Column name of each segment key. It is impossible to modify it. |
| Description of each key segment. This is not modifiable. |
| Data type of the key segment. This is not modifiable. |
|
Grid Parameters
| Code for each parameter, displayed automatically. It is impossible to modify it. |
| Description for each parameter, displayed automatically. This is not modifiable. |
| The mode defines how the parameter is transmitted in the call. It is impossible to modify it. By address
By value
Constant
|
| Data type of each key segment, displayed automatically. This is not modifiable. |
|
Close
Presentation
This section defines the methods for the representation. As the representation is linked to a user interface process, only stateful methods are available. Therefore, stateless operations can only be defined for classes.
Methods grid
It lists the methods and corresponding information.
Parameters grid
It lists the parameters associated with the current method or operation in Methods grid with their corresponding information.
Fields
The following fields are present on this tab :
Grid Methods
|
|
| Data type of the value returned by the method or operation. This is the type of the ARET_VALUE variable available in the event associated with the method. |
|
Grid Parameters
| Name of the variable that contains the parameter value, as it can be seen in the code called by the "$METHODS" event. |
| Data type of the parameter sent to the method. It refers to the keyword used for the variable declaration. |
| Variable description. |
| Defines how the parameter is transmitted in the call. By address
By value
Constant
|
| Defines if the parameter sent is an array and what is its first index value. It can be: No
From 1
From 0
|
| Defines the class of the parameter when the Type field has the 'Instance' value. |
Presentation
This section specifies the default hierarchical organization set up for the representation, as well as additional information used for the query page. A representation defines:
The sections, blocks and properties are placed by default in a page according to a predefined algorithm. You can use the customization function to change the layout without losing the hierarchical organization of the representation.
Section grid
It lists the properties of the page.
Blocks grid
It lists the blocks of the page.
Filters grid
It lists those filters that can be used for the current representation. The filters contained in this list are used in the Query facet. A filter that is set as mandatory will always be applied on the query.
All the other filters are displayed as links on the right side of the page. If you click this link, the query is refreshed and the filter is applied, in addition to the mandatory filter, if any. If you click several links, filters will not be combined but your new set of filters will replace the previous one.
If there is at least a filter which is not the mandatory filter in the grid, an additional link called No filter is also present, to allow users to query a list with no other filter than the default one When entering the query, the filter with the Default field set as Yes is the default filter, but it can be replaced by any other filter.
Sort order grid
It is used to set the default order used to display the query lines. If it is not specified, the default index for the main grid associated with the class will be used.
Close
Fields
The following fields are present on this tab :
Grid Sections
|
|
|
|   |
|
Grid Blocks
|
|
|
|
|   |
|   |
|
Grid Filters
| Unique code for the filter. A selection action is available on this field to select a filter defined for the class. |
|
|
|
|
|
|
|
Sort order
|
|   |
|
Close
Presentation
A representation displays on the device (mobile, tablet, computer) a list of properties, which can be:
Properties grid
It lists all available properties. The selection action provides access to the list of classes, child classes and properties to include. It is also possible to enter a property on a line.
Close
Fields
The following fields are present on this tab :
Grid Properties
|
|
|
|
|
|
|
|   |
|
|
|
|
|
|   |
|   |
|   |
|   |
|   |
|   |
|   |
|   |
|
|   |
|   |
|   |
Close
Presentation
This section defines the links that are available in various locations of the user interface. The links trigger operations or methods depending on the context. Because there can be many links in a representation, this section presents a restricted list of available links according to the following filters: the Anchor type field and the Generated links or Only the invalid links check boxes.
Links grid
It lists the links filtered according to the specified anchor type.
Keys grid
When a link requires a key to operate, this grid is loaded with the corresponding elements. It is necessary to specify the formula in the Value column.
Parameters grid
When a link requires additional parameters to operate, this grid is loaded with a list of these parameters. It is necessary to specify the formula in the Value column.
Close
Fields
The following fields are present on this tab :
Filter
|
|
|   |
|
Grid Links
|   |
|
|
|
|
|
|
|
|
|   |
|
|   |
|
|   |
|
|
|   |
|
|
|
|
|
|
|   |
|   |
|   |
|   |
Grid Keys
|   |
|   |
|   |
|   |
|
Grid Parameters
|   |
|   |
|   |
|   |
|   |
|   |
|   |
|   |
|   |
|
|   |
|   |
Close
Action icon
Presentation
In this section, the menus that organize the links can be defined.
Menu grid
It provides the menu definition for each line.
Default configuration grid
It defines, for each facet, the default link which appears in first position in the link panel, along with its associated style. The only information to be specified is the menu or the code of the link in the Link/Menu column, and an activity code in the Activity code column (the other columns are automatically loaded).
Close
Fields
The following fields are present on this tab :
Grid Menu
|
|
|
|
|
Grid Default configuration
|   |
|   |
|
|   |
|   |
|
Close
Only the actions of links other than the usual CRUD operations and other than the automatic link actions (PDF, Office integration, etc.) are described.
Click this action to validate the representation. This action:
|
Click this action to perform a general validation of the representation.
In addition to the generic error messages, the following messages can appear during the entry :
A property or a collection that has been used in a link is no longer available in the representation.
A generated link has itself a generated replacement link.
A replacement link must be compatible with the link which it replaces (have the same anchor and the same anchor type).
A replacement link must be activated.
This message appears in several cases:
The type is not correct.
The code entered does not correspond to a method of the class.
Modifications made on the representation may have an impact on other representations which have a link on a facet of this representation. Entering a representation in the dictionary can trigger the automatic update of the links. In that case, a message is displayed prompting the user to save the updated representation. The link on the representations is then automatically performed when a patch is installed or the folder is revalidated.
In Purchase and Sales modules some representations are no longer used nor maintained. New representations to replace them are available.