Batch tasks history in Transaction(BatchHistory)

Article
02/22/2022

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	BatchHistory/(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 tasks history

entity

a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
RecId		Transaction/BatchHistory
BatchId		Transaction/BatchHistory
BatchJobHistoryId		Transaction/BatchHistory
BatchJobId		Transaction/BatchHistory
Caption		Transaction/BatchHistory
ClassNumber		Transaction/BatchHistory
Company		Transaction/BatchHistory
DataPartition		Transaction/BatchHistory
EndDateTime		Transaction/BatchHistory
ExceptionCode		Transaction/BatchHistory
ExecutedBy		Transaction/BatchHistory
Info		Transaction/BatchHistory
Parameters		Transaction/BatchHistory
Priority		Transaction/BatchHistory
retriesOnFailure		Transaction/BatchHistory
retryCount		Transaction/BatchHistory
RuntimeTask		Transaction/BatchHistory
RunType		Transaction/BatchHistory
ServerId		Transaction/BatchHistory
SessionIdx		Transaction/BatchHistory
SessionLoginDateTime		Transaction/BatchHistory
StartDateTime		Transaction/BatchHistory
Status		Transaction/BatchHistory
Relationship_BatchJobHistoryRelationRelationshipId		Transaction/BatchHistory
Relationship_BatchJobRelationRelationshipId		Transaction/BatchHistory
Relationship_BatchRelationRelationshipId		Transaction/BatchHistory
Relationship_SysServerConfigRelationshipId		Transaction/BatchHistory

RecId

First included in: Transaction/BatchHistory (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	BatchHistory/(resolvedAttributes)/RecId	attribute

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

BatchId

First included in: Transaction/BatchHistory (this entity)

Properties

Name	Value
dataFormat	int64
isNullable	true

Traits

List of traits for the BatchId attribute are listed below.

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

is.dataFormat.integer
is.dataFormat.big

BatchJobHistoryId

First included in: Transaction/BatchHistory (this entity)

Properties

Name	Value
displayName	Batch job history ID
dataFormat	int64
isNullable	true

Traits

List of traits for the BatchJobHistoryId attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
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	Batch job history ID

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer
is.dataFormat.big

BatchJobId

First included in: Transaction/BatchHistory (this entity)

Properties

Name	Value
displayName	Batch job ID
dataFormat	int64
isNullable	true

Traits

List of traits for the BatchJobId attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
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	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/BatchHistory (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/BatchHistory (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the ClassNumber attribute are listed below.

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

is.dataFormat.integer

Company

First included in: Transaction/BatchHistory (this entity)

Properties

Name	Value
displayName	Company accounts
dataFormat	string
isNullable	true

Traits

List of traits for the Company 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	Company accounts

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

DataPartition

First included in: Transaction/BatchHistory (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the DataPartition 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

EndDateTime

First included in: Transaction/BatchHistory (this entity)

Properties

Name	Value
dataFormat	date
isNullable	true

Traits

List of traits for the EndDateTime attribute are listed below.

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

is.dataFormat.date

ExceptionCode

First included in: Transaction/BatchHistory (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the ExceptionCode attribute are listed below.

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

is.dataFormat.integer

ExecutedBy

First included in: Transaction/BatchHistory (this entity)

Properties

Name	Value
displayName	Executed by
dataFormat	string
isNullable	true

Traits

List of traits for the ExecutedBy 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	Executed by

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

Info

First included in: Transaction/BatchHistory (this entity)

Properties

Name	Value
dataFormat	binary
isNullable	true

Traits

List of traits for the Info attribute are listed below.

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

is.dataFormat.byte
is.dataFormat.array

Parameters

First included in: Transaction/BatchHistory (this entity)

Properties

Name	Value
dataFormat	binary
isNullable	true

Traits

List of traits for the Parameters attribute are listed below.

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

is.dataFormat.byte
is.dataFormat.array

Priority

First included in: Transaction/BatchHistory (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

retriesOnFailure

First included in: Transaction/BatchHistory (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/BatchHistory (this entity)

Properties

Name	Value
displayName	Actual retries
dataFormat	int32
isNullable	true

Traits

List of traits for the retryCount 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	Actual retries

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

RuntimeTask

First included in: Transaction/BatchHistory (this entity)

Properties

Name	Value
displayName	Runtime task
dataFormat	int32
isNullable	true

Traits

List of traits for the RuntimeTask 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	Runtime task

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

RunType

First included in: Transaction/BatchHistory (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the RunType attribute are listed below.

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

is.dataFormat.integer

ServerId

First included in: Transaction/BatchHistory (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/BatchHistory (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the SessionIdx attribute are listed below.

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

is.dataFormat.integer

SessionLoginDateTime

First included in: Transaction/BatchHistory (this entity)

Properties

Name	Value
dataFormat	date
isNullable	true

Traits

List of traits for the SessionLoginDateTime attribute are listed below.

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

is.dataFormat.date

StartDateTime

First included in: Transaction/BatchHistory (this entity)

Properties

Name	Value
dataFormat	date
isNullable	true

Traits

List of traits for the StartDateTime attribute are listed below.

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

is.dataFormat.date

Status

First included in: Transaction/BatchHistory (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the Status attribute are listed below.

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

is.dataFormat.integer

Relationship_BatchJobHistoryRelationRelationshipId

First included in: Transaction/BatchHistory (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_BatchJobHistoryRelationRelationshipId 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/BatchJobHistory.cdm.json/BatchJobHistory	RecId

entity

a reference to the constant entity holding the list of entity references

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

Relationship_BatchJobRelationRelationshipId

First included in: Transaction/BatchHistory (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_BatchJobRelationRelationshipId attribute are listed below.

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_BatchRelationRelationshipId

First included in: Transaction/BatchHistory (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_BatchRelationRelationshipId attribute are listed below.

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/core/operationsCommon/Tables/System/SystemAdministration/Transaction/Batch.cdm.json/Batch	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/BatchHistory (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_SysServerConfigRelationshipId attribute are listed below.

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

Share via

Batch tasks history in Transaction(BatchHistory)

Traits

Attributes

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Feedback

Additional resources