\n
\n
We want to create automation tasks frequently. Therefore, we define a convenience function to create automation tasks in\nHIRO. Since an automation task is a vertex, this function will call the create_vertex() function, which we have already\npreviously defined in another tutorial (as mentioned in the prerequisites). Then we will create an Automation Task by\ncalling this function.
\n
\n
\n
An Automation Task corresponds to the entity type ogit/Automation/AutomationIssue. We define now the function create_task(),\nwhich creates a vertex representing the Automation Task in HIRO:
\n
\n
\n
\n
def create_task (issueType, subject, originNode, attributes={}):\n\n vertex_data = {'ogit/Automation/issueType': issueType,\n 'ogit/subject':subject,\n 'ogit/Automation/originNode': originNode,\n 'ogit/status': 'NEW'\n }\n vertex_data.update(attributes)\n task_id = create_vertex(hiro_session, 'ogit/Automation/AutomationIssue', vertex_data)\n return task_id
\n
\n
\n
\n
The code above creates an automation task vertex (entity type ogit/Automation/AutomationIssue) in the HIRO™ Graph with the provided attributes:
\n
\n
\n
\n- \n
issueType \t: Type of task to be submitted, written to ogit/Automation/issueType attribute
\n \n- \n
subject \t: Task subject, which will be shown in user interfaces, written to ogit/subject attribute
\n \n- \n
originNode \t: vertex ID of the entity the task is initially associated with, written to ogit/Automation/originNode attribute
\n \n- \n
attributes\t: further attributes, i.e. Todo Variables and Information Variables.
\n \n
\n
\n
\n
The following attributes are mandatory attributes for automation tasks and need to be always provided upon creation: ogit/Automation/issueType, ogit/subject, ogit/Automation/originNode.
\n
\n
\n
Attributes of an automation task are also called Variables when you work with them in Knowledge Items. Information Variables provide additional information to HIRO™ about the specific task to perform. If your automation task would be purchasing office material, then the products to buy and the quantities might be relevant parameters that could be provided as information variables. Todo Variables represent sub-tasks or objectives that need to be satisfied. You need to specify at least one Todo Variable upon issue creation.\nNote: You may add arbitrary attributes to an automation task – either any already defined attributes from the OGIT schema, or free attributes with a trailing “/”. Be aware that such free attributes need to be registered as Variables in HIRO™ to be referenced in Knowledge Items. This is done in the Knowledge Acquisition Tool.
\n
\n
\n
Next, we will proceed to create our first Automation Task. As an example, we will create a task for rescheduling meetings in our calendar.\nIn this example, HIRO™ will attempt to reschedule a meeting when it finds that the meeting date is conflicting with a vacation period.\nAs a design decision, we set ogit/Automation/originNode to the ID of the calendar vertex in the graph, so that the ogit/Schedule/Calendar represents the context in which the rescheduling of meetings should be processed. We find out this vertex id by a query for the external google calendar id (xid query).\nWe proceed to create the task with the following function call, by passing the parameters needed (issueType, subject, and originNode):
\n
\n
\n
\n
google_calendar_id = '7hfea2godbmajrspfp30l23q1o@group.calendar.google.com' #replace with the id of your calendar!\ncalendar_node = read_vertex_by_xid ('CAL-' + google_calendar_id)['ogit/_id']\ntask_id = create_task('RescheduleMeeting', 'Reschedule Meeting to After Vacation', calendar_node, {})
\n
\n
\n
\n
After the automation task with the above parameters is created, HIRO™ will immediately update the task status to RESOLVED, due to the fact that no Todo Variable has been provided in the parameters. For any Automation Task that is submitted without a Todo Variable, HIRO™ will automatically consider it RESOLVED, without any actual processing being done. We can read the Automation Task from the Graph and see that the status is RESOLVED.
\n
\n
\n
\n
task_status = read_vertex(task_id)['ogit/status']\nprint ('Task status: ' + task_status)
\n
\n
\n
\n
\n
\n
Task status: RESOLVED
\n
\n
\n
\n
When an automation task is submitted (task state: NEW), it must be submitted with at least one Todo Variable for HIRO™ to work on. The task will then be processed by HIRO™ (task state: PROCESSING).Provided that HIRO™ has enough Knowledge to act on it, the objective of each Todo Variable will be achieved, and the Todo Variable will be removed. When all the Todo Variables are removed, the state of the task will be set to RESOLVED.
\n
\n
![\"Task](\"/7.0/images/tutorials/issue_state_diagram.png\")
\n![\"Stopped](\"/7.0/images/tutorials/iv_stopped_task.png\")
\n![\"Stopped](\"/7.0/images/tutorials/teaching_session_automation_issue_1.png\")
\n![\"Teaching](\"/7.0/images/tutorials/teaching_session_automation_issue_2.png\")
\n