Making a Class Representation Visible in the Client

Introduction

This document describes 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:

  • Dashboards, which are displayed in a browser tab when a user connects to the Web server.
  • Vignettes, which are autonomous components displayed in a dashboard.
  • Menu items, which define a link to a page managed by the software within a portal vignette.

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

Vignettes

Click Vignettes in the Personalization portal component displayed on the Home dashboard to create and maintain vignettes. A query facet screen with the list of existing vignettes is displayed.

To create a new vignette:

  1. Click Create on the right-hand panel.
  2. In the Information block:
    1. Enter the title of the vignette in the Title field. This field is mandatory.
    2. Set the Type field to "Menu".
  3. In the Filter block:
    1. In the Application field, enter the name of the application you want to associate the vignette to, or select it from the list of applications available. If the vignette must be displayed on all dashboards, leave this field blank.
    2. In the Endpoint field, enter the name of the endpoint you want to associate your representation to, or select it from the list of endpoints available.
      Leave it blank, if necessary.
  4. In the Content block, add the menu items to be added to the existing vignette.
    If you have not created your menu item yet, you can add menu items to Vignettes directly within the Menu items application.

Click Menu Items in the Personalization portal component displayed on the Home dashboard to create and maintain menu items. A query facet screen with the list of existing menu items is displayed.

To create a new menu item:

  1. Click Create on the right-hand panel.
  2. In the Information block:
    1. Enter a table code defined for a master table in the Code field.
    2. Enter the name to be displayed in the Title field. This field is mandatory.
    3. Set the Link type field to "Representation".
  3. In the Content block:
    1. In the Application field, enter the name of the application you want to associate the menu item to, or select it from the list of applications available. This field is mandatory for representation link types.
    2. In the Endpoint field, enter the same endpoint name you entered for the vignette, or select it from the list of endpoints available.
    3. Set the Representation field to the Sage X3 representation defined for the Sage X3 class required for the menu item. This field is mandatory for representation link types.
    4. Set the Entity field to the Sage X3 class required for the menu item. This field is mandatory for representation link types.

  4. In the Display block, enter the required vignette codes, or select them from the list of vignettes displayed. You can also, create a vignette and add the menu items via the Content fields of the Vignettes application.

Dashboard variants

Click Dashboards in the Personalization portal component displayed on the Home dashboard to create and maintain dashboards. A query facet screen with the list of existing dashboards is displayed.

To create a dashboard variant:

  1. Select your Home dashboard definition.
    The list of existing dashboard variants is displayed.
    Each Home dashboard can have multiple variants associated with users, endpoints, roles, and an individual connection settings. You can create a new variant of the Home dashboard, and add your vignette and menu items to that variant.
  2. Click Edit in the right-hand panel.
  3. Click Add in the Variants block.
  4. Enter the following information for your new variant:
    1. Enter an identifiable code for your dashboard variant in the Code field.
    2. Enter the default title for your dashboard variant in the Title field.
    3. Enter a user-friendly description for the title in the Description field.
    4. Select Applies to all applications if the new dashboard variant must be available on all applications (or endpoints).
    5. In the Application field, enter the specific application (or endpoint) the variant should be available for, or select it from the list of applications available.
  5. Save your dashboard variant.
    Your vignettes and menu items are now available from the dashboard variant screen.

Completed result

You can select the new Dashboard variant from the Views drop-down list.

Note: You may need to log out and then log back in to your portal for the new dashboard variant to be available. After logging in, return to your regular home portal.