Batch transactions in Transaction(Batch)

Latest version of the JSON entity definition is available on GitHub.

Traits

Traits for this entity are listed below.

is.identifiedBy
names a specifc identity attribute to use with an entity

Parameter	Value	Data type	Explanation
attribute	Batch/(resolvedAttributes)/RecId	attribute

is.CDM.entityVersion

Parameter	Value	Data type	Explanation
versionNumber	"1.1"	string	semantic version number of the entity

is.application.releaseVersion

Parameter	Value	Data type	Explanation
releaseVersion	"10.0.13.0"	string	semantic version number of the application introducing this entity

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Batch transactions	entity	a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
RecId		Transaction/Batch
AutomaticTransaction		Transaction/Batch
BatchJobId		Transaction/Batch
Caption		Transaction/Batch
ClassNumber		Transaction/Batch
Company		Transaction/Batch
ConstraintType		Transaction/Batch
DataPartition		Transaction/Batch
EndDateTime		Transaction/Batch
ExceptionCode		Transaction/Batch
ExecutedBy		Transaction/Batch
GroupId		Transaction/Batch
IgnoreOnFail		Transaction/Batch
Info		Transaction/Batch
Parameters		Transaction/Batch
Priority		Transaction/Batch
PrivateTask		Transaction/Batch
retriesOnFailure		Transaction/Batch
retryCount		Transaction/Batch
RunTimeTask		Transaction/Batch
RunType		Transaction/Batch
ServerId		Transaction/Batch
SessionIdx		Transaction/Batch
SessionLoginDateTime		Transaction/Batch
StartDateTime		Transaction/Batch
Status		Transaction/Batch
Relationship_BatchGroupRelationshipId		Transaction/Batch
Relationship_BatchJobRelationshipId		Transaction/Batch
Relationship_SysServerConfigRelationshipId		Transaction/Batch

RecId

First included in: Transaction/Batch (this entity)

Properties

Name	Value
isPrimaryKey	true
dataFormat	int64
isReadOnly	true

Traits

List of traits for the RecId attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.identifiedBy
names a specifc identity attribute to use with an entity

Parameter	Value	Data type	Explanation
attribute	Batch/(resolvedAttributes)/RecId	attribute

is.readOnly
is.dataFormat.integer
is.dataFormat.big

AutomaticTransaction

First included in: Transaction/Batch (this entity)

Properties

Name	Value
displayName	Automatically start transaction
dataFormat	int32
isNullable	true

Traits

List of traits for the AutomaticTransaction attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Automatically start transaction	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

BatchJobId

First included in: Transaction/Batch (this entity)

Properties

Name	Value
displayName	Batch job ID
dataFormat	int64

Traits

List of traits for the BatchJobId attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Batch job ID	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer
is.dataFormat.big

Caption

First included in: Transaction/Batch (this entity)

Properties

Name	Value
displayName	Task description
dataFormat	string
isNullable	true

Traits

List of traits for the Caption attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Task description	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

ClassNumber

First included in: Transaction/Batch (this entity)

Properties

Name	Value
dataFormat	int32

Traits

List of traits for the ClassNumber attribute are listed below.

is.dataFormat.integer
is.dataFormat.integer

Company

First included in: Transaction/Batch (this entity)

Properties

Name	Value
displayName	Company accounts
dataFormat	string

Traits

List of traits for the Company attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Company accounts	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

ConstraintType

First included in: Transaction/Batch (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the ConstraintType attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

DataPartition

First included in: Transaction/Batch (this entity)

Properties

Name	Value
dataFormat	string

Traits

List of traits for the DataPartition attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.character
is.dataFormat.array

EndDateTime

First included in: Transaction/Batch (this entity)

Properties

Name	Value
dataFormat	date
isReadOnly	true
isNullable	true

Traits

List of traits for the EndDateTime attribute are listed below.

is.dataFormat.date
means.measurement.date
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.dataFormat.date

ExceptionCode

First included in: Transaction/Batch (this entity)

Properties

Name	Value
dataFormat	int32
isReadOnly	true
isNullable	true

Traits

List of traits for the ExceptionCode attribute are listed below.

is.dataFormat.integer
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

ExecutedBy

First included in: Transaction/Batch (this entity)

Properties

Name	Value
displayName	Run by
dataFormat	string
isReadOnly	true
isNullable	true

Traits

List of traits for the ExecutedBy attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Run by	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

GroupId

First included in: Transaction/Batch (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the GroupId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

IgnoreOnFail

First included in: Transaction/Batch (this entity)

Properties

Name	Value
displayName	Ignore task failure
dataFormat	int32
isNullable	true

Traits

List of traits for the IgnoreOnFail attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Ignore task failure	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

Info

First included in: Transaction/Batch (this entity)

Properties

Name	Value
dataFormat	binary
isReadOnly	true
isNullable	true

Traits

List of traits for the Info attribute are listed below.

is.dataFormat.byte
is.dataFormat.array
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.dataFormat.byte
is.dataFormat.array

Parameters

First included in: Transaction/Batch (this entity)

Properties

Name	Value
dataFormat	binary
isReadOnly	true
isNullable	true

Traits

List of traits for the Parameters attribute are listed below.

is.dataFormat.byte
is.dataFormat.array
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.dataFormat.byte
is.dataFormat.array

Priority

First included in: Transaction/Batch (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the Priority attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

PrivateTask

First included in: Transaction/Batch (this entity)

Properties

Name	Value
displayName	Private
dataFormat	int32
isNullable	true

Traits

List of traits for the PrivateTask attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Private	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

retriesOnFailure

First included in: Transaction/Batch (this entity)

Properties

Name	Value
displayName	Maximum retries
dataFormat	int32
isNullable	true

Traits

List of traits for the retriesOnFailure attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Maximum retries	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

retryCount

First included in: Transaction/Batch (this entity)

Properties

Name	Value
displayName	Actual retries
dataFormat	int32
isReadOnly	true
isNullable	true

Traits

List of traits for the retryCount attribute are listed below.

is.dataFormat.integer
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Actual retries	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

RunTimeTask

First included in: Transaction/Batch (this entity)

Properties

Name	Value
displayName	Runtime task
dataFormat	int32
isReadOnly	true
isNullable	true

Traits

List of traits for the RunTimeTask attribute are listed below.

is.dataFormat.integer
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Runtime task	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

RunType

First included in: Transaction/Batch (this entity)

Properties

Name	Value
dataFormat	int32
isReadOnly	true
isNullable	true

Traits

List of traits for the RunType attribute are listed below.

is.dataFormat.integer
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

ServerId

First included in: Transaction/Batch (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the ServerId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

SessionIdx

First included in: Transaction/Batch (this entity)

Properties

Name	Value
dataFormat	int32
isReadOnly	true
isNullable	true

Traits

List of traits for the SessionIdx attribute are listed below.

is.dataFormat.integer
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

SessionLoginDateTime

First included in: Transaction/Batch (this entity)

Properties

Name	Value
dataFormat	date
isReadOnly	true
isNullable	true

Traits

List of traits for the SessionLoginDateTime attribute are listed below.

is.dataFormat.date
means.measurement.date
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.dataFormat.date

StartDateTime

First included in: Transaction/Batch (this entity)

Properties

Name	Value
dataFormat	date
isReadOnly	true
isNullable	true

Traits

List of traits for the StartDateTime attribute are listed below.

is.dataFormat.date
means.measurement.date
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.dataFormat.date

Status

First included in: Transaction/Batch (this entity)

Properties

Name	Value
dataFormat	int32
isReadOnly	true
isNullable	true

Traits

List of traits for the Status attribute are listed below.

is.dataFormat.integer
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

Relationship_BatchGroupRelationshipId

First included in: Transaction/Batch (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_BatchGroupRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/operationsCommon/Tables/System/SystemAdministration/Group/BatchGroup.cdm.json/BatchGroup RecId	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

Relationship_BatchJobRelationshipId

First included in: Transaction/Batch (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_BatchJobRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/operationsCommon/Tables/System/SystemAdministration/Transaction/BatchJob.cdm.json/BatchJob RecId	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

Relationship_SysServerConfigRelationshipId

First included in: Transaction/Batch (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_SysServerConfigRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/operationsCommon/Tables/System/SystemAdministration/Framework/SysServerConfig.cdm.json/SysServerConfig RecId	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array