Skip to main content


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

Zen page for System Management Portal - Edit SSL/TLS configuration

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.SSL.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,SSL/TLS Configurations;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = SSL/TLS Configuration;
Displayed name of this page.
parameter PARENTPAGE = /csp/sys/sec/%CSP.UI.Portal.SSLList.zen;
Inherited description: 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 RECENT = 0;
Inherited description: If true, register visits to this page in the recent list.
parameter RESOURCE = %Admin_Secure;
Security requirement


property AllowTest as %Integer [ InitialExpression = 1 ];
Flag to indicate what to do with the Test and Save button. -1 = Both disabled; 0 = Test disabled; -10 = Test hidden; 1 = Test enabled
Property methods: AllowTestDisplayToLogical(), AllowTestGet(), AllowTestIsValid(), AllowTestLogicalToDisplay(), AllowTestNormalize(), AllowTestSet(), AllowTestXSDToLogical()
property CipherDefault as %String;
Default Ciphersuites value
Property methods: CipherDefaultDisplayToLogical(), CipherDefaultGet(), CipherDefaultIsValid(), CipherDefaultLogicalToDisplay(), CipherDefaultLogicalToOdbc(), CipherDefaultNormalize(), CipherDefaultSet()
property IsEditForm as %Boolean [ InitialExpression = 1 ];
Inherited description: If set to 1 then the generic Save and Cancel button will be shown on the ribbon bar.
Property methods: IsEditFormDisplayToLogical(), IsEditFormGet(), IsEditFormIsValid(), IsEditFormLogicalToDisplay(), IsEditFormLogicalToXSD(), IsEditFormNormalize(), IsEditFormSet(), IsEditFormXSDToLogical()
property Max as %String;
Keep TLSMinVersion
Property methods: MaxDisplayToLogical(), MaxGet(), MaxIsValid(), MaxLogicalToDisplay(), MaxLogicalToOdbc(), MaxNormalize(), MaxSet()
property Min as %String;
Keep TLSMinVersion
Property methods: MinDisplayToLogical(), MinGet(), MinIsValid(), MinLogicalToDisplay(), MinLogicalToOdbc(), MinNormalize(), MinSet()
property PID as %String (ZENURL = "PID");
ID for edit. Null if adding new configuration.
Property methods: PIDDisplayToLogical(), PIDGet(), PIDIsValid(), PIDLogicalToDisplay(), PIDLogicalToOdbc(), PIDNormalize(), PIDSet()
property isMirror as %ZEN.Datatype.boolean (ZENURL = "isMirror") [ InitialExpression = "0" ];
isMirror is 1 if this window is called from Mirroring Settings
Property methods: isMirrorDisplayToLogical(), isMirrorGet(), isMirrorIsValid(), isMirrorLogicalToDisplay(), isMirrorLogicalToOdbc(), isMirrorLogicalToXSD(), isMirrorNormalize(), isMirrorSet(), isMirrorXSDToLogical()
property isNew as %ZEN.Datatype.boolean (ZENURL = "isNew") [ InitialExpression = "0" ];
Property methods: isNewDisplayToLogical(), isNewGet(), isNewIsValid(), isNewLogicalToDisplay(), isNewLogicalToOdbc(), isNewLogicalToXSD(), isNewNormalize(), isNewSet(), isNewXSDToLogical()
property pwModified as %ZEN.Datatype.boolean [ InitialExpression = "0" ];
Indicate if password is modified. If pwModified is 0 then at save time we won't save password.
Property methods: pwModifiedDisplayToLogical(), pwModifiedGet(), pwModifiedIsValid(), pwModifiedLogicalToDisplay(), pwModifiedLogicalToOdbc(), pwModifiedLogicalToXSD(), pwModifiedNormalize(), pwModifiedSet(), pwModifiedXSDToLogical()


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
Inherited description: Get the (localized) name of the page. This should be implemented in a subclass.
method LoadData(PID As %String) as %Status
Used when Editing an existing SSL/TLS configuration. Load previously defined values into fields.
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
Inherited description: Get information to display in the ribbon bar.
classmethod SaveData(PID, isTest, Name, Description, Enabled, Type, VerifyPeer, CAFile, CRLFile, CertificateFile, PrivateKeyFile, PrivateKeyType, PrivateKeyPassword, CipherList, Ciphersuites, TLSMinVersion, TLSMaxVersion, TestHost, TestPort, pwModified, PWOptions, OCSP, OCSPIssuer, OCSPResp, OCSPTimeout, DHBits) as %ZEN.proxyObject [ ZenMethod ]
Save general association data to server Test can only be done for client, not server.
clientmethod 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.
clientmethod changePW() [ Language = javascript ]
User changed password. Update flag.
clientmethod changePeer() [ Language = javascript ]
User changed Peer certificate verification level. If this is Type Server, and the Peer level is None then disable CAFile field. OW enable.
clientmethod changeType() [ Language = javascript ]
User changed Type. Show/hide client/server credentials related fields.
clientmethod changeVersion(MinVersion) [ Language = javascript ]
Change Min or Max Version
clientmethod changedCAFile() [ Language = javascript ]
User changed CAFile. If not null, enable CRL file. OW, disable
clientmethod changedFile() [ Language = javascript ]
User changed CertificateFile. If not null, enable Private password fields. OW, disable
clientmethod doFinish() [ Language = javascript ]
End Add/Edit and return to list page. If this page is called from Mirror then close window.
clientmethod doSave(isTest) [ Language = javascript ]
Get user input and send to server to save settings. If isTest is 1, user clicked the Test button. Then after saving, we'll do a TestConnection.
clientmethod getPageTitle() as %String [ Language = javascript ]
Get the title string to add to the locator row.
clientmethod getVersion(value) [ Language = javascript ]
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 ]
Set focus to the Name field.
clientmethod testButtons() [ Language = javascript ]
-1 = Both disabled; 0 = Test disabled; -10 = Test hidden; 1 = Test enabled
clientmethod toggleOCSP() [ Language = javascript ]
User changed OCSP option.
clientmethod togglePW() [ Language = javascript ]
User changed PWOptions option. If they want to enter new password, show password fields. Otherwise hide them.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab