| Information |
Pipeline Name | Name of the Pipeline. |
Pipeline API Name | API Name for the Pipeline. If left blank, it automatically defaults to the Pipeline's Name when the record is saved. |
Template Direction | Used as a template for creating Executables from this Pipeline. |
Deployable? | Indicates whether this Pipeline is deployable; automatically set to true if any associated Executable is deployable. |
Description | A brief description of the Pipeline's purpose and scope. |
Specification | Free-form field for documenting detailed information about the Pipeline, including its configurations, underlying rationale, and any additional notes. |
All Internal Users Can Read Executables? | Update to this field will sync with the "All Internal Users Have Read Access?" field of the related Executables. "All Internal Users Have Read Access?" is used to share the Executables with All Internal Users for accessing Executables through the record page or the LWCs that are in reference to those Executables, such as the Executable Data List and Pipeline Data Lists. |
Incremental Backup to File? | Marks this Pipeline for incremental backup to file, which enables the backup and restore features and enforces backup-compliant settings on its Executables. |
Record-Based Configuration Deployment? | Specifies whether this Pipeline deploys record-based configuration. When enabled, the Data Sync Pro VS Code plugin exports the source data of all related Executables as JSON, supporting local backup and metadata-driven version control in a code repository. |
Raw Record | Opens a full field inspector for this record, showing every field's API name, type, and value, with quick search, edit, and clone. |
Access Permissions | Comma separated custom permission names. If set, Pipeline components/execution are accessible only to users who have at least one listed permission. |
Additional Retrieve Criteria | Additional SOQL criteria appended to each Executable's Retrieve query, refining data retrieval with extra conditions (e.g., LastModifiedDate > 2022-01-01T00:00:00Z). |
Scope Filter | Shared Scope Filter for this Pipeline, applied in addition to each Executable's individual filters to refine data processing across the entire Pipeline. |
Origin ID | Identifier used for matching records during cross-system synchronization. It defaults to the Salesforce record ID on save but can be overridden with a custom unique value. Once established, it must remain unchanged after the initial sync. |
| #Batch |
Next Pipeline (Scheduled or API) | Specifies the next Pipeline to run automatically after this Pipeline completes. It runs on scheduled batch execution, and on API batch execution when the caller opts in. |
Stop Remaining When an Executable Fails? | If checked, when one of the Pipeline's Executables completes and fails the execution, the Pipeline Execution stops without executing the remaining Executables. |
Notify When Execution Completes | DSP sends a notification to the provided email addresses when the Pipeline Execution is completed. This also depends on the Email Deliverability setting if running in Sandbox. |
Notify Email Addresses | Comma-separated email addresses to add to the notification recipients. This applies on Pipeline Execution completion (when 'Notify When Execution Completes' is specified) or when a related Trigger Executable running in a Future method fails. |
Notify Running User? | When enabled, adds the running user to the email notification recipients. This applies on Pipeline Execution completion (when 'Notify When Execution Completes' is specified) or when a related Trigger Executable running in a Future method fails. |
Action Button Label | Sets the label for the Pipeline level action button such as "Pipeline Batch Execution Button". Defaults to "Execute Pipeline" if left blank. |
Notify Owner? | When enabled, adds the Pipeline owner to the email notification recipients. This applies on Pipeline Execution completion (when 'Notify When Execution Completes' is specified) or when a related Trigger Executable running in a Future method fails. |
| #Action Button |
Visible Action Buttons | Maximum number of Action Buttons displayed directly on the Pipeline Action Buttons component; additional buttons are collapsed into a menu. For a Data List Executable with 'Q: Action Buttons' specified to the current Pipeline, this value defines the number of visible list action buttons on the Data List when the Executable's 'Q: Max Visible List Action Buttons' is not defined. |
| #Data List |
Variant | Specifies how Pipeline components are displayed. If not specified, ‘stack’ is used by default. |
Tabset Variant | Defines the visual style of tabs when the Data Lists Variant is set to 'tabs'. If not specified, 'scoped' is defaulted. |
