Menu Items

Administration Page Application/Contract Syracuse/Collaboration Class menuItems Representation menuItem

A menu item defines a link within a portal vignette that links to a page managed by the software.

The page that helps you define a menu item is structured as follows:

Information Content Parameter Display Classification

Information

Defines the main characteristics of the link.

Code

Unique code that identifies the menu item. For "classic" functions, it is recommended to use the Sage X3 function code. For entities or representation pages, it is recommended to use the representation code.

Title

Title displayed when a menu item is referenced. This information is mandatory.

You can add translations to this title if necessary:

This allows the display of the title in the correct language using the corresponding widget.

Description

User-friendly description of the menu item. This field can also be translated.

Link type

Indicates the type of page displayed when the link is clicked:

  • Representation is a page that manages a facet of an entity. Therefore, the user has to enter an entity, an associated representation, and a facet.
  • Function (classic) is a page that manages a Sage X3 function in "classic" mode. Therefore, the user has to enter the Sage X3 function code.
  • Process is a page that manages a Sage X3 visual process. Therefore, the user has to enter the Sage X3 function code.
  • Request is a page that manages a request. Therefore, the user has to enter the request code and the detail level.
  • Statistics is a page that manages a statistical inquiry. Therefore, the user has to enter the Sage X3 function code.
  • 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 the user has to specify.
  • Calendar is used when the menu item links to the calendar representation of a request that the user has to specify.
  • Sage X3 People site is used when the menu item links to a HRM site that the user has to specify.

Icon

Specifies the file name and repository of the icon to display.

Application menu

Defines how the menu item appears on mobile clients.

Content

Based on the type selected before, the user has to enter additional information in this section.

Application

Refers to the application used for the link. The Sage X3 application is mandatory if the link is a "Function (classic)" type link.

Note: This field is not available for the "External link" type.

Endpoint

If this field has a value, the link is automatically displayed in a vignette, if the vignette is associated with the correct endpoint.

Note: This field is not available for the "External link" type.

Representation

Defines the representation used for the user interface. This representation is linked to an entity (only some representations are available for each entity). You can select it:

  • If the application is a Syracuse collaboration.
  • If the application is Sage X3, and if the endpoint (Sage X3 folder) is identified for the menu item.

Only a representation attached to an entity can be used.

Note: This field is only available for the "Representation" type.

Entity

Indicates the entity managed by the page. You can select it:

  • If the application is a Syracuse collaboration.
  • If the application is Sage X3, and if the endpoint (Sage X3 folder) is identified for the menu item.

If the application is Sage X3 but the endpoint is not known, the selection is only done if a default endpoint has been set up for Sage X3 type endpoints.

Note: This field is only available for the "Representation" type.

Action

Determines which action is executed for the representation:

  • Query is used to display a page that lists the entity values, and allows the user to display the details of an entity instance, to edit it, or to create a new instance.
  • Statistics is used to display the summarized information associated with an entity instance. A key value must be entered.
  • 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.
  • Create is used when a page is displayed to create a new instance of the entity.

Note: This field is only available for the "Representation" type.

Function

Indicates the Sage X3 function code. If the Sage X3 endpoint (Sage X3 folder) is identified for the menu item, the function code is selected from the corresponding folder. If not, no selection is possible unless a default endpoint has been set up for Sage X3 type endpoints.

If the function requires an additional parameter, it can be added with syntax FUNCTION_CODE~PARAMETER_VALUE. This is especially useful:

  • for any function that might use a transaction code (for example, GESSOH~MYORDER uses the sales order entry with the MYORDER transaction)
  • for an inquiry that has different screens (for example, SAIWRKPLN~PUR uses the workflow monitor with screen code PUR)
  • for a report execution (for example, AIMP~POSCOD executes the POSCOD report).

Note: This field is only available for the "Function (classic)" type.

Key

Defines the key.

Note: This field is only available for the "Function (classic)" type.

Process Name

Defines the visual process code to be displayed.

Note: This field is only available for the "Process" type.

Process menu

Defines the menu from which the user can select processes.

Note: This field is only available for the "Process" type.

Process legislation

Defines the optional legislation code assigned to the process.

Note: This field is only available for the "Process" type.

Query name

Defines the code of the query to be displayed.

Note: This field is only available for the "Query" and "Calendar" types.

Query level

Defines the level to be displayed (0 to 99).

Note: This field is only available for the "Query" and "Calendar" types.

Stat name

Defines the code of the statistic report to be displayed.

Note: This field is only available for the "Statistics" type.

Dashboard

Defines the code of the dashboard to be displayed.

Note: This field is only available for the "Dashboard page" type.

URL

Defines the URL to open upon clicking the link.

Note: This field is only available for the "External link" type.

Site

Defines the HRM site to be displayed.

Note: This field is only available for the "Sage X3 People Site" type.

Parameters

This section contains additional values depending on the link previously defined. The value that can be sent to the Sage X3 function is usually for the "object" types function called GESxxx.

Key

This is the key value for a detail, edit or summary facet. It is entered in character format. If the key has several components, they must be separated with a tilde ("~") character. For example, an account number 73ABC defined in the USA chart of accounts will be named USA~73ABC.

Parameters grid

Depending on the entity, the user may have to enter additional parameters. If this is the case, the name and title columns are filled, and the value column has to be filled.

The parameters available may depend on the page that is called:

  • Standard parameters exist especially for query facets, and are documented here.
  • The parameters that can be added to requests are defined here.
  • The parameter that can be added to statistical inquiries are defined here.

Display

This section can contain the following information.

Open in...

It can be either:

  • "Same window": the page opened by the menu item link replaces the current page.
  • "New window": a new tab opens in the browser to display the page called by the item link.

Display in vignettes

A vignette can contain several menu items. They can be assigned from a selection window that allows multiple selections, or from the vignette page.

Classification

Categories

Menu items can be associated with categories. They can be assigned from a selection window that allows multiple selections.