Conversion Batch — entity reference

A staged document conversion (Order → Invoice, Requisition → Purchase Order, …). Created by the batch engine and executed by the scheduler.

Fields

Field	Label	Type	Required	What it does
`ActionName`	Action	Text		Server action that staged the batch.
`AttemptCount`	Attempts	Number		Execution attempts consumed.
`BatchId`	BatchId	Lookup → ConversionBatchLine
`CancelledLines`	Cancelled Lines	Number		Lines cancelled before they ran.
`ChunkSize`	Chunk Size	Number		Lines per execution transaction. Bounds lock duration and the work a crash discards.
`CompletedUtc`	Completed	DateAndTime		When it reached a terminal status.
`ConversionKey`	Conversion	Text		Registered conversion key, e.g. sales.order-to-invoice. The discriminator that lets one table serve every conversion.
`CreatedById`	Created By	Lookup → UserAccount	Yes
`CreatedDateTime`	Created On	DateAndTime	Yes
`ErrorMessage`	Error	LongMultiLineText		Why the last attempt failed.
`FailedLines`	Failed Lines	Number		Lines that failed and exhausted their attempts.
`FromDate`	From Date	Date		Start of the document-date window the submission used.
`Id`	Id	Guid	Yes
`IdempotencyKey`	Submission Key	Text		Client submission key. The first call creates the batch and later calls append to it, so one submission is one batch however many records it covers.
`JobRunId`	Job Run	Guid		Tenant-jobs run that executed the batch.
`Label`	Label	Text		Display label, defaulted to the conversion display name.
`LeaseExpiryUtc`	Lease Expiry	DateAndTime		Claim expiry. Past this any worker may reclaim the batch — how a dead worker is recovered from.
`LeaseOwner`	Lease Owner	Text		Worker holding the claim, as machine:pid.
`MaxAttempts`	Max Attempts	Number		Attempts allowed before the batch fails terminally.
`ModifiedById`	Modified By	Lookup → UserAccount	Yes
`Name`	Name	Text	Yes
`NextAttemptUtc`	Next Attempt	DateAndTime		Earliest the scheduler may retry, after backoff.
`OptionsJson`	Options	LongMultiLineText		Conversion options as supplied.
`OwnerId`	Owner	Lookup → UserAccount	Yes
`PayloadJson`	Payload	LongMultiLineText		The staging action arguments verbatim, for replay and forensics.
`PendingLines`	Pending Lines	Number		Lines still to convert.
`PendingQuantityField`	Pending Quantity Field	Text		Field read off the source line as the pool supply.
`Priority`	Priority	Number		Lower runs earlier — lets a stuck queue be jumped without a code change.
`ProcessingMode`	Processing Mode	PickList		RecordLevel (every eligible line) or LineLevel (only the lines the user picked).
`QuantityPool`	Quantity Pool	Text		Pool the batch holds quantity against. Conversions sharing a pending-quantity field share a pool, so they cannot promise the same units twice.
`QueuedUtc`	Queued	DateAndTime		When the batch was staged.
`RecordTypeId`	Record Type	Guid, hidden
`RequestedById`	Requested By	Lookup		User who submitted the batch.
`RequestedByName`	Requested By Name	Text		Display name of the submitter.
`ScopeAccountId`	Account	Lookup		Account the submission was scoped to.
`ScopeBranchId`	Branch	Lookup		Branch the submission was scoped to.
`ScopePartnerAccountId`	Partner Account	Lookup		Company the submission was scoped to.
`SkippedLines`	Skipped Lines	Number		Lines with nothing left to convert, or no available quantity.
`SourceEntityName`	Source Entity	Text		Entity the batch converts from. Denormalized so a historical batch still renders after its module is removed.
`SourceLineEntityName`	Source Line Entity	Text		Line entity of the source document.
`StartedUtc`	Started	DateAndTime		When a worker first claimed it.
`Status`	Status	PickList		Draft, Queued, Processing, Cancelling, Completed, CompletedWithErrors, Failed or Cancelled.
`SubscriptionKey`	Subscription Key	Guid, hidden	Yes
`SucceededLines`	Succeeded Lines	Number		Lines that produced a target document.
`TargetEntityName`	Target Entity	Text		Entity the batch creates.
`ToDate`	To Date	Date		End of the document-date window the submission used.
`TotalLines`	Total Lines	Number		Lines staged in the batch.
`TotalProcessedQuantity`	Processed Quantity	Decimal		Total quantity actually converted.
`TotalRequestedQuantity`	Requested Quantity	Decimal		Total quantity accepted at staging.
`UpdatedDateTime`	Updated On	DateAndTime	Yes
`ValidationMessage`	Validation Message	LongMultiLineText		Why the batch as a whole was rejected.

Actions

Action	Label	Type	What it does
`CancelBatch`	Cancel Batch	ServerAction (`CancelBatch`)	Cancels a queued batch outright, or asks a running one to stop at its next chunk.
`GetConversions`	Get Conversions	ServerAction (`GetConversions`)	Record-less. Returns the registered conversion descriptors.
`GetHeldQuantities`	Get Held Quantities	ServerAction (`GetHeldQuantities`)	Record-less. Returns quantity held per source line.
`RetryFailedLines`	Retry Failed Lines	ServerAction (`RetryFailedLines`)	Returns parked failed lines to pending and re-queues the batch.

ConversionBatchLine — referenced by via BatchId

Conversion Batch — entity reference

Fields

Actions

Related entities

Related topics