Task Configuration

Once your Activepieces (AP) task has been placed on your template, you can click the edit button in the task's hamburger menu.

Configuring the Activepieces Task

The fields will be documented in the order they appear in the edit interface.

Label of the task

The label you wish to have shown on the task in your Maestro template builder.  By default it is set to "Activepieces task".  You can change the label so that you can differentiate it from any other AP tasks you may have in the template.  The label you choose has no effect on its operation.

Activepieces Webhook URL

The URL that Activepieces has provided for you via the Activepieces Catch Webhook trigger. 

You do not create the URL!  Activepieces provides this URL for you.

Future capabilities:  Via the Orchestration module, Webhooks in Activepieces created the Drupal Webhook trigger will be presented as options for use as the webhook URL.

Keep this task resident in the Maestro Queue

This option only appears if you have the Orchestration module installed.

When your Maestro template is being run by the Maestro Orchestrator, you can keep the AP task you're editing from completing by turning this option on.  

When on, the AP task will execute once (unless there's an error as defined below).  After the single execution, the task remains resident in the Maestro queue.  The task will present itself as having an "On Hold" status, however, the execution of the task will be bypassed.

It will be up to you as a developer OR as an Activepieces flow creator to send back a task completion flag update in order to allow the AP task to complete.

Implementation Details

The Maestro AP task accomplishes the task suspension via the Maestro Orchestrator's API to suspend a task.  The "suspend" flag is used by the Maestro AP task to determine whether to run the task or to bypass the execution when the suspension flag is set.

Authentication Type

The authentication option comes directly from the Activepeices configuration for the Catch Webhook trigger.  The option for basic or header auth will only appear if you install the Key module.  See the section in this guide on configuration of the Key for use in basic or header auth.

The options are

• None
  • Nothing more to configure.
• Basic Auth
  • Reveals a Key to choose from.
• Header Auth
  • Reveals  a Key to choose from.

Select the key for Basic or Header Auth which should be based on the values you've configured in the Activepieces Catch Webhook trigger on your Activepieces site (not Drupal).

Error Handling

When you expand the Error Handling section, a number of options appear as shown here.

• Log failure to call the Activepieces webhook will dump a message into the watchdog log.
• Keep this task in the queue on failure to call the Activepieces webhook option will not complete the task and will re-execute the task on the next Maestro Orchestrator execution cycle.  
  • At this moment in time, there is no limit to the number of times the orchestrator will re-run the AP task.
  • Future versions of the task will be able to configure the number of runs that have happened and gracefully fail.
• Set the webhook error to a process variable on webhook call failure option allows you to trap the error message in a process variable and create your own exception handling routine with Maestro.

Data to send to Activepieces

The Data section is where you define what data you're sending to Activepieces.

You're able to create any number of Key/Value pairs to send to Activepieces.  Those Key/Value pairs can be used within Activepieces to perform the actions you wish to take place.

The Key field is where you'll give your data a unique identifier.  This identifier you'll use as a reference to its value within Activepieces.

The Type field is used to define whether you wish to manually enter the data or to use the value from a Process Variable to associate to the Key.

The Value field will change from a textarea as shown above or a drop down select list of Process Variables.  When using the Manual entry and/or token type option, you can enter in any text you wish into the value field, including tokens.  A token browser is provided for you if you have the Token module installed.  This is how you can pass any type of information to Activepieces including the render of Maestro process variables, Maestro AI entities, and any other tokens and text you see fit to pass along.