RAD routine: marquee.publish

A RAD routine used to send a marquee message. This routine is always called from within marquee.send.

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

marquee.publish

Parameters

The following parameters are valid for the marquee.publish routine:

Name	Data type	Required	Description
name	character	Yes	The published variable used by the agent to search the database. Note The system automatically adds `$MARQUEE` to the beginning your variable name before publishing it.
text	character	No	A variable that contains the message to be published.
prompt	character	No	The display color for your marquee or the valid system number in the Color field. The default value is Red.
boolean1	Boolean	No	A logical field. Set the flag to `true` to add this message to the marquee table. The marquee agent then reads the record and publishes it. If the flag is set to `false`, the routine immediately publishes your message without adding it to the marquee table (recommended method).
cond.input	Boolean	No	A logical field. Set the flag to `true` to add the name to the database if that record does not exist.

Name

Data type

Required

Description

name

character

Yes

The published variable used by the agent to search the database.

Note The system automatically adds $MARQUEE to the beginning your variable name before publishing it.

text

character

A variable that contains the message to be published.

prompt

character

The display color for your marquee or the valid system number in the Color field. The default value is Red.

boolean1

Boolean

A logical field. Set the flag to true to add this message to the marquee table. The marquee agent then reads the record and publishes it. If the flag is set to false, the routine immediately publishes your message without adding it to the marquee table (recommended method).

cond.input

Boolean

A logical field. Set the flag to true to add the name to the database if that record does not exist.