Batch Table

  • Article

The Batch table contains batch task information including the class number to run, parameters, company and whether it should run impersonated or not.

Methods

  Method Description
Gg860539.pubmethod(en-us,AX.60).gif aosValidateDelete
Gg860539.pubmethod(en-us,AX.60).gif aosValidateInsert
Gg860539.pubmethod(en-us,AX.60).gif aosValidateRead Validates on the server that the specified record can be read. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif aosValidateUpdate
Gg860539.pubmethod(en-us,AX.60).gif buf2con Packs the table buffers of an xRecord instance into an X++ container. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif cancelTimeOut Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
Gg860539.pubmethod(en-us,AX.60).gif canSubmitToWorkflow Indicates whether submission to workflow is possible. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif caption Gets and sets the caption property of a table. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif checkInvalidFieldAccess Gets and sets invalid field access. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif checkRecord Gets and sets the property that indicates whether to check mandatory fields. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif checkRestrictedDeleteActions Gets and sets the property that indicates whether a record can be deleted. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif classDescription
Gg860539.pubmethod(en-us,AX.60).gif className
Gg860539.pubmethod(en-us,AX.60).gif clear Removes all rows from the table buffer. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif company Gets and sets the property that indicates a legal entity for the record. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif con2buf Unpacks a container into the table buffers. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif concurrencyModel Gets and sets the default concurrency model to use to update records. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif context Gets and sets the context property. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif data Retrieves a row from the table. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif dataSource Retrieves the data source of the table. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif defaultField Populates default values in a field in the table. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif defaultRow Populates default values in fields in the table in the non-interactive case. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif delete Deletes the current record from the table. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif disableCache Gets and sets the property that indicates whether caching is disabled. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif dispose Releases resources that are used by the xRecord object. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif doClear Removes all rows from the table buffer and bypasses any additional logic in the clear method of the table. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif doDelete Deletes the current record from the table and bypasses any additional logic in the delete method of the table. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif doInsert Inserts the record into the table and bypasses any additional logic in the insert method of the table. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif doUpdate Updates the current record and bypasses any additional logic in the update method of the table. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif doValidateDelete Performs the action to validate that a record can be deleted. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif equal Determines whether the specified object is equal to the current one. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif exceptionText
Gg860539.pubmethod(en-us,AX.60).gif fieldAccessRight Returns the field access right. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif fieldBufferAccessRight Returns the field access right for the current record. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif fieldState Sets or returns the state of a field in the table buffer. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif getAllowRedefault Returns the list of fields that are allowed to re-default. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif getDefaultingDependencies Returns the container that holds defaulting dependencies. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif getExtension Returns the table extension. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif getFieldValue Gets the value of the specified field from a table buffer. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif getInstanceRelationType Returns the table name that corresponds to the InstanceRelationType ID. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif getPhysicalTableName Return the physical table name, which, in the case of the SQL Temp DB table, is the table instance name. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif getPresenceFieldData Retrieves the PresenceInfo value from the specified field. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif getSQLStatement Gets the SQL statement that is used to return records from the database. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif getTableInInstanceHierarchy (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif getTableType Indicates the type of the table. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif getTimeOutTimerHandle Returns the timer handle for the object. (Inherited from Object.)
Gg860539.pubmethod(en-us,AX.60).gif handle Retrieves the handle of the class of the object. (Inherited from Object.)
Gg860539.pubmethod(en-us,AX.60).gif hasError
Gg860539.pubmethod(en-us,AX.60).gif hasInfo
Gg860539.pubmethod(en-us,AX.60).gif hasRelatedTable Indicates whether a foreign key constraint buffer is linked with the table. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif helpField Retrieves a string that contains the Help text for the specified field. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif initFromClass
Gg860539.pubmethod(en-us,AX.60).gif initValue Initializes a field to the default value. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif inputStatus Sets or returns the current input status of the table buffer. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif insert
Gg860539.pubmethod(en-us,AX.60).gif interactiveContext Sets or returns the current interactive context of the table buffer. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif isFieldDataRetrieved Checks whether the data of the given field has been retrieved. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif isFieldSet Checks whether a field has a Set or Defaulted state. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif isFormDataSource Indicates whether the data source is a form. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif isNewRecord Returns true if the record is a new record that hasn't been persisted yet. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif isPartOfUOWSaveChanges (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif isTempDb Indicates whether the type of the table is SQL TempDB. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif isTmp Indicates whether this is a temporary table. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif joinChild Finds the join child of the current record. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif joinParent Finds the join parent of the current record. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif linkPhysicalTableInstance Checks whether there is a link for the physical table instance for the record. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif merge Merges the current table with the specified table. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif modifiedField Modifies the specified field to the original. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif modifiedFieldValue Modifies the specified field to the original value. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif new Initializes a new instance of the Object class. (Inherited from Object.)
Gg860539.pubmethod(en-us,AX.60).gif notify Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
Gg860539.pubmethod(en-us,AX.60).gif notifyAll Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
Gg860539.pubmethod(en-us,AX.60).gif object
Gg860539.pubmethod(en-us,AX.60).gif objectOnServer Determines whether the object is on a server. (Inherited from Object.)
Gg860539.pubmethod(en-us,AX.60).gif orig Retrieves the original values of the current record. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif overwriteSystemfields Gets and sets the property that indicates whether system fields can be overwritten. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif owner Returns the instance that owns the object. (Inherited from Object.)
Gg860539.pubmethod(en-us,AX.60).gif postCacheLoad Is executed after data is hit from the cache for the select operation on the table. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif postLoad Is executed after a record is read. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif preRemoting Is executed before a cross-tier call is about to be executed for the table that would pack its state to the other tier. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif queryTimedOut Indicates whether the query exceeded the time limit for execution. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif queryTimeout Gets and sets the property that indicates the time limit for the execution of a query. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif readCommittedLock (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif readPast Gets and sets the property that indicates whether to skip rows that are locked by other processes when a record is read. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif recordLevelSecurity Gets and sets the property that indicates whether to apply security on a record level. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif relatedTable Sets or returns the related buffer of a link of a table buffer. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif renamePrimaryKey Renames the foreign keys in other tables according to the change of the corresponding primary key value in this table. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif reread Rereads the record from the table. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif RowCount Retrieves the number of rows in the table. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif selectForUpdate Gets and sets the property that indicates whether to select records for update when they are read. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif selectLocked Indicates whether to select locked records. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif selectRefRecord Selects the record by referenced field ID. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif selectWithRepeatableRead Gets and sets the property that indicates whether repeatable read is enabled. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif setConnection Sets the user connection for this table. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif setCrossPartition Sets or resets cross-partitioning for the table. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif setFieldValue Sets the field value in the record buffer. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif setSQLTracing Enables or disables SQL tracing mode. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif setTimeOut Sets up the scheduled execution of a specified method. (Inherited from Object.)
Gg860539.pubmethod(en-us,AX.60).gif setTmp Sets the table so that it is not persisted to the database. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif setTmpData Sets the contents of the temporary table to the specified data. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif setXDSContext Sets new XDS context. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif showDependencyExist Determines whether the current task depends on another task.
Gg860539.pubmethod(en-us,AX.60).gif showDialog
Gg860539.pubmethod(en-us,AX.60).gif showProgress
Gg860539.pubmethod(en-us,AX.60).gif skipAosValidation Gets and sets the property that indicates whether to skip validation of Microsoft Dynamics AX Application Object Server (AOS). (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif skipDatabaseLog Gets and sets the property that indicates whether to skip database log requests. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif skipDataMethods Gets and sets the property that indicates whether to discard overloaded methods. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif skipDeleteActions Gets and sets the property that indicates whether to skip delete actions on the table. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif skipDeleteMethod Gets and sets the property that indicates whether to discard overloaded methods. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif skipEvents Provides an option to turn off calling the Application.event* methods for the lifetime of an xRecord object. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif skipPostLoad Gets and sets the property that indicates whether to skip executing the xRecord.postLoad method on the table. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif skipTTSCheck Gets and sets the property that indicates whether to skip the check to determine whether the record is selected for update. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif statusClass
Gg860539.pubmethod(en-us,AX.60).gif suppressWarnings Gets and sets the property that indicates whether to suppress warnings for this pointer. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif tableAccessRight Returns the table access right. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif tableBufferAccessRight Returns the table access right for the current record. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif takeOwnershipOfTempDBTable (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif toolTipField Retrieves the HelpText value for the specified field. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif toolTipRecord Retrieves the ToolTip value for the current record. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif toString Returns a string that represents the current object. (Inherited from Object.)
Gg860539.pubmethod(en-us,AX.60).gif ttsabort Aborts a transaction that was started by a call to the ttsbegin method. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif ttsbegin Starts a transaction that can be either committed by the ttscommit method or aborted by the ttsabort method. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif ttscommit Commits a transaction that was started by a call to the ttsbegin method. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif update Updates the current record. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif updateRunType Updates the RunType field on the Batch table depending on whether the task runs impersonated or not.
Gg860539.pubmethod(en-us,AX.60).gif usageCount Retrieves the current number of references (the value of the reference counter) that the object has. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif useExistingTempDBTable (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif validateDelete Determines whether the current record is valid and ready to be deleted from the database.
Gg860539.pubmethod(en-us,AX.60).gif validateField Determines whether the id field is valid.
Gg860539.pubmethod(en-us,AX.60).gif validateFieldValue (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif validateWrite Determines whether the current record is valid and ready to be written. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif validTimeStateUpdateMode Sets a valid time state update mode on the cursor. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif wait Pauses a process. (Inherited from Object.)
Gg860539.pubmethod(en-us,AX.60).gif wasCached Specifies the location from which the data was retrieved. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif write Updates a record if it exists; otherwise, inserts a record. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif xml Retrieves an XML string that represents the current object. (Inherited from xRecord.)
Gg860539.pubmethod(en-us,AX.60).gif Gg860539.static(en-us,AX.60).gif ::existRecId
Gg860539.pubmethod(en-us,AX.60).gif Gg860539.static(en-us,AX.60).gif ::findRecId
Gg860539.pubmethod(en-us,AX.60).gif Gg860539.static(en-us,AX.60).gif ::isBatchOperator
Gg860539.pubmethod(en-us,AX.60).gif Gg860539.static(en-us,AX.60).gif ::isPrivilegedUser
Gg860539.pubmethod(en-us,AX.60).gif Gg860539.static(en-us,AX.60).gif ::showLog

Top

Fields

Field Type Configuration key Description
AutomaticTransaction Enumeration: NoYes
 None If selected, the batch framework will manage the transaction
BatchJobId Extended Data Type: RefRecId
Type: Int64
 None Record ID for the batch job
Caption Extended Data Type: BatchCaption
Type: String
 None Description of the task
ClassNumber Extended Data Type: ClassId
Type: Integer
 None ID for the class
Company Extended Data Type: SelectableDataArea
Type: String
 None Extension of the database where the job is to be executed.
ConstraintType Enumeration: BatchConstraintType
 None Specifies whether all conditions should be met or any condition should be met.
createdBy Extended Data Type: CreatedBy
Type: String
 None
createdDateTime Extended Data Type: CreatedDateTime
Type: UtcDateTime
 None
DataPartition Extended Data Type: PartitionKey
Type: String
 None Partition Key (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2 (SYS))
dEL_CreatedTime Extended Data Type: DEL_CreatedTime
Type: Integer
 None (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2 (SYS))
EndDateTime Extended Data Type: EndDateTime
Type: UtcDateTime
 None Date/time that the task ended
ExceptionCode Enumeration: Exception
 None Type of error encountered when the batch task was run
ExecutedBy Extended Data Type: UserId
Type: String
 None User ID of the user who ran the task
GroupId Extended Data Type: BatchGroupId
Type: String
 None Group that the task is attached to
IgnoreOnFail Enumeration: NoYes
 None Ignore task status when determining whether batch job succeeded
Info Extended Data Type: InfologData
Type: Container
 None Packed Infolog message
modifiedDateTime Extended Data Type: ModifiedDateTime
Type: UtcDateTime
 None
Parameters Extended Data Type: BatchParameters
Type: Container
 None Parameters for batch job
Priority Extended Data Type: BatchPriority
Type: Integer
 None Task priority
PrivateTask Enumeration: NoYes
 None Task can be run only by the user who ordered it (applicable only to client tasks)
RecId Extended Data Type: RecId
Type: Int64
 None
recVersion Extended Data Type: RecVersion
Type: Integer
 None
retriesOnFailure Extended Data Type: BatchRetries
Type: Integer
 None Number of retries a batch task is run before failing
retryCount Extended Data Type: BatchRetries
Type: Integer
 None Number of times the task was actually retried
RunTimeTask Enumeration: boolean
 None Determines if the task is valid for the current batch job run
RunType Enumeration: BatchRunType
 None Determines if the task runs on server or client
ServerId Extended Data Type: ServerId
Type: String
 None AOS on which this task was run
SessionIdx Extended Data Type: SessionId
Type: Integer
 None Session ID of the user who started the job.
SessionLoginDateTime Extended Data Type: UTCTimestamp
Type: UtcDateTime
 None The UTC timestamp.
StartDateTime Extended Data Type: StartDateTime
Type: UtcDateTime
 None Date/time that the task started
Status Enumeration: BatchStatus
 None Current status of the task

Top

Field Groups

Field Group Fields
AutoReport
Batch
Executed
Identification
Journal
Ordered
Period
Start
System

Top

Relations

Relation Table Lines
BatchGroup BatchGroup
BatchJob BatchJob
DataAreaRelation DataArea
PartitionRelation Partitions
SysServerConfig SysServerConfig
UserInfo UserInfo

Top

Indexes

Index AllowDuplicates Enabled Fields
BatchIdx Yes Yes
BatchJobId Yes Yes
DEL_RecId Yes Yes
RecId No Yes
SessionIdx Yes Yes
Statususer Yes Yes

Top

Inheritance Hierarchy

xRecord Class
  Common Table
    Batch Table

See Also

Table Methods

Tables Overview