ActionableEventOrchDef

Represents the definition of an actionable event orchestration so that the records can be migrated from one org to another.

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

ActionableEventOrchDef components have the suffix .actionableEventOrchDef and are stored in the ActionableEventOrchDef folder.

Version

ActionableEventOrchDef components are available in API version 64.0 and later.

Fields

actionableEventUsageType

  • Field Type: string
  • Description: The usage type of the actionable event orchestration definition.
  • Possible values:
    • Automotive—1
    • Manufacturing—2
    • Standard—3

apiName

  • Field Type: string
  • Description: Required. The API name of the actionable event orchestration definition record.

contextDefinitionDeveloperName

  • Field Type: string
  • Description: The developer name of a context definition that's associated with the actionable event orchestration definition.

contextMappingTitle

  • Field Type: string
  • Description: The title of a context mapping that's associated with the actionable event orchestration definition.

eventCategory

  • Field Type: string
  • Description: The category of an actionable event orchestration definition.

eventSubtypeApiName

  • Field Type: string
  • Description: The API name of an actionable event orchestration definition subtype.

eventTypeApiName

  • Field Type: string
  • Description: Required. The API name of an actionable event orchestration definition type.

executionProcedureAPIName

  • Field Type: string
  • Description: The API name of the flow definition or the expression set template that executes the orchestration.

executionProcedureType

  • Field Type: string
  • Description: Specifies the type of automated procedure that executes the orchestration.
  • Possible values:
    • ExpressionSetBasedOrchestration—1
    • FlowBasedOrchestration—2

isActive

  • Field Type: boolean
  • Description: Required. Specifies if an actionable event orchestration definition record is active (true) or not (false).
  • Default value: false

isTemplate

  • Field Type: boolean
  • Description: Required. Indicates whether the actionable event orchestration definition is a template (true) or not (false).

    The default value is false.

label

  • Field Type: string
  • Description: Required. The label of the actionable event orchestration definition record.

Declarative Metadata Sample Definition

The following is an example of an ActionableEventOrchDef component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ActionableEventOrchDef xmlns="http://soap.sforce.com/2006/04/metadata">
3    <actionableEventUsageType>1</actionableEventUsageType>
4    <apiName>Create_Asset_Registration</apiName>
5    <contextDefinitionDeveloperName>AssetRegistrationCreateRecordDetails_stdctx</contextDefinitionDeveloperName>
6    <contextMappingTitle>VehicleFaultEventDetailMapping</contextMappingTitle>
7    <eventSubtypeApiName>Create_Registration_Records_SubType</eventSubtypeApiName>
8    <eventTypeApiName>Create_Registration_Records</eventTypeApiName>
9    <executionProcedureAPIName>CreateAssetFlow</executionProcedureAPIName>
10    <executionProcedureType>2</executionProcedureType>
11    <isActive>true</isActive>
12    <label>Create Asset Registration</label>
13</ActionableEventOrchDef>

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>*</members>
5        <name>ActionableEventOrchDef</name>
6    </types>
7<version>64.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.