Customizing workflows and advanced configuration options

The Problem

I want to customize a workflow in xMatters, but the features I'd like to amend aren't available.

Environment

All versions of xMatters

The Cause

You may be trying to edit one of our built-in workflow templates, which are pre-configured with default settings.

There are two types of templates that you can use:

• Built-in workflows can be installed directly and have a streamlined configuration process.

• Custom workflows are available for download, along with detailed configuration and setup instructions.

If you select a built-in workflow and need to customize it, some options will not be available. (Also, only users with the Developer role in xMatters can create or edit workflows - check to make sure it's not just a permission issue.)

Some built-in workflows, such as the default xMatters Incident Workflow in Flow Designer, are read-only. To change these, open Flow Designer, locate the workflow template, and use Install Workflow to add a customizable copy before you make any edits.

Resolution

If you need to modify a built-in workflow, you'll need to convert the template to a custom workflow. Converting a built-in workflow to a custom workflow is permanent. But, once converted, your custom workflow will still function exactly as the previous built-in workflow.

For workflows that are used by other features, make sure any integrations or actions are updated to reference your new custom workflow instead of the original. Once your customized version is in use, you can disable the default workflow to prevent it from being triggered by mistake.

Converting built-in workflows to custom workflows

1. On the workflow's details page, click the Settings icon and select Convert to Custom Workflow.

   

2. On the warning dialog window that appears, click Convert to Custom Workflow.

You can find more information on creating and managing your workflows here.