Overview
The Mobile Integration Broker app lets you design pages and UI components for a mobile device. Pages are exposed through the “Integration Broker Device” scenario and consumed by a mobile app/client, which renders the UI starting from a JSON configuration.
Setup configuration (Config Entity)
What it does
Defines which Config Entity will be returned by the CONFIG action, used to provide the device with environment parameters (settings, defaults, code lists) without reading transactional data.
How to use it
1. Open the extended Setup page “NBT_IBK Setup”.
2. In the “Config Entity” field, enter the code of the desired entity.
3. Save the page.
4. On the device/integration side, run the CONFIG action to retrieve the Config Entity JSON.
Notes / tips
Use a Config Entity when you need to provide “environment” parameters to the device (e.g., settings, defaults, mappings) separately from transactional data.
Configure Actor and scenario “Integration Broker Device”
What it does
Sets up the Actor that exposes pages and actions to the mobile client through the “Integration Broker Device” scenario.
How to use it
1. Open the Actor card “NBT_IBK Actor Card”.
2. Set the Scenario field to “Integration Broker Device”.
3. Save the Actor card.
Protected parameters (SaaS vs OnPrem)
Depending on your deployment (SaaS or OnPrem), fill in the required protected parameters on the Actor. These values are used by the mobile client to authenticate and determine the initial page.
SaaS
Required protected parameters:
CLIENTID, CLIENTSECRET, TENANTID, HOME
Steps:
1. On the Actor card, open the protected parameters section/action.
2. Fill in: CLIENTID, CLIENTSECRET, TENANTID and HOME.
3. Save.
OnPrem
Required protected parameters:
USERNAME, PASSWORD (and HOME if applicable)
1. On the Actor card, open the protected parameters section/action.
2. Fill in: USERNAME and PASSWORD (and HOME if applicable).
3. Save.
Connection QR and encoded/clean strings
What it does
Displays, on the Actor card, a QR code and two connection strings (an “encoded” version and a “clean” version) to be used on the device.
How to use it
1. Make sure the Actor Scenario is “Integration Broker Device”.
2. Verify the required protected parameters are filled in (see 4.1).
3. On the Actor card, locate the QR/Connection section.
4. Scan the QR with the device or copy the “clean/encoded” string into the mobile client, according to the mobile app instructions.
Notes / tips
If the QR or strings are not shown, re-check the scenario and protected parameters; in many cases, saving and reopening the Actor card is enough.
Device pages management (list and card)
What it does
Lets you create and maintain the pages that the mobile client can render.
How to use it
1. From the app Dashboard, select “Device Pages” to open the list.
2. Select New to create a page.
3. Fill in at least “Code” and “Description”.
4. Open the page card to add rows/elements (chapter 7).
[Screenshot: Device Pages]
Page fields: Code, Description, Default Focus Bind
What it does
Defines the page identifier (Code), the user-facing description, and the default focus used by the device when the _FOCUS parameter is not provided.
How to use it
1. Open the device page card.
2. Set “Default Focus Bind” if you want an initial focus.
3. Save.
4. If the device does not pass the _FOCUS parameter, the default focus is applied.
Define page elements (subform)
What it does
Lets you build the page layout by adding UI elements (fields, labels, buttons, etc.).
How to use it
1. Open the device page card.
2. In the “Page SubForm”, insert a new line.
3. Fill in the key fields: Line No., Priority, Element Type, Bind, and Label.
4. Repeat for all required elements.
5. Save the page.
[Screenshot: Page SubForm]
Basic properties and layout (Row Type / Element Type)
What it does
Controls the element layout through Row Type and defines the element behavior through Element Type.
How to use it
1. For each element, choose the Row Type that best matches the desired layout.
2. Choose the Element Type based on the data/action you want to expose on the device.
3. Save the page and verify the result on the device.
Style, icons, validations and scanner
What it does
Lets you configure element style and behavior: emphasis (bold), colors, icons, validation through regular expressions, and scanner activation.
How to use it
1. Open the element line in the page subform.
2. Fill in the needed fields (depending on the use case): Bold, Background-Color, Text-Color, leading-icon, trailing-icon.
3. If validation is required, set RegularExpression.
4. If the user must capture a code (barcode/QR) from the device, enable EnableScanner.
5. Save and test on the device.
Action parameters (Function Parameters)
What it does
Associates additional parameters to the element for actions/operations (e.g., click, serialize), which will be included in the element JSON.
How to use it
1. In the page subform, select the target element.
2. Run the “Function Parameters” action.
3. Enter the required parameters (e.g., ACTIONCODE, ENTITY, PAGENO, WHERE, TOP, SKIP, MODE, etc.).
4. Confirm and save the page.
Notes / tips
Document internally the standard parameters used in your project to keep consistency across different pages.
[Screenshot: Function Parameters]
Label translations
What it does
Manages translations for element labels/captions based on the language set on the Actor (LANGUAGE parameter).
How to use it
1. In the page subform, select the element to translate.
2. Run the “Translations” action.
3. Enter the “Language Code” and the translated “Caption”.
4. Repeat for all required languages.
5. Save.
Notes / tips
If no translation exists for the requested language, the element’s default label will be used.
[Screenshot: Page Element Translation]
Scenario actions and JSON output
The “Integration Broker Device” scenario exposes a set of actions that the mobile client can call. Actions return (or consume) data in JSON format.
Prerequisites
Actor with Scenario = “Integration Broker Device”.
Protected parameters filled in (see 4.1).
If required, input parameters such as PAGENO, ENTITY, WHERE, TOP, SKIP, MODE.
Available actions
Action |
Short description |
HOME |
Opens the page indicated in the protected parameter HOME. |
PAGE |
Returns the JSON of the requested page (PAGENO). |
SERIALIZE |
Serializes Entity data with TOP/SKIP/WHERE filters. With MODE=SINGLE returns one record. |
CONFIG |
Returns the JSON of the Config Entity defined in Setup (chapter 3). |
DELETE |
Performs a delete based on WHERE filter and reports the result through _SUCCESS. |
[Screenshot: Scenario Actions]
Example usage (general logic)
1. The device requests HOME to get the initial page.
2. When the user navigates, the device requests PAGE with the page number/code.
3. To read data, the device uses SERIALIZE specifying ENTITY and filters (WHERE, TOP, SKIP).
4. To read settings, the device uses CONFIG.
5. To delete records (if part of the process), the device uses DELETE with WHERE.