Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

FlowCategory

Represents a list of flows that are grouped by category. Flows aren’t added directly to a Lightning Bolt Solution. Instead, add the category the flows are in to the Lightning Bolt Solution. This type extends the Metadata metadata type and inherits its fullName field.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

File Suffix and Directory Location

FlowCategory components have the suffix .flowCategory and are stored in the flowCategories folder.

Version

FlowCategory components are available in API version 43.0 and later.

Fields

Field Name	Field Type	Description
description	string	The description of this flow category.
flowCategoryItems	FlowCategoryItems[]	The list of flows in this flow category.
masterLabel	string	Required. The label for this flow category, which appears in Setup.

FlowCategoryItems

Represents the list of flows in a flow category.

Field Name	Field Type	Description
flow	string	Required. The name of the flow.

Declarative Metadata Sample Definition

The following is an example of a FlowCategory component.

1<?xml version="1.0" encoding="UTF-8"?>
2<FlowCategory xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
3    <flowCategoryItems>
4        <flow>PausableFlow</flow>
5    </flowCategoryItems>
6    <flowCategoryItems>
7        <flow>BankingFlow</flow>
8    </flowCategoryItems>
9    <masterLabel>updateBenefits</masterLabel>
10        <description>All the update benefits.</description>
11</FlowCategory>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>updateBenefits</members>
5        <name>FlowCategory</name>
6    </types>
7    <version>43.0</version>
8</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide