Menu items
| Administration Page | Application/Contract | Syracuse/Collaboration | Class | menuItems | Representation | menuItem |
|---|
A menu item defines a link present in portal vignettes that links to a page managed by the software.
The page that defines a menu item contains several sections:
Defines the main characteristics of the link, including the following:
Code
A unique code that identifies the menu item. For Classic functions, it is recommended to use the Sage X3 People function code. For Entities / Representations pages, it is recommended to use the representation code.
Title
This mandatory information appears when a menu item is referenced.
A translation link is present for this information:
It enables entering descriptions in different languages with the corresponding widget.
Description
User friendly description of the menu item. This field is also translatable.
Link type
Indicates what kind of page will be called if the link is activated. The following choices are available:
- Representation is a page that manages a facet of an entity. Thus, the user will have to enter an entity, an associated representation and a facet.
- Function (Classic) is a page that manages a Sage X3 People function in Classic mode. Therefore, the Sage X3 People function code must be entered.
- Process is a page that manages a Sage X3 People visual process. Therefore, the Sage X3 People function code must be entered.
- Request is a page that manages a request. Therefore, the request code and the detail level must be entered.
- Statistics is a page that manages a statistical inquiry. Therefore, the Sage X3 People function code must be entered.
- Dashboard Page is a link that brings the user to another dashboard. The code of the dashboard is required.
- External link is used when the menu item links to a URL that will have to be given.
- Calendar is used when the menu item links to calendar representation of a request that will have to be given.
- HRM site is used when the menu item links to a HRM site that will have to be given.
Icon
Indicates the file name and repository of the icon to display.
Application menu
This check box is used to define how the menu item appears on mobile clients. This is subject to change in a near future.
Factory
This check box defines if the record is supplied as a factory record. When this happens, a factory code is also displayed and can be entered if you are a factory provider. This features allows to prevent some modifications on records supplied by defaut by Sage or by a vertical solution provider. More information about this feature is given in the following document.
Based on the previous type, additional information must be entered in this section:
Application
Entered for every type except Exernal link link types. Refers to the application used for the link. The Sage X3 People application is mandatory if the link is a Classic type link.
Endpoint
Can be entered for every type except Exernal link link types. If entered, the link will automatically be displayed in a vignette (if the vignette is associated with the right endpoint).
Representation
Entered for Representation link types only. Defines the representation used for the user interface. This representation is linked to the entity; therefore, only some representations are available for a given entity. A selection is possible in the same conditions as for the entity definition. Only a representation attached to the previous entity can be used.
Entity
Entered for Representation link types only. Indicates the entity managed by the page. A selection is possible:
- If the application is a Syracuse collaboration.
- If it is Sage X3 People and if the endpoint (Sage X3 People folder) is identified for the menu item.
If the application is Sage X3 People but the endpoint is not known, a selection will be done if a default endpoint has been set up for Sage X3 People type endpoints.
Action
Entered for Representation link types only. Determines the action that will be executed of the representation. The following actions can be selected:
- Query is used to display a page that lists the entity values and allows to display the detail of an entity instance, or to edit it, or to create a new instance.
- Details is used to display the detail of an entity instance. A key value must be entered.
- Edit is used to modify the detail of an entity instance. A key value must be entered.
- Summary is used to display the summarized information associated with an entity instance. A key value must be entered.
- Create is used when a page is displayed to create a new instance of the entity.
Function
Entered for Function (Classic) link types only. Indicates the Sage X3 People function code. A selection is possible:
- For Sage X3 People application: if the endpoint (Sage X3 People folder) is identified for the menu item, the selection will be done on the corresponding folder. Otherwise, no selection is possible unless a default Endpoint has been set up for Sage X3 People type endpoints.
If the function requires an additional parameter, the parameter can be added with the syntax FUNCTION_CODE~PARAMETER_VALUE. This is especially the case in the following situations:
* for any function that might use a transaction code (for example, GESSOH~MYORDER will use the sales order entry with MYORDER transaction)
v* for an inquiry that has different screens (for example, SAIWRKPLN~PUR will use the workflow monitor with the screen code PUR)
* for a report execution (for example, AIMP~POSCOD will execute the report POSCOD)
* ...
Key
Entered for Function (Classic) link types only. Defines the key.
Process Name
Entered for Process link types only. Defines the visual process code to be displayed.
Process legislation
Entered for Process link types only. Defines the optional legislatation code assigned to the process.
Process menu
Entered for Process link types only. If present, defines the menu that allows selecting processes in a list.
Request name
Entered for Request or Calendar link types only. Defines the code of the request to be displayed.
Request level
Entered for Request or Calendar link types only. Defines the level to be displayed (0 to 99).
Statistics name
Entered for Statistics link types only. Defines the code of the statistic report to be displayed.
Dashboard
Entered for Dashboard link types only. Defines the code of the dashboard to be displayed.
URL
Entered for External link link types only. Defines the URL to be called to display the page.
Site
Entered for HRM site link types only. Defines the HRM site to be displayed.
This section contains additional values depending on the link previously defined. The value that can be sent to the Sage X3 People function is usually for the "object" types function called GES_xxx_.
Key
This is the key value for a detail, edit or summary facet. The key will be entered in character format. If the key has several components, the components will be separated by a tilde ~ character. For example, an account number 73ABC defined in the USA chart of accounts will be entered as USA~73ABC.
Parameters grid
Depending on the entity, additional parameters may have to be entered. If this is the case, the name and title columns will be filled and the value column must be entered.
The parameters available may depend from the page called:
* Standard parameters exist especially for query facets, and are documented here.
* The parameters that can be added on requests are defined here.
* The parameter that can be added on statistical inquiries are defined here.
This section states the following information:
Open in...
The choice can be:
* Same window where the page opened by the menu item link will replace the current page,
* New window where a new tab will open in the browser to display the page called by the item link.
Display in vignettes
A vignette can contain several item menus. The assignment can be done with a selection window allowing multiple selections, or on the vignette page.
This section displays the following information:
Categories
Item menus can be associated with categories. The assignment can be done in categories with a selection window allowing multiple selections.