How to make a class representation visible in the client

Introduction

This ‘How-to’ explains how to add a newly-created representation to the Sage X3 client portal. This is achieved by defining and amending three components of the portal:

1. Dashboard: A dashboard is displayed in a browser tab when a user connects to the web server.

2. Vignettes: A vignette is an autonomous component displayed in a dashboard.

3. Menu items: A menu item defines a link present in a portal vignette that links to a page managed by the software.

The representation will be defined on a menu item, which will be contained in a vignette, which in turn,
appears on a dashboard (variant).

Vignettes

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:

Information block:

• Title: The title of this vignette. This field is mandatory.

• Type: Must be set to Menu.

Filter block:

• Application: To associate this vignette with a specific application, type the required application, or select from the List of applications available. 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 type the endpoint, or select from the List of endpoints available. Alternatively, leave it blank.

Content block:

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 directly within the Menu items application.

Menu items

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 hyper-link in the right panel, and then set the following field values:

Information block:

• 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.

Content block:

• Application: To associate this menu item with a specific application, type the required application, or select it from the List of applications available. This field is mandatory for Representation link types.

• Endpoint: As this menu item is to be displayed in a vignette you must type the endpoint, or select it from the List of endpoints displayed. 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. 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.

Display block:

• Display in vignettes: If this menu item is to be displayed in an existing vignette, type the required vignette code(s), or select it from the List of vignettes displayed. Alternatively, create a vignette and add the menu item(s) via the Content fields in the Vignettes application.

Dashboard variants

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.

Select your home dashboard definition.

The list of existing dashboard variants is displayed. Each master (Home) dashboard can have multiple variants associated with users, endpoints, roles, and an individual’s connection settings. You can create a new variant of the home dashboard and add your vignette (and menu items) to that variant.

Select the Edit hyperlink in the right panel. From the Variants block 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: Type the specific application (or endpoint) that this variant should be available for, or select from the List of applications available.

You can now add vignettes 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 displaying the list of available vignettes is displayed. Select the check box for each vignette that is to be added to the dashboard variant, and then click the Accept icon.

Save your dashboard variant. Your vignettes (and menu items) will now be available from your dashboard variant screen.

Completed result

From the Views drop-down, your new Dashboard variant 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 variant and your portal should display as you have designed.