Jump to: navigation, search

Changes


HowTo:Configure Start Screen Content

1,667 bytes added, 09:18, 31 August 2016
/* Buttons */
== Introduction ==
The Dynamic Configurable start screen feature allows the {{UBIK Service engineer }} user 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® {{UBIK}} to recognize the different tabs and buttons. The xml file, which must have the name '''css_config.xml''', should be placed under '''''SD_CARD''/Android/data/''APP_PACKAGE_NAME''/files/UIConfigurations''' where{| class="wikitable" | width = "50%"|-! Parameter!! Purpose|-| ''SD_CARD''|| represents in the root of the external storage of a device[[UI_Configuration_(Mobile_Client)|-| ''APP_PACKAGE_NAME''|| is the concatenation of "comUI Configurations folder]].augmensys.ubik." and the application name, e.g. ''demo'', ''manualtest'', ''companyname'' etc.|}
* After the folder is configured, the next step is to validate the XML configuration file against the [http://wiki.augmensys.com/index.php/File:Start_Screen_Configuration_Schema.zip schema] using an online validator. A solution can be found at [http://www.utilities-online.info/xsdvalidation/ 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 (also can be downloaded as [http://wiki{{FileLink|Start_Screen_Configuration.augmensys.com/index.php/File:zip|Start_Screen_Configuration.zip }} an xml file]):
<source lang="xml">
<StartScreenConfiguration>
https://www.google.com/maps/place/Linz/@48.295065,14.327405,12z/data=!3m1!4b1!4m2!3m1!1s0x47739595fa99854d:0x7c53292c577975c4
</TargetURI>
</CustomIntentButton>
<CustomIntentButton caption="Skype">
<TargetClass>
com.skype.raider.Main
</TargetClass>
</CustomIntentButton>
<CustomIntentButton caption="Maps">
<TargetClass>
com.augmensys.ubik.demo.lib.ui.activities.ar.map.UBIKMapActivityDemo
</TargetClass>
</CustomIntentButton>
<TargetMapsButton caption="Flow Controller 213" UBIK-UID="2ccd91c0-9cee-42f3-9d1d-be745908457d"/>
<ARNavigationButton caption="Flow Controller 213" UBIK-UID="2ccd91c0-9cee-42f3-9d1d-be745908457d"/>
<NavigationMapsButton caption="Flow Controller 213" UBIK-UID="2ccd91c0-9cee-42f3-9d1d-be745908457d"/>
<DemoMapsButton caption="Flow Controller 213" UBIK-UID="2ccd91c0-9cee-42f3-9d1d-be745908457d"/>
<RFIDScanButton caption="RFID Scan" />
</Tab>
</StartScreenConfiguration>
</source>
 
{{Hint|The config file has to be named '''css_config.xml'''. }}
 
== Tab groups ==
== Buttons ==
Buttons should be placed inside tab elements and can be parameterized. Buttons are configurable in terms of
* Icon(Parameter: ''iconPath'')* Caption(Parameter: ''caption'')* Group/tab(name of tab group)* Action + Parameters Object UID if needed(Parameter: ''UBIK-UID'')
{{Hint|The icons are specified by their relative paths under '''''SD_CARD''/Android/data/''APP_PACKAGE_NAME''/files/UIConfigurations/CSSButtonIcons''' }}
The supported button types are as follows:
* <gallery heights="100">File:UI_Android_CSS_Buttons_Content_Browser.jpg‎|Content Browser Button File: UI_Android_CSS_Buttons_Custom_Intent.png‎|Custom Intent ButtonFile:UI_Android_CSS_Buttons_Maps.jpg|Maps ButtonFile:UI_Android_CSS_Buttons_Maps.jpg|Target Maps ButtonFile:UI_Android_CSS_Buttons_ID_Marker_Scan.jpg|ID Marker Scan ButtonFile:UI_Android_CSS_Buttons_QR_Code_Scan.jpg|QR Code Scan ButtonFile:UI_Android_CSS_Buttons_POI_View.jpg|POI View ButtonFile:UI_Android_CSS_Buttons_Config_AR.jpg|Configurable AR ButtonFile:UI_Android_CSS_Buttons_Config_Image.jpg|Configurable Image Marker ButtonFile:UI_Android_CSS_Buttons_Nav_Maps.jpg|Navigation ButtonFile:UI_Android_CSS_Buttons_AR_Navigation.jpg|AR Navigation ButtonFile:UI_Android_CSS_Buttons_Barcode.png|Barcode Scan ButtonFile:UI_Android_CSS_Buttons_RFID_Scan.jpg|RFID Scan ButtonFile:UI_Android_CSS_Buttons_OCR_Scan.png|OCR Scan Button {{Version/AndroidSince|2.5.0}}</gallery>  {| class="wikitable sortable" | width = "70%"|-! Button!! Purpose !! Parameters|-| ''ContentBrowserButton''|| Opens a content browser for displaying an object or the root if no object/uid is specified.[[File:UI_Android_CSS_Buttons_Content_Browser.jpg|border|alt=Content Browser Button''UBIK-UID'': UID of object to be shown on map|Content Browser Button]]-| ''[[File:UI_Android_CSS_Buttons_Content_Browser_Events.jpg|borderCustom_Intent_Button|alt=Content Browser Button For Events|Content Browser Button For EventsCustomIntentButton]]* Custom Intent Button '' || Launches a certain application or URI for the specified intent (using a customized intent URI or target class) . || ''TargetClass'': Launches a certain name of an activity or an application for the specified Intent.<br />''TargetURI'': link information[[File:UI_Android_CSS_Buttons_Custom_Intent.jpg|border-| ''MapsButton''|alt=Custom Intent Button|Custom Intent Button]]* Maps Button : Opens {{UBIK}} map.|| -[[File:UI_Android_CSS_Buttons_Maps.jpg|border-| ''TargetMapsButton''|alt=Maps Button|Maps Button]]* Target Maps Button : Opens {{UBIK}} map for a target object.[[File:UI_Android_CSS_Buttons_Target_Maps.jpg|border|alt=Target Maps Button''UBIK-UID'': UID of object to be shown on map|Target Maps Button]]-* | ''ID Marker Scan Button : MarkerScanButton''|| Starts ID marker scanning.[[File:UI_Android_CSS_Buttons_ID_Marker_Scan.jpg|border|alt=ID Marker Scan Button-|ID Marker Scan Button]]-* QR Scan Button : | ''QRScanButton''|| Starts QR code scanning.|| -[[File:UI_Android_CSS_Buttons_QR_Code_Scan.jpg|border-| ''POIViewButton''|alt=QR Code Scan Button|QR Code Scan Button]]* POI View Button : Opens {{UBIK}} POI view.[[File:UI_Android_CSS_Buttons_POI_View.jpg|border|alt=POI View Button-|POI View Button]]-* Configurable AR Button : | ''ConfigurableARButton''|| Opens the markerless ID marker 3D view.[[File:UI_Android_CSS_Buttons_Config_AR.jpg|border|alt=Configurable AR Button-|Configurable AR Button]]-* Configurable Image Marker Button : | ''ConfigurableImageMarkerButton''|| Opens the ID marker 3D markerless view.|| -[[File:UI_Android_CSS_Buttons_Config_Image.jpg|border-| ''ARNavigationPOIViewButton''|alt=Configurable Image Marker Button|Configurable Image Marker Button]]* AR Navigation POI View Button : Opens {{UBIK}} POI view with the AR navigation support.|| ''UBIK-UID'': UID of object to be navigated to[[File|-| ''ARNavigationMapsButton''|| Opens {{UBIK}} map for the specified object.Starts navigating to the specified object. || ''UBIK-UID'':UI_Android_CSS_Buttons_AR_NavigationUID of object to be navigated to|-| ''BarcodeScanButton''|| Starts barcode scanning.jpg|border|alt=AR Navigation Button-|AR Navigation Button]]-* AR Navigation Maps Button : | ''RFIDScanButton''|| Starts navigating RFID scanning. || -|-| ''OCRScanButton''|| Starts OCR scanning. {{Version/AndroidSince|2.5.0}} || -|} === Color of Buttons === If no user is logged in the buttons are de-saturated. Once a user is logged in the buttons are colored according to following behaviour:* If default buttons are used the buttons are colored programmatically. The button and the color can be customized by the Development.* If custom buttons are used (specified objectby the parameter "iconPath") the original color of the button is retained. [[FileCategory:UI_Android_CSS_Buttons_Nav_Maps.jpgAndroid|borderConfigure Start Screen Content]][[Category:How-To|alt=Navigation ButtonConfigure Start Screen Content]][[Category:Publishing|Navigation ButtonConfigure Start Screen Content]]
== Configuration guidelines ==
 * See [[UI_Configuration_(Mobile_Client)]]* The '''maximum number of tabs is 6'''. Once this limit is exceeded, the configuration is invalid and won't be shown.
* The captions of tabs are optional. In case there's only one tab, the tab will be invisible.
* The '''buttons ''' should always be '''nested inside tabs'''. Otherwise, the configuration is also invalid.* When either the caption parameter or the icon parameter is not explicitly customized in the xml file, default caption Captions and icons, specific to each button, of buttons are optional. Default values are usedfor the unspecified ones.* While configuring the [[Custom Intent Button|custom intent button]], one should always specify one and only one of the target class and the target URI. Otherwise, the button is invalid and the an error will be shown.* The configuration of the ''UBIK-UID '' parameter is obligatory should always be specified for AR Navigation POI View Button, AR Navigation Maps Button, Demo Maps Button and Target Maps Button.  {{Attention|The configuration is only applied when the app starts. Close the app completely (not only move it to the background) and restart it to make sure the configuration is read.}} 
== 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.
The following screenshots demonstrates demonstrate the results of the example XML configuration.<br/>[[File:UI_Android_CSS_Buttons_Tab1.png|500px|border|alt=The First Tab|The First Tab]]<br/>[[File:UI_Android_CSS_Buttons_Tab2.png|500px|border|alt=The Second Tab|The Second Tab]]<br/>[[File:UI_Android_CSS_Buttons_Tab3.png|500px|border|alt=The Third Tab|The Third Tab]]
After users log in, the buttons are enabled and colored. Upon being clicked, they should trigger different actions.
<br/>[[File:UI_Android_CSS_Buttons_After_Login.png|500px|border|alt=Buttons After Login|Buttons After Login]] == See also ==* [[UI_Configuration_(Mobile_Client)]]* [[Custom_Intent_Button]]
[[Category:How-ToAndroid|Configure Start Screen Content]][[Category:UBIK ClientHow-To|Configure Start Screen Content]][[Category:UBIK AndroidPublishing|Configure Start Screen Content]]
335
edits