Mobile gadgets
| Administration Page | Application/Contract | Syracuse/Collaboration | Class | mobileGadgets | Representation | mobileGadget |
|---|
A mobile gadget is very similar to a menu item, but some types of menu items (for example the Classic pages) cannot be considered for mobile gadget usage.
In summary, a mobile gadget defines a link to a page that can be displayed on a mobile device The page that sets up a mobile gadget includes several sections:
| Information | Content | Parameter |
Information
Defines the main characteristics of the gadget including the following:
Code
Defines an internal code that does not display.
Title
Defines a title that displays when the gadget is used. You can translate the title into any language using this link:
You can enter descriptions in different languages using the corresponding widget.
Description
Provides a user-friendly description for the dashboard. You can translate the description into any language using a similar link.
Factory
This check box indicates if the record is supplied as a factory record. In this case, a factory code displays that you can enter if you are a factory provider. This features prevents some modifications on default records that are supplied by Sage or by a vertical solution provider. More information about this feature is given in the following document.
Gadget type
Indicates what kind of page is called if the gadget is activated. The following choices are available:
- Representation is a page that manages a facet of an entity. The user needs to enter an entity, an associated representation, and a facet.
- Request is a page that manages a request created by the requester. The user needs to enter a request name and a level.
- Statistics is a page that manages a statistical inquiry. The user needs to enter a statistic name.
- Dashboard page is a link that brings the user to another [mobile dashboard](../administration-reference/mobile-dashboards.md). The code of the dashboard is required.
- External link is used when the menu item links to a URL that needs to be provided.
Icon
Indicates the file name and repository of the icon to display.
Factory
This check box indicates if the record is supplied as a factory record. In this case, a factory code displays that you can enter if you are a factory provider. This features prevents some modifications on default records that are supplied by Sage or by a vertical solution provider. More information about this feature is given in the following document.
Content
Based on the previous type, additional information must be entered in this section:
Application
Entered for Representation, Requests and Statistics gadget types. Refers to the application used for the link.
Endpoint
Can only be entered for Representation, Requests and Statistics gadget types.
Representation
Entered for Representation link types only. Defines the representation used for the user interface. This representation is linked to the entity; therefore, only some representations are available for a given entity. A selection is possible under the same conditions as for the entity definition. Only a representation attached to the previous entity can be used.
- If the application is a _Syracuse collaboration_.
- If it is _$$PRODUCT_ and if the [endpoint](../administration-reference/endpoints.md) (Sage X3 folder) is identified for the menu item.
If the application is $$PRODUCT but the endpoint is not known, a selection is performed if a default endpoint has been set up for $$PRODUCT type endpoints.
Mobile dashboard
Entered for Dashboard link types only. Defines the dashboard referenced.
Entity
Entered for Representation link types only. Indicates the entity managed by the page. A selection is possible:
- If the application is a _Syracuse collaboration_.
- If it is _$$PRODUCT_ and if the [endpoint](../administration-reference/endpoints.md) (Sage X3 folder) is identified for the gadget.
If the application is $$PRODUCT but the endpoint is not known, a selection is performed if a default endpoint has been set up for $$PRODUCT type endpoints.
Request name
Entered for Request link types only. Defines the code of the request to be displayed.
Request level
Entered for Request link types only. Defines the level to be displayed (0 to 99).
Statistics name
Entered for Statistics link types only. Defines the code of the statistic report to be displayed.
Facet
Entered for Representation link types only. Determines the facet of the representation that is used. The following facets can be selected:
- Query is used to display a page that lists the entity values that are used to display the details of an entity instance, to edit it, or to create a new instance.
- Details is used to display the details of an entity instance. A key value must be entered.
- Edit is used to modify the details of an entity instance. A key value must be entered.
- Summary is used to display the summarized information associated with an entity instance. A key value must be entered.
Action
This information is only entered for a representation. It defines which kind of action (and therefore which facet) is used. The possible choices are:
- Query: a query page displays for the entity
- Details: a detail page displays (the key element is required)
- Edit: an edit page opens (the key element is required)
- Create: a page opens to create a new record
Key
This is the key value for a detail, edit, or summary facet. The key is entered in character format. If the key has several components, the components are separated by a tilde ~ character. For example, an account number 73ABC defined in the USA chart of accounts is entered as USA~73ABC.
Parameters grid
Depending on the entity, additional parameters may have to be entered. If this is the case, the name and title columns are filled and the value column must be entered.
The parameters available may depend on the page called. Some standard parameters exist especially for query facets, and are documented here.