| ActiveVersionId |
- Type
- reference
- Properties
- Filter, Group, Nillable, Sort
- Description
- The ID of the active orchestration version. This field is a
relationship field.
- This field is a relationship field.
- Relationship Name
- ActiveVersion
- Refers To
- FlowOrchestrationVersion
|
| ApiName |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- The API name of the the orchestration.
|
| ApiVersion |
- Type
- int
- Properties
- Filter, Group, Nillable, Sort
- Description
- The API version of the active orchestration or the last saved
orchestration.
|
| AverageRunTime |
- Type
- int
- Properties
- Filter, Group, Nillable, Sort
- Description
- The average duration of an orchestration run that has completed
without error.
|
| CompletionRate |
- Type
- percent
- Properties
- Filter, Nillable, Sort
- Description
- The percentage of the total number of orchestration runs that
have completed without error.
|
| Description |
- Type
- textarea
- Properties
- Nillable, Update
- Description
- The description of the flow orchestration.
|
| FailedRunCount |
- Type
- int
- Properties
- Filter, Group, Nillable, Sort
- Description
- The number of orchestration runs that have failed.
|
| InstalledPackageName |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- The API name of the installed package that the orchestration is a
part of.
|
| IsCitizenEnabled |
- Type
- boolean
- Properties
- Defaulted on create, Filter, Group, Sort
- Description
- Indicates whether the orchestration can be modified by
non-admins. Valid value is False.
- The default value is false.
|
| IsOverridable |
- Type
- boolean
- Properties
- Defaulted on create, Filter, Group, Sort
- Description
- Indicates whether the orchestration that's part of a managed
package is overridable.
- The default value is false.
|
| IsTemplate |
- Type
- boolean
- Properties
- Defaulted on create, Filter, Group, Sort
- Description
- Indicates whether the orchestration record is a template.
- The default value is false.
|
| LastReferencedDate |
- Type
- dateTime
- Properties
- Filter, Nillable, Sort
- Description
- The timestamp for when the current user last viewed a record
related to this record.
|
| LastViewedDate |
- Type
- dateTime
- Properties
- Filter, Nillable, Sort
- Description
- The timestamp for when the current user last viewed this
record.
|
| ManageableState |
- Type
- picklist
- Properties
- Filter, Group, Nillable, Restricted picklist, Sort
- Description
- Specifies the managable state of the orchestration that's
contained in a package.
- Valid values are:
-
beta—Managed-Beta
-
deleted—Managed-Proposed-Deleted
-
deprecated—Managed-Proposed-Deprecated
-
deprecatedEditable—SecondGen-Installed-Deprecated
-
installed—Managed-Installed
-
installedEditable—SecondGen-Installed-Editable
-
released—Managed-Released
-
unmanaged—Unmanaged
|
| Name |
- Type
- string
- Properties
- Filter, Group, idLookup, Sort, Update
- Description
- The label of the orchestration.
|
| NamespacePrefix |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- The namespace prefix associated with the orchestration record.
|
| OrchestrationDefinition |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- Represents the orchestration definition.
|
| OrchestrationLabel |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort, Update
- Description
- The label of the orchestration.
|
| OrchestrationType |
- Type
- picklist
- Properties
- Filter, Group, Nillable, Restricted picklist, Sort
- Description
- The orchestration's flow type. FlowType consolidates ProcessType
and TriggerType into one field. FlowType is used with permissions,
so admins can control access to each flow type.
- Valid values are:
-
OrchAutolnch—Autolaunched No Trigger
Orchestration: Launches when invoked by Apex, REST API,
custom buttons, or custom links. An orchestration lets you
create a multi-step, multi-user process.
-
OrchRecTrigAftSave—Record-Triggered After
Save Orchestration: Launches when a record is created or
updated. An orchestration lets you create a multi-step,
multi-user process. This type of flow runs in the background
without user interaction.
-
CmsOrchAutolnch
—CMS Workflow Orchestration Autolaunched:
Launches when invoked from the Workflows component in a CMS
workspace. This type of orchestration lets you create a
multi-step, multi-user process to create, edit, organize, and
manage digital content from a centralized location
|
| OverriddenById |
- Type
- reference
- Properties
- Filter, Group, Nillable, Sort
- Description
- The ID of the orchestration that's overriding the current
orchestration.
- This field is a relationship field.
- Relationship Name
- OverriddenBy
- Refers To
- FlowOrchestration
|
| OverriddenOrchestrationId |
- Type
- reference
- Properties
- Filter, Group, Nillable, Sort
- Description
- The ID of the orchestration that the current orchestration is
overriding.
- This field is a relationship field.
- Relationship Name
- OverriddenOrchestration
- Refers To
- FlowOrchestration
|
| RunCount |
- Type
- int
- Properties
- Filter, Group, Nillable, Sort
- Description
- The number of orchestration runs that have been started across
all orchestration versions.
|
| SourceTemplateId |
- Type
- reference
- Properties
- Filter, Group, Nillable, Sort
- Description
- The ID of the template that the orchestration was created
from.
- This field is a relationship field.
- Relationship Name
- SourceTemplate
- Refers To
- FlowOrchestration
|
| Status |
- Type
- picklist
- Properties
- Filter, Group, Nillable, Restricted picklist, Sort
- Description
- The status of the record.
- Valid values are:
-
Active—Active
-
Draft—Inactive
-
InvalidDraft—Draft
-
Obsolete—Inactive
|
| TriggerType |
- Type
- picklist
- Properties
- Filter, Group, Nillable, Restricted picklist, Sort
- Description
- Specifies the trigger type for a record-triggered orchestration.
- Valid values are:
-
RecordAfterSave—Record—Run After Save
|
j