Getting Started with
Index
Navigating ………………………………………….……………………….…………
Overview ………………………………………………………………………………..
Dashboard ………………………………………………………………..………..
Tickets ……………………………………………………………………...............
Applications ……………………………………………………………………....
Event Monitoring …………………………………………………………….........
Critical, Medium, and Low Alerts…………………………………….....
Suppressed …………………………………………………………………….....
Organizations ………………………………………….……………………………..
Adding an organization....................................................................
Adding an application.......................................................................
Analysis...........................................................................................................
Settings ………………………………………………………………………………….
Users.........................................................................................................
PSA & Email...........................................................................................
Customize Alerts..................................................................................
API.............................................................................................................
User Privileges......................................................................................
Reports............................................................................................................
Navigating
SaaS Alerts has been designed for simple navigation. On the left hand side of the screen, a menu bar can be found with all available left hand menu options
Clicking on the hamburger icon (≡) will open the menu bar, giving the user a full list of sections and subsections to navigate, each of which is labeled. The contents of each section and subsection will be explained on the following pages.
Overview
Dashboard
At the top of the Dashboard screen, you will see Setup and Release Notes information.
The bottom portion of the Dashboard displays a map showing the "Last known connection points" based on the last 10,000 connection points. The map represents all your organizations in the last 7 days.
Tickets
This screen will give you a quick overview of the organizations with the most tickets created.
Selecting an organizations(s) from the list will hide it from the chart.
Applications
This screen displays Applications by User Connections as well as Applications by Critical Alerts.
Event Monitoring - Critical, Medium, and Low Alerts
Here you can view the most recent Critical, Medium, and Low alerts. Alerts shown are the last 100 alerts which update every 60 seconds. You can filter the results using the drop-down menus in the top section of the window.
Event Monitoring - Suppressed
Here you can search and view alerts that are suppressed. You can view when a suppression expires as well as release a suppression.
Organizations
This section is where all customers are listed in alphabetical order, along with their group, additional alert recipients, PSA status, whitelisted countries, total/billable users, status, and applications being monitored.
Tips:
- Similar to other sections, there is a search bar at the top of the page to find specific customers based on keywords (i.e. customer name or application)
- Pressing the star icon “favorites” the customer starred, moving them to the top of the list; starred companies will appear in alphabetical order separately from the rest of the list
- Pressing the person icon will show a list of accounts for that organization
- Pressing the pencil-shaped icon allows for the editing of the status and listed applications of the selected customer
- Pressing the trash can icon deletes the selected customer
Adding an Organization
To add a new Customer, select the "New Organization" button in the top right will begin the process.
Fields with a red asterik are required information. It is necessary to select at least one country, IP address, or range of addresses to successfully create an organization.
Add an Application
You can now select "Add Application" to begin the process of adding an application connection.
If you have the customer's global admin credentials you can select "I have customer's global admin credentials".
If you do not have credentials then select "I want my customer to create the connection". This self-onboarding option provides the ability to either have SaaS Alerts email the Domain Admin or copy the link so the email can be sent personally.
Note: Please make sure to disable popup blockers so SaaS Alerts can authenticate to each App being monitored.
Once these steps have been completed, the new customer will have been successfully added to the list.
Analysis
The Analysis Module is where you can search for any logged event in SaaS Alerts. You can filter on organization, user account, event type, as well as other filters listed at the top of the page.
After you run a report, you can search or filter on the results using the drop-down menus. Selecting "Export" will display the data in .csv or .pdf format.
The "Magnifying Glass" icon will show you additional information about an alert. This is the extent of the information provided by the API for an alert.
Settings
General Information
This section is where your business information is listed, including billing information and payment methods
Users
The Users page is where you can add/remove or update users with access to SaaS Alerts. You can filter on Status, Email, or MFA Enabled.
- Selecting the "pencil" icon will allow you to edit a user account.
- The "lock" icon will tell you if the account is active or not
- The "trash can" icon will delete an MSPUser account (MSPAdmin accounts first have to be demoted to an MSPUser to delete)
- The button "Export All Users" will export the user list to a spreadsheet in .csv format
PSA & Email
The PSA & Email screen is where you can add a PSA or Email Notification.
To add a PSA, select the "Add PSA" Button
Select the PSA you would like to add and enter the relevant information
To add email notifications, select the "Add Email" button from the PSA & Email screen and add an email address.
Customize Alerts
- This screen allows you to customize alert severity. Alert Severity can be set to Low, Medium, or Critical.
- This list of Alerts can also be exported for reference.
- Hovering over the "i" icon will display the list applications relevant to the alert.
- Changing the "Rows per page" at the bottom of the screen will allow you to see the entire list.
* Only Alerts with a Medium or Critical Severity will generate an email or ticket
API
To setup a SaaS Alerts Webhooks subscription:
- To add a domain for subscription authorization press the ‘+’ button
Enter a valid domain you will use for creating subscription endpoints example formats:
- “partnerdomain.com”
- “partnerdomain.com/path..”
- “webhooks.partnerdomain.com”
- Click the "Add" Button
Pressing “Add” will submit the domain for validation and add the domain authorization for SaaS Alerts Webhooks subscriptions if validation is successful.
Validation requires that when queried the domain returns a 2xx (typically 200) response indicating that it is live and can accept HTTP(s) requests. The domain host can have a blank page, API endpoint, or maybe the domain on which your primary website exists.
*The domain must match the location of your Webhook endpoint.
The domain validation process will produce either:
“Domain validation succeeded”
or
“Domain validation failed - unable to reach the specified domain.”
Additional information can be found in our KB Article Webhooks (API Documentation)
User Privileges
This screen allows you to enable Role Based Access Control - Group Access
Important note: RBAC requires at least 2 organizations to be connected to the platform and at least 1 non MSP Admin account (MSP User). If no MSP User accounts are present one will need to be created or an MSP Admin demoted to MSP user first for RBAC to function as expected.
- Select the toggle switch to enable RBAC/Group Access
- Select the "+" icon to add a New Group
- Enter Group Name, Select Organization(s) and User(s)
- Click on Create New Group to create the group.
Important note: if the "Create New Group" option remains blanked out after selecting "Select all users" it means there are no MSP Users in your partner instance. RBAC only works on non MSP Admin accounts. Creating a new MSP User account or demoting an existing MSP Admin account will then allow you to create a group as expected.
Additional information can be found in our KB Article RBAC - Role Based Access Control - Group Access
Modules
Reports
The Reports Module requires an additional authentication with SaaS Alerts from a user account with MFA enabled.
Risk Dashboard
The Reports Module provides a "Risk Dashboard". Based on the dates selected, Worldwide Risk Events for all organizations are displayed on the map. Events are updated every 5 seconds for the last 24 hours.
Reports
SaaS Alerts provides a list of pre-defined reports. They are listed in three categories:
- Executive Reports
- Operational Reports
- Configuration Reports
Scheduled Reports
The SaaS Alerts Report Module Allows Partners to Customize Report Schedules for each Customer
Create a new scheduled report
- You will see any existing scheduled reports in the Main Screen for Scheduled Reports.
- Select the New Schedule Button to Create a new Report Schedule.
- Select Schedule Type whether is a Recurring or One time schedule and the Frequency of the Report such as Daily, Weekly, Monthly, Quarterly, Yearly.
Note: When choosing Recurring, this will send the report at the beginning of the preferred frequency at 12:00 AM UTC time zone. Example: Scheduled Weekly reports will be send every Monday at 12:00 AM UTC.
- Report Details - Reports are listed in two categories, Organization and MSP Only.
- Select the Report(s) you would like for the Customer Organization.
- Select the Organization you would like to Report on
- Select the Recipients you would like to have Report(s) emailed to
- Click on the Save Button when finished
Settings - Branding
Branding allows you to upload a Logo to be used in reports and dashboards.
For image branding to be successfull, please follow the guidlines in terms of file size and image format.
Comments
0 comments
Article is closed for comments.