Elements of a message

Previous  Top  Next

A message contains a whole set of properties. It contains the main 3 properties described in the Introduction part (level, Mode and Lifetime) but also few more properties. Some of the properties can only be set within the Pigeon Admin console. The following table lists all properties. When a property cannot be set by a module, a default value is used as shown in the table:

Property	Description	Admin	Client	Generator
Title	Title given to the message. Only used by the Admin console when listing messages.	ü	See note 1	See note 1
Message's body	This is the text to be displayed on client's screen.	ü	ü	ü
Document link	You may link your message to any document which can be accessible and opened by the clients.	ü
Level	Can be Message, Warning, Alert or Alarm	ü	See note 2	ü
Mode	Acknowledgeable or continuous	ü	ü	ü
Lifetime	One Shot, Repeating or Once	ü	ü	ü
Enabled	Message is active or not.	ü	Yes	Yes
Receipt	You want to know who got the message	ü	Yes	Yes
Targetted groups	UserID, MachineName or GroupName	ü	ü	ü
Start Date	The date the message should start displaying	ü	Today	Today
Start Time	The time the message should start displaying	ü	Now	Now
Repeat every	Units of repeat (0-99)	ü	0	0
Repeat type	Type of repeats (minute, hour, day, week, month, year)	ü
Expiration Date	The date the message will become disabled	ü	See note 3	See note 3
Delete after expiration	To delete the message when the expiration date is reached.	ü	Yes	Yes

Notes :   1.   If title is not specified, it is extracted from the first 30 characters of the message's body.   2.   The client can not send an Alarm level.   3.   The expiration date depends on the lifetime:   · 1 week for a One shot to connected users   · 2 weeks for a Repeat at every logon   · 3 weeks for Once to every targetted users