Task object
An identity that is automatically generated as a technical identification of a task.
The identity of the organizational account where the task was created and processed.
Identity of a flow that is used in the task creation process, (supporting data in identifying flows).
Unique ID to identify a hub.
The flow name used in making a task, refers to the existing flow in the organization. When creating a task, you cannot use the flow with the name Handover because it has been used as a reserved key.
Organization Entity Information: Encompasses the organization's name, email, and ID. This information is present in the task data upon task creation and processing.
Information of hub entity : contains hub name, hub id, coordinates.
The value of a task is used as the Title of the task, which will appear on task pages on the web and apps.
The value of a task is used as a Content, which will appear on task pages on the web and in apps.
The value of a task is used as a Label, which will appear on task pages on the web and in apps.
Status that describes the process of a task:
Unassigned : Tasks that have been created but have not been assigned to the user field
Ongoing : Tasks that have been assigned to the user field and are in progress
Done : Tasks that have been completed by the user field.
List of email that has been assigned the task.
Detail information of assignee : contains field user name, email, hub, organization and user role.
Email that assigned the task.
Date and time when the task is assigned.
The initial time for working on a task that can be set by the admin user when the task is created.
The deadline for completing tasks that can be set by the admin user when the task is created.
Information of time when the task was last updated.
information about the user who last modified a task. It provides details about the user who made the most recent update to the task, typically including their email address.
Email that created the task.
Identify where the task was created from: WEB, API, Automation, Mobile.
Date and time when the task is created.
Email that processed the task until it is done.
Coordinate where the task is done.
Date and time when the task is finished.
Identify where the task was done from: WEB, MOBILE, System (for sample data).
openTaskTime is data when the task was last opened when it was still ongoing.
Time provided (in minute) for a vehicle to wait before start travelling to the next visit.
The travelDuration is calculated as the time taken to travel between two consecutive visits and is measured in minutes. It is obtained by subtracting the doneTime of the current visit from the doneTime of the previous visit in the optimized route.
The duration in this context is also measured in minutes and represents the time taken to complete a particular visit or task. It is calculated by subtracting the doneTime of the current visit from th page1DoneTime of the same visit. This calculation allows us to determine the time it took to complete the specific task or visit, starting from when it was initiated (page1DoneTime) until it was marked as completed (doneTime).
Estimated vehicle mileage (in meter).
Estimated Time Of Arrival at the destination.
Estimated Time of Departure before start travelling to the next visit.
The Unique ID is used to mark a vehicle during route optimization to ensure that the visit associated with this vehicle ID remains assigned to the same vehicle in the subsequent optimization route and does not get randomly assigned to another vehicle.
The purpose of marking a vehicle on a successfully optimized visit is to ensure that the visit can be assigned to the same vehicle in the next optimizer route.
The routePlannedOrder serves as the key to identify that a visit has been successfully optimized within a specific route. It also helps to determine the order of that visit within the optimized route.
idleDuration is the total duration of the idle user while working on a task, the user is considered idle when the speed is less than 3 km/h
Coordinates used in MileField to display routes on google maps.
Timestamp for expectation done time for the task.
Coordinate where the task is created.
A flag used to indicate whether a task employs geolock or not. Geolock is a feature that restricts task access based on predefined geographic locations and radius. When useGeoLock is set to true, it means that the task uses geolock to limit access based on the task's specified geographic parameters.
Define geolocation-based access restrictions for tasks. It is an array of objects that contain information about allowed locations and their corresponding radius. Tasks are accessible only when accessed from within the specified locations and within the defined radius. If an attempt is made to access the task from outside the allowed area, access will be denied.
The identifier for geolock usage is triggered when a task begins or when a task is completed.
Task reference identity that involves multiple flows.
Id / Identity of a task created by mobile.
By default this number is generated based on the task created time in epoch format, orderIndex is used to define the order of this Task in the Task list. User can define it by number value.
An identifier is used to distinguish whether this task is sample data or user-generated real data.
History identity when a task was created, modified, or deleted.
An information about device that used by user for complete the task.
This key is related to the Cross Docking configuration. When a user dispatches the result, a handover task is generated for the Sub Hub. This key serves to distinguish the Handover task from other tasks within MileApp.
This key is associated with the Auto Split configuration. If the routing result suggests a visit that needs to be split into two or more visits, upon dispatch, we generate the split tasks. The parentTaskId signifies the main task that has been split.
This key indicates the type of Auto Split used, which can be either Equal or Maximize. It indicates the method employed for splitting tasks.
This key identifies the segment of the split task, corresponding to the Auto Split configuration. It helps in tracking the divided tasks effectively.
Example: 1/2, 2/2
A flag indicating whether the routing optimization considers visits within the same group. This ensures that visits within the same group are assigned to the same vehicle and prioritized sequentially.
This key indicates that visits belong to the same group if they are set to the same name. The routing solution will suggest assigning visits with the same group to the same vehicle.
Priority ranges from 0 to 100, with the default value set to 0. A lower number indicates a higher priority compared to other visits within the same group.
This key stores the value of the maximum distance a vehicle sub hub can travel. It is related to cross docking.
Generated when the task done for flagging the sequence of completed tasks.
Generated when the task done for flagging the latest completed task.
Generated when user enter the range (50m) of task coordinates. This feature activated when task has geoloc feature.
Generated when user out the range (50m) of task coordinates after inLocation recorded.
This key depends on doneOrder key, generated when task done by calculating distance between done tasks and distance between Hub to task if done order is 1
Identifies the task category and its relationship within the task hierarchy.
Enum:
ā¢ task - Regular standalone task
ā¢ taskMaster - Parent task containing multiple subtasks (created when flow has subflow components)
ā¢ taskChild - Subtask belonging to a parent task (auto-generated from subflows)
ā¢ activityMaster - Main activity containing workflow steps
ā¢ activityChild - Individual step within an activity workflow
Default: task
ID of the parent task that this subtask belongs to. This field only appears for child tasks (taskChild) created from subflows or activity steps (activityChild) within a workflow. The system automatically assigns this value when creating child tasks.
Example: 64b4e719dc92e91ae936d664
Array of child task IDs that belong to this parent task. This field appears for parent tasks (taskMaster) that have subtasks from subflow components or activity tasks (activityMaster) that contain workflow steps. The system automatically populates this array when creating child tasks.
Example: ["64b4e719dc92e91ae936d665", "64b4e719dc92e91ae936d666"]
Contains the workflow template configuration for activity tasks. This field appears only for activityMaster tasks and includes the workflow definition with all its sequential steps that need to be completed. The system embeds this information directly in the task for faster access.
ID of the workflow template used to create this activity task. This field appears only for activityMaster tasks and references the original workflow definition that was used to generate the activity steps.
Example: workflow_vehicle_inspection_v2
Task Module business failedCode that indicate specific failure conditions or business rule violations during task module operations. These codes help identify the failed operation of task-related and provide standardized failure identification across the system.
Possible values:
- task-031: Duplicate entry - Task with same identifier exists
- task-032: Invalid state/condition - Task state transition not allowed
- task-033: Task not found - Task record does not exist
- task-035: Task forbidden - User lacks permission for task
- task-036: Task assignment invalid hub - Task assigned to invalid hub
- task-038: Export size exceeded - Export data exceeds limit
- task-039: File/upload failure - File upload failed
- task-040: Limit exceeded - Task limit per organization exceeded
- task-041: External service failure - Third-party service failure
- task-042: Task tracking expired - Tracking link expired
- task-045: Server failure - Internal server failure in task module
task-031, task-032, task-033, task-035, task-036, task-038, task-039, task-040, task-041, task-042, task-045