Versions Compared

Old Version 3

changes.mady.by.user Jason Andrew

Saved on

compared with

New Version Current

changes.mady.by.user Jason Andrew

Saved on

Key

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

An activity is a scheduled event that may or may not be associated with an actual address. Activities appear within the mobile application's schedule views along side scheduled work orders.

Any time the mobile user performs an action that causes the activity object to change, it will automatically be uploaded to the server. For example, when the activity is started, the activity object will be uploaded to the server with the updated Started field populated.


Panel
borderColorgrey
bgColorwhitesmoke

Related pages:


Activity Object Formats

Include Page
_Activity Object Formats 1
_Activity Object Formats 1

Activity Object Properties

(info) Required properties are in bold.

PropertyTypeDescription
ActivityIDstringThe unique identifier for the activity. This value must be globally unique across all activities.
ActualEndDatedatetimeIdentifies the actual date and time the activity was completed.
ActualStartDatedatetimeIdentifies the actual date and time the activity was started on site at the account location. This value does not include the start travel time.
ActualTravelEndDatedatetimeIdentifies the actual end travel date and time for the activity.
ActualTravelStartDatedatetimeIdentifies the actual start travel date and time.
DescriptionstringA simple description of the activity.
Extensionsobject
Include Page
_def_Extensions
_def_Extensions
FlexAttrsobject

This property contains the Flex-Field values that were entered.

  • Flex-Fields are always associated with a Flex-Form

Flex-Field values can be pre-populated from the backend

PropertyTypeDescription
${FlexFormID}object

Identifies the Flex-Form

PropertyTypeDescription
ValuebooleanIdentifies the value associated with the rule
CanOverridebooleanIdentifies if the provided value can be edited by the mobile worker. Default value is  false



FlexFormscollection

Include Page
_def_FlexForms
_def_FlexForms

FlexViewcollection

Include Page
_def_FlexViews
_def_FlexViews

Locationobject

The account location identifies the actual location (address) of where the activity is to be completed.

See: Account Location Object

Notescollection

The Notes object contains an optional collection of notes associated with the activity. These can be recorded by anyone involved with scheduling the activity.

Pausedboolean

Identifies if the activity is currently paused.

Valid values are:

  • true = The activity is currently paused.
  • false = The activity is not paused.
PlannedEndTimedatetimeThe date and time, in UTC format, when the activity is scheduled to end.
PlannedStartTimedatetimeThe date and time, in UTC format, when the activity is scheduled to start.
Prioritystring

Identifies the current priority of the activity. Contains an Activity Priorities System Category value identifying the priority of activity.

Statusstring

Identifies the current status of the activity. Contains an Activity Status System Category value for status of the activity

TitlestringA short title for the activity.
TypestringIdentifies the type of activity. Activity types are defined and controlled with a Activity Types System Category.

UserAdjustedEndUTC

datetime

The ending date and time, in UTC format, as recorded by the mobile worker. This value may be different from the ActualEndDate property if the application configuration (Activity.editStartEndTimeEnabled = true) allows the mobile worker to edit activity date and time

Status
title4.16.0

UserAdjustedStartUTC

datetime

The starting date and time, in UTC format, as recorded by the mobile worker. This value may be different from the ActualStartDate property if the application configuration (Activity.editStartEndTimeEnabled = true) allows the mobile worker to edit activity date and time.

Status
title4.16.0

UserAdjustedTravelEndUTCdatetime

The ending travel date and time, in UTC format, as recorded by the mobile worker. This value may be different from the ActualTravelEndDate property if the application configuration (Activity.editStartEndTimeEnabled = true) allows the mobile worker to edit activity travel date and time

Status
title4.16.0

UserAdjustedTravelStartUTCdatetime

The starting travel date and time, in UTC format, as recorded by the mobile worker. This value may be different from the ActualTravelEndDate property if the application configuration (Activity.editStartEndTimeEnabled = true) allows the mobile worker to edit activity travel date and time

Status
title4.16.0

UserNamestringThis property identifies the ID of the mobile worker that has been assigned to the activity.