Message Fields
This section provides a list of message text fields.
Field |
Label |
Data Type |
Description |
|---|---|---|---|
Access Hours |
appt.access_hours |
VARCHAR2 |
Formatted string. Contains set of hours the activity is accessible at the day it is scheduled for (including overnight) |
Access Schedule |
appt.access_schedule |
VARCHAR2 |
Formatted string. Contains schedule of access hours for the place where activity must be done. |
Account Number |
appt.customer_number |
VARCHAR2 |
String with name of customer account in external system |
Activity Features |
appt.afeatures |
INTEGER |
Bitmask field that defines active features for this activity. This value is copied from selected activity type |
Activity ID |
appt.aid |
INTEGER |
Unique numerical identifier of the activity |
Activity Location ID |
appt.a_locationid |
INTEGER |
Activity location ID |
Activity Properties |
appt.properties |
INTERNAL/PROP/LIST |
List of all custom activity properties with their values |
Activity Time of Assignment |
appt.atime_of_assignment |
DATE |
Date/Time when the last move/reschedule/assign to resource operation was performed for the activity |
Activity Time of Booking |
appt.atime_of_booking |
DATE |
Date/time when the activity was booked. |
Activity Traveling Time |
appt.continuous_traveling_time |
INTEGER |
Travel time between activities/locations with addresses/coordinates |
Activity Type |
appt.atype |
VARCHAR2 |
Primary type of the activity (prework, reopened, regular...) |
Activity Update Flag |
appt.aupdate_flags |
INTEGER |
Bitmask field. Displays bit flags after updating the activity. |
Activity Work Skills |
appt.activity_workskills |
VARCHAR2 |
List of ID for Work Skills and Work Skill Groups for the activity. |
Activity Work Type |
appt.aworktype |
VARCHAR2 |
label of the activity type defined for the activity. |
Activity Work Zone |
appt.aworkzone |
VARCHAR2 |
Work zone which is defined for the activity |
Activity status |
appt.astatus |
VARCHAR2 |
Status of the activity |
Auto-routed to Date |
appt.auto_routed_to_date |
DATE |
The date the activity was scheduled for during the latest Routing run. |
Auto-routed to Resource |
appt.auto_routed_to_provider_id |
INTEGER |
The date the activity was scheduled for during the latest Routing run. |
Auto-routed to Resource (Name) |
appt.auto_routed_to_provider_name |
VARCHAR2 |
Name of resource the activity was assigned to during the latest Routing run. |
Capacity Categories |
appt.activity_capacity_categories |
VARCHAR2 |
List of ID for Capacity Categories for the activity |
City |
appt.ccity |
VARCHAR2 |
City name, part of Customer address |
Coordinate X |
appt.acoord_x |
FLOAT |
X coordinate received from geocoding module for the activity |
Coordinate Y |
appt.acoord_y |
FLOAT |
Y coordinate received from geocoding module for the activity |
Coordinate accuracy |
appt.acoord_accuracy |
INTEGER |
Accuracy level of coordinates for the activity |
Coordinate status |
appt.acoord_status |
VARCHAR2 |
Coordinate status for the activity |
Customer Email |
appt.cemail |
VARCHAR2 |
Email of the customer for whom the activity is provided. |
Customer Language |
appt.clanguage |
VARCHAR2 |
Message language of the customer for whom the activity is provided. |
Customer Name |
appt.cname |
VARCHAR2 |
Name of the customer for whom the activity is provided. |
Customer Phone |
appt.cphone |
VARCHAR2 |
Phone number of the customer for whom the activity is provided. |
Customer Time Zone |
appt.c_zid |
VARCHAR2 |
Time Zone Label of the customer for whom the activity is provided. |
Delivery Window End |
appt.delivery_window_end |
DATE |
End time for activity Delivery Window |
Delivery Window start |
appt.delivery_window_start |
DATE |
Start time for activity Delivery Window |
Delivery address |
appt.caddress |
VARCHAR2 |
Customer address (except City, Zip/Postal code, State) |
Description of Message Sending Result |
message_log.mqdesc |
VARCHAR2 |
Description, complementing the message final status |
Duration |
appt.length |
INTEGER |
Activity length in minutes. Filled when activity is finished. Value = end time - start time. |
End |
appt.end_time |
VARCHAR2 |
Estimated or real end time of activity. Calculated as ETA (Start time)+activity duration. |
End Time of Activity Reported in Message |
message_log.mqtime_delivered_end |
VARCHAR2 |
End date/time of activity which is delivered to the customer with the message. |
End of Message Sending Interval |
message_log.mqsendto |
DATE |
Planned end date/time of message sending range (UTC) |
Estimated Time of arrival |
appt.ETA |
DATE |
ETA date/time. Can be empty for Regular and Reopen activities if status is Pending or Suspended. For Started and Ended - time when activity is started. For Canceled can be empty or set, if set - it is time when provider started an activity before it was Canceled |
First Manual Operation |
appt.first_manual_operation |
VARCHAR2 |
The name of the first manual reschedule/move/reorder operation performed after an automatic one. |
First Manual Operation (User name) |
appt.first_manual_operation_user_name |
VARCHAR2 |
Name of the user performing the first manual reschedule/move/reorder operation after an automatic one. |
First Manual Operation (Interface) |
appt.first_manual_operation_interface |
INTEGER |
The interface the first manual reschedule/move/reorder operation was performed from after an automatic one. |
First Manual Operation (User ID) |
appt.first_manual_operation_user_id |
VARCHAR2 |
ID of the user who performed the first manual reschedule/move/reorder operation after an automatic one. |
First Manual Operation (User login) |
appt.first_manual_operation_user_login |
VARCHAR2 |
Login of the user performing the first manual reschedule/move/reorder operation after an automatic one. |
Free-Format Message Notes |
message_log.mqdata |
VARCHAR2 |
Notes for the message (for example filled by the external message system) |
Launch Condition Name |
message_log.mqtrigger |
VARCHAR2 |
Message launch condition |
Local Time of Message Sending |
message_log.mqsent_local |
DATE |
Date/time when the message was sent to customer (Local time zone) |
Master Activity ID |
appt.amaster_aid |
INTEGER |
ID of main activity for prework, reassigned and reopened activities |
Message Activity ID |
message_log.mq_aid |
INTEGER |
Unique internal identifier of the activity for which the message was created. |
Message Address |
message_log.mqaddress |
VARCHAR2 |
Message notification address. |
Message External ID |
message_log.mqexternalid |
VARCHAR2 |
Identifier of the message in the external system |
Message ID |
message_log.mqid |
INTEGER |
Internal unique identifier of the message |
Message Inventory ID |
message_log.mq_invid |
INTEGER |
Unique internal identifier of the inventory item for which the message was created. |
Message Language |
provider.planguage |
VARCHAR2 |
Language of the resource. |
Message Recipient |
message_step.msrecipient |
VARCHAR2 |
Recipient of the message. |
Message Route ID |
message_log.mq_qid |
INTEGER |
Internal unique identifier of the route for which the message was created. |
Message Scenario Step: Duration |
message_log.mqduration |
INTEGER |
Time spent on message sending until receiving the final message status for the message scenario step. |
Message Scenario Step: ID |
message_log.mq_msid |
INTEGER |
Internal unique identifier of the message scenario. |
Message Scenario Step: Name |
message_step.msname |
VARCHAR2 |
Name of the scenario step |
Message Scenario Step: Type |
message_step.mstype |
VARCHAR2 |
Type of the message scenario step ("start" or "inner") |
Message Sending Method |
message_log.mqmethod |
VARCHAR2 |
Method of notification |
Message Sending Result |
message_log.mqstatus |
VARCHAR2 |
Final status of the message |
Message Step Purpose |
message_step.msfunction |
VARCHAR2 |
Message step type: "PAS" (survey message) or "regular" (regular message) |
Message User ID |
message_log.mq_uid |
INTEGER |
Internal unique identifier of the user who sent the message. |
Mobile Phone |
appt.ccell |
VARCHAR2 |
Mobile phone number of the customer for whom the activity is provided. |
Points |
appt.apoints |
INTEGER |
Number of points that represent efforts required to perform the activity. |
Postal Code |
appt.czip |
VARCHAR2 |
ZIP/Postal code of customer for whom the activity is provided. |
Reminder |
appt.cmessageTime |
INTEGER |
Number of minutes before Delivery Window/ETA when reminder notification is sent. |
Reported End Time of Activity Delivery |
appt.ctime_delivered_end |
DATE |
End date/time of activity which is delivered to the customer. |
Reported Start Time of Activity Delivery |
appt.ctime_delivered_start |
DATE |
Start date/time of activity which is delivered to the customer. |
Resource ID |
message_log.mq_pid |
INTEGER |
ID of resource the activity is assigned to. |
SLA End |
appt.sla_window_end |
DATE |
End date and time of Service Level Agreement |
SLA Start |
appt.sla_window_start |
DATE |
Start date and time of Service Level Agreement |
Service Request ID |
message_log.mq_srid |
INTEGER |
Unique internal identifier of the service request for which the message was created. |
Service Window End |
appt.service_window_end |
DATE |
End time of Service Window |
Service Window Start |
appt.service_window_start |
DATE |
Start time of Service Window |
Start - End |
appt.eta_end_time |
VARCHAR2 |
Real start time - end time for the activity |
Start Time of Activity Reported in Message |
message_log.mqtime_delivered_start |
VARCHAR2 |
Start date/time of activity which is delivered to the customer with the message. |
Start of Message Sending Interval |
message_log.mqsendfrom |
DATE |
Planned start date/time of message sending range (UTC) |
State |
appt.cstate |
VARCHAR2 |
State (Geographic area) of the customer for whom the activity is provided. |
Teamwork ID |
appt.a_teamid |
INTEGER |
ID of team for teamwork activities |
Template ID |
appt.a_templateid |
INTEGER |
ID of activity template for mass/repeating activities |
Time Slot ID |
appt.a_tsid |
VARCHAR2 |
ID of Time Slot assigned to the activity |
Time of Message Sending |
message_log.mqsent |
DATE |
Date/time when the message was sent to recipient (UTC) |
Travel estimation method |
appt.travel_estimation_method |
INTEGER |
Method that was used to make current traveling time estimation.Applicable for the activity. |
Travel Time adjustment: ID of previous activity |
appt.travel_from_aid |
INTEGER |
ID of previous activity adjustment is entered for. Applicable for the activity. |
Traveling Time |
appt.travel |
INTEGER |
Time of travel from a previous activity/location. |
Visit ID |
appt.a_visitid |
INTEGER |
ID of Visit for the activity. |
Work Order |
appt.appt_number |
VARCHAR2 |
Identifier of the activity (string, value of field "Work Order") |
Message Scenario Name |
message_flow.mfname |
VARCHAR2 |
Name of the message scenario. |
Message Scenario ID |
message_flow.mfid |
VARCHAR2 |
Unique internal identifier of the message scenario |
* |
Activity Custom Fields |
||