Batch Table

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