Versions Compared

Old Version 9

changes.mady.by.user Andrew Hill

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
_Activity Object Formats

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.
DescriptionstringA simple description of the activity.
Durinteger

The duration, in seconds, on how long the activity took to complete.

(warning) This property is being deprecated. You can calculate the actual duration based on the Started and Ended values.

Endeddatetime

The actual end date and time of when the activity was completed.

Extensionsobject
Include Page
_def_Extensions
_def_Extensions
FlexAttrsobject(info) Flex attributes for activities will be implemented in a future release.
Pausedboolean

Identifies is the activity is currently paused.

Valid values are:

  • true = The activity is currently paused.
  • false = The activity is not paused.
Prioritystring

Identifies the current priority of the activity.

See: Activity Priorities

RefCodestring

Identifies the primary key of a record this activity record is associated with. The meaning of the RefCode is identified by the RefType field.

RefTypestring

If this activity record is associated (linked) with another object (e.g. a work order) then this field identifies the type of object it is linked to and the RefCode property identifies the actual object ID.

Valid values are:

  • 0 or null - The activity is not associated with any other object in the system.
  • 1001 - The activity is associated with a work order. The RefCode property will contain the work order number that it is associated with.
  • 1002 - The activity is associated with an account. The RefCode property will contains the account number that it is associated with.
RemarkscollectionA collection of remarks made on the activity.
SchedDuration
SchedDurinteger(warning) This field has been deprecated.
SchedEndTimedatetimeThe date and time, in UTC format, when the activity is scheduled to end.
SchedStartTimedatetimeThe date and time, in UTC format, when the activity is scheduled to start.
StarteddatetimeThe date and time, in UTC format, when the activity was started.
Statusstring

Identifies the current status of the activity.

SysActCodestring

Identifies the type of activity. Activity types are defined and controlled with a system category.

TitlestringA short title for the activity.