Batch job in Transaction(BatchJob)

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	BatchJob/(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 job

entity

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

Attributes

Name	Description	First Included in Instance
RecId		Transaction/BatchJob
CanceledBy		Transaction/BatchJob
Caption		Transaction/BatchJob
Company		Transaction/BatchJob
DataPartition		Transaction/BatchJob
EndDateTime		Transaction/BatchJob
Finishing		Transaction/BatchJob
LogLevel		Transaction/BatchJob
OrigStartDateTime		Transaction/BatchJob
recurrenceData		Transaction/BatchJob
RuntimeJob		Transaction/BatchJob
StartDateTime		Transaction/BatchJob
Status		Transaction/BatchJob
StartDate		Transaction/BatchJob
StartTime		Transaction/BatchJob
Critical		Transaction/BatchJob
MonitoringCategory		Transaction/BatchJob
Managed		Transaction/BatchJob
ActivePeriod		Transaction/BatchJob
ExecutingBy		Transaction/BatchJob
SchedulingPriority		Transaction/BatchJob
SchedulingPriorityIsOverridden		Transaction/BatchJob
BatchGroup		Transaction/BatchJob
Relationship_BatchJobActivePeriodRelationshipId		Transaction/BatchJob
Relationship_BatchGroupRelationshipId		Transaction/BatchJob

RecId

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

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

CanceledBy

First included in: Transaction/BatchJob (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true
isNullable	true

Traits

List of traits for the CanceledBy 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.dataFormat.character
is.dataFormat.array

Caption

First included in: Transaction/BatchJob (this entity)

Properties

Name	Value
displayName	Job 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	Job description

entity

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

is.dataFormat.character
is.dataFormat.array

Company

First included in: Transaction/BatchJob (this entity)

Properties

Name	Value
displayName	Company accounts
dataFormat	string
isReadOnly	true
isNullable	true

Traits

List of traits for the Company 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	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/BatchJob (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true
isNullable	true

Traits

List of traits for the DataPartition 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.dataFormat.character
is.dataFormat.array

EndDateTime

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

Finishing

First included in: Transaction/BatchJob (this entity)

Properties

Name	Value
dataFormat	int32
isReadOnly	true
isNullable	true

Traits

List of traits for the Finishing attribute are listed below.

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

is.dataFormat.integer

LogLevel

First included in: Transaction/BatchJob (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the LogLevel attribute are listed below.

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

is.dataFormat.integer

OrigStartDateTime

First included in: Transaction/BatchJob (this entity)

Properties

Name	Value
displayName	Scheduled start date/time
dataFormat	date

Traits

List of traits for the OrigStartDateTime attribute are listed below.

is.dataFormat.date
means.measurement.date
is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Scheduled start date/time

entity

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

is.dataFormat.date

recurrenceData

First included in: Transaction/BatchJob (this entity)

Properties

Name	Value
dataFormat	binary
isNullable	true

Traits

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

RuntimeJob

First included in: Transaction/BatchJob (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the RuntimeJob attribute are listed below.

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

is.dataFormat.integer

StartDateTime

First included in: Transaction/BatchJob (this entity)

Properties

Name	Value
displayName	Actual start date/time
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.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Actual start date/time

entity

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

is.dataFormat.date

Status

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

StartDate

First included in: Transaction/BatchJob (this entity)

Properties

Name	Value
dataFormat	date
isReadOnly	true
isNullable	true

Traits

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

StartTime

First included in: Transaction/BatchJob (this entity)

Properties

Name	Value
dataFormat	time
isReadOnly	true
isNullable	true

Traits

List of traits for the StartTime attribute are listed below.

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

is.dataFormat.time

Critical

First included in: Transaction/BatchJob (this entity)

Properties

Name	Value
displayName	Critical Job
dataFormat	int32
isNullable	true

Traits

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

entity

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

is.dataFormat.integer

MonitoringCategory

First included in: Transaction/BatchJob (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the MonitoringCategory attribute are listed below.

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

is.dataFormat.integer

Managed

First included in: Transaction/BatchJob (this entity)

Properties

Name	Value
displayName	Managed Data Access Job
dataFormat	int32
isNullable	true

Traits

List of traits for the Managed 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	Managed Data Access Job

entity

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

is.dataFormat.integer

ActivePeriod

First included in: Transaction/BatchJob (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

ExecutingBy

First included in: Transaction/BatchJob (this entity)

Properties

Name	Value
displayName	Run by
dataFormat	string
isNullable	true

Traits

List of traits for the ExecutingBy 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	Run by

entity

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

is.dataFormat.character
is.dataFormat.array

SchedulingPriority

First included in: Transaction/BatchJob (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the SchedulingPriority attribute are listed below.

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

is.dataFormat.integer

SchedulingPriorityIsOverridden

First included in: Transaction/BatchJob (this entity)

Properties

Name	Value
displayName	Scheduling Priority is overidden
dataFormat	int32
isNullable	true

Traits

List of traits for the SchedulingPriorityIsOverridden 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	Scheduling Priority is overidden

entity

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

is.dataFormat.integer

BatchGroup

First included in: Transaction/BatchJob (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

Relationship_BatchJobActivePeriodRelationshipId

First included in: Transaction/BatchJob (this entity)

Properties

Name	Value
dataFormat	guid

Traits

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

entity

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

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

Relationship_BatchGroupRelationshipId

First included in: Transaction/BatchJob (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_BatchGroupRelationshipId attribute are listed below.

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

Share via

Batch job in Transaction(BatchJob)

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

Feedback

Additional resources