Configure Start Screen Content
Contents
Introduction
The Dynamic Configurable start screen feature allows the UBIK Service engineer to tailor the buttons on the start screen according to the needs of the customer.
Setup
- The first step is to configure the start screen data using an xml in order for UBIK® to recognize the different tabs and buttons. The xml file should be placed in a subfolder under the "UBIK" folder on the device's SD card.
- After the folder is configured, the next step is to validate the schema against an online validator. A solution can be found at Online XML Schema Validator. The schema used to validate against will be found inside the UBIK Folder and is named ConfigurableStartScreenSchema.
The following xml shows an example configuration:
<Tab caption="Content">
<ContentBrowserButton caption="Content Browser"/>
<ContentBrowserButton caption="My Tasks" UBIK-UID="5baf5be8-ed79-11e3-83b1-82687f4fc15c" iconPath="tasks.png"/>
</Tab>
<Tab caption="AR">
<MapsButton/>
<PoiViewButton caption="AR View"/>
<CustomIntentButton caption="Map of Linz">
<TargetURI>
https://www.google.com/maps/place/Linz/@48.295065,14.327405,12z/data=!3m1!4b1!4m2!3m1!1s0x47739595fa99854d:0x7c53292c577975c4
</TargetURI>
</CustomIntentButton>
</Tab>
</StartScreenConfiguration>
Tab Groups
The user can configure tab groups in the XML, however the allowed number of tabs to configure may vary depending on the screen size of the device. As parameters, the caption is mandatory.
Buttons
Buttons should be placed inside tab elements and can be parameterized. Buttons are configurable in terms of
- Icon
- Caption
- Group/tab
- Action + Parameters if needed
For now, the supported button types are the following, they are categorized based on their availability in specific projects:
UBIK.Android.UI:
- Content Browser Button
- Custom Intent Button (using a customized intent URI or target class)
UBIK.Android.Kernel.AR:
- Maps Activity Button
- ID Marker Scanning Button
- QR/Barcode Scanning Button
- POI View Button
- Configurable AR Button
- Configurable Image Marker Button
UBIK.Android.ARNavigation:
- AR Navigation POI View
- AR Navigation Maps View
UBIK.Android.RAG:
- RAG Navigation Maps View
UBIK.Android.Demo:
- Demo Navigation Maps View
Additionally, Button parameter configurations should maintain the following guidelines:
- When either the caption parameter or the icon parameter is not explicitly customized in the xml file, default caption and icons, specific to each button, are used.
- While configuring the custom intent button, either target class or target URI should be specified, but not both and not neither. The later two cases will result in an error.
- The configuration of the UID parameter is obligatory for AR Navigation POI View Button, AR Navigation Maps View Button, RAG Navigation Maps View Button and Demo Navigation Maps View Button.
Results
The result is that the tabs and buttons configured in the XML file will be visible and open the right activity once they are clicked.