Class Reference
%CSP.UI.Portal.PKI
Server:appadmin-00044-deployment-6bf4cbc86d-9f4xc
Instance:IRIS
User:SuperUser
 
-
  [USER] >  [%CSP] >  [UI] >  [Portal] >  [PKI]
Private  Storage

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

System Management Portal - System Administration - InterSystems IRIS Public Key Infrastructure

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 2 49


Summary

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

Properties
%condition %import %includeFiles %page
%resource 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
isCAClientDefined isCAServerDefined label labelClass
labelDisabledClass labelPosition labelStyle layout
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
BuildMenu CheckAllBlanks CheckContextLinks CheckEnterpriseManager
ConvertParameter Decrypt DeletePendingProcess DoLogout
DrawGetCAList DrawGetCAListError DrawLocator DrawProcessPending
DrawRibbon DrawSubjectDN DrawTitle Encrypt
EscapeHTML EscapeURL EvalResult Exist
GetCSPURL GetCertificate GetContextLinks GetDocURL
GetHomePage GetNewURL GetQuickLinks GetStatus
HyperEventCall HyperEventHead Include InsertHiddenField
InsertHiddenFields IsPrivate JavaInstalled 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 addChild
addChildAfter addChildBefore afterSave afterValidate
browseSelect cancelPopup changeContact changePassword
changeSMTP childrenMutated correctIELayering createComponent
createComponentNS deleteComponent disableCommandButton doBack
doCancel doDetails doGetCertificate doIssue
doModified doNext doProcess doProcessCancel
doProcessDelete doProcessFinish doProcessRefresh doReinitialize
doSave doShowGetList dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler drawDone 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 removeChild render
renderContents renderSVG resetMsg resetMsgColor
searchBlur searchBoxHandler searchFocus searchKeyDown
searchKeyPress setComponentId setConnectivityStatusMsg setHidden
setModified setOverlayMode setPageTitle setProperty
setPropertyAll setSortMode setSortModeHandler setSubjectDN
setTraceOption setViewMode setViewModeHandler showAbout
showCommandButton showContact showDocumentation showHelp
showMsg showTLS startModal startProgressBar
stopProgressBar switchNamespace trimSpace validate
validateNumeric 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.PKI.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,Security,Public Key Infrastructure";
Each SMP page should set this link which points to the documentation anchor name.
• parameter PAGENAME = "Public Key Infrastructure";
Displayed name of this page.
• parameter RESOURCE = "%Admin_Secure";
Security requirement

Properties

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

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 %OnGetPageName() as %String
Get the (localized) name of the page. This should be implemented in a subclass.
• classmethod %OnPreHTTP() as %Boolean
Advanced security is always enabled now so the redirection when disabled is no longer necessary. I don't know whether the do nothing %OnPreHTTP method is still needed.
• 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 doCancel() [ 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 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 ]
Disable save button for EMS-managed pages. Be sure to use this.invokeSuper('onloadHandler',arguments); when overriding.
• 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 showTLS(flag) [ Language = javascript ]
• 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.


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.