add_diary()
Add text to the diary of a PATROL event.
Syntax
add_diary(<eventID>,<text>,\[<user_name>\])
Parameter
Parameter | Definition |
|---|---|
eventID | unique number returned by event_trigger() or event_trigger2() |
text | text that you want to add to the diary of a PATROL event |
user_name | optional parameter that you can use to add a user ID to the event diary |
Description
The add_diary() function enters text in the diary of a PATROL event. It writes information to the event diary in the following format:
{{<user_name> <date_and_time> <text>}}
After using this function, you can verify the event diary information by viewing the event in the PATROL Event Manager.
Example
This script demonstrates the add_diary() function.
save_event_ID = event_trigger("STD", "41", "INFORMATION", "3", "testing add diary");
add_diary(save_event_ID,"This comment should appear in the event diary.", "jsmith");
add_diary(save_event_ID,"This comment should appear in the event diary.", "jsmith");
The preceding command should put the following information in the event diary:
jsmith Mon Jan 08 15:02:38 This comment should appear in the event diary.
Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*