Home > Class Reference > ENSLIB namespace > Ens.Util.Tasks.UpdateSettingsReport

Ens.Util.Tasks.UpdateSettingsReport

class Ens.Util.Tasks.UpdateSettingsReport extends %SYS.Task.Definition

This task is used to update a settings report. For a given setting the task can be run in only one namespace.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter DOMAIN = Ensemble;
Default Localization Domain
parameter TaskName = Interoperability Productions Settings Report;
Inherited description: This defines the user-visible name of this task. It is defined in the subclasses.

Properties (Including Private)

property iSettingReportClass as %String (DISPLAYLIST = ",Port Settings", MAXLEN = 255, VALUELIST = ",Ens.Setting.Report.Port") [ InitialExpression = "Ens.Setting.Report.Port" ];
Property methods: iSettingReportClassDisplayToLogical(), iSettingReportClassGet(), iSettingReportClassIsValid(), iSettingReportClassLogicalToDisplay(), iSettingReportClassLogicalToOdbc(), iSettingReportClassNormalize(), iSettingReportClassSet()
property iiAllNamespaces as %Boolean [ InitialExpression = 1 ];
Search all productions in all namespaces in this instance Default is true
Property methods: iiAllNamespacesDisplayToLogical(), iiAllNamespacesGet(), iiAllNamespacesIsValid(), iiAllNamespacesLogicalToDisplay(), iiAllNamespacesNormalize(), iiAllNamespacesSet()
property iiiSpecificNamespace as %String (MAXLEN = 255);
If not AllNamespaces then limit to this namespace
Property methods: iiiSpecificNamespaceDisplayToLogical(), iiiSpecificNamespaceGet(), iiiSpecificNamespaceIsValid(), iiiSpecificNamespaceLogicalToDisplay(), iiiSpecificNamespaceLogicalToOdbc(), iiiSpecificNamespaceNormalize(), iiiSpecificNamespaceSet()
property ivIncludeExternalClients as %Boolean [ InitialExpression = 0 ];
If true look for enterprise clients defined in this namespace Default is off
Property methods: ivIncludeExternalClientsDisplayToLogical(), ivIncludeExternalClientsGet(), ivIncludeExternalClientsIsValid(), ivIncludeExternalClientsLogicalToDisplay(), ivIncludeExternalClientsNormalize(), ivIncludeExternalClientsSet()
property vSpecificExternalClientRegistryID as %String (MAXLEN = 254);
If this is set then search is limited to this client
Property methods: vSpecificExternalClientRegistryIDDisplayToLogical(), vSpecificExternalClientRegistryIDGet(), vSpecificExternalClientRegistryIDIsValid(), vSpecificExternalClientRegistryIDLogicalToDisplay(), vSpecificExternalClientRegistryIDLogicalToOdbc(), vSpecificExternalClientRegistryIDNormalize(), vSpecificExternalClientRegistryIDSet()
property viExternalClientRESTPath as %String;
Override path for REST call to Enterprise client. Default is /api/docdb/v1//find/
Property methods: viExternalClientRESTPathDisplayToLogical(), viExternalClientRESTPathGet(), viExternalClientRESTPathIsValid(), viExternalClientRESTPathLogicalToDisplay(), viExternalClientRESTPathLogicalToOdbc(), viExternalClientRESTPathNormalize(), viExternalClientRESTPathSet()
property viiLogExternalCallErrors as %Boolean [ InitialExpression = 0 ];
Log REST call errors to Enterprise Clients Default is off
Property methods: viiLogExternalCallErrorsDisplayToLogical(), viiLogExternalCallErrorsGet(), viiLogExternalCallErrorsIsValid(), viiLogExternalCallErrorsLogicalToDisplay(), viiLogExternalCallErrorsNormalize(), viiLogExternalCallErrorsSet()
property viiiPostSaveProcessing as %Boolean [ InitialExpression = 1 ];
Whether to call OnFinish() after saving results. Default is true and OnFinish() will be called after saving.
Property methods: viiiPostSaveProcessingDisplayToLogical(), viiiPostSaveProcessingGet(), viiiPostSaveProcessingIsValid(), viiiPostSaveProcessingLogicalToDisplay(), viiiPostSaveProcessingNormalize(), viiiPostSaveProcessingSet()

Methods (Including Private)

method OnTask() as %Status [ Language = objectscript ]
Inherited description: This method is responsible for executing the task.
At the scheduled time, the Task Manager creates an instance of this object, sets any property values using the stored "Settings" for the task, and then invokes this method to execute the task.
In order to execute a real task, override this method in a subclass.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)