What are Workflow Modules?
Modules are set of workflows steps with defined inputs that can be called/ inserted into multiple other workflows. Modules can never run on their own, they only run when called by a parent workflow.
How do you create Workflow Modules?
- In the left side navigation click Workflows!
- Navigate to Modules and click Create module
Modules tab within Workflows
3. After naming your module, define your inputs in the Input Data step. Inputs allow data to be passed from a workflow to a workflow module, enabling steps within the module to interact with that data.
4. Add the rest of your module workflow steps and save and publish the module.
5. Next, add a Module action step to the workflow you’d like to call the module. Select the module you just created in the module dropdown, then finish configuring the inputs by specifying what data from the parent workflow you would like to pass into the module.
- Adding the module action step means that when you run the parent workflow, it will execute all the steps in the module as part of that parent workflow run. Note that the module run will count as part of the parent workflow run (i.e., module runs are not double counted against their parent workflow run).
6. When making changes to modules, all workflows that call that module will be shown and you can propagate the latest module version to its parent workflows.
- You can also update to the latest module version in parent workflow (in module action step itself) with the Update to Latest button.
What can you do with Workflow Modules?
Simplify complex workflows
Workflows can get complex! By utilizing modules, workflow logic can be more easily organized and compartmentalized. You can also collapse modules, making it easier to visually manage workflows.
Minimize redundancy of maintaining
Some customers have workflow steps that need to happen in multiple workflows. By using workflow modules to handle these common steps, builders can make it easier to build and maintain workflows. Instead of having to update multiple workflows for changes to common steps (an error prone process), edits can happen in one workflow module and get propagated seamlessly.
Limitations
- Nested modules are not currently supported (i.e., you cannot create a module within a module)
- Modules not currently supported in embedded workflows in Inquiry template editor or in Actions
- Date fields are not supported as for inputs.
- Note that workflow modules are distinct from workflows (i.e. you should not assume every feature of workflows is inherited by modules). For instance:
- Modules’ runs never happen on their own, every module’s run will only happen as part of the parent workflow that calls it. This is also what makes workflow modules different from scheduled workflows, as scheduled workflows maintain separate workflow runs for the scheduling workflow and the executed workflow.
- Staged rollouts are not supported for modules
Examples
Module to update and tag Cases
Some customers have steps to update information from related objects to the Case and add relevant tags. Creating a module to run those steps is useful because any changes in field mapping or tagging can be maintained and updated in a central module, rather than having to update / manage mappings in multiple workflows.
Module for common workflow steps
Some customers end up running the same set of steps across multiple workflows. For instance, given a trigger inquiry and a case created off of it, a customer may want to run a Watch List and Politically Exposed Person report, attach the results to the case and apply a specific tag if there is a hit on either report. Putting these steps into a module can help reduce redundant steps across multiple workflows.
Plans Explained
Workflow Modules by plan
Startup Program | Essential Plan | Growth Plan | Enterprise Plan | |
---|---|---|---|---|
Workflow Modules | Limited | Limited | Available | Available |