Class %CSP.UI.Portal.EncryptionManage

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

Manage Existing Encryption Key File. You may view existing adminstrators defined for a key file, delete or add more administrators to an existing key file.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
5	7	15

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	CurrentKeyFile	CurrentKeyList	FirstFailed
HelpAddress	ISREADONLY	InvalidParam	IsEMSReadOnly
IsEditForm	LocatorHeader	OnclickArray	PID
ParentURL	StdTitle	ValidationErrorMsg	aboutPage
align	aux	backgroundTimerInterval	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
lblDefined	lblDelete	lblDeleted	lblKeyTable
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
AdminRemove	BuildMenu	CheckAllBlanks	CheckContextLinks
CheckEnterpriseManager	ConvertParameter	Decrypt	DoLogout
DrawAdmin	DrawKeys	DrawLocator	DrawRibbon
DrawTitle	Encrypt	EscapeHTML	EscapeURL
EvalResult	GetCSPURL	GetContextLinks	GetDocURL
GetHomePage	GetNewURL	GetQuickLinks	HyperEventCall
HyperEventHead	Include	InsertHiddenField	InsertHiddenFields
IsPrivate	JavaInstalled	KeyRemove	Link
LoadFile	OnDrawRibbon	OnGetRibbonInfo	OnHTTPHeader
OnPage	OnPageError	OnPostHTTP	OnPostHyperEvent
OnPreHTTP	OnPreHyperEvent	Page	QuoteJS
RegisterRecent	RewriteURL	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	doAdd	doCancel
doDelete	doDeleteKey	doModified	doOK
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
loadAdmin	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
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.EncryptionManage.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,Manage Encryption Key File";

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

• parameter PAGENAME = "Manage Encryption Key File";

Displayed name of this page.

• parameter RESOURCE = "%Admin_Secure";

Security requirement

Properties

• property CurrentKeyFile as %String;

This is the current key file name after user clicked the OK button.

• property CurrentKeyList as %String;

This is the current key list from the current key file.

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

The text that is shown in TitlePane above the license

• property lblDefined as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Administrators Defined in Key File %1") ];

• property lblDelete as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Are you sure you want to delete administrator %1 from %2?") ];

• property lblDeleted as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Deleted administrator: ") ];

• property lblKeyTable as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Encryption Keys Defined in Key File %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 AdminRemove(KeyFile, Username) as %ZEN.proxyObject [ ZenMethod ]

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

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

• classmethod KeyRemove(KeyFile, KeyID) as %ZEN.proxyObject [ ZenMethod ]

• classmethod LoadFile(KeyFile) as %ZEN.proxyObject [ ZenMethod ]

Load key file

• 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 doAdd(what) [ Language = javascript ]

• method doDelete(deleteUser) [ Language = javascript ]

• method doDeleteKey(deleteKey) [ Language = javascript ]

• method doOK() [ Language = javascript ]

Load key file.

• method loadAdmin() [ Language = javascript ]

Load or reload Key and Admin tables after user clicked OK for Key File, or after Add or Delete.

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

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

Class Reference IRIS for UNIX 2024.1.2
Documentation Search