Mobile pages UI

The update 9 of Sage X3 provides a new user interface suitable for both mobile phones and tablet devices. This document describes the new user interface.

The technical repository describing the new dashboards is different, and it is detailed in the following document. On the server, the description of classes and representations used remains the same although improvements have been made.

From a user interface point of view, the navigation and the behavior of the mobile pages are slightly different for following the reasons:

This document details how these new mobile pages work for the following topics:

Accessing the new interface

When a user connects to a Sage X3 site in product update 9, the user preference panel shows various links at the bottom. For compatibility reasons, the links to the two previous clients (the mobile for version 7, the tablet for version 7) are still available. A new link on the right provides access to the new product update 9 mobile/tablet client:

The primary access URL is different for each UI and reflected in the list below:

User interfaceURL
Desktop UIhttp://my_server:service/syracuse-main/html/main.html?url=%3Frepresentation%3Dhome.%24landing
V7 tablet UIhttp://my_server:service/syracuse-main/html/main-tablet.html?url=%3Frepresentation%3Dhome.%24landing
V7 desktop UIhttp://my_server:service//syracuse-mobile/html/mobile.html#start
V9 mobile/tablet UIhttp:/my_server:service//syracuse-tablet/dist/index.html

The main welcome page

When opening the new client, the welcome page displays Tiles that give users access to different applications by tapping the icon.

While the page loads, the following animated icon displays:

Arranging tiles

The size, text, and icons of the different applications are set up in authoring mode. The relative positions of the tiles depend on the dimensions of the device for a given setup. To illustrate this, here is a layout of three Tiles that varies based on the size of the device:

Page layout

The Configure icon on the bottom of the page allows you to rearrange tiles and to add more tiles.

When you tap the Configure icon:

The page switches to design mode:

Several actions are now possible:
* Delete a Tile by tapping the trash can icon located in the upper-right corner of the tile. No confirmation is required to do this.
*
Set up a tile by tapping the pen icon located in the lower-right corner of the tile.
* Add a new application by tapping the green "Add apps" icon located in the upper-left corner of the page.
* Exit design mode by tapping the red X located in the upper-right corner of the page.

Tile setup

The Tile setup page allows you to change the title, color, relative size, and associated icon.

  • Available colors are shown in the color picker.
  • Tap a size box to apply one of the tile sizes below:
    • Small is the smallest square size.
    • Medium is an intermediate square size.
    • Large is the largest square size.
    • Wide is an average horizontal rectangle size.
    • Full height is a vertical rectangle size that fills the entire height of the page.
    • Full page is a Tile that fills the entire page.
  • The relative sizes can be seen is this picture:
  • Tap a picture icon to display it on the Tile.


Adding an application

To add an application, tap the corresponding icon and select an application from the page that opens. Currently available applications are present in the list. Tapping an application selects it; tapping again deselects it. You can select several applications. Tap the green check mark to install the selected application or applications. Tap the red X to exit this mode without adding any applications.

Note:

Another way to add a Tile on the main page is to bookmark pages. The bookmarked pages link displays in a different category (My quick links rather than My applications):

The procedure to do this is described here.

Installing an application

If a new application is available on the server, the new Tile displays with an install icon in the upper-left corner:

Tap the Tile to install the new application. If you do not want to use the application, you can delete the Tile and the application is not suggested again. You can, of course, use the Add application link to find it again in the list of available applications.

Updating an application

If an application is updated on the server, a small icon displays in the upper-left corner of the tile:

When you tap the tile, you are asked if you want to update the application:

Tap Yes to install the update. The page fades out and a waiting animation displays until the update is complete (few seconds):

The updated application opens after the download is complete. The small update icon no longer displays.

If you tap No, the current version of the application launches. The small update icon remains until the next time you visit the home page.

Please note that new applications or updates on existing applications are only checked at log in. If your administrator adds a new application while you are already logged in, it will be available after you log out and log in again.

Global setup menu

Tap the user area located in the top-right corner to open a small menu:

The following operations are available:

Change profile

The following page opens with access to several operations:
  • Tap the red exit icon to log out.
  • Tap the green check mark to apply any modifications.
  • Tap the orange X to leave the operation without saving changes.
  • Selecting another endpoint, another role, another language changes the connection parameters.

Settings

The following page opens to set up:
  • The device used (smart phone, tablet, or auto). 'Auto' automatically determines the best layout; it should be used in most cases.
  • The caching of information. The different boxes display the number of records that have been accessed per period of time and the corresponding data volume. When you tap one of these boxes, you are asked if you want to clear the cache, followed by a confirmation:

If you tap the green box again, the cache is cleared. Tap the orange X to cancel the clear cache operation.

The application home page

An application home page can either be a list of links or a collection of gadgets, depending on how the mobile dashboard has been designed.

Home page organization

The following links display:

Tap a menu item to open a gadget. A gadget is the equivalent of a V7 page. Several types are available:
* A Query page displays a list of records.
* A Details page displays a record.
* An Edit page is used to create or modify a record.

You can change the design of the page by changing the color and arrangement of the Tiles.

A home page that contains gadgets displays as follows:

Designing this type of page combines Tile arrangement and the design on a full page (depending on its type). The full design of pages is detailed for every type of facet (query, details, edit).

Design the home page

This section describes the Tile arrangement that is the only available for a list of menu pages.

Tapping the user panel displays the following pop-up menu:

Tap Design page to open the following page:

This page contains the following elements:

  1. The left panel displays the nested structure of the document. For the home page, several levels are present, depending on the structure of the page. Tapping each level changes the right panel and provide access to different parameters.
  2. The central panel shows the page layout according to the current customization choices.
  3. The right panel defines all the customization options and differs for each level.
  4. The top-left area has device settings options.
  5. The top-middle area has global options like create a new layout and delete the page.
  6. The top-right area has options to undo the most recent or all modifications and to save and/or exit design mode.


When designing the home page, an important design level is the Cell level. The right panel associated with it is the following:

The following choices are available:

You can select the background color of the menu item Tile: color selector displays.
You can select the relative size and color of the menu item Tile for different device sizes (smart phone, tablet in portrait, mini-tablet in landscape, tablet in landscape) based on the following:
  • The lateral size of the tablet is divided into 12 squares.
  • For each Tile, you can select a size from 1 to 12 squares.
  • The system places the Tiles from left to right until there is no more room on the row. The next Tile is placed on the row below.
For example, if you create 7 Tiles with different sizes, the system arranges them as shown below:

Query gadget description

A query page can look like this:

This page contains the following elements:

  1. The breadcrumb displays the navigation path to the page and allows you to navigate back to the previous pages by tapping the corresponding title.
  2. The pagination area is used to navigate between pages in the list: the first/previous/next/last icons are present.
  3. The search box is used to perform searches in the list.
  4. The title line displays the title of the columns for the list.
  5. The user panel opens a menu to provide access to additional operation when clicking it.
  6. The sort/filtering link opens a panel used to define how the list must be sorted and filtered.
  7. The status area displays a set of icons that displays depending on conditions based on the line.
  8. The line number.
  9. The icon that links to the detail record.

The design page action allows you to deactivate the different areas: they can be partially present.

Search in queries

When entering a text in the search box, a search is performed on the items in the list.

Sort and filter in queries

When tapping the Sort/filtering link, the following panel displays to sort and/or filter the query:
*Tapping Apply closes the panel and displays the query sorted and/or filtered accordingly.
*Tapping Close closes the panel without changing the previous sorting and filtering options.

By default, the sorting tab is displayed:

The fields present in the query are displayed, and you can tap the ascending and descending arrays to sort the list. Tapping an array a second time deactivates the sort.

When tapping the Filter tab, the following panel displays. You can then select fields, operators, and values to create conditions applied to filter the query. For field and operator selections, dialog boxes display with the following options:

You can then enter a value and tap the check mark to validate the filtering criterion. Several criteria can be added in a filter using the "and" operator.

Design the query page

By tapping the user panel, and then Design page, you display the following design page:

The same areas as for the home page design are present. Two levels of nested elements are present on the left panel. The first is associated with the query page, the second to the grid that contains the list of lines.

Query page structure

The right panel associated with the query page is the following:

The Expert mode and the Data model (prototype) provide access to the technical structure of the document; they should not to be used except by skilled developers.

Tapping Actions displays the following choices:

The first selector indicates if a download action is available on the page and the next information on the panel is a list of actions with icons:
  • To delete an action, tap the X.
  • To edit an action, tap the pen.
  • To add a new action, tap Add an action. Only actions present in the page prototype can be added. The button is grayed-out if no additional actions can be added.
For each action link setup, the following section opens:
  • Select or change the action you want to set up.
  • Select the options for each action:
    • Add to footer/header adds an icon to the appropriate area depending on the device.
    • Refresh page triggers a page reload.
    • Multi-selection allows you to select multiple records before initiating the action. With this option, a column of check boxes displays on the grid to select multiple records.The action then applies to every line selected.
  • You can select an icon for the operation. An icon is mandatory if the footer/header option has been chosen.

Note that some standard actions can already be present by default on the action panel, but using the action setup allows you to change the default icon. Selecting a check box icon for the Creation action changes the icon as shown here:
To validate the action setup, tap Apply. Tapping Cancel exits edit mode without saving changes.

Query grid definition

The right panel associated with the $resources tag of the query page, representing the grid in the query, is the following:

The Data model (prototype) link provides access to the technical structure of the document; it should not be used except by skilled developers.

This panel contains the following elements:

This option allows you to show or to hide labels.
This option allows you to choose between two types of design: the list design or the card design. When the card design is chosen, the following options may change. The list of options given next are those available with the list design.
Select the check box to enable any of these elements for the query page:
  • Pagination links (First page / Previous Page / Next Page / Last page)
  • Enable sorting and selection options
  • Search area
  • Show row detail link on every line
  • Row index on every line
You can select whether a detail page or an edit page displays when tapping a line.
You can decide whether the table header is displayed or not on the page.
This section defines the number of columns in the list and the order for the selected columns. To do this:
  • You can first chose the number of columns to display. The maximum number possible is determined by the prototype.
  • You can then select the columns in a selection list. The fields are determined by the prototype.
  • For each field, you can indicate the best size :
    • Allow the system automatically determine a size
    • Define a fixed size
    • Define a proportion
You can define a fixed size using a slider.
You can define a percentage of the total width using a slider.
For the fields referring to an entity that has a description, you can define if it is hidden and its relative position compared to the field value.
A status column can be managed based on the following principles:
  • You can define as many conditions as you want.
  • Each condition is associated with an icon.
  • The conditions are evaluated in the order of their description.
  • The first condition fulfilled defines the icon displayed.
  • If no condition is fulfilled, no icon is displayed in the column.
When the status is not set to No status, the list of conditions already entered is displayed, and you can:
  • Delete an existing condition
  • Modify an existing condition
  • Add a new condition
To define a condition, you need to enter:
  • A field that can be selected in the list of fields given by the prototype
  • A condition that is given by a combo box whose contents depend on the type of field
  • A value
You can then define the color of the indicator associated with the condition. A color selector is available for this:
Finally, you can select the icon associated with the condition. An icon selector is available for this:
You can validate the conditions you have added by tapping Apply, or exit without saving the changes by tapping Cancel.

When the card design is chosen, it displays in the central panel:

The options that can be chosen are almost the same, except for the following:

The columns are all displayed in the order determined by the prototype and cannot be changed.
You can set the number of cards per row, from 1 to 4.
You can set the minimum width of a card in pixels.
You can define how the empty record located at the end of an incomplete line is displayed:
  • As a blank card
  • As a card with labels only
  • Not displayed
Because card view space is less limited than a line, you can choose:
  • To display no icon by selecting No status
  • To display only the first icon associated with a fulfilled condition by selecting Single status
  • To display several icons if several conditions are simultaneously fulfilled by selecting Multiple status

Description of the Details gadget

A detail gadget page displays a record for an entity such as an order or a customer.

Details page organization

A detail page can have the following design:

This page contains the following elements:

  1. The breadcrumb displays the navigation path to the page and allows you to navigate back to previous pages by clicking the corresponding title.
  2. Data blocks in the page can be collapsible by tapping the corresponding icon.
  3. The user panel opens a menu that accesses additional operations when clicking it.
  4. The bottom left has two icons:
    • Tap the House icon to return to the home page
    • Tap the Pin icon to add this page as a shortcut Tile on the home page
  5. The bottom right displays icons that provide access to several operations such as edit the current record, delete the current record, and go back to list, which are the most common, but others can be added by page design.

The design page action impacts different areas that can look differently or be absent.

Design the details page

By tapping the user panel, and then Design page, you display the following design page:

This page contains the following elements:

  1. The left panel displays the document structure.
  2. The central panel shows the page layout according to the current customization choices.
  3. The right panel defines all the customization options and differs for each level.
  4. The second tab of the left panel is used to add elements.
  5. The top-left area has device settings options.
  6. The top-middle area has global options like create a new layout and delete the page.
  7. The top-right area has options to undo the most recent or all modifications and to save and/or exit design mode.

Left panel: Structure

The nested structure of the document is displayed here. For the detail page, multiple levels can be nested depending on the page structure. Tapping a level displays it in orange and changes the right panel, providing access to corresponding parameters. The different levels used for a detail page are:

  • The first level is the document level (displayed in green). This level can embed several types of elements that can themselves be nested: groups (rows), Tiles (cells), stacks, and fields.
  • A stack groups several sub-elements (rows, cells, fields, and even stacks). A stack can be set up as collapsible: all the sub-elements hide if the stack is collapsed.
  • A row, displayed in green, is an intermediate level that can contain several Tiles, but also direct fields.
  • A cell (or a Tile), displayed in blue, is the element that allows you to create columns by defining their sizes. It can contain fields, but also nested stacks.
  • The field, displayed in purple, is data displayed on the page. This data can be simple (such as a date, a number, a text), but also a grid representing a collection of lines (such as sales order lines).

You can perform the following operations from this panel:

Left panel: Insert operations

This panel displays two sections:

Right panel

On the right panel, you can change the setup for the elements located at every level. Depending on the level, this panel displays different information:

Document level

At this level, you can setup the actions, exactly as for the query page structure.

Stack level

At this level, you can define the layout setup of the stack with the following information:

Assign a title
The stack can be collapsible, and if collapsible, it can be opened or collapsed by default.
Select a theme from a list

Cell (Tile) level

At this level, you can set up the actions, exactly as for the home page tiles design.

Field level

At this level, you can set up the characteristics of the fields present on the page by entering different values, depending on the type of the field:

For each type of field, you can define if the title is displayed or not and how it is positioned and aligned.
When the field is a reference to another entity (for example a customer code, an item reference, a country code), you can define which information linked to the corresponding record should be displayed (title, description, or both in the order you want). You also need to define its position relative to the code (it can be also hidden).
When the field is numeric, you can decide to display it as a gauge. Three types of gauges are possible: default (0-100), static (fixed range), or dynamic (two fields that must be present in the prototype are used as range). The two images below show the parameter input in both cases, which is validated by tapping Apply:
For a gauge, the number of segments that are displayed must be defined from 1 to 5. Tap Apply to save the values entered.
For each segment, you can enter:
  • A range of data values (starting, ending value)
  • The corresponding values on the gauge (the values go from 0 to 1)
  • A color in hexadecimal RGB format
. Tap Apply segments configuration to save the values entered.
When the field represents a collection, the right panel displays a list of options that are almost the same as for the query display, with some exceptions:
  • Label position and label alignment have been added to define the global label associated with the grid
  • Only one option is available on array controls: the row index display
  • No navigation option is present

Description of the Edit gadget

An edit gadget page allows you to create or modify a record for an entity such as an order or a customer.

Edit page organization

An edit page can have the following layout:

An edit page can contain the following elements:

  1. The breadcrumb displays the navigation path to the page and allows you to navigate back to previous pages by tapping the corresponding title.
  2. Data blocks on the page can be collapsed by tapping the down arrow.
  3. The user panel opens a menu that provides access to additional operations when tapping it.
  4. Selection icons are available when a field is a reference to another entity. Tap the eye icon to open a query page and select the corresponding reference.
  5. Tap the calendar icon to select a date.
  6. Because the grid is editable, tap the X to delete the line (if the deletion is possible on the corresponding grid).
  7. Because the grid is editable, tap the pen icon o update the line (if the modification is possible on the corresponding grid).
  8. Because the grid is editable, tap Add row to add lines to the grid (if the addition is possible on the corresponding grid).
  9. The bottom-left has two icons:
    • Tap the house icon to return to the home page.
    • Tap the pin icon to add this page as a shortcut tile on the home page.
  10. The bottom right displays icons that provide access to several operations such as edit the current record, delete the current record, and go back to list, which are the most common, but others can be added by page design.

Design the edit page

The design options for the edit tablet are exactly the same as for the Design page.

Saving the page design

When you are finished customizing a page, tap the global validation icon to save. The following panel opens:

In this panel, you can enter a code, a title, a description, or a comment. The customization can be saved as personal, global, or factory, which assigns it to your default factory code.
Note that this action will save the customization on the server. When you leave customization mode, you see the result. But if you reload the page later, you see the previous page, unless you update your version by using the Update version action in the mobile application definition page.

Manage the data cache

The mobile client uses HTML5 data caching features to store local data previously used by the user. The main principles are the following:
* the page layout of every application is stored in the cache as soon as the application has been launched.
* the data associated to the pages is stored if the page has been accessed. But there is also a way to update the cache by selecting a list of records.
* the settings screen allows cleaning the cache.

Update the cache

Manage cache on a page can be done by using the page personalization. In the page personalization of the query, at the document level, an Allow download selector can be swithed on or off:

When this switch is on, it is possible to perform multi-selection on queries. Depending on the layout(mobile or tablet), the icones are not located at the same place:
For the tablet mode, the switch is located in the top right side of the screen, just under the user identification area:For the mobile mode, it is located on the right panels that opens when clicking on the upper right chevron:
When the multi-selection mode is activated, the user can select several records by clicking on the lines and / or the record, depending on the grid mode used. The number of record selected is displayed:
on the bottom of the page in tablet modeat the top of the page in mobile mode
In both cases, the lines and / or the record can be selected, and the count of selected record is displayed.For instance, you can see here the layout of a tablet page when a multiple selection has been done in record mode:
On multiple selections, a popup displays different choices:
  • unselect or select all.
  • revert the selection.
  • hide the unselected records.
  • any additional operation that can be launched on all the selected lines (this depends on the page).
  • and finally, download the corresponding data.
The download choice allows not only to download the data associated to the details of the entity, but also to the data that can be displayed from links available on the details. Let's for instance imagine that, on a customer details, links exists to display the list of his orders, quotes, invoices, returns with various selections. Based on these links, the system will not only propose to download the selected customers, but the corresponding documents. This is defined by checking the corresponding boxes:
Clicking on the download button will display the following page:
  • The count of the customer will evolve during the download process.
  • On every document, the count of the documents to be downloaded for the current customer is displayed and will evolve as well.
  • It is possible to stop the download process by clicking on the orange bar that displays the global count of data being transferred.