Example
Code Block | ||
---|---|---|
| ||
<application> ... <pages> <page id="MainMenu" type="Menu" icon="icon"> <title defaultValue="Mobile WMS" /> <menuConfiguration> <menuItems> <menuItem id="Receive" displayName="Receive" icon="mainmenureceive"/> <menuItem id="BinContent" displayName="Bin Content" icon="mainmenubincontent"/> </menuItem> </menuConfiguration> </page> ... <page id="Receive" type="OrderList" icon="mainmenureceive"> <title defaultValue="Receive Orders" /> <orderListConfiguration> <service id="Receive" /> <filter configurationKey="ReceiveOrderFilters" /> <list listId="Orders" /> <onOrderSelected navigateTo="ReceiveLines" /> <unlockOrder title="Release {BackendId}"/> </orderListConfiguration> </page> ... <page id="BinContent" type="Lookup" icon="mainmenubincontent"> <title defaultValue="Bin Content" /> <lookupConfiguration type="BinContent"> <header configurationKey="BinContentCfgHeader" /> <request documentName="Lookup" /> <list listId="Lookup" /> </lookupConfiguration> <actions headerTitle="Actions for Item {ItemNumber}"> <open id="UnplannedMove" title="Unplanned Move (Max {Quantity})"> <transfer property="LookupSelectedResult" to="UnplannedItemRegistrationInputValue" /> <returnTransfer property="UnplannedItemRegistrationCompleted" to="RefreshOnResume" /> </open> <adhocRegistration id="binContentAdHocRegistration" title="Notify backend" registrationType="Notify" /> <print id="printOrderLabel" registrationType="Label" title="Print Label" sendOrderData="true" /> </actions> </page> <menu numberOfPromotedItems="2"/> </pages> ... </application> |
Sections
- <page> - Overall container of configuration parameters of configuration parameters for a page. page
- id = "" - Id for referencing the page from other pages. This id must match that of the associated menu item
. - type = "" - Sets the type of page,
enabling different - enabling different functionality per type.
This value also - This value also affects the
configuration element. - configuration element
- Lookup - Used for e.g. Bin Content, and contains a filter, which can be toggled
.- configuration element
- Menu - The main screen when logged in. Defines which types of work can be performed. In combination, the configuration and the backend
defines - define which items are available
.- OrderLines - Used to display a list of order lines.
Example - Examples of which can be Receive, Put Away etc.
- OrderList - Displays a list of orders. The page contains a filter, can be filled with values from reference data, and used to filter down the list
.- Registrations - Displays a list of order line registrations. This page also enables the user to delete a single or all registrations
.- Settings - Contains information
of - on the client version and the
data base - database version
.- UnplannedItemRegistration -
Can - This can be used for unplanned work, such as Unplanned Move, and contains a
sticky area in - sticky area at the top of the page for entering values
.- icon = "" - Reference to the image
resource to - resource to display when the page is open
.- <title>
- defaultValue = "" - Sets default title value of the page, which is displayed in the header.
- enabled = "" -
Dictates - Defines if the page can be displayed. It still has to be added
in - to the menu configuration
.e- labelId = "" -Reference to a label
which - that can override the default title value
.- <actions> Actions allow one page to open another, and send data between them
.- headerTitle = "" - Used as a header for all action items
.<onSuccessfulPost> - Determine what to do after a successful submit of the call to print- <open> - Defines a page to open, and which properties to transfer to that page, and which to return from the opened page.
- id = "" - Id of the page which should be opened.
- <transfer> - Defines the mapping of a property between the current page and a page which should be opened. It is important to match the properties to the page in question. Both in regards to the current page, but also the page to open.
- property = "" - Defines the property to transfer to a new page.
- LookupSelectedResult - A property on the Lookup page holding the selection made, which can be transferred to a new page.
- OrderLinesSelectedLine - Reference to the selected line of the order lines page.
- to = "" - Reference to the property on the receiver page.
- LookupInputValues - Reference to the input values of the lookup page. The list of values are mapped to input fields on the opening page.
- UnplannedItemRegistrationInputValue - Reference to the input values of the unplanned item registration. The list of values are mapped to the input fields on the opening page.
- property = "" - Defines the property to transfer to a new page.
- <returnTransfer> - Defines the mapping of a property between the opened page and the current page.
- property = "" - Defines the property of the opened page to get values from when returning.
- LookupPostCompleted - Property indicating whether posting on the opened page went well.
- UnplannedItemRegistrationCompleted - Property indicating whether posting on the unplanned page went well.
- to = "" - Reference to a property on the current page to receive the value from the opened page when returning.
- RefreshOnResume - Reference to the refresh on resume property on all pages, allowing an update to be called only on successful post by opening page.
- property = "" - Defines the property of the opened page to get values from when returning.
- <adHocRegistration> Defines a custom call to the backend with a custom request that the backend will handle, and what to do after a successful post
- registrationType - The registration type that will be sent to in the request. The registration type can be used on the backend to call a certain custom function etc.
- documentType - The default document Type is "PostAdhocRegistration" but if needed this can be overwritten
- sendOrderData - if true the data that is normally included in the PostOrder will be included in the request to the server. The order tag will be added to the response. The default is false. Notice that this is only valid in Order and OrderLinesPages
- <onSuccessfulPost> - Determine what to do after a successful submit of the call to print
- <open> - Defines a page to open, and which properties to transfer to that page, and which to return from the opened page.
<print> - Defines a call to the backend with a print request (a special adHocRegistration), and what to do after a successful post- registrationType - The registration type that will be sent to in the request. It could be Label, SalesReceipt etc.
- documentType - The default document Type is "Print" but if needed this can be overwritten
- sendOrderData - if true the data that is normally included in the PostOrder will be included in the request to the server. The order tag will be added to the response. The default is false and only valid in OrderPages and OrderLinesPages
- <menu>
- numberOfPromotedItems
- The menu items will only be promoted if there is available space on the screen
If there are more menu items than added as promoted items a "Menu" menu item will be added to open the popup menu
The number of promoted items defines how many menu items will be placed on the menubar outside of the popup menu
The promoted items are based on the placement defined on the individual menu items
Set the number of promoted items to -1 to let the system place as many menu items outside the popup menu as possible.
- The menu items will only be promoted if there is available space on the screen
- numberOfPromotedItems
- The elements described below are placed under the page element, and belong to the specific page type.
- <lookupConfiguration> - Configuration for the Lookup page type. Lookup Configuration
- <menuConfiguration> - Configuration for the Menu page type. /wiki/spaces/SD/pages/78939911 Menu Configuration
- <orderLinesConfiguration> - Configuration for the OrderLines page type. /wiki/spaces/SD/pages/78939899 Order Lines Configuration
- <orderListConfiguration> - Configuration for the OrderList page type. /wiki/spaces/SD/pages/78939896 Order List Configuration
- <registrationsConfiguration> - Configuration for the Registrations page type. /wiki/spaces/SD/pages/78939891 Registrations Configuration
<settingsConfiguration> -Currently there is not configuration available to the settings page. Settings Configuration<Settings Configuration>
- <unplannedItemRegistrationConfiguration> - Configuration for the UnplannedItemRegistration page type. /wiki/spaces/SD/pages/78939888 UnplannedItemRegistration Mobile Configuration
Action examples
As mentioned earlier, the actions allow pages to open other pages, and share data between them.
One example is to perform a BinContent to perform a BinContent and wanting to drill down on down on a specific item. This can be achieved by creating an action opening a new lookup page where the input to the new page is the selection of the current page. LookupSelectedResult → LookupSelectedResult → LookupInputValues
Another example is when performing a BinContent lookup, and wanting to move a selected bin item. Again here, the selection made on the page can be transferred to the input value of the new page, allowing it to prefill values of the same name. LookupSelectedResult → UnplannedItemRegistrationInputValue
See Page Navigation