Skip to main content

%SYS.Task.Config

Class %SYS.Task.Config Extends %Persistent [ System = 4 ]

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.

Parameters​

DOMAIN​

Parameter DOMAIN = "%Utility";

Properties​

ParamName​

Property ParamName As %String(MAXLEN = 1024);

Parameter Name

Data​

Property Data As %String(MAXLEN = 32000);

Parameter Value

Methods​

GetData​

ClassMethod GetData(ParamName As %String) As %String [ Internal ]

Return data associated with Parameter

GetObject​

ClassMethod GetObject(ParamName As %String) As %String [ Internal ]

Return object associated with Parameter If the row is not found return a New object with the parameter Name set

UpdateData​

ClassMethod UpdateData(ParamName As %String, Data As %String, Message As %String) As %Status [ Internal ]

Update the data associated with Parameter

Initialize​

ClassMethod Initialize() As %Status [ Internal ]

Used for New installations or Upgrade to 1.3

AuthPassGet​

ClassMethod AuthPassGet() As %String [ Internal ]

Used to return the encoded Mail Authentication Password

AuthPassSet​

ClassMethod AuthPassSet(pwd As %String) As %String [ Internal ]

Used to update the encoded Mail Authentication Password

SubstitutionFields​

ClassMethod SubstitutionFields() As %String

Available fields for substitution into mail message subject / body

SubstitutionsValid​

ClassMethod SubstitutionsValid(text, ByRef bad) As %Boolean

Validate substitution fields in a message. 'bad' returns a specific problem field.

MakeSubstitutions​

ClassMethod MakeSubstitutions(ByRef text, ByRef sub) [ Internal ]

genericMailSubject​

ClassMethod genericMailSubject() As %String

Return the generic Task Manager email subject text

genericMailMessage​

ClassMethod genericMailMessage() As %String

Return the generic Task Manager email message text

EmailGet​

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"

EmailSet​

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"