Versions Compared

Version Old Version 5 New Version Current
Changes made by

Andrew Hill

Jason Andrew

Saved on

Key

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

The Alert Template object contains properties related to alert/notification. Alert provide a means to notify the mobile worker to a specific condition related to either the customer, asset, part, etc. in various business processes.


Panel
borderColorgrey
bgColorwhitesmoke

On this page:

Table of Contents
maxLevel2


Alert Template Object Formats

Include Page
_Alert Template Object Formats
_Alert Template Object Formats

Alert Template Object Properties

(info) Required properties are in bold.

PropertyTypeDescription
Acceptobject

This properly contains various criteria definition for accepting alert/notification.

PropertyTypeDescription

DisplayNotes

boolean

Identifies if the mobile application should display notes field

Default value is false

RequireResponseNotes

boolean

Identifies if the response notes are required from mobile worker on accepting alert/notification

Default value is false


Decline

object

This property contains various criteria definition for declining alert/notification. If this object is not specified, then the decline button will not be displayed.

PropertyTypeDescription

DisplayNotes

boolean

Identifies if the mobile application should display notes field

Default value is false

RequireResponseNotesboolean

Identifies if the response notes are required from mobile worker on declining alert/notification

Default value is false


Deleted

boolean

Identifies if the alert template is to be deleted.

Valid values are:

  • true - The alert template object should be deleted
  • false - The alert template object should not be deleted. This is the default value if this property is not specified.

Message

stringThis property contains information text to be displayed in alert/notification.

TemplateID

stringThis property uniquely identifies the alert template.

RefID

string

This property contains optional customer assigned reference identifier. This allows the customer to tie the response back to another system

URLstring

This property contains URL to an external web site.