This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

%CSP.UI.Portal.Config.ValueEditor

class %CSP.UI.Portal.Config.ValueEditor extends %CSP.UI.Portal.Template

This value editor is specific for the Configure individual Startup/Memory/Compatibility settings

Property Inventory

Method Inventory

Parameters

parameter AUTONS = 0;
Do not switch namespace for this page: it needs to stay in %SYS
parameter CSPURL = /csp/sys/mgr/%CSP.UI.Portal.Config.ValueEditor.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 EMSSERVICE = Config;
parameter HELPADDRESS = Home,Configuration;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter RECENT = 0;
Inherited description: If true, register visits to this page in the recent list.
parameter RESOURCE = %Admin_Manage;
Security requirement
parameter RESTARTREQUIREDLIST = NullSubscripts;
A CSL listing those properties that should get a restart required warning even if the parent class does not implement the NoRestartOnActivate method.

Properties

property ClassName as %ZEN.Datatype.string (ZENURL = "ClassName");
Name of the current configuration class
Property methods: ClassNameDisplayToLogical(), ClassNameGet(), ClassNameIsValid(), ClassNameLogicalToDisplay(), ClassNameLogicalToOdbc(), ClassNameNormalize(), ClassNameSet()
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 IsRequired as %Boolean [ InitialExpression = 0 ];
Property methods: IsRequiredDisplayToLogical(), IsRequiredGet(), IsRequiredIsValid(), IsRequiredLogicalToDisplay(), IsRequiredLogicalToXSD(), IsRequiredNormalize(), IsRequiredSet(), IsRequiredXSDToLogical()
property PID as %ZEN.Datatype.string (ZENURL = "PID");
Inherited description: ID for edit.
Property methods: PIDDisplayToLogical(), PIDGet(), PIDIsValid(), PIDLogicalToDisplay(), PIDLogicalToOdbc(), PIDNormalize(), PIDSet()
property Subject as %String (ZENURL = "Subject");
Subject name for the setting page.
Property methods: SubjectDisplayToLogical(), SubjectGet(), SubjectIsValid(), SubjectLogicalToDisplay(), SubjectLogicalToOdbc(), SubjectNormalize(), SubjectSet()
property pType as %ZEN.Datatype.string;
Property methods: pTypeDisplayToLogical(), pTypeGet(), pTypeIsValid(), pTypeLogicalToDisplay(), pTypeLogicalToOdbc(), pTypeNormalize(), pTypeSet()

Methods

method %GetDescHTML(pSeed As %String) as %Status
Provide contents of description component only if locale is English.
Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
Subclasses may override.
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 DrawAfterCreatePage() as %Status
classmethod SaveData(ConfigClass As %String, Properties As %String, Values As %String, SelectedType As %String) as %ZEN.proxyObject [ ZenMethod ]
Call server save method. Values passed in is delimited by "|" if there are more than one.
clientmethod doSave() [ Language = javascript ]
Check if field is required and make value is not null

Inherited Members

Inherited Properties

Inherited Methods

Feedback