DocGenerationBatchProcess

Represents a grouping of document generation requests associated with the batch document generation ID. Only one batch document generation request can be processed at a time. To create a new batch document generation record, pause or cancel the current record. This object is available in API version 58.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Special Access Rules

DocGenerationBatchProcess is available if your org has the DocGen platform license and related addon and user licenses.

Fields

Field Details
Category
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The category/classification of the document generation batch process request.
Possible values are:
  • Agreements
  • Proposals
  • Quotes
CompletionDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date when the document generation batch process was completed.
Description
Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The description of the document generation batch process record.
FailedRequestCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of failed document generation requests associated with the document generation batch process.
InProgressRequestCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of in progress document generation requests associated with the document generation batch process.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The autogenerated system name for a document generation batch process record. For example, BatchReq-0001.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the user that owns this record.
This field is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
The status of the document generation batch process request.
Possible values are:
  • Canceled
  • Completed
  • InProgress—In Progress
  • New
  • Paused
The default value is New.
SuccessfulRequestCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of successful document generation requests associated with the document generation batch process.
TotalRequestCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The total number of document generation requests associated with the document generation batch process.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

DocGenerationBatchProcessChangeEvent
Change events are available for the object.
DocGenerationBatchProcessFeed
Feed tracking is available for the object.
DocGenerationBatchProcessHistory
History is available for tracked fields of the object.
DocGenerationBatchProcessOwnerSharingRule
Sharing rules are available for the object.
DocGenerationBatchProcessShare
Sharing is available for the object.