Adding and Reviewing Task Runner Tasks

The procedures in this section describe how to add and configure Task Runner tasks. Task-step templates, provided with Voyager, enable you to set up task details and add the steps within each task. You can review and edit tasks to configure how they execute, or use them as models to create other tasks. You can also inactivate a step if you want to skip its execution within a task.

Yardi recommends that you do not change the standard step templates that are provided with Task Runner.

How to...

To add a Task Runner task

To review, edit, or delete a Task Runner task

Additional Information

Adding and Reviewing Task Runner Task Schedules

Task Runner Task Setup Examples

Reviewing the Service Manager Event Log

To add a Task Runner task

1	From the Voyager System Administration side menu, select Admin > Task Runner > Task > Add. The Task Runner Task screen appears.

2	Type a unique code (12 characters or less), name, and description for the new task.

3	Click Save. The Steps tab appears.

4	For each new step that you want to add to the task:

For task setup examples using the standard step templates provided with Task Runner, see “Task Runner Task Setup Examples”.

a	Click the New Record button . The Task Runner Step screen appears.

b	In the Template field, select the step template that applies to the task.

Task Runner completes the Name and Description fields, based on the step template that you select. You can change this information, if needed.

c	Click Save. Step parameter names and value descriptions appear in the Details table.

d	Complete the fields in the Value column, as needed. For more information, see “Task Runner Step Screen Reference”.

5	Click Save. The new step appears in the Steps table.

You can now schedule the tasks that you added. For more information, see “Adding Task Runner Task Schedules” on page 15.

To review, edit, or delete a Task Runner task

1	From the Voyager System Administration side menu, select Admin > Task Runner > Task > Review. The Task Runner Task filter appears.

2	Complete the filter, as needed, to locate the task that you want to review. Click Submit. The Task Runner Task screen appears.

3	If you want to delete the task, click Delete.

4	Edit, as needed. For more information, see “To add a Task Runner task”.

5	Add new steps, as needed. If you want to review or edit a specific step in the Steps table, click the EditURL button in the row. The Task Runner Step screen for that step appears. For more information about editing a step, see “Task Runner Task Setup Examples”.

6	If you made any changes, click Save.

Task Runner Step Screen Reference

 

Template	Displays the step templates that are provided with Task Runner. Select the template for the task that you want to configure. For more information about the available step templates, see “Task Runner Task Setup Examples”. Task Runner completes the Name and Description fields, based on the selected template. You can change these, if needed.
Order	Determines the order that this step will execute within the task. The default starting value is 0. NOTE Yardi recommends that you use multiple-digit order numbers (for example, 10, 20, 30). This enables you to add new steps between existing ones, without having to reorder the entire list.
Inactive	Enables Task Runner to skip this step within the task. For example, you can associate several steps with a task, but inactivate a step when it is not needed for a particular task run. You can then activate the step later, when needed.
Execute only if task already failed	Enables Task Runner to perform this step even if the task has already failed. For example, you can use this option to perform a separate override or “clean-up” step that will be activated if the preceding steps in the task failed to execute.
Details table	Contains parameter names and values that Task Runner applies to the step during execution.
Value	Applies specific user-supplied values for the step parameters identified in the Name column. These fields contain variable information, depending on the task step template that you choose. For examples of typical task-step values in this table, see “Task Runner Task Setup Examples”.