Class %CSP.UI.Portal.EncryptionDatabase

class %CSP.UI.Portal.EncryptionDatabase extends %CSP.UI.Portal.Template

Database Encryption Keys. Activate, Deactivate database encryption key and configure startup options.

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
5	10	23

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	AllowMultiDB	DefaultKey	FirstFailed
HelpAddress	ISREADONLY	InvalidParam	IsEMSReadOnly
IsEditForm	JournalKey	KeyFileName	KeyLenList
KeyList	LocatorHeader	OnclickArray	PID
PageURL	ParentURL	StdTitle	ValidationErrorMsg
aboutPage	align	aux	backgroundTimerInterval
browseselect	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	lblDeactivate	lblTitle
limitPopups	name	onafterdrag	onbeforedrag
onclick	ondrag	ondrop	onhide
onrefresh	onshow	onupdate	pageModified
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	%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
ActivateKey	BuildMenu	CheckAllBlanks	CheckContextLinks
CheckEnterpriseManager	ConvertParameter	DeactivateKey	Decrypt
DoLogout	DrawIDs	DrawLocator	DrawRibbon
DrawTitle	DrawWarning	Encrypt	EscapeHTML
EscapeURL	EvalResult	GetCSPURL	GetContextLinks
GetDocURL	GetHomePage	GetNewURL	GetQuickLinks
HyperEventCall	HyperEventHead	Include	InsertHiddenField
InsertHiddenFields	IsPrivate	JavaInstalled	Link
OnDrawRibbon	OnGetRibbonInfo	OnHTTPHeader	OnPage
OnPageError	OnPostHTTP	OnPostHyperEvent	OnPreHTTP
OnPreHyperEvent	Page	QuoteJS	RegisterRecent
RewriteURL	SaveStartup	SetDefaultKey	ShowError
StartTimer	StopTimer	ThrowError	UnescapeHTML
UnescapeURL	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType	addChild	addChildAfter	addChildBefore
afterSave	afterValidate	browseSelect	cancelPopup
changePassword	childrenMutated	correctIELayering	createComponent
createComponentNS	deleteComponent	disableCommandButton	doActivate
doCancel	doConfigure	doDeactivate	doDefault
doFileChange	doModified	doOptions	doSave
doSaveStartup	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	getTitleAreaHeight	getType
goHome	goMenu	gotoNamespace	gotoPage
hideCommandButton	invokeSuper	isButtonDisabled	isOfType
launchPopupWindow	logout	makeId	navigate
onCreate	onDelete	onDisplayHandler	onEndModalHandler
onPopupAction	onRefreshContents	onSerialize	onServerMethodCall
onServerMethodError	onServerMethodReturn	onStartModalHandler	ondisabledHandler
onhandleAutoLogoutWarn	onkeydownHandler	onkeyupHandler	onlayoutHandler
onloadHandler	onlogoutHandler	onoverlayHandler	onresizeHandler
onunloadHandler	onupdateHandler	popupActionHandler	refreshContents
refreshPage	removeChild	render	renderContents
renderSVG	resetMsg	searchBlur	searchBoxHandler
searchFocus	searchKeyDown	searchKeyPress	setComponentId
setConnectivityStatusMsg	setHidden	setModified	setOverlayMode
setPageTitle	setProperty	setPropertyAll	setSortMode
setSortModeHandler	setTraceOption	setViewMode	setViewModeHandler
showAbout	showCommandButton	showContact	showDocumentation
showHelp	showMsg	startModal	startProgressBar
stopProgressBar	switchNamespace	trimSpace	validateRequired

Parameters

• parameter AUTONS = 0;

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

• parameter CSPURL = "/csp/sys/sec/%CSP.UI.Portal.EncryptionDatabase.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 = "System Administration,Encryption,Database Encryption";

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

• parameter PAGENAME = "Database Encryption";

Displayed name of this page.

• parameter RESOURCE = "%Admin_Secure";

Security requirement

Properties

• property AllowMultiDB as %Boolean [ InitialExpression = 1 ];

Wheter to allow multiple DB Encryption (restrict it in 2013.2 and allow for 2014.1+)

• property DefaultKey as %String;

Current activated default key.

• property JournalKey as %String;

Current activated key for journals.

• property KeyFileName as %String;

Key File for Unattended.

• property KeyLenList as %String;

List of currently activated key lengths, comma delimited.

• property KeyList as %String;

List of Current activated keys delimited by commas.

• property LocatorHeader as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Database Encryption") ];

The text that is shown in TitlePane above the license

• property PageURL as %ZEN.Datatype.string;

• property browseselect as %String;

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

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.

• classmethod ActivateKey(pKeyFile, pUsername, pPassword) as %ZEN.proxyObject [ ZenMethod ]

Save general data to server

• classmethod DeactivateKey(pKeyID) as %ZEN.proxyObject [ ZenMethod ]

Save general data to server

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

Draw activated databases encryption key identifier table

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

• 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.

• classmethod SaveStartup(pMode, pJournalFile, pIRISTemp, pAuditEncrypt, pKeyFile, pUsername, pPassword) as %ZEN.proxyObject [ ZenMethod ]

Save startup settings to server.

• classmethod SetDefaultKey(pKeyID, use) as %ZEN.proxyObject [ ZenMethod ]

Set new default key to server.

• method browseSelect(name, wildcard) [ Language = javascript ]

User clicked one of the Browse buttons. Save the name of the textfield so that when you return you know which textfield to update.

• method doActivate() [ Language = javascript ]

User clicked the "Activate Key" button. Show the form to Activate.

• method doCancel() [ Language = javascript ]

Hide edit forms.

• method doConfigure() [ Language = javascript ]

User clicked the "Configure Startup Settings" button. Show the form to configure.

• method doDeactivate(KeyID) [ Language = javascript ]

User clicked the "Deactivate Key" button. Process only if confirmed.

• method doDefault(KeyID, use) [ Language = javascript ]

User clicked the "Set Default" button to change default key id.

• method doFileChange() [ Language = javascript ]

User changed Key File. Enable fields if file name is changed.

• method doOptions(option) [ Language = javascript ]

User selected a Startup option. Show or hide related fields based on selection.

• method doSave() [ Language = javascript ]

Get user selection and send to server to activate key.

• method doSaveStartup() [ Language = javascript ]

Get user selection and send to server to save.

• method getPageTitle() as %String [ Language = javascript ]

Get the title string to add to the locator row.

• 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 ]

Multiple DB Encryption is allowed starting from 2014.1. And Configure Startup Settings is always allowed.

• method refreshPage() [ Language = javascript ]

Reload page.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search