Portal generation tool

The portal generation is a tool used to convert the version 6 portal with all of the menu links associated with a user or a trade code. Its purpose is to generate the appropriate dashboard on the Version 7 Platform.

For information on the launch of the generation, see the Administration reference dashboard upgrade document.

Generation principles

Generation is performed by analyzing the portal, the menu profile, and the user or the trade code favorites; and creating the corresponding elements in the administration database:

  • A variant of the home dashboard that has access to the main portal (all dashboard tabs are on the same portal).
  • A set of portlets present in the portal (processes, statistical inquiries, web pages, main menu, favorites menu, and so forth).
  • A set of menu items corresponding to single portlets, or present in menu portlets.
  • A set of additional dashboards to manage the menu hierarchy. A dashboard is created for every first level menu entry of the main menu and favorite menus. On every dashboard, a menu portlet is created by the second level of the menu.

Example of generation

VERSION 6 MENU CONFIGURATION GENERATED VERSION 7 DASHBOARD
If a user called USER1 has the following portal:
  • A first vignette displaying a visual process VP1.
  • A second vignette presenting a request REQ1.
  • A third vignette with the menu with the following hierarchy.
 The generation will create:
  • A dashboard variant of the default home dashboard with 3 portlets: the visual process VP1, the request REQ1, and the main menu.
  • The main menu will have three lines: Development, Setup, and Main data. Each line is linked to another dashboard.
  • The Development dashboard setup contains 2 vignettes: Data Dictionary and UI description. Data dictionary contains 2 menu entries (Tables and Data types) and UI description contains one menu entry (Classes representation).
  • The Setup dashboard contains 1 vignette: Dictionary Setup. It encloses all the functions present in the sub-menus (Accounts, Auto journal comparison, and Reports). The intermediate menu level (Accounting setup and Purchasing setup) disappears.
  • The Main Data dashboard contains 1 vignette: Customer data. This vignette includes the Companies menu entry and all the functions present in the Business partners menu entry.

Element naming rules

In a Sage X3 folder, many menu entries are present. A potential entry exists for every function, and every user can have different options and configurations. As more than 2,000 standard functions exist in Sage X3, the number of combinations of menu entries for functions, portlets, and dashboards exceeds thousand entries; this makes it difficult to manage if all entries must be created in the administration database.

For this reason, the generation algorithm has been written to minimize the number of entries created. This is performed by applying the naming rules summarized in the next table.

For the name description:

  • Every Name in italic bold and upper/lower case combination refers to a variable.
  • The uppercase NAMEs are constants.
  • The undercore is the separator between the segments.
Menu items naming rules
Element Codification
Standard ERP function with no parameter STD_FunctionCode
Standard ERP function with parameters (such as EXEALH/RequestCode, AIMP/ReportCode) PAR_FolderCode_FunctionCode_ParameterValue
Specific ERP functions with a name starting with X, Y, or Z with no parameter SPE_FolderCode_FunctionCode
Specific ERP functions with a name starting with X, Y, or Z with a parameter SPE_FolderCode_FunctionCode_ParameterValue
Portlet naming rules (also used for the menu item referring to them)
Element Codification
Standard portlet menu identical to the administrator standard menu (identical means that all the sub-menus are the same) USR_FolderCode_AdminCode_MenuCode
Other menus USR_FolderCode_MenuProfileCode_MenuCode
Other portlet menus identical to the administrator standard menu (identical means that all the sub-menus are the same) USR_FolderCode_admin
Main menu portlet for a user USR_FolderCode_UserCode
Favorite menu portlet for a user FAV_FolderCode_UserCode
Main menu portlet for a trade code TRD_TradeCode_UserCode
Other portlets found in the user portal USR_FolderCode_UserCode_PortalModuleCode
Other portlets found in the trade code portal TRD_TradeCode_UserCode_PortalModuleCode

The following codes are used:

  • AdminCode is the code of the Sage X3 administrator in the folder (ADMIN by default).
  • FolderCode is the code of the folder in which the portal information has been found.
  • FunctionCode is the code of the Sage X3 version 6 function. This is not a Syra Classic link, but it is a version 7 native link if a class and a representation exist.
  • MenuCode is the code of the current menu in the menu profile.
  • ParamValue is the value of the parameter associated with a function when it exists.
  • PortalMenuCode is the code of the portal module (CODMOD column in APORTMOD table). This code usually looks like "TxMy" where x is the tab number and y is the portlet number in the tab.
  • TradeCode is the trade code for which the dashboard generation is executed.
  • UserCode is the code of the user for which the dashboard generation is executed.