ReleaseUpdateDB Class [AX 2012]

Article
04/11/2014

The ReleaseUpdateDB class is the base class for all of the upgrade scripts.

Syntax

class ReleaseUpdateDB

Run On

Server

Methods

	Method	Description
	addCrossModuleDependency	Adds cross module, version dependency for an upgrade script.
	addCrossVersionModuleDependency	Adds cross module, version dependency for an upgrade script.
	addDependency	Adds a dependency of a method on another method in the same class.
	addFinalJob	Adds an upgrade script as a final job.
	addSharedJob	Adds an upgrade script as a shared job.
	addStandardJob	Adds an upgrade script as a standard job.
	addStartJob	Adds an upgrade script as a start job.
	callInsertUpdateRelatedSkipMethods	Calls the skip methods that are relevant when doing inserts or updates.
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	fromVersion	Gets the version of the Microsoft Dynamics AX system that is being upgraded.
	fromVersionEx	Gets the version of the AX system that is being upgraded.
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	initAdditionalJobs	Contains the initial setup for additional upgrade scripts.
	initAdditionalUpdateJobs	Contains the initial setup for additional upgrade scripts.
	initDynamicTableDependencies	Creates table dependencies for scripts whose dependencies cannot be set by using upgrade attributes.
	initJobs	Builds list upgrade script classes and creates dependencies that are based on their attributes.
	initJobsUsingUpgradeAttributes	Creates upgrade jobs and sets up their dependencies based on the attributes of every upgrade script method in a class.
	initOperationProgress	Creates a progress form that can be used to show the progress of an upgrade step.
	initPostSyncJobs	Contains the initial setup for the PostSync upgrade scripts.
	initPostSyncUpdateJobs	Contains the initial setup for the PostSyncUpdate upgrade scripts.
	initPreSyncJobs	Contains the initial setup for PreSync upgrade scripts.
	initPreSyncUpdateJobs	Contains the initial setup for PreSyncUpdate upgrade scripts.
	isConfKeyEnabledInPrevVersion	Determines whether the configuration key was enabled in the earlier version of the application.
	moduleName	Gets the module name of an upgrade class.
	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.)
	objectOnServer	Determines whether the object is on a server. (Inherited from Object.)
	owner	Returns the instance that owns the object. (Inherited from Object.)
	parmCockpit	Gets or sets the Cockpit parameter.
	parmCurrentBatch	Gets or sets the CurrentBatch parameter.
	parmScriptStage	Gets or sets the ScriptStage parameter.
	prefixCurrentClassId	Gets or sets the classId parameter.
	prefixCurrentVersion	Gets or sets the version of the current instance of an upgrade class.
	run	Runs the upgrade script.
	setImportfromVersion	Sets the version of the Microsoft Dynamics AX system that is being upgraded.
	setModuleConfigKey	Sets the configuration keys of the current module.
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	tableProgress	Sets the progress of the upgrade process, depending on the number of tables processed.
	toString	Returns a string that represents the current object. (Inherited from Object.)
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	validatedModuleName	Validates that a module name is not too long.
	validateModuleName
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::addBulkCopyFieldOption	Specifies options for field processing during bulk copy.
	::addBulkCopyTableException	Adds a table to the bulk copy exceptions list.
	::addTableDependency	Adds a table dependency for scripts whose table dependencies cannot be set using upgrade attributes.
	::addTableRelationTypeMapping	Indicates that the specified field of the specified table must be updated by using the specified relation type.
	::backendFieldBaseType	Gets the back-end base type of a field.
	::backendFieldName	Gets the back-end field name of a Microsoft Dynamics AX table.
	::backendTableName	Gets the back-end table name of a Microsoft Dynamics AX table.
	::changeFieldByAOTName	Changes a field ID, depending on the field AOT name.
	::changeFieldByName	Changes a field by its name.
	::changeFieldId	Used as a start PreSync job to change a field ID.
	::changeNameByFieldId	Changes the name of a table, depending on its ID.
	::changeTableByAOTName	Sets a new table ID, depending on a table name.
	::changeTableByName	Gets the table ID, based on its name and old IDs.
	::changeTableId	Changes the ID of a table.
	::cleanupJobs	Cleans up the framework tables that store information about upgrade scripts.
	::constructList	Builds a list of all upgrade classes.
	::dataImportFinal	Runs all final upgrade scripts.
	::dataImportStart	Runs all PreSync, start upgrade scripts.
	::dataImportUpdate	Runs the upgrade routine for the imported data.
	::deleteDuplicatesUsingIds	Deletes duplicate records by using field IDs.
	::deleteDuplicatesUsingNames	Deletes duplicate records by using names.
	::description	Gets the description of the class.
	::fieldExists	Verifies whether the specified field exists.
	::fields2WhereClause	Gets a string to be used in the where clause in a direct SQL statement.
	::fieldStringSize	Gets the string length of a field.
	::getDataAreaIds	Gets a list of companies in a partition.
	::getDataAreaIdsForPartition	Gets a list of companies in a partition.
	::getFromVersion	Gets the version of the Microsoft Dynamics AX source system that is being upgraded.
	::getFromVersionEx	Gets the version of the Dynamics AX source system that is being upgraded.
	::getPartitionKeys	Gets all partitions in the system.
	::getSchemaName	Gets the current system account that is running the Microsoft Dynamics AX Application Object Server (AOS) instance.
	::getToVersion	Gets the Microsoft Dynamics AX version to which the current system is being upgraded.
	::getToVersionEx	Gets the Dynamics AX version to which the current system is being upgraded.
	::indexAllowDup	Disables a unique index and saves the modification in the layer where the index exists.
	::indexAllowNoDup	Enables a unique index.
	::indexAllowNoDupAndDateEffective	Enables the index on date effective tables.
	::IsFlattenDBStepNeededInInPlaceUpgrade	Checks if the flatten database step is needed during a minor version upgrade.
	::isMinorVersionUpdateInProgress	Checks whether the minor version upgrade is already in progress.
	::isRightJustified	Checks whether the field is right justified.
	::isScriptStageInPlace	Detects if a upgrade script stage is an In-Place stage.
	::log	Writes a log message to the ReleaseUpdateLog table.
	::majorMinorEtc2sysReleasedVersion	Gets a release version from major and minor versions.
	::minorUpgradeScriptExists
	::registerAllUpdateScripts
	::registerForMinorUpgradeScript	Registers a script to be run during minor version upgrade.
	::runWithoutUpdate	This method is deprecated.
	::setMinorVersionUpdateInProgress
	::setReadyForMinorUpgrade	Asks Microsoft Dynamics AX to load the update checklist at startup after registering for the minor upgrade scripts.
	::setupDynamicDependencies	Sets up dependencies for some special scripts whose dependencies cannot be set using the upgrade attributes.
	::sourceFieldExists	Verifies whether the source field exists.
	::sourceTableExists	Verifies whether the source table exists.
	::statementExeQuery	Executes a direct SQL statement by using the Statement.executeQuery method.
	::statementExeUpdate	Executes a direct SQL update statement.
	::tableExists	Verifies whether a table exists.
	::validateAttributes

Top

Remarks

This class is the root of the Upgrade tree, which is structured by upgrade versions, from version 401, 41, and 60.

This class also contains many private and public APIs that are used in the Upgrade framework.

Inheritance Hierarchy