RAD routine: message.fc

A RAD routine used to send messages under user control.

Search for	Example	Results
A single word	`cat`	Topics that contain the word "cat". You will also find its grammatical variations, such as "cats".
A phrase. You can specify that the search results contain a specific phrase.	`"cat food"` (quotation marks)	Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase.

Search for	Operator	Example
Two or more words in the same topic	`AND` `and` `+` (plus symbol) `&` (ampersand)	`cat AND dog` `"cat food"+milk` `"cat food"&"dog food"`
Either word in a topic	`OR` `or` `\|` (pipe)	`cat OR dog` `cat \| dog`
Topics that do not contain a specific word or phrase	`NOT` `not` `!` (exclamation point)	`NOT cat` `! dog`
Topics that contain one string and do not contain another	`^` (caret)	`cat ^ mouse`
A combination of search types	`( )` parentheses	`cat + (dog \| mouse)` `cat \| dog + (! mouse)`

Routine

message.fc

Parameters

The following parameters are valid for the message.fc routine:

Name	Data type	Required	Description
index	number	No	Select one of three message levels: `1` for information, this is the default. `2` for action. `3` for error. In Text mode, message levels may appear in different colors.
prompt	character	No	Enter a message class that matches one of the records in the msgclass table, such as problemclose. To send email messages, there must be a msgclass record with a type of email for the message class name specified. The default value is `msg`.
text	character	Yes	The text of the message can be a string or an array. For example, generate an array of the screen contents using the genout() function and then insert lines of text at the top of the array.
name	character	No	This value can contain either a list of operator names or a single name. For internal Service Manager messages, the names must be operator ID’s defined in the operator table. For email, the names can either be operator ID’s or contact names (contact.name) defined in the contacts table; an email address must be specified in the relevant table. The default is `operator()`.
string1	character	No	The message name parameter identifies the message. Use the name of the Service Manager application or application area that generates the message.
number1	number	No	The message number parameter identifies a message within the area specified by the string1 parameter.
query	character	No	The mail class parameter is used within Incident Management applications to identify the record number so that mail already sent can be selected and updated. It must contain the string pm.main and a Mail Target must be defined.
names,1	array (characters)	No	The mail target parameter must contain the incident record number.

Name

Data type

Required

Description

index

number

Select one of three message levels:

1 for information, this is the default.
2 for action.
3 for error.

In Text mode, message levels may appear in different colors.

prompt

character

Enter a message class that matches one of the records in the msgclass table, such as problemclose. To send email messages, there must be a msgclass record with a type of email for the message class name specified. The default value is msg.

text

character

Yes

The text of the message can be a string or an array. For example, generate an array of the screen contents using the genout() function and then insert lines of text at the top of the array.

name

character

This value can contain either a list of operator names or a single name. For internal Service Manager messages, the names must be operator ID’s defined in the operator table. For email, the names can either be operator ID’s or contact names (contact.name) defined in the contacts table; an email address must be specified in the relevant table. The default is operator().

string1

character

The message name parameter identifies the message. Use the name of the Service Manager application or application area that generates the message.

number1

number

The message number parameter identifies a message within the area specified by the string1 parameter.

query

character

The mail class parameter is used within Incident Management applications to identify the record number so that mail already sent can be selected and updated. It must contain the string pm.main and a Mail Target must be defined.

names,1

array

(characters)

The mail target parameter must contain the incident record number.