Class %CSP.UI.Portal.Dialog.Integ

class %CSP.UI.Portal.Dialog.Integ extends %CSP.UI.Portal.Dialog.WizardTemplate

Integrity Check dialog for Management Portal

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
6	6	25

Summary

This is a Zen Page class. It belongs to the application %CSP.UI.Portal.Application.

Properties
%condition	%import	%includeFiles	%page
%resource	CHECKINTEGALL	Directory	FILETYPE
Finished	FirstFailed	GlobalChanged	InvalidParam
IsEMSReadOnly	TOTALDB	ValidationErrorMsg	align
aux	backgroundTimerInterval	cellAlign	cellSize
cellStyle	cellVAlign	children	composite
containerStyle	cssLevel	dialogTitle	disabled
disabledStyle	dragAndDrop	dragEnabled	dropEnabled
enclosingClass	enclosingStyle	error	groupClass
groupStyle	height	helpId	hidden
hideApplyButton	hideCancelButton	hint	hintClass
hintStyle	id	index	label
labelClass	labelDisabledClass	labelPosition	labelStyle
layout	name	onafterdrag	onbeforedrag
onclick	ondrag	ondrop	onhide
onrefresh	onshow	onupdate	parent
showLabel	slice	title	tuple
useSVG	useSoftModals	valign	visible
width	window	zenPersistentPopup

Methods
%AddChild	%AddChildAfter	%AddChildBefore	%AddComponent
%AddImportedComponents	%AddToSaveSet	%ApplyURLParms	%Attr
%BindExport	%ClassIsLatestVersion	%ClassName	%ConstructClone
%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty	%DrawAutoLogout
%DrawClassDefinitions	%DrawComponentHTML	%DrawHTML	%DrawHTMLPage
%DrawJSStrings	%DrawObjectDefinitions	%DrawTitle	%EnclosingDivId
%EndBackgroundMethod	%EndScript	%Eval	%EvalC
%Extends	%ForceClientRender	%GetChildIndex	%GetComponent
%GetComponentById	%GetComponentByName	%GetEventHandlers	%GetLinks
%GetPageName	%GetParameter	%GetValueById	%GetValueByName
%GetXMLName	%IsA	%IsModified	%Link
%LinkCSS	%LinkScript	%MakeId	%New
%NormalizeObject	%ObjectModified	%OnAddToPageAfter	%OnAddToPageBefore
%OnAfterCreatePage	%OnBeforeCreatePage	%OnCreateApplication	%OnCreatePage
%OnDetermineCSSLevel	%OnDrawEnclosingDiv	%OnDrawHTMLBody	%OnDrawHTMLHead
%OnDrawHTMLMeta	%OnDrawObjectProperties	%OnFinishBackgroundTask	%OnGetSubtitle
%OnGetTitle	%OnMonitorBackgroundTask	%OnMutateChildren	%OnObjectSynch
%OnPreHTTP	%OnSubmit	%OnUseSoftModals	%OnZENDeserialize
%OriginalNamespace	%PackageName	%QuoteValue	%QuoteValueL10N
%RemoveChild	%RemoveChildren	%RemoveComponent	%RemoveFromSaveSet
%RunBackgroundMethod	%Self	%SerializeObject	%SetBackgroundMethodStatus
%SetErrorById	%SetErrorByName	%SetModified	%SetValueById
%SetValueByName	%SetValuesByName	%StartScript	%ValidateObject
%ZENVersion	ConvertParameter	Decrypt	DrawDBs
DrawGlobals	DrawPageTitle	Encrypt	EscapeHTML
EscapeURL	EvalResult	GetLink	HyperEventCall
HyperEventHead	Include	InsertHiddenField	InsertHiddenFields
IsEnabled	IsPrivate	JavaInstalled	Link
OnHTTPHeader	OnPage	OnPageError	OnPostHTTP
OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent	Page
PrepareAction	QuoteJS	RewriteURL	SaveGlobals
ShowError	StartTimer	StopTimer	ThrowError
UnescapeHTML	UnescapeURL	XMLDTD	XMLExport
XMLExportToStream	XMLExportToString	XMLNew	XMLSchema
XMLSchemaNamespace	XMLSchemaType	addChild	addChildAfter
addChildBefore	adjustSize	btnApply	btnOK
canFinish	canGoBack	canGoNext	cancelPopup
changeCheckbox	childrenMutated	correctIELayering	createComponent
createComponentNS	ctrlKeyDown	deleteComponent	dialogApply
dialogCancel	dialogFinish	dialogTitleGet	disableButtons
disableDBboxes	doRun	dragFinishHandler	dragHandler
dragNotifyHandler	dragStartHandler	dropHandler	dropStartHandler
enableGlobalButton	endModal	exposeComponent	findElement
fireOnResizeEvent	fireOnUnloadEvent	fireOnUpdateEvent	firePopupAction
formValidationHandler	getChildIndex	getComponent	getComponentById
getDBValues	getDialogValue	getEnclosingDiv	getGlobals
getHidden	getHintElement	getLabelElement	getOpener
getProperty	getSettings	getType	gotoPage
hasMultiplePages	invokeSuper	isOfType	launchPopupWindow
makeId	nextPage	onCreate	onDelete
onDisplayHandler	onEndModalHandler	onPopupAction	onRefreshContents
onSerialize	onServerMethodCall	onServerMethodError	onServerMethodReturn
onStartModalHandler	ondialogCancel	ondialogFinish	ondialogStart
ondisabledHandler	onfinishHandler	onhandleAutoLogoutWarn	onkeydownHandler
onkeyupHandler	onlayoutHandler	onloadHandler	onlogoutHandler
onoverlayHandler	onresizeHandler	onstartHandler	onunloadHandler
onupdateHandler	popupActionHandler	previousPage	refreshContents
removeChild	render	renderContents	renderSVG
resetMsg	setComponentId	setHidden	setOverlayMode
setProperty	setPropertyAll	setTraceOption	showDocumentation
showGlobals	showHelp	showMsg	startModal
startProgressBar	stopProgressBar	toggleCheckboxes	toggleDBboxes
updateDBValues	updateState	validateRequired

Parameters

• parameter APPLICATION = "%CSP.UI.Portal.Application";

Class name of application this page belongs to.

• parameter APPLYBUTTON = 0;

If true, then this dialog displays an Apply button.

• parameter AUTONS = 0;

If $NAMESPACE is set, auto switch namespace

• parameter CSPURL = "/csp/sys/op/%CSP.UI.Portal.Dialog.Integ.zen";

This parameter is used to make sure that if multiple CSP applications are mapped to the same namespace that the CSP engine can correctly identify which class corresponds with which URL. If 'LockCSPName' is true (the default, defined in the CSP application) then you can only access this page if the url exactly matches this 'CSPURL'. You can set this parameter to "" if you wish to disable this check for this class. This check is applied for all CSP urls (cls/csp/zen).
If this page was compiled from a .csp file, then this parameter is automatically set to contain the url of this file used for compilation.

• parameter PAGENAME = "IntegrityCheck";

Displayed name of this page.

• parameter RESOURCE = "%Admin_Operate:USE";

This is a comma-delimited list of system Resources and associated permissions. A user must hold the specified permissions on at least one of the specified resources in order to view this page or invoke any of its server-side methods from the client.
The format of each item in the list should be as follows:
Resource[:Permission]
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE.

Properties

• property CHECKINTEGALL as %ZEN.Datatype.string(ZENURL="CHECKINTEGALL");

• property Directory as %ZEN.Datatype.string;

Last Directory user selected

• property FILETYPE as %ZEN.Datatype.string(ZENURL="FILETYPE");

Type from where we get the selected items from: Class or Routine.

• property Finished as %ZEN.Datatype.boolean [ InitialExpression = "0" ];

When Run is clicked then Finished is set to 1, indicating Next and Run buttons should be disabled.

• property GlobalChanged as %ZEN.Datatype.boolean;

If user unchecked a global, this is set to 1.

• property TOTALDB as %ZEN.Datatype.integer [ InitialExpression = "0" ];

Total number of DBs user selected. If it's 1 then allow to select/unselect globals.

Methods

• method %OnGetSubtitle() as %String

Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.

• method %OnGetTitle() as %String

Get the (localized) title string for the dialog. This should be implemented in a subclass.

• classmethod DrawDBs(pSeed) as %Status

• classmethod DrawGlobals(pSeed) as %Status

• classmethod DrawPageTitle(pSeed As %String) as %Status

• method GetLink() as %String [ ZenMethod ]

• classmethod PrepareAction(filetype, selectedRows, GLOBALLIST) as %String [ ZenMethod ]

If at least one database is selected, then save it into session

• classmethod SaveGlobals(pGlobals) [ ZenMethod ]

• method canFinish() [ Language = javascript ]

Return true if this template can Finish (i.e., enable the Finish button).

• method canGoBack() [ Language = javascript ]

Return true if this template can go to the previous page (i.e., enable the Back button).
This is implemented by subclasses.

• method canGoNext() [ Language = javascript ]

Return true if this template can go to the next page (i.e., enable the Next button).

• method changeCheckbox(thisCheckbox) [ Language = javascript ]

• method disableDBboxes() [ Language = javascript ]

Disable or enable db checkboxes. If globals selected, then disable other DB checkboxes. If user unchecked the only DB they have globals selected, then enable all and lose global selections.

• method doRun() [ Language = javascript ]

Now Run Integ.

• method enableGlobalButton() [ Language = javascript ]

For Integrity check, if user selected more than one database, then disable the Global button

• method getDBValues() [ Language = javascript ]

• method getDialogValue() [ Language = javascript ]

Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.

• method getGlobals() [ Language = javascript ]

Get global checkboxes and save it to temp global for processing.

• method hasMultiplePages() [ Language = javascript ]

Return true if this template has more than one "page". This will display Back and Next buttons. This is implemented by subclasses.

• method onloadHandler() [ Language = javascript ]

This client event, if present, is fired when the page is loaded.

• method onresizeHandler() [ Language = javascript ]

This client event, if present, is fired when the page is resized.

• method showGlobals(pickGlobals) [ Language = javascript ]

• method toggleCheckboxes(cbState) [ Language = javascript ]

• method toggleDBboxes(cbState) [ Language = javascript ]

• method updateDBValues(cbState) [ Language = javascript ]

gather state of check boxes and update cbState

Class Reference IRIS for UNIX 2024.1.2
Documentation Search