Workflow Transforms

Referencing a Workflow Transform

Workflow Transforms function like transforms created in the Module Builder. The main difference is how you trigger a Workflow Builder transform. Module Builder transforms trigger a Plug-In component using the Execute Transform service, while workflows trigger their transform using the Get Workflow Submission service. The point in your workflow at which you add the Plug-In component depends on the use case.

Adding a Plug-In Component

Use a Plug-In component to make an API call to the Get Workflow Submission endpoint. Configure it to reference the name of your transform in the call.

The module where you configure the Plug-In component must exist in the workflow-type application where you created your transform.

1. Open the module where you created the transform.

2. In the Module Builder, drag and drop a Plug-In component onto the canvas.

3. In the Property ID and Canvas Label Text fields, enter pluginExecuteTransform.

4. From the Internal Services drop-down, enter or select Get Workflow Submission. The Data Source URL and Request Type fields populate.

5. In the Data Source URL, replace the {workflowId} and {submissionId} placeholder values in with the workflow ID and workflow submission ID containing the transform.

   You have two options for replacing the placeholder values. You can manually input the workflow ID and submission ID values. Or, you can reference components in your module that are storing those values. If referencing a component in your module, retain the curly braces around the component's Property ID. If hardcoding the values, replace the {workflowId} and {submissionId} placeholders.

6. In the Inputs table, enter the following:

   Property ID	Mapping
   'Your Workflow ID'	workflowId
   'Your Workflow Submission ID'	submissionId
   'Your Transform Name'	transformName

   Replace the Property ID fields with your workflow, submission, and transform values.

7. In the Outputs table, enter the following:

   	Property ID	Mapping	Option	Header
   1	data	{{targetDestination}}

   Entering data references the entire object returned by the API call. Your transformed data returns as an object stored under the data key. You can also use dot notation to reference the fields stored inside the data object. To learn more about other parameters, view the Get Workflow Submission endpoint here: https://developers.unqork.io/#tag/Submissions%2Fpaths%2F~1workflows~1%7BworkflowId%7D~1submissions~1%7BsubmissionId%7D%2Fget.

   Consider the following resources for Transform Inputs and Outputs in the Plug-In component’s Outputs table:

   Transform Type	Mapping
   Input	Map the information coming out of the transform to the applicable field(s) in your module. This overrides the original information.
   Output	Map the information coming from the transform to where you want it to go.

   

8. Click Save Component.

Adding a Button Component

Next, add a Button component to trigger the Plug-In component.

1. Drag and drop a Button component onto your canvas, placing it below the pluginExecuteTransform Plug-In component.

2. In the Property ID  field, enter btnExecuteTransform.

3. In the Label Text field, enter Execute Transform.

4. From the Action Type drop-down, select Event.

5. From the On Click drop-down, enter or select pluginExecuteTransform.

6. Click Save Compoenent.

7. Save your module.

Testing a Transform

Test transforms by opening your workflow in Express View and creating a submission. Next, use the submission ID in the Transforms modal’s Unit Testing field.

To test your transform:

1. Open your workflow in the Workflow Builder.

2. Click the (ellipsis) button.

3. Select Transforms. Your transforms display in the Active Transforms table.

4. From the Action drop-down, click View and Edit for the transform you want to test.

5. Navigate to the bottom of the Transforms modal and expand the Unit Testing panel.

6. In the Submission ID field, enter a submission ID. Submission data from the module populates in the Input field.

7. Click Run Test. The transformed data displays in the Output field.

   

Editing a Transform

After creating and testing your transform, you can make changes to it. Once you've created a transform, you can only change the Transform block or what your transform actually does.

To edit a transform:

1. Open your module in the Module Builder.

2. Click the (ellipsis) button.

3. Select Transforms. Your transforms display in the Active Transforms table.

4. From the Action drop-down, click View and Edit for the transform you want to edit.

                                              

5. Edit your transform as necessary.

   You cannot edit the transform name after creation.

6. Click Save.

7. Click Back to return to the Transforms modal. Or, click X to return to the Module Builder.

Downloading a Transform

If you restore a previously deleted module, the transform does not restore with it. To avoid having to recreate the transform, you can download it as a backup. Then, you can copy and paste it to a new transform.

It's important to note that your downloaded transform includes the transform body only. The file does not include the Unqork settings that go with it. To restore your Unqork settings, set them up as you would a new transform.

To download a transform:

1. Open your module in the Module Builder.

2. Click the (ellipsis) button.

3. Select Transforms. Your transforms display in the Active Transforms table.

4. From the Action drop-down, click Download for the transform you want to download.

                                              

5. Locate the file in the downloads folder of your computer.

Deleting a Transform

If you no longer need a transform, you can delete it.

Deleting a transform does not delete the components that reference it in a module.

To delete a transform:

1. Open your module in the Module Builder.

2. Click the (ellipsis) button.

3. Select Transforms. Your transforms display in the Active Transforms table.

4. From the Action drop-down, click Delete for the transform you want to remove.

                                              

5. At the Delete confirmation message, click OK.