Schedule operations

This category contains operations allowing a user to control the bot’s schedules. Deployed schedules and events are managed by the bot and synchronized with third-party calendars, for example Microsoft Office 365, when they are connected

Connect schedule

Creates and deploys a new schedule to the bot scheduler. This operation has the following properties.

Property name	Type	Description
Description	String	Displayed name of the operation. This property is only used in the HMI and has no effect at run-time.
Schedule name	String	Unique name of the schedule to deploy. This property supports usage of internal bot variables.
Overwrite file	Boolean	If a schedule with the same name already exists, this parameter specifies the action. True to dismiss the existing schedule before deploying a new one. False to leave the existing Schedule and do nothing.

Disconnect schedule

Dismiss the Schedule with the given name from the bot scheduler. This operation has the following properties.

Property name	Type	Description
Description	String	Displayed name of the operation. This property is only used in the HMI and has no effect at run-time.
Schedule name	String	Unique name of the schedule to dismiss. This property supports usage of internal bot variables.

Deploy event

Deploy an event to the given Schedule. This operation has large number of properties displayed in a number of tabs in the configuration dialog.

In the General tab.

Property name	Type	Description
Schedule name	String	Unique name of the event to deploy. This property supports usage of internal bot variables.
Name	String	A unique identifier of the event. If the field is empty the identifier will be generated automatically. Otherwise, if the event with the same name exists, it will be replaced.
Summary	String	Summary of the event. This property supports the usage of internal bot variables.
Location	String	This property is not related to geolocation zones. This property supports the usage of internal bot variables.
Description	String	Description of the event. This property supports the usage of internal bot variables.
Status bit variable	String	The name of a remote but variable. The bit will be set to 1 when the event is started and 0 when it is stopped. If at startup, the event was already started (the start date is passed) and not yet finished (the end date is later in future), the variable will still be set to 1.

In the Entry Action tab.

Property name	Type	Description
Call procedure when event is triggered	Boolean	Specifies whether to deploy a smart bot procedure when the Event starts.
Chat name	String	Name of the chat in which the smart bot will be added.
Branch	String	Branch name applied to all SCADA variables in bot’s operation and conditions. This property supports usage of internal bot variables.
Bot path	String	Path to the Smart Bot blueprint file to be executed. This property supports usage of internal bot variables. The specified path is relative to the following directory: <projectFolder>\MsgData\Bots.
Parameters list	Set	List of internal variables and corresponding values that will be predefined in the executed Smart Bot. Both variable name and value properties support usage of internal bot variables.
At the end of the event	Enum	Specifies an action to perform when event is finished or removed. The following values are available. Do nothing. Pause the procedure. Dismiss the procedure.

In the Exit Action tab.

Property name	Type	Description
Call procedure when event is finished	Boolean	Specifies whether to deploy a smart bot procedure when the Event starts.
Chat name	String	Name of the chat in which the smart bot will be added.
Branch	String	Branch name applied to all SCADA variables in bot’s operation and conditions. This property supports usage of internal bot variables.
Bot path	String	Path to the Smart Bot blueprint file to be executed. This property supports usage of internal bot variables. The specified path is relative to the following directory: <projectFolder>\MsgData\Bots.
Parameters list	Set	List of internal variables and corresponding values that will be predefined in the executed Smart Bot. Both variable name and value properties support usage of internal bot variables.

In the Chat tab.

Property name	Type	Description
Create or modify chat if necessary	Boolean	Specifies whether the chat with the given name should be created / modified or not. When the event starts, the bot searches for the chat with the given name. If True and the chat was not found, a new chat will be created. If True and the chat was found, it will be modified. If False and entry or exit actions are specified, the corresponding SmartBot procedures will still be invited to the chat.
Chat name	String	Name of the Chat in which the Entry or Exit Smart Bots procedures will be added. Use combo box to select the existing chats. This property supports usage of internal bot variables.
Associate Chat to a zone	String	Name of the zone associated to the given chat. This property is used only if the chat is created or modified. This property supports usage of internal bot variables.
Chat color	String	HEX code of the color to apply. This property is used only if the chat is created or modified. This property supports usage of internal bot variables.
Attendees Set	List of event attendees	If the existing Chat is selected, this list is pre-filled with all the chat users. Both the user name and email properties support usage of internal bot variables.

In the Trigger tab.

Property name	Type	Description
Trigger event	Enum	Specifies triggers starting and finishing the event. The following values are available. Once deployed – event is started as soon as it is deployed. Event is finished after the given duration. At the given date and time – event is started at the given date and time. Event is finished after the given duration. During specified period – event is started and finished at the given date and time.
Start date	String	Date and time when the event has to be started. This property supports usage of internal bot variables. This property supports the local date and time format defined by the selected culture in the bot manager preferences. This property is only available for “At the given date and time” trigger.
End date	String	Date and Time when the event has to be finished. This property supports usage of internal bot variables. This property supports the local date and time format defined by the selected culture in the bot manager preferences. This property is only available for “During specified period” trigger.
Duration	String	Duration of the event. Text near the value is reformatted automatically after validating the input. This property supports usage of internal bot variables. This property is only available for “Once deployed” and “At the given date and time” triggers.
Frequency	Enum	Specifies how often the recurrent event should occur. The following values are available. One time – for non-recurrent events Secondly Minutely Hourly Daily Weekly Monthly Yearly
Interval	Int	Specifies how often the recurrent event should occur. E.g. if the Frequency is set to “Secondly” and Interval is 5, then the event will occur every 5 seconds. This property is used only for recurrent events. This property supports usage of internal bot variables.
End date	String	Specifies when to finish the event or when to stop the event’s recurrence. This property is used only for recurrent events or events with the “During specified period” trigger. This property supports the local date and time format defined by the selected culture in the bot manager preferences. This property supports usage of internal bot variables.
Recur on	Set	Specifies days of week on which the Event should occur. This property is used only for “Weekly” event frequency.

Dismiss event

Dismiss event from the schedule with the given name. This operation has the following properties.

Property name	Type	Description
Description	String	Displayed name of the operation. This property is only used in the HMI and has no effect at run-time.
Schedule name	String	Unique name of the schedule with the event to dismiss. This property supports usage of internal bot variables.
Name	String	Unique name of the event to dismiss.

Find event

Applies the specified filter on the list of events and saves the selected event object in the bot agent’s memory. This operation has the following properties.

Property name	Type	Description
Description	String	Displayed name of the operation. This property is only used in the HMI and has no effect at run-time.
Key	String	Unique reference to the found event object in memory. This property supports usage of internal bot variables.
Scope	Enum	Accessibility scope of event object in memory specified by the “Key” reference. The following values are available. Private – value is available only for the current bot. Internal – value is available for the current thread, i.e. for parent bots, for the current bot and for all children executed bots. Shared – value is available for all bots.
Index	Integer	1-based index of the user in the list of selected events, i.e. corresponding to the specified filters. This property supports usage of internal bot variables.
Schedule names	String	Names of the deployed schedules, in which the event should be searched. Multiple ranges are separated with commas. This property supports wildcard symbols. “?” is a replacement for any single character. “*” is a replacement for any amount of characters. This property supports usage of internal bot variables.
Filter by attendees	String	Selects only events with the specified attendees. If the field is empty, corresponding filter is not applied.
Filter by name	String	Filter events by the unique name of the event.
Filter by summary	Function	A function that will be applied to compare the actual event summary and the value of the summary property. The following functions are available. Any value – any text is accepted. Equals – the exact text matching is required. Equals to any of the following strings – the exact text matching is required. Use one string per line to separate options. Contains – the summary must contain the specified value. Contains any of the following strings – the summary must contain any of the specified values. Use one string per line to separate values. Starts with – the summary must start with the specified value. Starts with any of the following strings – the summary must start with any of the specified values. Use one string per line to separate values. Ends with – the summary must end with the specified value. Ends with any of the following strings – the summary must end with any of the specified values. Use one string per line to separate values. Not equals – the summary must not match the specified value. Not contains – the summary must not contain the specified value. Not starts with – the summary must not start with the specified value. Not ends with – the summary must not end with the specified value. Match regular expression – the summary must match the specified regular expression. See this Microsoft article about the Regex Class for further details.
Summary	String	Text or Regular expression verified using the “Filter by summary” function. This property supports usage of internal bot variables.
Filter by location	Function	A function that will be applied to compare the actual event location and the value of the location property. The following functions are available. Any value – any text is accepted. Equals – the exact text matching is required. Equals to any of the following strings – the exact text matching is required. Use one string per line to separate options. Contains – the location must contain the specified value. Contains any of the following strings – the location must contain any of the specified values. Use one string per line to separate values. Starts with – the location must start with the specified value. Starts with any of the following strings – the location must start with any of the specified values. Use one string per line to separate values. Ends with – the location must end with the specified value. Ends with any of the following strings – the location must end with any of the specified values. Use one string per line to separate values. Not equals – the location must not match the specified value. Not contains – the location must not contain the specified value. Not starts with – the location must not start with the specified value. Not ends with – the location must not end with the specified value. Match regular expression – the location must match the specified regular expression. See this Microsoft article about the Regex Class for further details.
Location	String	Text or Regular expression verified using the “Filter by location” function. This property supports usage of internal bot variables.
Filter events creating a chat	Enum	Filter events creating or modifying a chat.
Filter by chat name	Function	A function that will be applied to compare the actual event chat and the value of the Chat name property. The following functions are available. Any value – any text is accepted. Equals – the exact text matching is required. Equals to any of the following strings – the exact text matching is required. Use one string per line to separate options. Contains – the chat name must contain the specified value. Contains any of the following strings – the chat name must contain any of the specified values. Use one string per line to separate values. Starts with – the chat name must start with the specified value. Starts with any of the following strings – the chat must start with any of the specified values. Use one string per line to separate values. Ends with – the chat name must end with the specified value. Ends with any of the following strings – the chat name must end with any of the specified values. Use one string per line to separate values. Not equals – the chat name must not match the specified value. Not contains – the chat name must not contain the specified value. Not starts with – the chat name must not start with the specified value. Not ends with – the chat name must not end with the specified value. Match regular expression – the chat name must match the specified regular expression. See this Microsoft article about the Regex Class for further details.
Chat name	String	Text or Regular expression verified using the “Filter by chat name” function. This property supports usage of internal bot variables.
Filter events by entry procedure	Enum	Filter events having entry action specified.
Filter by entry bot name	Function	A function that will be applied to compare the actual event entry bot name and the value of the entry bot name property. The following functions are available. Any value – any text is accepted. Equals – the exact text matching is required. Equals to any of the following strings – the exact text matching is required. Use one string per line to separate options. Contains – the bot name must contain the specified value. Contains any of the following strings – the bot name must contain any of the specified values. Use one string per line to separate values. Starts with – the bot name string must start with the specified value. Starts with any of the following strings – the bot name must start with any of the specified values. Use one string per line to separate values. Ends with – the bot name must end with the specified value. Ends with any of the following strings – the bot name must end with any of the specified values. Use one string per line to separate values. Not equals – the bot name must not match the specified value. Not contains – the bot name must not contain the specified value. Not starts with – the bot name must not start with the specified value. Not ends with – the bot name must not end with the specified value. Match regular expression – the bot name must match the specified regular expression. See this Microsoft article about the Regex Class for further details.
Entry bot name	String	Text or Regular expression verified using the “Filter by Entry bot name” function. This property supports usage of internal bot variables.
Filter events by exit procedure	Enum	Filter events having exit action specified.
Filter by exit bot name	Function	A function that will be applied to compare the actual event exit bot name and the value of the exit bot name property. The following functions are available. Any value – any text is accepted. Equals – the exact text matching is required. Equals to any of the following strings – the exact text matching is required. Use one string per line to separate options. Contains – the bot name must contain the specified value. Contains any of the following strings – the bot name must contain any of the specified values. Use one string per line to separate values. Starts with – the bot name must start with the specified value. Starts with any of the following strings – the bot name must start with any of the specified values. Use one string per line to separate values. Ends with – the bot name must end with the specified value. Ends with any of the following strings – the bot name must end with any of the specified values. Use one string per line to separate values. Not equals – the bot name must not match the specified value. Not contains – the bot name must not contain the specified value. Not starts with – the bot name must not start with the specified value. Not ends with – the bot name must not end with the specified value. Match regular expression – the bot name must match the specified regular expression. See this Microsoft article about the Regex Class for further details.
Exit Bot name	String	Text or Regular expression verified using the “Filter by Exit bot name” function. This property supports usage of internal bot variables.
Start date	String	Beginning of the time period in which to search for an event. This property supports usage of internal bot variables. This property supports the local date and time format defined by the selected culture in the bot manager preferences.
End date	String	End of the time period in which to search for an event. This property supports usage of internal bot variables. This property supports the local date and time format defined by the selected culture in the bot manager preferences.

Find the right time for a user

Applies the specified filter on the list of users, searches a free time slot in the specified schedules for a first available user in the list and saves the selected schedule name, user name and selected date in bot agent’s memory. This operation has the following properties.

Property name	Type	Description
Description	String	Displayed name of the operation. This property is only used in the HMI and has no effect at run-time.
Key for result date	String	Unique reference to the value in memory. This property supports usage of internal bot variables. Date and time object for the selected time slot satisfying the given filter is written to the corresponding variable.
Key for result user	String	Unique reference to the value in memory. This property supports usage of internal bot variables. Available user for the selected time slot satisfying the given filter is written to the corresponding variable.
Key for result schedule	String	Unique reference to the value in memory. This property supports usage of internal bot variables. Schedule name for the selected time slot satisfying the given filter is written to the corresponding variable.
Scope	Enum	Accessibility scope of value in memory specified by the “Key for result date”, “Key for result user” and “Key for result schedule” references. The following values are available. Private – value is available only for the current bot. Internal – value is available for the current thread, i.e. for parent bots, for the current bot and for all children executed bots. Shared – value is available for all bots.
Index	Integer	1-based index of the time slot and a user in the list of selected options, i.e. corresponding to the specified filters. This property supports usage of internal bot variables.
Schedule names	String	Names of the deployed schedules, in which the events should be verified. Multiple ranges are separated with commas. This property supports Wildcard symbols. “?” is a replacement for any single character. “*” is a replacement for any amount of characters. This property supports usage of internal bot variables.
Users	String	Verifies only events with the specified attendees. Multiple user names are separated with commas. If the field is empty, corresponding filter is not applied. This property supports usage of internal bot variables.
Duration	String	Duration of the time slot to fit into the planning. Text near the value is reformatted automatically after validating the input. This property supports usage of internal bot variables.
Start date	String	Beginning of the time period in which to search for a free time slot. This property supports usage of internal bot variables. This property supports the local date and time format defined by the selected culture in the bot manager preferences.
End date	String	End of the time period in which to search for a free time slot. This property supports usage of internal bot variables. This property supports the local date and time format defined by the selected culture in the bot manager preferences.