Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

CSPX.EnsConfigProperty

class CSPX.EnsConfigProperty extends %CSP.Page

Property page for SVG-based config page.

Method Inventory

Parameters

parameter CONTENTTYPE = text/html;
Inherited description: Specifies the default content type for the page. This can be overriden using the <CSP:CONTENT TYPE=> tag, or by setting the %response.ContentType property in the OnPreHTTP() method. The default value if this parameter is not set is text/html.
parameter DOMAIN = Ensemble;
Use our own domain for localization
parameter LongTipWidth = 600;
parameter MAXLEN4TEXTAREA = 1024;
parameter MaxTipHeight = 800;
parameter ShortTipHeight = 130;
parameter ShortTipWidth = 400;

Methods

classmethod CheckSpec(name, target) as %Boolean
Check each specific setting item. Return 1 if it is not Default. Return 0 if it is Default. target is either "Host" or "Adapter".
classmethod GetClassDescription(pClass As %String, pDefault As %String = "N/A") as %String
Find the description for a given class.
pClass is a complete class name (with package).
Returns the short form (first line) of class description or pDefault if there is no description.
classmethod GetDuplicateItems(production As Ens.Config.Production, pItem As Ens.Config.Item, Output dlist) as %Boolean
See if there are multiple copies with the same name as the given item within the production; return a list if there are.
classmethod OnPage() as %Status
Inherited description: Event handler for PAGE event: this is invoked in order to generate the content of a csp page.
classmethod OnPageBODY() as %Boolean
classmethod OnPageCSPROOT() as %Boolean
classmethod OnPageHEAD() as %Boolean
Must build this method to hold the HyperEventCall() for updating %session.Data("ItemSpecific") when field is modified. YSD2170
classmethod OnPageHTML() as %Boolean
classmethod OnPreHTTP() as %Boolean
Inherited description: Event handler for PreHTTP event: this is invoked before the HTTP headers for a CSP page have been sent. All changes to the %CSP.Response class, such as adding cookies, HTTP headers, setting the content type etc. must be made from within the OnPreHTTP() method. Also changes to the state of the CSP application such as changing %session.EndSession or %session.AppTimeout must be made within the OnPreHTTP() method. It is prefered that changes to %session.Preserve are also made in the OnPreHTTP() method as this is more efficient, although it is supported in any section of the page. Return 0 to prevent OnPage() from being called.
classmethod SaveSesNode(thisId As %String, newvalue As %String)
Save temp node to indicate that the field has been updated with new value
classmethod ShowAddHostForm(production As Ens.Config.Production, item As Ens.Config.Item, pHostType As %String, pHostName As %String)
Add new host wizard page
classmethod ShowItemSheet(production As Ens.Config.Production, item As Ens.Config.Item)
Display a form for the given item
classmethod ShowProductionSheet(production As Ens.Config.Production)
Display a form for the production
classmethod makeTooltipString(description As %String) as %String
takes the tooltip string; prefixes the "click for popup" localized string to it; and (maybe) truncates it; then returns the result

Inherited Members

Inherited Methods

FeedbackOpens in a new tab