Complete Task Smart Service

The Complete Task Smart Service allows you to complete a task belonging to another process from your current process.

Permissions Needed

The user running the smart service must have rights to complete the selected task. Attempting to complete this task without the proper user rights generates an error message for the process administrator and pauses the process.

Properties

  • Category: Process Management

  • Icon: Complete Task Icon

  • Assignment Options: Unattended/Attended - Note: When this smart service is attended, the form that the user sees is the form configured on the node, not the form for the specified task.

Configuration Options

This section contains tab configuration details specific to this smart service. For more information about common configurations see the Process Node Properties page.

Data Tab

Node Inputs

Input Data Type Description Required Multiple
Task Id Number (Integer) The id of the task to complete Yes No
Task Inputs Any Type A dictionary containing keys and values that corresponds to the task’s inputs. No No

The Task Inputs property is a dictionary that must contain entries for any required parameters for the selected task. It may also contain fields for optional parameters for the task. If any required parameters are missing or if the dictionary contains any entries that do not match parameters of the selected task, the target task will not be completed and this node will pause.

For example, if you have a task that is a part of an employee review cycle, it might have a required parameter named employeeId and optional parameters named deadline, and reasonCode.

To successfully complete this task, the Task Inputs input would look like one of the following:

1
2
3
{
    employeeId: 12345
}
1
2
3
4
{
    employeeId: 12345,
    deadline: today()+30
}
1
2
3
4
5
{
    employeeId: 12345,
    deadline: today()+30,
    reasonCode: "ANNUAL"
}

In the below examples, the target task does not complete. For the first two cases, the reason is that the required task input, employeeId, was not provided. For the third case the reason is that an entry in the task input, supervisorId, did not match any of the inputs of the task.

1
2
3
{
    
}
1
2
3
{
    deadline: today()+30
}
1
2
3
4
{
    employeeId: 12345,
    supervisorId: 6789
}

a!completeTask()

The Complete Task smart service is available as an expression function that can be executed inside a saveInto on a Interface Component or as part of a Web API.

Syntax

a!completeTask(taskId, taskInputs, onSuccess, onError)

Inputs

  • taskId (Number(Integer)): The ID of the task to complete.
  • taskInputs (Dictionary): A dictionary containing keys and values that corresponds to the task’s inputs.
  • onSuccess (Any Type): A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a!save() or a!httpResponse().
  • onError (Any Type): A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a!save() or a!httpResponse().
FEEDBACK