Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
5	2	48

Properties
%condition	%import	%includeFiles	%page
%resource	HelpAddress	ISREADONLY	LocatorHeader
ParentURL	StdTitle	aboutPage	align
aux	backgroundTimerInterval	cellAlign	cellSize
cellStyle	cellVAlign	children	composite
containerStyle	cssLevel	currSortMode	currStep
currViewMode	disabled	dragAndDrop	dragEnabled
dropEnabled	enclosingClass	enclosingStyle	error
groupClass	groupStyle	height	hidden
hint	hintClass	hintStyle	home
homePage	id	index	isCAClientDefined
isCAServerDefined	label	labelClass	labelDisabledClass
labelPosition	labelStyle	layout	lblTitle
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
%%OIDGet	%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
%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
BuildMenu	CheckAllBlanks	ConvertParameter	Decrypt
DeletePendingProcess	DoLogout	DrawGetCAList	DrawGetCAListError
DrawLocator	DrawProcessPending	DrawRibbon	DrawSubjectDN
DrawTitle	Encrypt	EscapeHTML	EscapeURL
Exist	GetCSPURL	GetCertificate	GetContextLinks
GetDocPage	GetHomePage	GetNewURL	GetQuickLinks
GetStatus	HyperEventBody	HyperEventCall	HyperEventFrame
HyperEventHead	Include	InsertHiddenField	InsertHiddenFields
IsPrivate	Link	LoadClientConfigure	LoadServerConfigure
OnDrawRibbon	OnGetRibbonInfo	OnHTTPHeader	OnPage
OnPageError	OnPostHTTP	OnPostHyperEvent	OnPreHTTP
OnPreHyperEvent	Page	QuoteJS	RegisterRecent
Reinitialize	RewriteURL	SaveClientConfigure	SaveServerConfigure
ShowError	SignProcess	StartTimer	StopTimer
SubmitCSR	ThrowError	UnescapeHTML	UnescapeURL
ValidateFile	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType	ZStripW	addChild	addChildAfter
addChildBefore	afterSave	browseSelect	cancelPopup
changeContact	changePassword	changeSMTP	childrenMutated
correctIELayering	createComponent	createComponentNS	deleteComponent
doBack	doClose	doDetails	doGetCertificate
doIssue	doNext	doProcess	doProcessCancel
doProcessDelete	doProcessFinish	doProcessRefresh	doReinitialize
doSave	doShowGetList	dragFinishHandler	dragHandler
dragNotifyHandler	dragStartHandler	drawDone	dropHandler
dropStartHandler	endModal	exposeComponent	findElement
fireOnLoadEvent	fireOnResizeEvent	fireOnUnloadEvent	fireOnUpdateEvent
firePopupAction	getChildIndex	getComponent	getComponentById
getEnclosingDiv	getHidden	getHintElement	getLabelElement
getOpener	getProperty	getSettings	getTitleAreaHeight
getType	goHome	goMenu	gotoNamespace
gotoPage	invokeSuper	isOfType	launchPopupWindow
logout	makeId	navigate	onCreate
onDelete	onDisplayHandler	onEndModalHandler	onPopupAction
onRefreshContents	onSerialize	onServerMethodCall	onServerMethodError
onServerMethodReturn	onStartModalHandler	ondisabledHandler	onkeydownHandler
onkeyupHandler	onlayoutHandler	onloadHandler	onlogoutHandler
onoverlayHandler	onresizeHandler	onunloadHandler	onupdateHandler
popupActionHandler	refreshContents	removeChild	render
renderContents	renderSVG	resetMsg	resetMsgColor
searchBlur	searchBoxHandler	searchFocus	searchKeyDown
searchKeyPress	setComponentId	setHidden	setModified
setOverlayMode	setProperty	setPropertyAll	setSortMode
setSortModeHandler	setSubjectDN	setTraceOption	setViewMode
setViewModeHandler	showAbout	showDocumentation	showErrMsg
showHelp	showMsg	startModal	startProgressBar
stopProgressBar	switchNamespace	validate	validateNumeric
validateRequired

• parameter AUTONS = 0;

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

• parameter CSPURL = "/csp/sys/sec/%CSP.UI.Portal.PKI.cls";

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 = "Public Key Infrastructure";

Displayed name of this page.

• parameter PARENTPAGE = "%CSP.Portal.Home.cls";

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 RESOURCE = "%Admin_Secure";

Security requirement

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

Indicate whether the local Certificate Authority client has been defined.

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

Indicate whether the local Certificate Authority server has been defined.

• 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

Decorate the page.

• method %OnGetPageName() as %String

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

• classmethod %OnPreHTTP() as %Boolean

If user does not have advanced security privilege this option should be disabled from the Home menu and user should not be able to come here.
This is an extra check just in case user typed the URL in the browser location. Redirect to the Home page if that is the case.

• classmethod DeletePendingProcess(pName) as %ZEN.proxyObject [ ZenMethod ]

• classmethod DrawGetCAList(pType As %String) as %Status

Draw html code for Get Certificate(s) from Certificate Authority server The pType determines if we are going to (showall) List all issued certificates, or (showinstance) List certificates issued for this instance

• classmethod DrawGetCAListError(ErrorMsg)

• classmethod DrawProcessPending(pName As %String) as %Status

Draw html code for Pending Certificate Signing Request

• classmethod DrawSubjectDN(pConfigType As %String) as %Status

Draw Subject Disignated Name for "Server" and "Client" (passed in as pConfigType)

• classmethod Exist(CAPath, CAFilename) as %Boolean [ ZenMethod ]

Return 1 if both cer and key files exist; 0 otherwise.

• classmethod GetCertificate(pNumber) as %ZEN.proxyObject [ ZenMethod ]

• classmethod GetStatus(tab) as %ZEN.proxyObject [ ZenMethod ]

tab = 2: Draw is finished, Status is "Done".

• classmethod LoadClientConfigure() as %Boolean [ ZenMethod ]

Load CA Client configure properties into form

• classmethod LoadServerConfigure() as %Boolean [ ZenMethod ]

Load CA Server configure properties into form

• 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 Reinitialize() as %ZEN.proxyObject [ ZenMethod ]

This method deletes the Certificate Authority server configuration and all pending Certificate Signing Requests and issued Certificates, allowing user to start over.

• classmethod SaveClientConfigure(pIsCAClientDefined, pProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]

• classmethod SaveServerConfigure(pIsCAServerDefined, pProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]

• classmethod SignProcess(pName, pPassword, pCertType) as %ZEN.proxyObject [ ZenMethod ]

• classmethod SubmitCSR(pProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]

• classmethod ValidateFile(pValue As %String) as %String [ ZenMethod ]

validate file name root.

• method afterSave(result As %ZEN.proxyObject) [ Language = javascript ]

Write out result message and refresh option when appopriate.

• method browseSelect(name) [ 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 changeContact(namevalue) [ Language = javascript ]

Enable/disable Contact Phone and Email depending on whether the Contact Name is null.

• method changeSMTP(namevalue) [ Language = javascript ]

Enable/disable SMTP related fields depending on whether the SMTP Server is null.

• method doBack() [ Language = javascript ]

User clicked the Back button for CA Server form. Hide the required fields and show the first two.

• method doClose() [ Language = javascript ]

User clicked Cancel on an option.

• method doDetails(option) [ Language = javascript ]

• method doGetCertificate(number) [ Language = javascript ]

• method doIssue(name) [ Language = javascript ]

User clicked a Process link on the "Process pending Certificate Singing Requests" table.

• method doNext() [ Language = javascript ]

User clicked Continue for CA Server form. Validate the first two required fields and decide whether to show the rest of required fields.

• method doProcess(name) [ Language = javascript ]

User clicked a Process link on the "Process pending Certificate Singing Requests" table.

• method doProcessCancel() [ Language = javascript ]

• method doProcessDelete(name) [ Language = javascript ]

User clicked a Delete link on the "Process pending Certificate Singing Requests" table.

• method doProcessFinish() [ Language = javascript ]

• method doProcessRefresh() [ Language = javascript ]

• method doReinitialize() [ Language = javascript ]

• method doSave(option) [ Language = javascript ]

• method doShowGetList(showflag) [ Language = javascript ]

On the Get Certificate option, show all certificates or show certificate for this instance only. showflag is equal to "showall" or "showinstance". Default is "showall" when the option is opened.

• method drawDone(tab) [ Language = javascript ]

This method is fired up after onDrawContent is finished. Hide progress message and display error if exists.

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

Check if user really wants to exit if they have not saved changes

• method resetMsgColor() [ Language = javascript ]

• method setSubjectDN(proxy As %ZEN.proxyObject, n, value) [ Language = javascript ]

prepare proxy for transporting SubjectDN's value from page to server.

• method showErrMsg(msg) [ Language = javascript ]

This method displays the error message with text in red color.

• method validate(option) [ Language = javascript ]

• method validateNumeric(ctl) as %Boolean [ Language = javascript ]

This method validate the following: 1) value must not be null, AND 2) value must be only numeric

• method validateRequired(ctl, pass, type) as %Boolean [ Language = javascript ]

validate the control value. pass is either "true" or "false" indicating if there is already a field failed pass validation.