Ens.Setting.Report.base

class Ens.Setting.Report.base extends %Library.RegisteredObject

This class is for InterSystems internal use.

Method Inventory (Including Private)

Parameters

parameter DocDBName;
The DocDB Name
parameter DocDBResource;
The resource to protect the DocDB.
parameter SettingNamePattern;
Regular expression to find particular setting names for one type of setting

Methods

classmethod ClearPersistentReportNamespace() as %Status [ Language = objectscript ]
This clears from the central location the name of the namespace where the data can be stored. It does not remove the actual data.
classmethod CreateDocDBAndApplication(pRecreate As %Boolean = 0) as %Status [ Language = objectscript ]
Class method to create or recreate DocDB application Uses the definition in XDATA DocDBDefinitions equal to parameter DocDBName
classmethod CreateDocDBApplication() as %Status [ Language = objectscript ]
Class method to create just DocDB application Uses the definition in XDATA DocDBDefinitions equal to parameter DocDBName
classmethod GetPersistentReportNamespace(Output pSC As %Status = $$$OK, pSetIfHaveData As %Boolean = 0) as %String [ Language = objectscript ]
This returns the namespace where the data can be stored. This is used to limit the saving to one namespace per instance. If pSetIfHaveData is 1 and the central namespace is not set but there are documents then register the central namespace and create the DocDB Application - this is to aid mirroring setup.
classmethod GetReportAppURL(Output pWebServer As %String = "", Output pWebPort As %String = "", pWebPath As %String = "", pUseSSL As %Boolean = "") as %Status [ Language = objectscript ]
Find the URL of the application external to the SMP
classmethod SetPersistentReportNamespace(ByRef pNamespace As %String = $Namespace, pChangeNamespace As %Boolean = 0) as %Status [ Language = objectscript ]
This sets in a central location the namespace where the data can be stored. This is used to limit the saving to one namespace per instance.
classmethod SetReportAppURL(pWebServer As %String, pWebPort As %String, pWebPath As %String, pUseSSL As %Boolean) as %Status [ Language = objectscript ]
This sets the URL details for the Setting Report Application
classmethod SystemMode() as %String [ Language = objectscript ]
Override in sub class if want a different value for 'mode'
classmethod onFinishSave(pReporter As Ens.Setting.Reporter = $$$NULLOREF) as %Status [ Language = objectscript ]
Optional Implement in sub class.

Inherited Members

Inherited Methods (Including Private)

Subclasses

Feedback