Conversion Batch — entity reference

A conversion batch is one submission from a Bulk Conversion screen: a set of source documents or lines (for example order lines) being converted into their next document (for example invoices) in the background. Submitting reserves each line's quantity in the conversion's quantity pool, so the same units cannot be promised twice, and queues the batch. A worker then runs the conversion's per-record action in chunks and records the outcome on one batch line per source line. A submission spanning several companies or branches becomes one batch per company and branch. Batches are created only by the conversion engine, never typed in by hand. Users follow them under Recent runs or on the batch record, where Retry Failed Lines and Cancel Batch are available. Target documents already created are never removed by cancelling or failing a batch.

Fields

Field	Label	Type	Required	What it does
`ActionName`	Action	Text		The server action that staged the batch, taken from the definition's Batch Action Name.
`AttemptCount`	Attempts	Number		Whole-batch execution attempts used so far.
`BatchId`	BatchId	Lookup → ConversionBatchLine
`CancelledLines`	Cancelled Lines	Number		Lines released by Cancel Batch, by cancellation at a chunk boundary, or by deleting the batch.
`ChunkSize`	Chunk Size	Number		Lines per execution transaction, copied from the definition's Chunk Size (default 50).
`CompletedUtc`	Completed	DateAndTime		When the batch reached a final status.
`ConversionKey`	Conversion	Text		The conversion definition's key (its Name), for example sales.order-to-invoice. The batch looks the definition up by this key when it runs and when it is retried, so a deactivated or removed definition stops its batches being retried.
`CreatedById`	Created By	Lookup → UserAccount	Yes
`CreatedDateTime`	Created On	DateAndTime	Yes
`ErrorMessage`	Error	LongMultiLineText		Why the batch or its last attempt failed. For a mixed or failed result without a more specific error, a summary of failed, succeeded and skipped line counts.
`FailedLines`	Failed Lines	Number		Lines that failed for good: a validation failure, a missing record or action, or attempts used up. Retry Failed Lines puts them back to pending when quantity is still available.
`FromDate`	From Date	Date		Not recorded on batches; the date range used on the screen is not stored.
`Id`	Id	Guid	Yes
`IdempotencyKey`	Submission Key	Text		The submission key sent by the screen. Every call of one submission joins the same batch, and a repeated submission finds its quantity already reserved, so nothing converts twice.
`JobRunId`	Job Run	Guid		The background job run that executed the batch, for finding it under Setup, Platform, Monitoring, Jobs.
`Label`	Label	Text		Display name of the batch, defaulted to the conversion's display name.
`LeaseExpiryUtc`	Lease Expiry	DateAndTime		When the current worker's claim lapses.
`LeaseOwner`	Lease Owner	Text		The worker currently holding the batch. If that worker stops, another worker reclaims the batch once the lease expires; finished chunks are not redone.
`MaxAttempts`	Max Attempts	Number		Whole-batch attempts allowed (default 3). After a failed attempt the batch waits 2, 4, 8 minutes and so on, at most 30, before the next one.
`ModifiedById`	Modified By	Lookup → UserAccount	Yes
`Name`	Name	Text	Yes	The batch number. Taken from the Conversion Batch document numbering when a series is set up, otherwise a generated number starting with CVB.
`NextAttemptUtc`	Next Attempt	DateAndTime		Earliest time a failed batch may be attempted again.
`OptionsJson`	Options	LongMultiLineText		The conversion options chosen on the screen when the batch was submitted.
`OwnerId`	Owner	Lookup → UserAccount	Yes
`PayloadJson`	Payload	LongMultiLineText		The staging arguments as submitted, kept for troubleshooting.
`PendingLines`	Pending Lines	Number		Lines still waiting or being processed.
`PendingQuantityField`	Pending Quantity Field	Text		The source-line field that holds the quantity still to convert, for example the pending invoice quantity on an order line.
`Priority`	Priority	Number		Order in which waiting batches are picked up; lower runs first. Default 100.
`ProcessingMode`	Processing Mode	PickList		RecordLevel when whole records were submitted and every available line converts; LineLevel when the user picked individual lines, which then convert at the quantities picked.
`QuantityPool`	Quantity Pool	Text		The reservation pool the batch holds quantity in, from the definition. Conversions consuming the same pending-quantity field share a pool, so a line held by one batch shows as held to every conversion in the pool.
`QueuedUtc`	Queued	DateAndTime		When the batch was staged.
`RecordTypeId`	Record Type	Guid, hidden
`RequestedById`	Requested By	Lookup		Not recorded on batches.
`RequestedByName`	Requested By Name	Text		Not recorded on batches.
`ScopeAccountId`	Account	Lookup		Not recorded on batches. Batches record only the company and branch their records belong to.
`ScopeBranchId`	Branch	Lookup		Not recorded under this name. Batches record the branch every record belongs to in Branch, blank when they span several.
`ScopePartnerAccountId`	Partner Account	Lookup		Not recorded under this name. Batches record the company every record belongs to in Partner Account, blank when they span several.
`SkippedLines`	Skipped Lines	Number		Lines with nothing left to convert, quantity held by another batch, or an action that produced no target document. Not an error; a batch of only skipped lines ends Completed.
`SourceEntityName`	Source Entity	Text		The entity the batch converts from, kept on the batch so an old batch still reads correctly.
`SourceLineEntityName`	Source Line Entity	Text		The line entity of the source document.
`StartedUtc`	Started	DateAndTime		When a worker first claimed the batch.
`Status`	Status	PickList		Lifecycle of the batch, set only by the engine. Draft: being filled by a select-all run and not yet runnable. Scheduled: reserved and waiting for its run time. Queued: waiting for a worker. Processing: being converted. Cancelling: cancel requested, stops at the next chunk. Completed: no line failed (skipped lines do not count as failures). CompletedWithErrors: some lines failed and some succeeded. Failed: lines failed and none succeeded, or the batch itself could not run (it is retried after a backoff while attempts remain). Cancelled: stopped by a user or every line cancelled.
`SubscriptionKey`	Subscription Key	Guid, hidden	Yes
`SucceededLines`	Succeeded Lines	Number		Lines whose record converted and produced a target document.
`TargetEntityName`	Target Entity	Text		The entity the batch creates.
`ToDate`	To Date	Date		Not recorded on batches; the date range used on the screen is not stored.
`TotalLines`	Total Lines	Number		Number of batch lines, including lines staged as Skipped.
`TotalProcessedQuantity`	Processed Quantity	Decimal		Total quantity converted. A succeeded line is credited with the quantity it requested, because the conversion action reports success per record, not per line.
`TotalRequestedQuantity`	Requested Quantity	Decimal		Total quantity actually reserved at submission, counting only lines that were reserved.
`UpdatedDateTime`	Updated On	DateAndTime	Yes
`ValidationMessage`	Validation Message	LongMultiLineText		Not recorded on the batch. Validation messages are kept per line, on each batch line.

Actions

Action	Label	Type	What it does
`CancelBatch`	Cancel Batch	ServerAction (`CancelBatch`)	Cancels a Queued or Scheduled batch at once and releases its pending lines' quantity; a Processing batch moves to Cancelling and stops at its next chunk. A finished batch is left as it is. Target documents already created are kept.
`GetConversions`	Get Conversions	ServerAction (`GetConversions`)	Record-less. Returns the active conversion definitions, which the Bulk Conversion screen reads when it loads.
`GetHeldQuantities`	Get Held Quantities	ServerAction (`GetHeldQuantities`)	Record-less. Returns the quantity open batches hold per source line, which the screen subtracts to show what is still available.
`RetryFailedLines`	Retry Failed Lines	ServerAction (`RetryFailedLines`)	Puts Failed lines back to Pending and re-queues the batch. Each line is re-checked against the source's current pending quantity less what other batches hold, and retried for at most what it originally asked; a line with nothing left stays Failed with the numbers in its error. Refused while the batch is Scheduled or when its conversion is no longer registered.

ConversionBatchLine — referenced by via BatchId

Conversion Batch — entity reference

Fields

Actions

Related entities

Related topics