Ens.Setting.Reporter

class Ens.Setting.Reporter extends %Library.RegisteredObject

This class is for InterSystems internal use.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter RESTVERSION = 1;
This is used to identify the External Registry Entry

Properties

property AllNamespaces as %Boolean [ InitialExpression = 0 ];
If AllNamespaces then SearchNamespaces array will be rebuilt for each search.
Property methods: AllNamespacesDisplayToLogical(), AllNamespacesGet(), AllNamespacesIsValid(), AllNamespacesLogicalToDisplay(), AllNamespacesNormalize(), AllNamespacesSet()
property CallonFinishSave as %Boolean [ InitialExpression = 1 ];
Allows control of calling onFinishSave of the Setting Report class after saving saving search results
Property methods: CallonFinishSaveDisplayToLogical(), CallonFinishSaveGet(), CallonFinishSaveIsValid(), CallonFinishSaveLogicalToDisplay(), CallonFinishSaveNormalize(), CallonFinishSaveSet()
property CreateDocDBAndApplication as %Boolean [ InitialExpression = 1 ];
If the Document database for the Setting Report does not exist when saving create the document database and application
Property methods: CreateDocDBAndApplicationDisplayToLogical(), CreateDocDBAndApplicationGet(), CreateDocDBAndApplicationIsValid(), CreateDocDBAndApplicationLogicalToDisplay(), CreateDocDBAndApplicationNormalize(), CreateDocDBAndApplicationSet()
property ExternalClientRESTPath as %String;
Override path for REST call to External client. Default is first to use the Client's RESTPath value and if that is empty string use /api/docdb/v1//find/
Property methods: ExternalClientRESTPathDisplayToLogical(), ExternalClientRESTPathGet(), ExternalClientRESTPathIsValid(), ExternalClientRESTPathLogicalToDisplay(), ExternalClientRESTPathLogicalToOdbc(), ExternalClientRESTPathNormalize(), ExternalClientRESTPathSet()
property ExternalClientRegistryID as %String (MAXLEN = 254);
At the start of a search of ExternalClients if this is set then search is limited to this client whether or not it has property RESTClient of true. The Client is the Registry ID
Property methods: ExternalClientRegistryIDDisplayToLogical(), ExternalClientRegistryIDGet(), ExternalClientRegistryIDIsValid(), ExternalClientRegistryIDLogicalToDisplay(), ExternalClientRegistryIDLogicalToOdbc(), ExternalClientRegistryIDNormalize(), ExternalClientRegistryIDSet()
property ExternalResultsAsJSON as %String [ MultiDimensional ];
%Dynamic array of %Doc objects subscripted by External Registry ID if retrieved from external system
Property methods: ExternalResultsAsJSONDisplayToLogical(), ExternalResultsAsJSONGet(), ExternalResultsAsJSONIsValid(), ExternalResultsAsJSONLogicalToDisplay(), ExternalResultsAsJSONLogicalToOdbc(), ExternalResultsAsJSONNormalize(), ExternalResultsAsJSONSet()
property IncludeExternalClients as %Boolean [ InitialExpression = 0 ];
Whether to include External Clients in search
Property methods: IncludeExternalClientsDisplayToLogical(), IncludeExternalClientsGet(), IncludeExternalClientsIsValid(), IncludeExternalClientsLogicalToDisplay(), IncludeExternalClientsNormalize(), IncludeExternalClientsSet()
property LocalResults as %String [ MultiDimensional ];
Array of local instance results subscripted by Namespace
Property methods: LocalResultsAsJSONDisplayToLogical(), LocalResultsAsJSONGet(), LocalResultsAsJSONIsValid(), LocalResultsAsJSONLogicalToDisplay(), LocalResultsAsJSONLogicalToOdbc(), LocalResultsAsJSONNormalize(), LocalResultsAsJSONSet(), LocalResultsDisplayToLogical(), LocalResultsGet(), LocalResultsIsValid(), LocalResultsLogicalToDisplay(), LocalResultsLogicalToOdbc(), LocalResultsNormalize(), LocalResultsSet()
property LocalResultsAsJSON as %String [ MultiDimensional ];
Array of local instance results as %DynamicArray objects subscripted by Namespace
Property methods: LocalResultsAsJSONDisplayToLogical(), LocalResultsAsJSONGet(), LocalResultsAsJSONIsValid(), LocalResultsAsJSONLogicalToDisplay(), LocalResultsAsJSONLogicalToOdbc(), LocalResultsAsJSONNormalize(), LocalResultsAsJSONSet()
property LogExternalCallErrors as %Boolean [ InitialExpression = 0 ];
If this is true then Event Log Warnings will be used to report REST Call errors
Property methods: LogExternalCallErrorsDisplayToLogical(), LogExternalCallErrorsGet(), LogExternalCallErrorsIsValid(), LogExternalCallErrorsLogicalToDisplay(), LogExternalCallErrorsNormalize(), LogExternalCallErrorsSet()
property RemoteTimeout as %Integer [ InitialExpression = 5 ];
Timeout used REST connect to External Clients
Property methods: RemoteTimeoutDisplayToLogical(), RemoteTimeoutGet(), RemoteTimeoutIsValid(), RemoteTimeoutLogicalToDisplay(), RemoteTimeoutNormalize(), RemoteTimeoutSet()
property RemoveLocalResultsAfterCopyToJSON as %Boolean [ InitialExpression = 0 ];
If StoreLocalResultsAsJSON is true then this property allows for removing contents of LocalResults
Property methods: RemoveLocalResultsAfterCopyToJSONDisplayToLogical(), RemoveLocalResultsAfterCopyToJSONGet(), RemoveLocalResultsAfterCopyToJSONIsValid(), RemoveLocalResultsAfterCopyToJSONLogicalToDisplay(), RemoveLocalResultsAfterCopyToJSONNormalize(), RemoveLocalResultsAfterCopyToJSONSet()
property SearchNamespaces as %String [ MultiDimensional ];
Namespaces on this instance to search Subscripted by Namespace. Data is Production to search. If Data empty then the active production for the namespace is used.
Property methods: SearchNamespacesDisplayToLogical(), SearchNamespacesGet(), SearchNamespacesIsValid(), SearchNamespacesLogicalToDisplay(), SearchNamespacesLogicalToOdbc(), SearchNamespacesNormalize(), SearchNamespacesSet()
property SettingNamePattern as %String;
This can be used to override the SettingNamePattern parameter from report class.
Property methods: SettingNamePatternDisplayToLogical(), SettingNamePatternGet(), SettingNamePatternIsValid(), SettingNamePatternLogicalToDisplay(), SettingNamePatternLogicalToOdbc(), SettingNamePatternNormalize(), SettingNamePatternSet()
property SettingReportClass as %String (MAXLEN = 254) [ InitialExpression = "Ens.Setting.Report.Port" ];
required to extend Ens.Setting.Report.base
Property methods: SettingReportClassDisplayToLogical(), SettingReportClassGet(), SettingReportClassIsValid(), SettingReportClassLogicalToDisplay(), SettingReportClassLogicalToOdbc(), SettingReportClassNormalize(), SettingReportClassSet()
property SpecificNamespace as %String (MAXLEN = 255) [ InitialExpression = $Namespace ];
If not searching all namespaces and SearchNamespaces not defined specify one namespace to search - or populate ..SearchNamespaces() array
Property methods: SpecificNamespaceDisplayToLogical(), SpecificNamespaceGet(), SpecificNamespaceIsValid(), SpecificNamespaceLogicalToDisplay(), SpecificNamespaceLogicalToOdbc(), SpecificNamespaceNormalize(), SpecificNamespaceSet()
property StoreLocalResultsAsJSON as %Boolean [ InitialExpression = 0 ];
After searching convert LocalResults to an array of %DynamicArray objects in LocalResultsAsJSON
Property methods: StoreLocalResultsAsJSONDisplayToLogical(), StoreLocalResultsAsJSONGet(), StoreLocalResultsAsJSONIsValid(), StoreLocalResultsAsJSONLogicalToDisplay(), StoreLocalResultsAsJSONNormalize(), StoreLocalResultsAsJSONSet()

Methods

private method %OnClose() as %Status [ Language = objectscript ]
Clean up code to help mechanism for preventing more than one running search or save
method AllowOthers() [ Language = objectscript ]
method GetPersistentReportNamespace(Output pSC As %Status = $$$OK, pSetIfHaveData As %Boolean = 0) as %String [ Language = objectscript ]
method GetReportAppURL(Output pWebServer As %String = "", Output pWebPort As %String = "", pWebPath As %String = "", pUseSSL As %Boolean = "") as %Status [ Language = objectscript ]
method SaveSearchResults(pIncludeExternalResults As %Boolean = 1, pKeepExclusive As %Boolean = 0) as %Status [ Language = objectscript ]
Save contents of LocalResults array and External Results if specified to persistent table. pKeepExclusive flag will keep exclusive lock at end of save if required. Default is not to.
method SearchSettings(pKeepExclusive As %Boolean = 0) as %Status [ Language = objectscript ]
Search the specified namespaces and clients examining active/registered production
method SetPersistentReportNamespace(pNamespace As %String = "", pChangeNamespace As %Boolean = 0) as %Status [ Language = objectscript ]
method SetReportAppURL(pWebServer As %String, pWebPort As %String, pWebPath As %String, pUseSSL As %Boolean) as %Status [ Language = objectscript ]
method UseExclusively() as %Status [ Language = objectscript ]
method configureSenderFromAttributes(pSender As Ens.Host, pExternalRegistryService As Ens.ServiceRegistry.External.Service) [ Language = objectscript ]

Inherited Members

Inherited Methods (Including Private)

Feedback