This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRISOpens in a new window, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions pageOpens in a new window (login required).

Caché & Ensemble 2018.1.5Opens in a new window > Class Reference > %SYS namespace > %SYS.Task.Config

%SYS.Task.Config

persistent class %SYS.Task.Config extends %Library.Persistent

SQL Table Name: %SYS_Task.Config

Configuration information for the Task Manager This table contains Parameter/Value pairs for the Configuration information

Users may access the Email parameters/values using the EmailSet() or EmailGet() methods.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter DOMAIN = %Utility;

Properties (Including Private)

property Data as %String (MAXLEN = 32000);
Parameter Value
Property methods: DataDisplayToLogical(), DataGet(), DataGetStored(), DataIsValid(), DataLogicalToDisplay(), DataLogicalToOdbc(), DataNormalize(), DataSet()
property ParamName as %String (MAXLEN = 1024);
Parameter Name
Property methods: ParamNameDisplayToLogical(), ParamNameGet(), ParamNameGetStored(), ParamNameIndexCheck(), ParamNameIndexCheckUnique(), ParamNameIndexDelete(), ParamNameIndexExists(), ParamNameIndexOpen(), ParamNameIndexSQLCheckUnique(), ParamNameIndexSQLExists(), ParamNameIndexSQLFindPKeyByConstraint(), ParamNameIndexSQLFindRowIDByConstraint(), ParamNameIsValid(), ParamNameLogicalToDisplay(), ParamNameLogicalToOdbc(), ParamNameNormalize(), ParamNameSet()

Methods (Including Private)

classmethod EmailGet(Parameter As %String, ByRef Value As %String) as %Status
Retrieve the email settings for the Task Manager. Available Parameters are:

"Server","Port","ReplyTo","Sender","TimeZone","AuthUser","AuthPassword", "SubjectSuccess","SubjectFailure","MessageSuccess","MessageFailure","SSLConfiguration","UseSTARTTLS"
classmethod EmailSet(Parameter As %String, Value As %String) as %Status
Set the email parameters for the Task Manager Available Parameters are:

"Server","Port","ReplyTo","Sender","TimeZone","AuthUser","AuthPassword", "SubjectSuccess","SubjectFailure","MessageSuccess","MessageFailure","SSLConfiguration","UseSTARTTLS"
classmethod SubstitutionFields() as %String
Available fields for substitution into mail message subject / body
classmethod SubstitutionsValid(text, ByRef bad) as %Boolean
Validate substitution fields in a message. 'bad' returns a specific problem field.
classmethod genericMailMessage() as %String
Return the generic Task Manager email message text
classmethod genericMailSubject() as %String
Return the generic Task Manager email subject text

Indexes

index (ParamNameIndex on ParamName) [Unique];
Index methods: ParamNameIndexCheck(), ParamNameIndexCheckUnique(), ParamNameIndexDelete(), ParamNameIndexExists(), ParamNameIndexOpen(), ParamNameIndexSQLCheckUnique(), ParamNameIndexSQLExists(), ParamNameIndexSQLFindPKeyByConstraint(), ParamNameIndexSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods (Including Private)

Storage

Storage Model: CacheStorage (%SYS.Task.Config)

^|"^^"_$ZU(12)|SYS("Task","ConfigD")(ID)
=
%%CLASSNAME
Data
ParamName

Subclasses

FeedbackOpens in a new window