ReleaseUpdateCockpit Class [AX 2012]

The ReleaseUpdateCockpit class is the back-end class of the ReleaseUpdateCockpit form.

Syntax

class ReleaseUpdateCockpit

Run On

Server

Methods

	Method	Description
	addDependency	Adds a script dependency.
	addDependencyByScriptId	Adds a script dependency that is based on the specified script IDs.
	addJob	Adds an upgrade job to the ReleaseUpdateScripts table.
	addTableDependencies	Builds script dependencies that are based on data from the ReleaseUpdateScriptsUsedTables table.
	applyConfigKeys	Updates script dependencies that are based on script configuration keys.
	batchIsBulkCopyJob	Checks whether a batch task is a bulk copy task.
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	cancelUpgradeJob	Cancels all upgrade jobs that are running.
	changeBatchTaskToWaiting	Changes a batch task to a waiting status.
	checkCyclicalDependency
	checkInvalidDependency	Verifies that there are no invalid or redundant dependencies set across the script type groups.
	classID2module	Gets the upgrade module name from the class ID.
	computeNowProcessingStage	Finds the next stage of the next script to be executed.
	computeNowProcessingVersion	Retrieves the version of the next scripts to be executed.
	createBatchGroup	Creates a batch group for upgrade.
	detectCyclicalDependency
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	fillReleaseUpdateJobStatus
	getFinishedJobWeight	Gets the weight of all of the finished jobs.
	getNumberOfBulkCopyTasks	Gets the status text to show the number of processed and finished bulk copy tasks.
	getNumberOfJobs	Gets the number of upgrade jobs.
	getNumberOfJobsError	Gets the number of failed jobs.
	getNumberOfJobsFinished	Gets the number of upgrade jobs that have been finished.
	getNumberOfUpgradeScripts	Builds a status text to show the number of finished scripts and the total number of scripts.
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	getTotalJobWeight	Gets the total weight of all of the loaded scripts.
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	init	Loads the upgrade scripts.
	initBatchJob	Searches for the upgrade batch job.
	initMode	Checks whether a script has its status set to a particular mode.
	initParmDefault	Is called from releaseUpdateDB.dataImportStart method.
	isPartitionScript	Indicates whether a script is a partition script.
	loadJobs
	new	Initializes a new instance of the ReleaseUpdateCockpit class.
	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.)
	parmBatchJob	Gets the BatchJob parameter.
	parmFormRun	Gets or sets the FormRun parameter.
	parmMode	Gets or sets the Mode parameter.
	parmSingleCompany	Gets or sets the SingleCompany parameter.
	parmSingleScriptMode	Sets single script schedule mode.
	pauseUpgradeJob	Pauses the upgrade job.
	reloadJobs	Reloads all upgrade scripts, depending on the script stage.
	resolveDependencies	Validates and updates the script dependencies.
	restartAllFailedUpgradeTasks	Restarts all of the failed upgrade tasks.
	restartTasksUpTree	Restarts the functionality of all tasks for the test run mode.
	restartUpgradeTask	Restarts a single upgrade task.
	resumeUpgradeJob	Resumes all of the upgrade tasks that are in the Canceled state or the NotRun state.
	run	Schedules all of the upgrade scripts.
	runFinal	Runs all of the upgrade final scripts.
	runPreSyncScripts	Runs the PreSync scripts depending on a specified script type.
	runScripts	Runs the scripts depending on a specified script type.
	scheduleBatch
	scheduleBatchDependency	Sets a dependency between two tasks.
	scheduleBatchTask	Schedules a script in a batch.
	scheduleCommonScript	Schedules an upgrade script and sets up its dependencies.
	scheduleCrossModuleDepencencies	Updates all the explicit dependencies for the scripts.
	scheduleDepencenciesForScript	Updates the dependencies of a script.
	scheduleModule	Schedules the upgrade scripts depending on the module type and the script types.
	scheduleModuleVersion	Schedules the upgrade scripts in a module.
	scheduleScripts	Schedules the upgrade scripts.
	scheduleScriptTypes	Schedules all of the upgrade scripts.
	scheduleSingleScript
	scheduleTransitionScriptModule	Schedules a transition job for upgrade scripts.
	scheduleTransitionScriptType	Schedules a transition job for the upgrade jobs.
	scheduleType	Schedules upgrade scripts depending on a specified type.
	scheduleUpgrade	Schedules the upgrade jobs.
	setImportFromVersion	Sets the version of the source system where the data was exported.
	setProgressText	Updates the progress text on the cockpit form.
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	toString	Returns a string that represents the current object. (Inherited from Object.)
	update	Updates the status of the upgrade jobs.
	updateBulkCopyShadowTableStatus	Copies the ReleaseUpdateTransformTable table from the source to the target system.
	updateJobStatusMode	Updates the job mode of all of the scheduled upgrade scripts.
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	userInteractionRequired	Gets or sets the value for the _userInteractionRequired variable.
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::cleanupBatch	Deletes all of the upgrade batch jobs in the Batch table.
	::construct	Creates a new instance of the ReleaseUpdateCockpit class.
	::getDatabaseLoggingLevel	Gets the database logging level.
	::newFormRun	Creates a new instance of the ReleaseUpdateCockpitClass class and binds it to a ReleaseUpdateCockpit form.
	::parmUnitTest	Gets or sets the value that will determine whether the upgrade test will be performed.
	::releaseUpdatePriority2BatchPriority	Converts the priority of an upgrade script to a batch job priority.
	::saveJobHistory	Saves the history of the upgrade jobs.

Top

Remarks

The ReleaseUpdateCockpit form is the main form that the user interacts with during upgrades. All UI events on this form are directed to methods in the ReleaseUpdateCockpit class.

Inheritance Hierarchy

Object Class
  ReleaseUpdateCockpit Class