Skip to main content


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

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

Property Inventory

Method Inventory


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;
Inherited description: 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;
Inherited description: 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


property isCAClientDefined as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Indicate whether the local Certificate Authority client has been defined.
Property methods: isCAClientDefinedDisplayToLogical(), isCAClientDefinedGet(), isCAClientDefinedIsValid(), isCAClientDefinedLogicalToDisplay(), isCAClientDefinedLogicalToOdbc(), isCAClientDefinedLogicalToXSD(), isCAClientDefinedNormalize(), isCAClientDefinedSet(), isCAClientDefinedXSDToLogical()
property isCAServerDefined as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Indicate whether the local Certificate Authority server has been defined.
Property methods: isCAServerDefinedDisplayToLogical(), isCAServerDefinedGet(), isCAServerDefinedIsValid(), isCAServerDefinedLogicalToDisplay(), isCAServerDefinedLogicalToOdbc(), isCAServerDefinedLogicalToXSD(), isCAServerDefinedNormalize(), isCAServerDefinedSet(), isCAServerDefinedXSDToLogical()


Return the array of links to show in the locator bar.
method %OnAfterCreatePage() as %Status
Inherited description: 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.
clientmethod afterSave(result As %ZEN.proxyObject) [ Language = javascript ]
Write out result message and refresh option when appopriate.
clientmethod 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.
clientmethod changeContact(namevalue) [ Language = javascript ]
Enable/disable Contact Phone and Email depending on whether the Contact Name is null.
clientmethod changeSMTP(namevalue) [ Language = javascript ]
Enable/disable SMTP related fields depending on whether the SMTP Server is null.
clientmethod doBack() [ Language = javascript ]
User clicked the Back button for CA Server form. Hide the required fields and show the first two.
clientmethod doCancel() [ Language = javascript ]
User clicked Cancel on an option.
clientmethod doDetails(option) [ Language = javascript ]
clientmethod doGetCertificate(number) [ Language = javascript ]
clientmethod doIssue(name) [ Language = javascript ]
User clicked a Process link on the "Process pending Certificate Singing Requests" table.
clientmethod 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.
clientmethod doProcess(name) [ Language = javascript ]
User clicked a Process link on the "Process pending Certificate Singing Requests" table.
clientmethod doProcessCancel() [ Language = javascript ]
clientmethod doProcessDelete(name) [ Language = javascript ]
User clicked a Delete link on the "Process pending Certificate Singing Requests" table.
clientmethod doProcessFinish() [ Language = javascript ]
clientmethod doProcessRefresh() [ Language = javascript ]
clientmethod doReinitialize() [ Language = javascript ]
clientmethod doSave(option) [ Language = javascript ]
clientmethod 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.
clientmethod drawDone(tab) [ Language = javascript ]
This method is fired up after onDrawContent is finished. Hide progress message and display error if exists.
clientmethod getPageTitle() as %String [ Language = javascript ]
Get the title string to add to the locator row.
clientmethod 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.
clientmethod onloadHandler() [ Language = javascript ]
Inherited description: Disable save button for EMS-managed pages. Be sure to use this.invokeSuper('onloadHandler',arguments); when overriding.
clientmethod resetMsgColor() [ Language = javascript ]
clientmethod setSubjectDN(proxy As %ZEN.proxyObject, n, value) [ Language = javascript ]
prepare proxy for transporting SubjectDN's value from page to server.
clientmethod showTLS(flag) [ Language = javascript ]
clientmethod validate(option) [ Language = javascript ]
clientmethod validateNumeric(ctl) as %Boolean [ Language = javascript ]
This method validate the following: 1) value must not be null, AND 2) value must be only numeric
clientmethod validateRequired(ctl As %Library.String, pass As %Library.String, type As %Library.String, checkRange As %Library.String, minVal As %Library.String, maxVal As %Library.String) as %Boolean [ Language = javascript ]
validate the control value. pass is either "true" or "false" indicating if there is already a field failed pass validation.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab