Class Reference
%SYS.Task.Config
Server:irisdocs2
Instance:IRISLATEST
User:UnknownUser
 
-
  [ENSLIB] >  [%SYS] >  [Task] >  [Config]
Private  Storage

persistent class %SYS.Task.Config extends %Persistent

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.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 2 13 1


Summary

Properties
Data ParamName

Methods
%AddToSaveSet %AddToSyncSet %BMEBuilt %CheckConstraints
%CheckConstraintsForExtent %ClassIsLatestVersion %ClassName %ComposeOid
%ConstructClone %Delete %DeleteExtent %DeleteId
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Exists
%ExistsId %Extends %GUID %GUIDSet
%GetLock %GetParameter %GetSwizzleObject %Id
%InsertBatch %IsA %IsModified %IsNull
%KillExtent %KillExtentData %LoadFromMemory %LockExtent
%LockId %New %NormalizeObject %ObjectIsNull
%ObjectModified %Oid %OnBeforeAddToSync %OnDetermineClass
%Open %OpenId %OriginalNamespace %PackageName
%PhysicalAddress %PurgeIndices %Reload %RemoveFromSaveSet
%ResolveConcurrencyConflict %RollBack %Save %SaveDirect
%SaveIndices %SerializeObject %SetModified %SortBegin
%SortEnd %SyncObjectIn %SyncTransport %UnlockExtent
%UnlockId %ValidateIndices %ValidateObject EmailGet
EmailSet SubstitutionFields SubstitutionsValid genericMailMessage
genericMailSubject

Subclasses
%SYSTEM.TaskConfig

Parameters

• parameter DOMAIN = "%Utility";

Properties

• property Data as %String(MAXLEN=32000);
Parameter Value
• property ParamName as %String(MAXLEN=1024);
Parameter Name

Methods

• 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

Indices

•index (ParamNameIndex on ParamName) [Unique];


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.