Class %CSP.UI.Portal.DatabaseDetails

class %CSP.UI.Portal.DatabaseDetails extends %CSP.UI.Portal.Utils

System Management Portal - System Operations - Database Details

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
7	16	21

Summary

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

Properties
%Pane	%condition	%import	%includeFiles
%page	%resource	AllowDismount	AllowMount
BackgroundPage	BackgroundTasks	CompactDialog	CurrentColumn
CurrentSort	DBName	DatabaseDetailsPage	DatabasesPage
DefragDialog	Directory	Filter	FirstFailed
HelpAddress	ISREADONLY	InvalidParam	IsEMSReadOnly
IsEditForm	LocatorHeader	OnclickArray	PID
ParentURL	StdTitle	SysBGTaskId	TableMaxRows
TablePageSize	TaskInfoDialog	TruncateDialog	ValidationErrorMsg
aboutPage	align	aux	backgroundTimerInterval
captionLastUpdate	cellAlign	cellSize	cellStyle
cellVAlign	children	composite	contactPage
containerStyle	cssLevel	currSortMode	currStep
currViewMode	disabled	dragAndDrop	dragEnabled
dropEnabled	enableAutoRefresh	enclosingClass	enclosingStyle
error	groupClass	groupStyle	height
hidden	hint	hintClass	hintStyle
home	homePage	id	index
label	labelClass	labelDisabledClass	labelPosition
labelStyle	layout	lblTitle	limitPopups
msgDismount	name	onafterdrag	onbeforedrag
onclick	ondrag	ondrop	onhide
onrefresh	onshow	onupdate	pageModified
paneDone	parent	searchKey	showLabel
slice	title	tuple	useSVG
useSoftModals	valign	visible	width
window	zenPersistentPopup

Methods
%AddChild	%AddChildAfter	%AddChildBefore	%AddComponent
%AddImportedComponents	%AddLocatorLinks	%AddToSaveSet	%ApplyURLParms
%Attr	%BindExport	%ClassIsLatestVersion	%ClassName
%ConstructClone	%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty
%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty
%DrawAutoLogout	%DrawClassDefinitions	%DrawComponentHTML	%DrawHTML
%DrawHTMLPage	%DrawJSStrings	%DrawObjectDefinitions	%EnclosingDivId
%EndBackgroundMethod	%EndScript	%Eval	%EvalC
%Extends	%ForceClientRender	%GetChildIndex	%GetComponent
%GetComponentById	%GetComponentByName	%GetEventHandlers	%GetHomePage
%GetHomeParam	%GetLinks	%GetLocatorLinks	%GetNavTableState
%GetPageName	%GetParameter	%GetProductName	%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
%OnGetPageName	%OnGetProductName	%OnGetSmallMenu	%OnGetTitle
%OnMonitorBackgroundTask	%OnMutateChildren	%OnObjectSynch	%OnPreHTTP
%OnSubmit	%OnUseSoftModals	%OnZENDeserialize	%OriginalNamespace
%PackageName	%QuoteValue	%QuoteValueL10N	%Register
%RemoveChild	%RemoveChildren	%RemoveComponent	%RemoveFromSaveSet
%RunBackgroundMethod	%Self	%SerializeObject	%SetBackgroundMethodStatus
%SetErrorById	%SetErrorByName	%SetModified	%SetValueById
%SetValueByName	%SetValuesByName	%StartScript	%ValidateObject
%ZENVersion	BuildMenu	BuildMeter	CheckAllBlanks
CheckContextLinks	CheckEnterpriseManager	ConvertParameter	Decrypt
Dismount	DoLogout	DrawAutoRefresh	DrawDetails
DrawLocator	DrawRibbon	DrawSize	DrawTasks
DrawTitle	Encrypt	EscapeHTML	EscapeURL
EvalResult	GetCSPURL	GetContextLinks	GetDBOBJ
GetDetailPane	GetDocURL	GetHomePage	GetNewURL
GetQuickLinks	HyperEventCall	HyperEventHead	Include
InsertHiddenField	InsertHiddenFields	IsPrivate	JavaInstalled
LastUpdateTime	Link	OnDrawRibbon	OnGetRibbonInfo
OnHTTPHeader	OnPage	OnPageError	OnPostHTTP
OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent	Page
QuoteJS	RegisterRecent	RewriteURL	ShowError
StartTimer	StopTimer	ThrowError	UnescapeHTML
UnescapeURL	UpdateAutoRefreshRate	UpdateAutoRefreshState	UpdateTableNavState
UpdateTableState	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType	addChild	addChildAfter	addChildBefore
afterSave	afterValidate	cancelPopup	changePassword
childrenMutated	columnSort	correctIELayering	createComponent
createComponentNS	deleteComponent	disableCommandButton	doAction
doCancel	doDismount	doModified	doMount
doTableViewSwitch	dragFinishHandler	dragHandler	dragNotifyHandler
dragStartHandler	dropHandler	dropStartHandler	enableCommandButton
endModal	exposeComponent	findElement	fireOnResizeEvent
fireOnUnloadEvent	fireOnUpdateEvent	firePopupAction	getChildIndex
getComponent	getComponentById	getEnclosingDiv	getHidden
getHintElement	getLabelElement	getOpener	getPageTitle
getProperty	getSettings	getTime	getTitleAreaHeight
getType	goHome	goMenu	gotoNamespace
gotoPage	hideCommandButton	invokeSuper	isButtonDisabled
isOfType	launchPopupWindow	logout	makeId
navMaxRowsChanged	navPageSizeChanged	navigate	onCreate
onDelete	onDisplayHandler	onEndModalHandler	onPopupAction
onRefreshContents	onSerialize	onServerMethodCall	onServerMethodError
onServerMethodReturn	onStartModalHandler	ondisabledHandler	onhandleAutoLogoutWarn
onkeydownHandler	onkeyupHandler	onlayoutHandler	onloadHandler
onlogoutHandler	onoverlayHandler	onresizeHandler	onunloadHandler
onupdateHandler	openTaskPage	popupActionHandler	refreshContents
refreshHandler	refreshkeyUp	removeChild	render
renderContents	renderSVG	resetMsg	searchBlur
searchBoxHandler	searchFocus	searchKeyDown	searchKeyPress
setComponentId	setConnectivityStatusMsg	setHidden	setModified
setOverlayMode	setPageTitle	setProperty	setPropertyAll
setRefreshMode	setRefreshRate	setSortMode	setSortModeHandler
setTraceOption	setViewMode	setViewModeHandler	showAbout
showCommandButton	showContact	showDocumentation	showHelp
showMsg	startModal	startProgressBar	stopProgressBar
switchNamespace	taskTimeout	trimSpace	updateTime
updateView	validateRequired	zeroFill

Parameters

• parameter AUTONS = 0;

Do not switch namespace for this page: it needs to stay in %SYS

• parameter CSPURL = "/csp/sys/op/%CSP.UI.Portal.DatabaseDetails.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 HELPADDRESS = "Home,Databases,Database Info";

Each SMP page should set this link which points to the documentation anchor name.

• parameter PAGENAME = "Operation DatabaseDetails";

Displayed name of this page.

• parameter PARENTPAGE = "/csp/sys/op/%CSP.UI.Portal.OpDatabases.zen";

This parameter defines the parent page for this page.
If the name ends in .csp, then the parent is assumed to be an autopage-enabled CSP page.
If the name ends in .cls, then the parent is assumed to be a Zen page.
This is used to automate the construction of the locator bar for this page and to build the index between portal pages and documentation.
The %GetLocatorInfo method is used to get this information.

• parameter RECENT = 0;

If true, register visits to this page in the recent list.

• parameter RESOURCE = "%Admin_Operate";

Security requirement

Properties

• property %Pane as %CSP.Util.Pane;

Server-side reference to the pane object so that the head and body sections can be added to the page correctly.

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

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

• property BackgroundPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/%25CSP.UI.Portal.BackgroundTaskList.zen",,1) ];

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

• property CompactDialog as %ZEN.Datatype.string [ InitialExpression = ..Link("%CSP.UI.Portal.Background.Dialog.DatabaseCompact.zen",,1) ];

• property DBName as %String(ZENURL="DBName");

Database Name

• property DatabaseDetailsPage as %String;

this page's link with Directory and DBName

• property DatabasesPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/op/%CSP.UI.Portal.OpDatabases.zen") ];

parent page link

• property DefragDialog as %ZEN.Datatype.string [ InitialExpression = ..Link("%CSP.UI.Portal.Background.Dialog.DatabaseDefragment.zen",,1) ];

• property Directory as %String(ZENURL="$ID1");

Database Directory

• property SysBGTaskId as %String;

ID for Systems background task id

• property TaskInfoDialog as %String [ InitialExpression = ..Link("/csp/sys/%CSP.UI.Portal.Background.Dialog.TaskInfo.zen",,1) ];

• property TruncateDialog as %ZEN.Datatype.string [ InitialExpression = ..Link("%CSP.UI.Portal.Background.Dialog.DatabaseTruncate.zen",,1) ];

• property msgDismount as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Are you sure you want to dismount database %1?") ];

• property paneDone as %Boolean;

Flag to indicate whether %Pane's OnDrawHEAD() method has been executed.

Methods

• method %GetLocatorLinks(Output pLink) as %Status

Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)

• method %OnAfterCreatePage() as %Status

Be sure to do ##super() when overriding.

• method %OnDrawHTMLHead() as %Status

Add the HEAD section for %Pane and override some CSS styles if HTML5 is enabled. Without these overrides, the font size is calculated to be 0.8px and padding is calculated to be 0 for the header cells..

• method %OnGetPageName() as %String

Get the (localized) name of the page. This should be implemented in a subclass.

• classmethod Dismount(Dir As %String) as %String [ ZenMethod ]

Dismount a DB.

• method DrawDetails(pSeed As %String) as %Status

Draw the contents of the diagram header, in the HTMLDashboard style.

• method DrawSize(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status

• method DrawTasks(pDirectory As %String) as %Status

Draw the contents of the ongoing tasks.

• classmethod GetDBOBJ(pDir) as %String [ ZenMethod ]

• classmethod GetDetailPane(pInstance As %CSP.Util.PageInstance) as %CSP.Util.Pane [ Language = objectscript ]

Set properties for HTMLDashboardPane to draw details.

• method OnDrawRibbon() as %Status

Add to the contents of the tool ribbon.

• method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status

Get information to display in the ribbon bar.

• method doAction(action) [ Language = javascript ]

• method doDismount() [ Language = javascript ]

• method doMount() [ Language = javascript ]

• method doTableViewSwitch() [ Language = javascript ]

• method onPopupAction(popupName, action, value) [ Language = javascript ]

This client event, if present, is fired when the a popup page launched from this page fires an action.

• method onloadHandler() [ Language = javascript ]

Disable save button for EMS-managed pages. Be sure to use this.invokeSuper('onloadHandler',arguments); when overriding.

• method openTaskPage(SysBGTaskId) [ Language = javascript ]

• method taskTimeout() [ Language = javascript ]

open task status info page after an action (such as Compact and Defragment) is commited and the page is closed.

• method updateView() [ Language = javascript ]

For auto-refresh on this page.


[USER] > [%CSP] > [UI] > [Portal] > [DatabaseDetails]		Private Storage