Industries Common Resources Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Industries Common Resources
AI Accelerator and Scoring Framework
Action Launcher
Actionable List Members
Actionable Segmentation
Business Rules Engine
Collections and Recovery
Context Service
Criteria-Based Search and Filter
Data Processing Engine, Batch Management, and Monitor Workflow Services
Data Model
Common Tooling API Object
Common Platform Event
Common Business APIs
Data Processing Engine
Data Processing Engine Tooling API Objects
BatchCalcJobDefinition
Data Processing Engine Standard Object
Data Processing Engine Metadata API
Data Processing Engine Invocable Actions
Batch Management
Monitor Workflow Services
Digital Lending
Discovery Framework
Decision Explainer
Einstein Relationship Insights
Einstein Standard Invocable Actions
Engagement
Group Membership and Households
Identity Verification
Intelligent Document Reader
Intelligent Form Reader
Interest Tagging
Omnistudio Business APIs
Outcome Management Developer Guide
Outreach List
Process Compliance Navigator
Record Alerts
Record Rollup Definitions
Scheduled Reminders
Sentiment Insights
Service Process Studio
Timeline
Virtual Calls
Associated Objects
IndustriesSettings
Industries Object Access by Community License
Access Industries Features Deployed Using Managed Packages
PDF

BatchCalcJobDefinition

Represents a Data Processing Engine (DPE) definition. This object is available in API version 51.0 and later.

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.

Note

Supported SOAP API Calls

describeSObjects(), query(), retrieve()

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Fields

Field Details
BatchJobDefinitionId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The unique identifier of the associated batch job definition.
This is a relationship field.
Relationship Name
BatchJobDefinition
Relationship Type
Lookup
Refers To
BatchJobDefinition
DefinitionRunMode
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Possible values are:
  • Batch
  • OnDemand—On Demand
The default value is Batch.
DeveloperName
Type
string
Properties
Filter, Group, Sort
Description
The developer name of the Data Processing Engine definition.
ExecutionPlatformType
Type
Picklist
Properties
Filter, Group, Restricted picklist, Sort, Not-Nillable
Description
Specifies the platform that's used to run the Data Processing Engine definition. Possible values:
  • CRMA—CrmAnalytics
  • CDP— DataCloudForMarketing
  • CORE—This value is reserved for internal use.
FullName
Type
string
Properties
Create, Group, Nillable
Description
The name of the Data Processing Engine definition.
Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
IsTemplate
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether this is a template Data Processing Engine definition.
Language
Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description
The language in which this Data Processing Engine definition is created.
Possible values are:
  • da—Danish
  • de—German
  • en_US—English
  • es—Spanish
  • es_MX—Spanish (Mexico)
  • fi—Finnish
  • fr—French
  • it—Italian
  • ja—Japanese
  • ko—Korean
  • nl_NL—Dutch
  • no—Norwegian
  • pt_BR—Portuguese (Brazil)
  • ru—Russian
  • sv—Swedish
  • th—Thai
  • zh_CN—Chinese (Simplified)
  • zh_TW—Chinese (Traditional)
ManageableState
Type
ManageableState enumerated list
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Indicates the manageable state of the specified component that is contained in a package:
  • beta
  • deleted
  • deprecated
  • deprecatedEditable
  • installed
  • installedEditable
  • released
  • unmanaged
MasterLabel
Type
string
Properties
Filter, Group, Sort
Description
Label of the Data Processing Engine definition.
Metadata
Type
complexvalue
Properties
Create, Nillable, Update
Description
Data Processing Engine definition's metadata.
Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
NamespacePrefix
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation.

The namespace prefix can have one of the following values:

  • In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There’s an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition organization of the package developer.
  • In organizations that aren’t Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There’s no namespace prefix for all other objects.
ProcessType
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
Required. The process type for which the Data Processing Engine definition is created.
Possible values are:
  • AccountingPeriodClosure—Legal Entity Accounting Period Closure
  • AccountingSubledger—This value is reserved for internal use.
  • ActionableList
  • AdvancedAccountForecast
  • BenefitManagement—Available in API version 61.0 and later.
  • BillingSchedulesforInvoiceGeneration—Billing Schedules for Invoice Generation
  • ChannelInventoryManagement—Available in API version 63.0 and later.
  • CriteriaBsdSearchAndFilter - Criteria-Based Search And Filter
  • CSVCoreUpload—This value is reserved for internal use.
  • DataProcessingEngine - Standard
  • DecisionMatrixDataUpload - This value is available only if you have Business Rules Engine enabled.
  • Decisiontable—Decision table activation
  • EmployeeService—Available in API version 63.0 and later.
  • FinancialSummaryRollup—Available in API version 62.0 and later.
  • FSCHierarchyRollUp
  • FundraisingRollups—Available in API version 63.0 and later.
  • InvoiceGeneration—Available in API version 62.0 and later.
  • LegalEntityAccountingPeriodClosureAdvanced—Available in API version 63.0 and later.
  • LifeSciencesCommercialTerritoryAlignment—Available in API version 63.0 and later.
  • Loyalty
  • LoyaltyPartnerManagement
  • LoyaltyPointsAggregation
  • NetZero
  • NextGenForecasting—Available in API version 62.0 and later.
  • PnmRosterFileUpload—Available in API version 62.0 and later.
  • PriceProtection—Available in API version 62.0 and later.
  • ProductCatalogManagement—Available in API version 62.0 and later.
  • ProgramBasedBusiness
  • ProgramManagementRollups
  • ProviderSearch—This value is reserved for internal use.
  • Rebates
  • Recruitment—Available in API version 62.0 and later.
  • RevenueTransactionManagement—Available in API version 63.0 and later.
  • SalesAgreement—Available in API version 63.0 and later.
  • TestProcessType—Available in API version 62.0 and later.
  • UsageManagement—Available in API version 62.0 and later.
When Data Processing Engine is enabled for a Salesforce org, the default value is 'Standard’. Other process types may be available to you depending on your industry solution and permission sets.