Activity
The activity object contains information about activities for a record.
Activities are created regarding records in Current RMS, for example regarding an organization in People & Organizations or regarding an opportunity. Use the activity object to access activities related to a record on a document layout or discussion template.
Current automatically creates activities for contacts, users, vehicles, and venues when they are allocated to a service booking on an opportunity. These activities are created with the type “Task” and are regarding the opportunity that the service booking is on.
Objects that return activities
Activity objects are always accessed within a forloop that iterates for each activity. You may use:
activities
activities
Returns all activities. For example, from a member document layout:
pending_activities
pending_activities
Returns activities that are pending, i.e. not completed. For example, from a member document layout:
service_activities
service_activities
Returns automatically created service booking activities. For example, from a member document layout:
Service booking activities are only created for contacts, users, vehicles, and venues so the service_activities
forloop will only return activities for document layouts or discussion templates created against these modules.
Document layouts
The activity
object can be accessed in document layouts created against the following modules:
Member
Opportunity
Quarantine
Discussion templates
The activity
object can be accessed discussion templates created against the following modules:
Organization
Contact
User account
Venue
Opportunity
Quarantine
activity_status_name
activity_status_name
Returns the activity status name.
Canceled
Concluded
Postponed
Scheduled
Input
Output
activity_type_name
activity_type_name
Returns the activity type name.
Call
Email
Fax
Holiday
Letter
Meeting
Task
Input
Output
completed?
completed?
Returns true if the activity is completed; false otherwise.
Input
Output
completed_at
completed_at
Returns the date and time that the activity was completed.
Input
Output
description
description
Returns the activity description.
For service booking activities, the order description and the related opportunity item description are pulled through.
Input
Output
ends_at
ends_at
Returns the date and time that the activity ends.
Input
Output
for_service?
for_service?
Returns true if the activity is for a service booking; false otherwise.
Input
Output
location
location
Returns the value of the activity’s “location” field.
For service booking activities, the opportunity delivery address is set as the location.
Input
Output
opportunity_item
opportunity_item
Returns opportunity item objects for activities that are automatically created for service bookings. The objects relate to the opportunity item for the service booking.
Input
Output
opportunity_item_asset
opportunity_item_asset
Returns opportunity item asset objects for activities that are automatically created for service bookings. The objects relate to the opportunity item asset for the service booking.
Input
Output
owner
owner
Returns user objects with information about the user who owns the purchase order.
Input
Output
participants
participants
Returns contact, organization, user, vehicle, or venue objects for participants of the activity.
Input
Output
priority
priority
Returns a number 1-5 for the activity’s priority. 1 is one star; 5 is five stars.
Input
Output
regarding
regarding
Returns objects for the record that the activity is regarding. This may be:
Organization
Contact
User
Venue
Vehicle
Product
Service
Quarantine
Purchase order
Input
Output
starts_at
starts_at
Returns the date and time that the activity starts.
Input
Output
subject
subject
Returns the activity subject.
Input
Output
time_status_name
time_status_name
Returns the activity time status.
Free
Busy
Input
Output
Last updated