Workflow Engine
  • Dark
  • PDF

Workflow Engine

  • Dark
  • PDF

Deprecations in WorkFlowEngine are shown in the table below.

Item Description Deprecation Release Removal Release Replacement
Task: WorkflowEngine→eventListener Event Listener task within an automation. 2019.3 2021.1 Task: WorkflowEngine→eventListenerJob
returnCompletedTaskData Completes a task and returns the updated job. 2020.1 2021.1 /workflow_engine/finishTask
getJobDeep Get active job details. 2020.2 2021.1 GET /workflow_engine/job/:job_id/details and POST /workflow_engine/tasks/search
getTaskIterations Get job task iterations. 2020.2 2021.2 POST /workflow_engine/tasks/search

Starting Jobs with Incorrect DataTypes Notice

When starting a job with variables, users will no longer be able to input incorrect values for those variables. For example, let's take a simple automation like this one below.


The correct types for the job variables are pictured below. Notice the form_name should be a string, resembling "this is a string", and the instance_data should be an object, resembling { "key": "data" }.


With the example below, the variables are set incorrectly, where an object is used for the form_name and a string for the instance_data.


Even with the incorrect variable types that were supplied, the automation will actually run when the user clicks Start.


Beginning with IAP 2020.2, however, the system will now display a warning message (at the bottom) to alert users they have given the job incorrect variables.


What should I do?

At a minimum of two releases from IAP 2020.2, this automation will no longer run if the job variable inputs do not match the type defined in the task. Begin now to modify your task input behavior to only start jobs with the correct input types for job variables so that once it becomes required, it will not impact your operations.

One special case (beginning in 2020.2.5) is if a job is started via child job and passes in a value of undefined for a variable. This will be processed as type null instead of being processed with an undefined type.

Item Description Deprecation Release Removal Release Replacement
startJobWithOptions Users will no longer be able to pass in values for job variables if the supplied value does not match the type (string, number, object, array, boolean, null) where the job variable is used.
Note: If the value passed in is undefined, it is processed as type null.
2020.2 2021.2 N/A

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.