SysCheckList Class [AX 2012]

Syntax

class SysCheckList

Run On

Client

Methods

	Method	Description
	applyStylesheet
	canBePreventedAtStartup
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	canRunSilent
	doInit
	doUpdateHtml	Updates the HTML content of a checklist.
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	finalize
	finalizeChecklist
	find
	getAdditionalCss	Gets additional CSS information for the checklist.
	getCheckListCaption
	getChecklistXml	Gets the checklist XML document.
	getGroupState	Gets the state of a group of checklist items in the checklist.
	getHelpImage
	getHtml
	getHtmlDocumentTemplate
	getHtmlGroupTemplate
	getHtmlGroupText
	getHtmlHeader
	getHtmlHeaderHelp
	getHtmlHeaderTemplate
	getHtmlHelpTemplate
	getHtmlInfoTemplate
	getHtmlItemTemplate
	getHtmlItemText
	getHtmlScript	Gets the HTML code of a checklist.
	getInterfaceId
	getItem
	getName
	getScroll
	getStatusImage
	getStatusToolTip
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	gotoScroll
	groupIsExpanded	Checks whether a checklist group is in an expanded state.
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	infoText
	init
	initCheckBoxControl
	initHtmlControl
	insertItem
	isEmpty
	isRunnable
	makeLink
	mandatoryFinished	Verifies whether all of the mandatory items of a checklist have finished.
	mandatoryItems
	mandatoryItemsFinished
	maybeDirRTL
	needReStart
	new	Initializes a new instance of the SysCheckList 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.)
	onlyPrimarilySortOrder
	owner	Returns the instance that owns the object. (Inherited from Object.)
	parmIsSetupMode	Gets or sets the IsSetupMode parameter.
	preRunFormInInitialization	Peforms operation before running the form in the initialization.
	preventAtStartup	Checks to see whether a checklist has been prevented at startup.
	refresh
	runSilent
	save
	sequenceSort
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	sortWithStatusPreference
	statusSort
	toString	Returns a string that represents the current object. (Inherited from Object.)
	updateHtml
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::checkListItems
	::checkListItemsHook
	::checkLists
	::checkListsHook
	::compileChecklists
	::createDATDataarea
	::findDependentItems
	::finished
	::getAllCheckListItems
	::getCheckList	Gets an instance of a checklist class from its class ID.
	::getDefaultStylesheet
	::getStylesheetAllClassicTheme
	::getStyleXPBlue
	::getStyleXPOlive
	::getStyleXPSilver
	::imageURL
	::initNoUpdate
	::isFinished	Checks to see whether a checklist is finished.
	::lookupLastExecuted
	::main	Provides an entry point for the SysCheckList class when it is called from a menu item.
	::markExecuted
	::preventCheckListAtStartup	Prevents a checklist from running at start up.
	::resetDependents
	::runCheckList
	::runCheckListSpecific
	::runUserMenuItem
	::themeName
	::update
	::updateConditional
	::updateItem

Top

Remarks

How to create a new checklist.

1. Create a new class, inheriting from SysCheckList.

2. Create a new empty interface. This will be used by the items that belong to the checklist.

3. Override all the abstract methods on SysCheckList: find, save, getInterfaceId and isRunable. Refer to the comments in these methods, or see how they have been overridden in SysCheckList_Setup.

4. Add the classid to the static method SysCheckList::checkLists(). Or, if the checklist must start automatically when Microsoft Dynamics AX starts (and the isRunable method returns a value of true), add the classid to the SysCheckList::checkListsHook() method.

5. If the checklist must be startable from a command, use the following properties:

Class	Class
Object	SysChecklist
Parameters	Class name of checklist, for example: SysCheckList_Setup
EnumTypeParameter	SysCheckListType
EnumParameter	Custom

How to add a new Item:

1. Create new class, inheriting from SysCheckListItem and implement the interface from the checklist that the item should be a part of; for example: SysCheckListInterfaceSetup if you are inserting in the setup checklist, or SysCheckListInterfaceUpgrade if you are inserting in the upgrade checklist.

2. Override the following methods:

   • getHelpLink: Return link for extra help. If something is returned, the item has a help icon with link.

   • getMenuItemName: Name of menu item.

   • getMenuItemType: Type of menu item.

   • isRunable: Only override if the item needs special conditions besides the general checklist conditions. For example, if you only want to show the item if the database is Oracle.

3. Define the behavior of the item by using the init method or the new method.

4. Use the addDependency method to add any item that should be finished before this item can be run.

5. Use the placeAfter method to set the sequence in the list (this is dependent upon sortWithStatusPreference in the checklist).

6. Use indeterminate() if you want the item to be able to be skipped. When the user clicks the icon of the item, the status will automatically change to finished.

7. If the item requires Microsoft Dynamics AX to restart, place a call to SysCheckList.needRestart(true) in the setStatus method for the item:

8. if (status == SysCheckListStatus::finished && !this.find())

9. {

10. this.save();

11. sysCheckList.needRestart(true);

12. }

Place a call to the SysCheckList::finished(classnum(SysCheckListItem_MyNewItem)) method in your code when the task is completed.

1. Add the classId to the static SysCheckList::checkListItems method.

Examples

This example demonstrates the use of the SysCheckList class. However, this example will not compile in a job as it must be run in the context of a class, form, or other object.

super();  
 
this.indeterminate(true); //You are able to skip this item  
 
this.placeAfter(classnum(SysCheckListItem_Synchronize));  
 
//Can only run after sync. 
 
this.addDependency(classnum(SysCheckListItem_Synchronize)); 
 
//Can only run after compile or licensecode. 
 
this.addDependency(classnum(SysCheckListItem_Compile));
this.addDependency(classnum(SysCheckListItem_LicenseCode));

Inheritance Hierarchy

Object Class
  SysCheckList Class
    RetailCheckList_OnlineStoreSetup Class
    RetailCheckList_RetailStoreSetup Class
    SysCheckList_CN Class
    SysCheckList_Company Class
    SysChecklist_Servicing Class
    SysCheckList_Setup Class
    SysCheckList_SetupPartition Class
    SysCheckList_SitesSvcConfiguration Class
    SysCheckList_SysUpdateCode Class
    SysCheckList_Update Class
    SysCheckList_Upgrade Class
    SysCheckList_UpgradeCode Class
    SysCheckList_User Class