UI Template Object

The UI Template object contains template definition for rendering various sections in mobile application. UI Template provide a means to quickly customize layout of UI elements using pre-defined templates for various business processes.

On this page:

UI Template Object Formats

JSON Format
{
    "Desc": {
        "en": ""
    },
    "IsActive": true,
    "TemplateID": "",
    "Template": ""
}

UI Template Object Properties

(info) Required properties are in bold.

PropertyTypeDescription
DescobjectThis object contains a list of localized descriptions for the template. Each entry in the object contains a key/value pair combination. The key identifies the language code (see: Language Culture Codes) and the value refers to the localized description for the language.
IsActiveboolean

Identifies if the UI template is enabled. This field is used to disable an old UI template so it can no longer be used.

Valid values are:

  • true - The UI template is enabled. This is default value is the property is not specified.
  • false - The UI template is disabled.

TemplateID

string

This property uniquely identifies the UI template. The system defines Template ID values. Template IDs are case-sensitive. Valid values are:

PropertyDescription
Phone.Schedule.ListThis template defines the schedule list for the small form factor version of ServiceMobility
Phone.WorkOrder.FollowUpTimeSlotThis template defines the time slot for the follow-up call functionality within the small form factor version of ServiceMobility.
Phone.WorkOrder.InvoicePreviewThis template defines the invoice preview within the small form factor mobile application 
Tablet.Home.HeaderThis template defines the header details for the Home screen in mobile application.
Tablet.Home.ListThis template defines the contents of list for the Home screen in mobile application.
Tablet.Inventory.StockRecommendationListThis template defines the contents of list for Stock Level Recommendation screen in mobile application.
Tablet.Schedule.ListThis template defines the contents of list for the Schedule screen in mobile application.
Tablet.WorkOrder.AssetHistoryThis template defines the contents of list for Asset History screen in mobile application.
Tablet.WorkOrder.EstimateListThis template defines the contents of list for Estimate screen in mobile application.
Tablet.WorkOrder.EstimateLegalDisclaimerThis template defines legal disclaimer for Estimate in mobile application.
Tablet.WorkOrder.InvoicePreviewThis template defines the invoice preview within the large form factor mobile application
Tablet.WorkOrder.LineItemListThis template defines the contents of list for Work Order Line Items screen in mobile application.
Tablet.WorkOrder.SummaryHeaderThis template defines the header details for the Work Order Summary screen in mobile application.
Tablet.WorkOrder.SummaryTagsThis template defines the tags rendering details for the Work Order Summary screen in mobile application.
Tablet.WorkOrder.SummaryLocationThis template defines the Account Location (address) details for the Work Order Summary screen in mobile application.
Tablet.WorkOrder.SummaryDetailsThis template defines the contents of Summary Details section for the Work Order Summary screen in mobile application.
Tablet.WorkOrder.SummaryInfoThis template defines the contents of Summary Info section for the Work Order Summary screen in mobile application.
Tablet.WorkOrder.SummaryHistoryThis template defines the contents of Summary History section for the Work Order Summary screen in mobile application.
Tablet.WorkOrder.FollowUpTimeSlotThis template defines the time slot for the follow-up call functionality within the large form factor version of ServiceMobility.
TemplatestringThis property contains template representation of HTML elements for UI rendering in mobile application.