Catalog Task workflow activity

The Catalog Task activity creates a service catalog task record.

Note: This activity is only available when the workflow runs on a table that extends Task.

A user must complete the catalog task. This activity is available only for workflows running on the Catalog Request Item [sc_req_item] table.

Results

You can assign a result value using activity.result from within a script field of the activity. The final State value of the catalog task record determines the result value for the Create Task activity. Possible result values are:
  • Closed complete
  • Closed incomplete
  • Closed skipped
  • Deleted
  • Cancelled

Input fields

The values you enter in the following fields determine the behavior of the activity.

Table 1. Catalog task activity information
Field Description
Catalog Task Activity Settings

The following fields specify the behavior of the Catalog Task Activity.

Task TableThe table on which this activity runs. In most cases, leave set to the default value: [sc_req_item].
Priority The value you want assigned to the Priority field for the new task.
Wait for completion If selected, the workflow activity waits for the task to complete before continuing. If cleared, the task is created but the workflow proceeds.
Catalog Task Record Settings

The following fields specify the field values that this activity sets for the catalog task it creates.

Task value from Specify how you want to populate fields on the new task.
  • Fields: a predefined set of fields including Fulfillment group, Assigned to, Short description and Instructions.
  • Template: an existing template for the selected task table.
  • Values: values that you specify using a Set Values widget.

After you select a value for Task value from, additional fields specific to that value appear on the form.

Fulfillment group

Only appears when Task value from is set to Fields

The group that is responsible for completing the task. Populates the Assignment group field on the new task.
Assigned to

Only appears when Task value from is set to Fields

The user who is responsible for completing the task. Populates the Assignment to field on the new task.
Short description

Only appears when Task value from is set to Fields

A short description for the task. Populates the Short description field on the new task.
Instructions

Only appears when Task value from is set to Fields

The task instructions for the user to complete prior to closing the task. Populates the Description field on the new task.
Template

Only appears when Task value from is set to Template.

The values in the task will be populated from the values in the template you select.
SetValues

Only appears when Task value from is set to Values.

Select any field on the task record to a value you specify here.
Advanced Check Advanced if you want to use a script to assign values on the catalog task. When you check Advanced, a text box appears where you can enter your script.
Advanced Script

Only appears when the Advanced field is checked.

Set additional values for the task in this script. This script is run after the task values are set using the Fields, Template or Values you have specified.

Use the variable task when setting additional values, for example:

task.short_description = current.short_description;

Catalog Task Variables
Variables on Task Form Specify optional catalog variables to include on the Catalog task form. The variables you select here will be displayed in a field called Variable Editor. If you select no variables here, the Variable Editor field in the Catalog Task form will not be visible.
Catalog Task Schedule
Due date based on Select how workflow determines the task's duration, due date, and schedule.
  • A user specified duration: The duration is based on a user specified value.
  • A relative duration: The duration is calculated from a relative duration (such as End of Next Business Day).
  • A date/time or duration field: The duration is based on the value of a field on the current record.
  • Script: The duration is returned by a script.
Duration

Only appears when Due date based on is set to A user specified duration

The specific number of days and hours.
Relative duration

Only appears when Due date based on is set to A relative duration

The general number and length of business days.
Due date field

Only appears when Due date based on is set to A date/time or duration field

The date/time or duration field.
Due date script

Only appears when Due date based on is set to Script

The script that sets 'answer' to the number of seconds for the duration.
Schedule based on The basic schedule the timer uses to count working hours. If a schedule is specified, the duration will only be considered for times that are specified on the schedule. For example, if the duration is 2 hours and the workflow begins at 4:00pm on a schedule that is 8am - 5pm, then it ends at 9:00am the next day. The options are:
  • This workflow's schedule: The schedule uses workflow context date, time, and an optional Time zone based on value.
  • A specific schedule: The schedule uses a pre-defined Schedule and an optional Time zone based on value.
  • A schedule field: The schedule uses a value from a table and an optional Time zone based on value.
Schedule

Only appears when Schedule based on is set to A specific schedule

The predefined Schedule from a list.
Schedule field

Only appears when Schedule based on is set to A schedule field.

A date and time or duration field for the schedule, that is associated with the table. Valid fields appear in blue on the Select the element from a tree dialog.
Time zone based on The time zone for calculating the duration. The time zone may be based on:
  • No time zone: Default. Workflow uses the GMT time zone.
  • A specific time zone: A specific Time zone that you choose from a choice list.
  • A time zone field: A Time zone field to track time duration from a field on the form.
Time zone

Only appears when Time zone based on is set to A specific time zone

.
Select the time zone you want from the choice list.
Time zone field

Only appears when Time zone based on is set to A time zone field.

A date and time or duration field for the schedule, that is associated with the table. Valid fields appear in blue on the Select the element from a tree dialog.

States

The activity state tells the workflow engine what to do with the activity.
Table 2. Catalog Task activity states
State Description
Executing The workflow engine knows to start the onExecute function of the activity.
Waiting The workflow engine ignores the activity until a specific event to restart the activity is fired.
Finished The activity finished running. See the result value for the outcome of the activity.
Cancelled This activity, or the workflow that contains this activity, was canceled.
Error A JavaScript error occurred. Review the logs for error details.