Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • <page> - Overall container of configuration parameters for a 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 functionality per type. This value also affects the configuration element. 
      • Lookup - Used for e.g. Bin Content, and contains a filter, which can be toggled.
      • Menu - The main screen when logged in. Defines which types of work can be performed. In combination, the configuration and the backend define which items are available.
      • OrderLines - Used to display a list of order lines. 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 the client version and the data base version.
      • UnplannedItemRegistration - Can be used for unplanned work, such as Unplanned Move, and contains a sticky area in the top of the page for entering values.
    • icon = "" - Reference to the image 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 if the page can be displayed. It still has to be added in the menu configuration.
      • labelId = "" -Reference to a label which 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.
      • <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.
        • <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.
      • <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
      • <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
        • <onSuccessfulPost> - Determine what to do after a successful submit of the call to printregistrationTy
    The elements described below are placed under the page element, and belong to the specific page type.

...