How to make a class representation visible on a mobile device
This ‘How-to’ provides information on how to add a newly-created representation to the Sage X3 client portal which can be displayed on a mobile device. This is achieved by defining and amending three components of the portal:
Dashboard: A dashboard is displayed in a browser tab when a user connects to the web server.
Vignettes: A vignette (also called portlet) is an autonomous component displayed in a dashboard.
Menu items: A menu item defines a link present in a portal vignette that points to a page managed by the software.
The representation is defined on a menu item, which will be contained in a vignette that appears on a dashboard, or as an application on a mobile device.
Your representation class must be set for a mobile phone (field Screen type = Mobile phone under the General tab > Type block).
Vignettes are created and maintained by selecting the Vignettes link in the Personalization portal component displayed on your ‘Home’ dashboard.
Selecting the Vignettes link displays a query facet screen with the list of existing vignettes.
To create a new Vignette, click the Create hyperlink on the right panel, and then set the following field values:
Title: The title of this vignette. This field is mandatory.
Type: Must be set to Menu.
Application: To associate this vignette with a specific application, enter the required application or select one from the list of available applications. If this vignette is to be displayed on all dashboards, leave this field blank.
Endpoint: An endpoint is a connection point associated with a specific service. To associate your representation with a Sage X3 folder, enter the endpoint or select from the list of available endpoints. Alternatively, leave this field blank.
If the menu item(s) to be added to this vignette currently exist, add them in the Content block. If you have not created your menu item at this stage, you can add menu items to Vignettes within the Menu items application.
Menu items are created and maintained by selecting the Menu Items link in the Personalization portal component displayed on your ‘Home’ dashboard.
Selecting the Menu Items link displays a query facet screen with the list of existing menu items.
To create a new Menu item, click the Create hyperlink on the right panel, and then set the following field values:
Code: You should use a table code defined for a master table.
Title: The name (menu item) to be displayed. This field is mandatory.
Link type: Must be set to Representation.
Application: To associate this menu item with a specific application, enter the required application or select from the list of available applications. This field is mandatory for Representation link types.
Endpoint: As this menu item is to be displayed in a vignette, you must enter the endpoint or select from the list of available endpoints. This should be the same endpoint you defined for your vignette.
Representation: This should be set to the Sage X3 representation defined for the Sage X3 class required for this menu item, for example, your mobile phone representation. This field is mandatory for Representation link types.
Entity: This should be set to the Sage X3 class required for this menu item. This field is mandatory for Representation link types.
Dashboards are created and maintained by selecting the Dashboards link in the Personalization component displayed on your ‘Home’ dashboard.
Selecting the Dashboard link displays a query facet screen with the list of existing dashboards.
A new dashboard must be created for menu items to be available on a mobile device. Select the Create dashboardDef hyperlink on the right panel, and then set the following field values:
Title:. The name to be displayed. This field is mandatory.
Description: A user-friendly description for the title.
Dashboard name: An identifiable name or code for your dashboard. This field is mandatory.
Mobile dashboard: Select this check box.
Each master (Home) dashboard can have multiple variants associated with users, endpoints, roles, and an individual’s connection settings. You add your vignette and menu items to a variant.
Select the Add action.
Add the following details for your new variant:
Code: An identifiable code for your dashboard variant.
Title: The default title for your dashboard variant.
Description: A user-friendly description for the title.
Applies to all applications: Select this check box if this new dashboard variant should be available on all applications or endpoints.
Application: Enter the specific application or endpoint that this variant should be available for, or select from the list of available applications.
You can now add your vignette to this variant.
Click the down arrow on this variant line. This will open a card view with tabs allowing details to be entered on Vignettes, Roles, Users, and Endpoints. As you only want to add a vignette, select the Add action from the Vignettes tab.
A query facet screen showing the list of available vignettes is displayed. Select the check box for your vignette, and then click Accept.
Save your dashboard. Your vignette and menu items will now be available from your dashboard.
To make your vignette and menu items available from a mobile device, select Mobile Desktop Authoring (or personalization) from the User Preference Panel (Dashboard block link panel).
Note: The User Preference Panel can be displayed by clicking the User Preference Panel icon on the Upper Bar.
A mobile phone emulator screen is displayed. Select either:
Locate your vignette. To download and install your vignette for a mobile device, select Add.
From the View drop-down, your new Dashboard will appear in the list of available views.
Note: You may need to log out and log back in to your portal for your new dashboard variant to become available. When logging in, you should return to your normal home portal.
Select your new dashboard and your portal should display as you have designed it.
The vignette will be displayed on the emulator window as an application. Click your vignette to start the application. The Menu items for your class representations are displayed on a list for selection.