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

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.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 8 1


Summary


Properties
%RunDate %RunTime iSettingReportClass
iiAllNamespaces iiiSpecificNamespace ivIncludeExternalClients
vSpecificExternalClientRegistryID viExternalClientRESTPath viiLogExternalCallErrors
viiiPostSaveProcessing

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
GetCollectionType GetPropertyName GetSettings GetTaskName
OnSubmit OnTask SetSettings


Parameters


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

Properties


• property iSettingReportClass as %String(DISPLAYLIST=",Port Settings",MAXLEN=255,VALUELIST=",Ens.Setting.Report.Port") [ InitialExpression = "Ens.Setting.Report.Port" ];
• property iiAllNamespaces as %Boolean [ InitialExpression = 1 ];
Search all productions in all namespaces in this instance Default is true
• property iiiSpecificNamespace as %String(MAXLEN=255);
If not AllNamespaces then limit to this namespace
• property ivIncludeExternalClients as %Boolean [ InitialExpression = 0 ];
If true look for enterprise clients defined in this namespace Default is off
• property vSpecificExternalClientRegistryID as %String(MAXLEN=254);
If this is set then search is limited to this client
• property viExternalClientRESTPath as %String;
Override path for REST call to Enterprise client. Default is /api/docdb/v1//find/
• property viiLogExternalCallErrors as %Boolean [ InitialExpression = 0 ];
Log REST call errors to Enterprise Clients Default is off
• property viiiPostSaveProcessing as %Boolean [ InitialExpression = 1 ];
Whether to call OnFinish() after saving results. Default is true and OnFinish() will be called after saving.

Methods


• method OnTask() as %Status
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.