Follow the guide below to create a bot from any report or widget.
The grid type of widget is the recommended widget type for creating a bot.
Prerequisites
- An email address - You need an email when sending alerts through email, chat, MS Teams, or Slack.
- The alert message - Prepare the alert message for the receiver.
- An escalation message, if an escalation step is needed.
1. Select a widget for bot creation
- Navigate to Widgets on the MSPbots app menu.
- Select the widget for which you need to create a bot.
- When the New Widget Builder appears, click More Options
.
- Select Create Bot.
Or
- Go to the Dashboard where the widget is located.
- Find the widget and hover to show the More Options
button.
- Click More Options
, then select Create Bot.
2. Create a bot
- When the Create a new bot window opens, enter a name in the Bot Name field.
- Next, identify the Role that will have access to the bot.
- (Optional) Add a Tag of the bot.
- (Optional) Add a clear Description of the bot.
- Then click the Confirm button. This action opens the Trigger screen.
The Trigger screen is also accessible from the Design tab.
3. Set up the bot trigger
- Proceed by selecting Widget as Data Source.
- Then select your Integration from the dropdown list.
The Integration dropdown list shows the available datasets or widgets connected to the selected integration. This field displays only the tenant integrations connected to MSPbots.
- Enter a Name for the bot.
Typing in the Name field searches for existing datasets or widgets for the selected integration. If an integration is not selected, typing in the field searches for across all integrations.
Users must select an Integration and a Name to proceed to the next step. If none is selected, the following warning message is shown:"Please complete the integration and name fields to ensure the bot runs successfully." -
If you want to preview the data, click the Data Inspector icon. - Go to the I want the bot to run based on this schedule section and set the time and frequency for running the bot.
4. (Optional) Set up Advanced Scheduling
- To set up advanced scheduling, scroll down to the Advanced Scheduler section on the Trigger screen.
- Click Setting to open the Advanced Scheduler window. Refer to How to Set Up Advanced Scheduler to configure the bot to send alerts in Minutes, Hours, Day, Month, or Year.
- Click the Next button to continue to the steps for defining the bot alert script.
5. Define the bot alert script
- Start by activating the channel where the bot will send the alert message. Click the slide button for any of the following to switch it ON:
- Microsoft Teams Chat
- Microsoft Team Channel
- Web Message
- Slack Chat
- Slack Channel
You may select multiple channels, depending on your requirements.
- Set up the alert message.
Example: To set an Email alert, fill in the following fields:- From - Select the address from which the email is sent.
-
To - Select a receiver or recipient from the Dataset Field, Drill through, or User List.
- Subject - Input a subject manually and/or select one using a Dynamic Token.
-
Message - Type a custom message for the alert message.
6. (Optional) Set the escalation script
The escalation recipient can be a manager and/or a next-level manager, depending on your requirements. You can also set several escalation steps as needed.
- Define the escalation steps by selecting an Escalation Threshold.
- Select a Time Frame for the escalation cycle. Choose from Day, Week, or Month.
- Write the Escalation message. Click the + Message button to add another message.
For example, if you select 3 for Escalation Threshold and Week for Time Frame, the escalation message would be sent when the bot is triggered three (3) times a week.
- Click the Finish button when done.
7. Activate the bot
To start sending alerts, activate the bot by going to the Detail tab and turning the following switches ON:
- Trigger - Switch this ON to make the bot available and running.
- Alert - Switch this ON to enable the sending of alerts.
- Escalation - Switch this ON to activate the escalation setup.