Configuration & Management

Configuration Basics¶

Most of the configuration and management tools have the same basic tool template.

1. Section Name - The name of the configuration or management section.
2. Column Name - The name of the column as per the section type. All columns in the table can be sorted by clicking on the column name.
3. Search - Enter the details of the customer, project, user, devices, distribution groups or reports to search for a particular persona.
4. Columns to Display - Select the columns to display in the table view.
5. Export Data - Export the presented data in either CSV, XLS, or XLSX format.
6. Pagination Tool - Determine the amount of rows to display per page. Also, navigate through the data using the first, previous, next, or last buttons.

Inzwa Cloud provides these management tools:

1. Manage Customers
2. Manage Projects
3. Manage Devices
4. Manage Customer Users
5. Manage Distribution Groups
6. Manage Reports
7. System Settings

Manage Customers¶

Customers are a key component of the organizational structure of Inzwa Cloud. Projects, users, and distribution groups are all related to a customer.

Accessing Manage Customers¶

To access manage customers:

1. Log in to the Dashboard.
2. Click and select Manage Customers.

Manage Customers Features¶

The Manage Customers page displays detailed information about the customers and the actions to perform.

1. Name - The name of the customer or group.
2. Site - Identify unique customer's with the same name using the site field. The combination of name and site must be unique.
3. Address - The address of the customer.
4. Email - The email of the customer.
5. Alarm Status - Indicates the highest severity level of active alarms on any of the customer's projects.
6. Number of Devices - The number of devices assigned to the customer.
7. Number of Active Projects - The number of active projects assigned to the customer.
8. Add Customer - Assigns a customer to the project.

Customer Action Items¶

The Customer table provides the following Action Items:

1. Adding a Customer
2. Editing a Customer
3. Enabling or Disabling a Customer
4. Deleting a Customer

Adding a Customer¶

To add a customer:

1. Log in to the Dashboard.
2. Click and select Manage Customers. The Manage Customers page opens.
3. Click . The Add Customer window opens.
4. Enter the Name.
5. [Optional] Enter the Site, Location, Email, Phone Number, and Notes.
6. Click Save to save the customer details.

Editing a Customer¶

To edit the customer details:

1. Log in to the Dashboard.
2. Click and select Manage Customers. The Manage Customers page opens.
3. Go to the customer row you wish to edit. The Edit button appears at the end of the row.
4. Click Edit. The Edit Customer window opens.
5. You can edit any of these fields: Name, Site, Location, Email, Phone Number, and Notes.
6. Click Save to save the changes.

Enabling or Disabling a Customer¶

To enable or disable a customer:

1. Log in to the Dashboard.
2. Click and select Manage Customers. The Manage Customers page opens.
3. Go to the customer row you wish to enable or disable. The Enable Customer or Disable Customer button appears at the end of the row.
4. Click Enable Customer or Disable Customer. The Enable Customer or Disable Customer window opens.
5. Click Yes to confirm the enabling or disabling of the customer from the project.

Deleting a Customer¶

To delete the customer details:

1. Log in to the Dashboard.
2. Click and select Manage Customers. The Manage Customers page opens.
3. Go to the customer row you wish to delete. The Delete button appears at the end of the row.
4. Click Delete. The Delete Customer window opens.
5. Click Yes to confirm the deletion of the customer from the project.

Manage Projects¶

Projects are a key component of Inzwa's Cloud architecture that allow for easy organization of devices and the data they collect.

Accessing Manage Projects¶

To access manage projects:

1. Log in to the Dashboard.
2. Click and select Manage Projects.

Manage Projects Features¶

The Manage Project page displays detailed information about the project and the actions to perform.

1. Name - The name of the project.
2. Customer - The name of the customer associated with the project.
3. Address - The address of the project.
4. Alarm status - Indicates the highest severity level if the project has active alarms.
5. Number of Devices - The number of devices assigned to the project.
6. Add Project - Assigns the project on the home screen map.

Project Action Items¶

The Manage Projects table provides the following Action Items:

1. Adding a Project
2. Editing a Project
3. Assigning a Device to a Project
4. Set Device Locations
5. Assigning Distribution Groups
6. Set Associated Users
7. Enabling or Disabling a Project
8. Deleting a Project

Adding a Project¶

To add a project:

1. Log in to the Dashboard.
2. Click and select Manage Projects. The Manage Projects page opens.
3. Click . The Add Project window opens.
4. Enter the Name and select Customer from the list of existing customers.
5. [Optional] Enter the Location Phone Number, Location, Purchase Order Number, Project Number, and Time Zone.

6. Devices associated with a project can be displayed on an uploaded image instead of on a map or table. In the Project Image field, drag and drop an image in the field or click the field to select a file to upload. After an image is added to a project, use Set Device Locations to position devices on the uploaded image.

   If a project has an uploaded image, Inzwa Cloud will, by default, display devices on this image even if the devices are assigned address or latitude/longitude information.

7. [Optional] Enter Notes.

8. Click Next.
9. [Optional] In Assign Distribution Groups, type the Distribution Group in the search bar. Select the distribution groups to assign to the project.
10. [Optional] In Associated Users, type the Customer User name in the search bar. Select the customer users who should have access to the project.
11. Click Finish.

Editing a Project¶

To edit the project:

1. Log in to the Dashboard.
2. Click and select Manage Projects. The Manage Projects page opens.
3. Go to the project row you wish to edit. The Edit button appears at the end of the row.
4. Click Edit. The Edit Project window opens.
5. You can edit any of these fields: Name, Location Phone Number, Location, Purchase Order Number, Project Number, Timezone, Project Image, or Notes.
6. Click Save to save the changes.

Assigning a Device to a Project¶

To add a device to a project:

1. Log in to the Dashboard.
2. Click and select Manage Projects. The Manage Projects page opens.
3. Click on the project row you wish to assign a device to. This will open up the project dashboard.
4. In the Devices table on the left, click Assign Device .
5. In the Assign Device menu, select the serial number of the device you wish to assign.
6. Click Next.
7. Add a unique Label to your device to distinguish it from other devices on your project.
8. If you have already configured your device, click Finish to assign it to your project. Otherwise, follow the steps below:
   • In the Device tab (applicable to all devices):
     • Enter the Label for the device.
     • [Optional] Enter the Location of the device. For Example: Address or the latitude and longitude coordinates.
     • Enter the Heartbeat Cycle of the device.
     • Select the Time Unit from the drop-down list. For Example: Days, Hours or Minutes.
   • In the Data Acquisition tab (Only applicable for Inzwa Veva 3):
     • Select the Sample Rate from the drop-down list. For Example: 1000, 2000 or 4000.
     • Select the Acceleration Range from the drop-down list. For Example: ±2g, ±4g, or ±8g.
   • In the Alarm Trigger tab (Only applicable for Inzwa Veva 3):
     • In Alarm Thresholds section:
       • Enter the X-axis Threshold, Y-axis Threshold, or Z-axis Threshold values in seconds in their respective fields.
       • Select Active to activate the specific threshold field.
     • In Alarm Recording Times section:
       • Enter the Pre-trigger Recording and Rearm Delay value in seconds.
       • Enter the Minimum Record Time and Maximum Record Time.
     • In Alarm Settings section:
       • Select the Alarm Filter from the drop-down list.
   • In the Settings tab:
     • Only applicable for Inzwa Veva 3:
       • In Histogram Recording section:
         • Enter the PVR Record Interval in Hours, Minutes, and Seconds.
       • In Scheduling Settings section:
         • Enter the Histogram File Upload Cycle in Days, Hours, Minutes, and Seconds.
         • Enter the Modem Reset Cyle in Days, Hours, Minutes, and Seconds.
       • In File Handling Options, select the actions applicable to the user.
     • Only applicable for Instantel® Micromate® and Topcon® Total Station:
       • Select the Timezone from the drop-down list. Set the Timezone the device is set to operate in.

Set Device Locations¶

To set device locations on a project image:

1. Log in to the Dashboard.
2. Click and select Manage Projects. The Manage Projects page opens.
3. Go to the project row you wish to set device locations on a project image. The Set Device Locations button appears at the end of the row.
4. Click Set Device Locations. The Set Device Locations window opens.
5. Click Place Entity.
6. If only one device is assigned to the project, a pin will be created automatically and can be dragged to a desired location.
7. If there are multiple devices assigned to the project:
   • In the Select Entity window, type the Device Name in the search bar or select the device from the drop-down.
   • Click Add to add the device on the project image.
   • The new device will appear in the center of the image, click and drag it to the desired location.
   • Click Close.

Assigning Distribution Groups to Existing Projects¶

To assign a distribution group to a project:

1. Log in to the Dashboard.
2. Click and select Manage Projects. The Manage Projects page opens.
3. Hover your cursor over the row of the project you wish to assign the distribution group. The Assign Distribution Groups button appears at the end of the row.
4. Click Assign Distribution Groups. The Assign Distribution Groups window opens.
5. Select the distribution groups to associate with the project. Optionally, type search phrase to filter the list.
6. Click Save to save the changes.

Set Associated Users¶

To assign a customer user to a project:

1. Log in to the Dashboard.
2. Click and select Manage Projects. The Manage Projects page opens.
3. Hover your cursor on the project row you wish to assign the customer user access to the project. The Associated Users button appears at the end of the row.
4. Click Associated Users. The Associated Users window opens.
5. A list of available customer users will appear. Select the customer users that should have access to the project. If the list of customer users is long, type the customer user's name in the search bar to filter the list.
6. Click Save to save the changes.

Enabling or Disabling a Project¶

1

!!! Note "Projects that have completed should be deactivated. This will remove the projects from the map and table views in Inzwa Cloud."

To enable or disable a project:

1. Log in to the Dashboard.
2. Click and select Manage Projects. The Manage Projects page opens.
3. Hover your cursor on the project row you wish to enable or disable. The Enable Project or Disable Project button appears at the end of the row.
4. Click Enable Project or Disable Project. The Enable Project or Disable Project window opens.
5. Click Yes to confirm the enabling or disabling of the project.

Deleting a Project¶

To delete the project:

1. Log in to the Dashboard.
2. Click and select Manage Projects. The Manage Projects page opens.
3. Go to the project row you wish to delete. The Delete button appears at the end of the row.
4. Click Delete. The Delete Project window opens.
5. Click Yes to confirm the deletion of the customer from the project. All devices assigned to the project will be unassigned.

Manage Devices¶

Manage Devices provides insights on the current status of your devices and allows you to configure and assign them to projects.

Accessing Manage Devices¶

To access manage devices:

1. Log in to the Dashboard.
2. Click and select Manage Devices.

Manage Devices Features¶

The Manage Devices page displays detailed information about the individual devices and the actions to perform.

1. Serial Number - The serial number of the device.
2. Label - The label of the device provided by the user.
3. Device Type - The type of the device. For Example: Inzwa Veva 3.
4. Assigned Project - Project assigned to the device.
5. Alarm Status - Indicates the highest severity level if the device has active alarms.
6. Last Data Acquisition - Indicates the date and time data was last received from the device.
7. Device Status - The status of the device such as its power source and level, signal strength and configuration sync status.
8. License Expiration - The device's license expiration date for all monitoring services.

Device Status¶

The Device Status column contains the following icons:

Icon	Name	Description
or	Power source and level	Indicates if powered by battery or external supply. Inzwa Veva 3 When on battery, indicates battery level. Indicates red color when level is getting low. Instantel® Micromate® Syscom® MR3000® Only indicates battery level
	Communications Link Level	Indicates the device signal strength. Only available for Inzwa Veva 3
	Configuration Sync Indication	Indicates if the configuration shown in the platform is synced to the device: Green - Displayed if the platform and device are in sync. Yellow - Displayed if the platform is sending the configuration to the device. Red - Displayed if there is a problem syncing the device to the platform. Only available for Inzwa Veva 3

Device Action Items¶

The Device table provides the following Action Items:

1. Configure a Device
2. View Device Certificates
3. View Device Project History
4. Unassign a Device
5. Assign a Device

Configure a Device¶

To configure a device:

1. Log in to the Dashboard.
2. Click and select Manage Devices. The Manage Devices page opens.
3. Go to the device row you wish to configure. The Configure Device button appears at the end of the row.
4. Click Configure Device. The Configure Device window opens.
   • In the Device tab (applicable to all devices):
     • Enter the Label for the device.
     • [Optional] Enter the Location of the device. For Example: Address or the latitude and longitude coordinates.
     • Enter the Heartbeat Cycle of the device.
     • Select the Time Unit from the drop-down list. For Example: Days, Hours or Minutes.
   • In the Data Acquisition tab (Only applicable for Inzwa Veva 3):
     • Select the Sample Rate from the drop-down list. For Example: 1000, 2000 or 4000.
     • Select the Acceleration Range from the drop-down list. For Example: ±2g, ±4g, or ±8g.
   • In the Alarm Trigger tab (Only applicable for Inzwa Veva 3):
     • In Alarm Thresholds section:
       • Enter the X-axis Threshold, Y-axis Threshold, or Z-axis Threshold values in seconds in their respective fields.
       • Select Active to activate the specific threshold field.
     • In Alarm Recording Times section:
       • Enter the Pre-trigger Recording and Rearm Delay value in seconds.
       • Enter the Minimum Record Time and Maximum Record Time.
     • In Alarm Settings section:
       • Select the Alarm Filter from the drop-down list.
   • In the Settings tab:
     • Only applicable for Inzwa Veva 3:
       • In Histogram Recording section:
         • Enter the PVR Record Interval in Hours, Minutes, and Seconds.
       • In Scheduling Settings section:
         • Enter the Histogram File Upload Cycle in Days, Hours, Minutes, and Seconds.
         • Enter the Modem Reset Cyle in Days, Hours, Minutes, and Seconds.
       • In File Handling Options, select the actions applicable to the user.
     • Only applicable for Instantel® Micromate® and Topcon® Total Station:
       • Select the Timezone from the drop-down list. Set the Timezone the device is set to operate in.
5. Click Finish to configure the device.

View Device Certificates¶

You can view a device's calibration certificates at any time for information on calibration dates and specifications.

1

!!! Note "This option is only available for Inzwa Veva 3 devices."

To view device certificates:

1. Log in to the Dashboard.
2. Click and select Manage Devices. The Manage Devices page opens.
3. Go to the device row you wish to unassign. The View Certificates button appears at the end of the row.
4. Click View Certificates. The View Certificates window opens.
5. Visible in each entry are the time in which the certificate was created in Created Time, as well as the certificate file name in Name. Click the Download or Open buttons on the end of a certiciate row to download or open the file.

View Device Project History¶

You can view the specific timestamps in which a device was assigned or unassigned to past and ongoing projects.

To view device project history: 1. Log in to the Dashboard. 2. Click and select Manage Devices. The Manage Devices page opens. 3. Go to the device row you wish to unassign. The Projects History button appears at the end of the row. 4. Click Projects History. The Projects History window opens. 5. Visible in each entry are the name of the projects the device was previously, or is currently assigned to, as well as the timespan in which the device was assigned to said project.

Unassign a Device¶

You can unassign a device from the project and assign it to another project.

1

!!! Note "For Crack Gauge devices, this option is unavailable."

To unassign a device:

1. Log in to the Dashboard.
2. Click and select Manage Devices. The Manage Devices page opens.
3. Go to the device row you wish to unassign. The Unassign Device button appears at the end of the row.
4. Click Unassign Device. The Unassign Device window opens.
5. Click Yes to confirm the unassignment of the device from the project.

Assign a Device¶

To assign a device to a project:

1. Log in to the Dashboard.
2. Click and select Manage Devices. The Manage Devices page opens.
3. Go to the device row you wish to assign.
4. Click Assign Device The Assign Device window opens.
5. From the Adding Method dropdown, select Assign Existing Device then continue with the following steps. Or, select Create Virtual Device, then follow these steps.
6. Click the device field. A list of unassigned device serial numbers will appear. Select the desired device. Optionally, key into the device field the first characters of the serial number to filter the list.
7. Click Next.
8. Click the project field. A list of projects will appear. Select the desired project. Optionally, key into the project field the first characters of the desired project to filter the list.
9. Click Next.
10. Continue by configuring the selected device.

Manage Customer Users¶

The Manage Users dashboard allows you to view and manage users. Users provide access to the customers to view the status of projects, view reports in real time, and receive alarm notifications. Customer users cannot create or edit projects, other customer users, distribution groups, etc.

Accessing Manage Customer Users¶

To access manage customer users:

1. Log in to the Dashboard.
2. Click and select Manage Users.

Manage Customer Users Features¶

The Manage Users dashboard displays detailed information about the customer users and the actions to perform.

1. Name - The name of the customer user.
2. Email - The email address of the customer user.
3. Phone - The phone number of the customer user.
4. Customer - The name of the customer the customer user is related to.
5. Projects - The name of the project(s) the customer user has access to.
6. Distribution Group - The name of the distribution group(s) the customer user is a member of.
7. Add User - Assigns a customer user to the project.

Customer User Action Items¶

The Manage Customer Users table provides the following Action Items:

1. Adding a Customer User
2. Editing a Customer User
3. Assigning Projects
4. Assigning Distribution Groups
5. Deleting a Customer User

Adding a Customer User¶

To add a customer user:

1. Log in to the Dashboard.
2. Click and select Manage Customer Users. The Manage Customer Users page opens.
3. Click . The Add User window opens.
4. Enter the First Name and Last Name.
5. Select the Customer from the drop-down list.
6. Enter the Email address.
7. [Optional] Enter the Location and Phone Number.
8. [Optional] Set the Units dropdown, "Allow user to login" checkbox, "Receive alarm notifications" checkboxes, and "Receive reports" checkbox.

9. Click Next.

   Inzwa Cloud uses the email address as the username, so it must be unique in the system. Therefore, a customer user can't share an email address with another customer or tenant user.

   If you wish to receive text messages and alarm notifications, provide a mobile phone number. Country code is required when entering phone numbers.

10. [Optional] In Assign Distribution Groups, type the Distribution Group in the search bar. Select the distribution groups the customer user should be a member of and click Next.

11. [Optional] In Assign Projects, type the Project Name in the search bar. Select the project the customer user should have access to and click Next.

    A customer user will not have access to a project unless assigned to it.

    While assigning the project, indicate if the customer user is the primary user for the project. The tenant users will use the information to contact the primary customer user of the project.

12. Click Finish. The customer user will receive an email to activate their account and create a password.

Editing a Customer User¶

To edit the customer user details:

1. Log in to the Dashboard.
2. Click and select Manage Customer Users. The Manage Customer Users page opens.
3. Hover your cursor on the user row you wish to edit. The Edit button appears at the end of the row.
4. Click Edit. The Edit User window opens.
5. You can edit any of these fields: First Name, Last Name, Location, Email, Phone Number, Units, Receive alarm notifications checkboxes, and the Receive reports checkbox.
6. Click Save to save the changes.

Assigning Projects to Users¶

To assign the user access to a project:

1. Log in to the Dashboard.
2. Click and select Manage Customer Users. The Manage Customer Users page opens.
3. Hover your cursor on the customer user row you wish to to assign the project. The Assign Projects button appears at the end of the row.
4. Click Assign Projects. The Assigned Projects window opens.
5. A list of available projects will appear. Select the projects the customer user should be assigned. If the list of projects is long, type the project name in the search bar to filter the list.
6. Click Save to save the changes.

To assign multiple customer users to projects at the same time:

1. Select the checkboxes next to each customer user row.
2. Click the Assign Project icon that appears above the table on the right.

Assigning Distribution Groups to Users¶

To assign the user a distribution group to be a member of the group:

1. Log in to the Dashboard.
2. Click and select Manage Customer Users. The Manage Customer Users page opens.
3. Hover your cursor to the user row you wish to assign the distribution group. The Assign Distribution Groups button appears at the end of the row.
4. Click Assign Distribution Groups. The Assign Distribution Groups window opens.
5. A list of available distribution groups will appear. Select the distribution groups the customer user should be assigned. If the list of distribution groups is long, type the distribution group name in the search bar to filter the list.
6. Click Save to save the changes.

To assign multiple customer users to distribution groups at the same time:

1. Select the checkboxes next to each customer user row.
2. Click the Assign Distribution Group icon that appears above the table on the right.

Deleting a Customer User¶

To delete the customer user details:

1. Log in to the Dashboard.
2. Click and select Manage Customer Users. The Manage Customer Users page opens.
3. Go to the customer row you wish to delete. The Delete button appears at the end of the row.
4. Click Delete. The Delete Customer User window opens.
5. Click Yes to confirm the deletion of the customer from the project.

To delete multiple customer users at the same time:

1. Select the checkboxes next to each customer user row.
2. Click the Delete icon that appears above the table on the right.

Manage Distribution Groups¶

The Manage Distribution Groups dashboard allows you to define a group of customer users that will receive notifications when a device alarm is triggered on an associated project.

Accessing Manage Distribution Groups¶

To access manage distribution groups:

1. Log in to the Dashboard.
2. Click and select Manage Distribution Groups.

Manage Distribution Groups Features¶

The Manage Distribution Groups page displays detailed information about the distribution groups and the actions to perform.

1. Group Name - The name of the distribution group. Note that the phrase 'Distribition Group' is automatically appended to the name.
2. Customer - The name of the customer assigned to the distribution group.
3. Group Members - The name of the members assigned to the distribution group.
4. Assigned Projects - The project assigned to the distribution group.
5. Add Distribution Group - Assigns a customer user to the distribution group.

Distribution Group Action Items¶

The Manage Distribution Groups table provides the following Action Items:

1. Adding a Distribution Group
2. Editing a Distribution Group
3. Assigning Projects
4. Assigning Group Members
5. Editing Alarm Severity Notifications
6. Deleting a Distribution Group

Adding a Distribution Group¶

To add a distribution group:

1. Log in to the Dashboard.
2. Click and select Manage Distribution Groups. The Distribution Groups page opens.
3. Click . The Add Distribution Group window opens.
4. Enter the Group Name.
5. Select the Customer from the drop-down list.
6. Click Next.
7. [Optional] In Assign Group Members, select the customer users that should be a member of the group and click Next.
8. [Optional] In Assign Projects, select the projects for which the distribution group will distribute alarm notifications.
9. Click Finish.

Editing a Distribution Group¶

To edit the distribution group details:

1. Log in to the Dashboard.
2. Click and select Manage Distribution Groups. The Distribution Groups page opens.
3. Hover your cursor on the distribution group row you wish to edit. The Edit button appears at the end of the row.
4. Click Edit. The Edit Distribution Group window opens.
5. You can edit only the Group Name.
6. Click Save.

Assigning Projects to an Existing Distribution Group¶

To assign a distribution group to a project:

1. Log in to the Dashboard.
2. Click and select Manage Distribution Groups. The Distribution Groups page opens.
3. Hover your cursor on the distribution group row you wish to assign to the project. The Assign Projects button appears at the end of the row.
4. Click Assign Projects. The Assigned Projects window opens.
5. A list of available projects will appear. Select the projects the distribution group should be assigned. If the list of projects is long, type the project name in the search bar to filter the list.
6. Click Save.

Assigning Group Members to an Existing Distribution Groups¶

To assign the customer users to be a member of the distribution group:

1. Log in to the Dashboard.
2. Click and select Manage Distribution Groups. The Distribution Groups page opens.
3. Hover your cursor to the distribution group row you wish to add members. The Assign Group Members button appears at the end of the row.
4. Click Assign Group Members. The Assign Group Members window opens.
5. A list of available group members will appear. Select the members to be added to the distribution group. If the list of members is long, type the member name in the search bar to filter the list.
6. Click Save.

Editing Alarm Severity Notifications¶

To edit the alarm severity notifications:

1. Log in to the Dashboard.
2. Click and select Manage Distribution Groups. The Distribution Groups page opens.
3. Hover your cursor to the distribution group row you wish to add members. The Alarm Severities Notifications button appears at the end of the row.
4. Click Alarm Severities Notifications. The Alarm Severities Notifications window opens.
5. A list of alarm types will appear. Select the alarm types you wish to recieve as notifications.
6. Click Save.

Deleting a Distribution Group¶

To delete the distribution group details:

1. Log in to the Dashboard.
2. Click and select Manage Distribution Groups. The Distribution Groups page opens.
3. Go to the distribution group row you wish to delete. The Delete button appears at the end of the row.
4. Click Delete. The Delete Distribution Group window opens.
5. Click Yes to confirm the deletion of the distribution group from the project.

Manage Reports¶

The Manage Reports dashboard allows you to schedule and format the reports that are delivered to customer users, distribution groups, or ad-hoc email addresses.

Accessing Manage Reports¶

To access manage reports:

1. Log in to the Dashboard.
2. Click and select Manage Reports.

Scheduled Reports¶

The Scheduled Reports page displays detailed information about each scheduled report and the actions to perform.

1. Name - The name of the report.
2. Schedule - The delivery schedule of the report.
3. Distribution Groups - The list of distribution groups assigned to receive the report.
4. Users - The list of users assigned to receive the report.
5. Add Scheduled Report - Create a report to deliver to a customer user, distribution group or an ad-hoc email address

Scheduled Report Action Items¶

The Scheduled Reports table provides the following Action Items:

1. Adding a Scheduled Report
2. Editing a Scheduled Report
3. Deleting a Scheduled Report

Adding a Scheduled Report¶

To add a scheduled report:

1. Log in to the Dashboard.
2. Click and select Manage Reports. The Manage Reports page opens.
3. On the Scheduled Reports tab, click . The Create Scheduled Report window opens.
4. In the Main tab, enter the Name and select Customer from the list of existing customers.

5. In the Select Report tab:

   • From Project, select the project you wish to generate the report from.
   • In the Report Template, select Daily Vibration Monitoring Report, Tilt Monitoring Summary Report, or Weekly Vibration Monitoring Summary Report based on your requirements. If any custom reports have been designed for you, they will appear in this list.
   • The Report Name Pattern sets the filename of the report attached to the recipients' email.
     • To display the report specific information and current time stamp in the report name, use this pattern:
       • Current Time stamp - {currentTime}
       • Project Name: {projectName}
       • Customer Name: {customerName}
   • Set the Report Output Format dropdown as either PDF or DOCX.

   If you are planning to review a report before sending it to clients, it is recommended to select DOCX so that you can make changes to the report.

   • Select the time zone for data in the report from Time Zone.
   • Select the time frame the report should cover from Report Period. This should be set to a time period appropriate for the type of report selected. For a weekly report, set either 'last 7 days' or a specific 7 day period using the time period selector. For a daily report, set either 'last 1 day' or a specific day using the time period selector.
   • To shift the report period back a certain number of hours from the report creation time, check Shift report period back and select the number of hours from the Hours from report creation time dropdown, otherwise leave Shift report period back unchecked.

   When Report Period is set to a relative value (eg. last 7 days), the report time period will end at the time the report is generated. Shift report period back allows users to shift the report end time back, up to 12 hours, from the report gneration time. This feaure is useful when reporting on devices that send data periodically by allowing reports to be generated after the devices have been given time to send in data to be included in the report.

   • Select Use Current User Credentials to use the user creating the report delivery schedule to generate the report.
     • If you do not select this option, select a user in the Customer User Credentials field.

     Keep Use Current User Credentials checked unless there's a good reason to change the user. The report may be incomplete if the customer user does not have access to the data desired on the report.

6. In the Select Delivery tab:

   • In the Recipients section, complete at least one the three sections.

     • Select distribution groups to send the report to a Distribution Groups. Distribution groups must belong to the same customer as the scheduled report.
     • Select customer users to receive the report from the Users drop-down. Customer users must belong to the same customer as the scheduled report.
     • Enter ad-hoc email addresses that should receive the report under To.

     Use a comma to separate multiple email addresses.

   • In Subject, enter the subject line of the email.

   • In Body, compose the message of the email.

     Both subject and body can use the following dynamic data fields: Current date and time - {currentTime}, Project name - {projectName}, Customer name {customerName}

7. In the Schedule tab:

   • Select the timezone of the scheduled report delivery time from the Timezone drop-down.
   • Set the Start Time the scheduled report delivery should begin.
   • Select Repeat to set a repeating delivery schedule.
     • Select the repeat schedule from Repeats.
     • When a repeating schedule is selected, select an end date for the scheduled delivery from Ends on.
8. Click Create to add a scheduled report.

Editing a Scheduled Report¶

To edit the scheduled report:

1. Log in to the Dashboard.
2. Click and select Manage Reports. The Manage Reports page opens.
3. Hover your cursor on the scheduled report row you wish to edit. The Edit Scheduled Report button appears at the end of the row.
4. Click Edit Scheduled Report.
5. For information on editing these fields, refer to Steps 4 - 7 in the Adding a Scheduled Report section.

Deleting a Scheduled Report¶

To delete the scheduled report:

1. Log in to the Dashboard.
2. Click and select Manage Reports. The Manage Reports page opens.
3. Go to the scheduled report you wish to delete. The Delete Scheduled Report button appears at the end of the row.
4. Click Delete. The Delete Scheduled Report window opens.
5. Click Yes to confirm the deletion of the scheduled report.

Report Templates¶

The Report Templates page displays information about each report template and the actions to perform.

1. Template Name - The name of the report template.
2. Description - The description of the report template.
3. Add Report Template - Create a report to deliver to a customer user, distribution group or an ad-hoc email address

Report Templates Action Items¶

The Report Templates table provides the following Action Items:

1. Adding a Report Template
2. Editing a Report Template
3. Copying a Report Template
4. Deleting a Report Template

Adding a Report Template¶

To add a report template:

1. Log in to the Dashboard.
2. Click and select Manage Reports. The Manage Reports page opens.
3. On the Report Templates tab, click . The Create Report Template window opens.

4. In the Report Configuration tab:

   • Enter the Template Name to assign a name to the new report template.
   • Select the Date Format for the report template.
   • Enter a Description for the report template.

   • Under Default Paragraph Styles:

     Changing the default styles is optional and will only apply to newly added content blocks. Most content blocks allow their styling to be customized.

     • Select the Font Family that the report paragraphs will be styled in.
     • Select the Font Size for the report paragraphs.
     • Select the number of spaces that will appear before each report paragraph under Spaces Before.
     • Select the number of spaces that will appear after each report paragraph under Spaces After.
     • Select the the Alignment for each report paragraph.
     • Select the Font Color for text in each report paragraph.
     • Select the Link Color for links in each report paragraph.
     • Select additional styling options for text in each report paragraph by checking the Bold, Italic, and/or Underline checkboxes.
     • Select additional styling options for links in each report paragraph by checking the Link Bold, Italic, and/or Underline checkboxes.

   • Under Default Table Styles:

     Changing the default styles is optional and will only apply to newly added content blocks. Most content blocks allow their styling to be customized.

     • Select the Width percentage for each table in the report.
     • Select the Alignment for each table in the report.
     • Select the number of spaces that will appear before each report table under Spaces Before.
     • Select the number of spaces that will appear after each report table under Spaces After.
     • Under Header Styles:
       • Select the Font Family that the table headers will be styled in.
       • Select the Font Size for the table headers.
       • Select the Fill Color for the table headers.
       • Select the Font Color for the table headers.
       • Select additional styling options for the table headers by checking the Bold, Italic, and/or Underline checkboxes.
     • Under Body Styles:
       • Select the Font Family that the table bodies will be styled in.
       • Select the Font Size for the table bodies.
       • Select the Fill Color for the table bodies.
       • Select the Font Color for the table bodies.
       • Select the Minimum Value Shade Color for the table bodies.
       • Select the Maximum Value Shade Color for the table bodies.
       • Select additional styling options for the table bodies by checking the Bold, Italic, and/or Underline checkboxes.

5. In the Content Configuration tab:

   • [Optional] Add blocks to the cover page of your report template by selecting Add Blocks under Cover Page Blocks, the following blocks can be added to the report cover page:
     • Report Title
     • Project Name
     • Customer Name
     • Tenant Name
     • Report Timeframe
     • Static Block
     • Image Block
   • Add blocks to the body of your report template by selecting Add Blocks under Cover Page Blocks, the following blocks can be added to the report body:
     • Device Inventory Table
     • Alarm Event Table
     • Data Aggregation Table
     • Chart Block
     • Site Map Block
     • Static Block
     • Image Block

6. Click Create to create the report template.

Editing a Report Template¶

To edit the report template:

1. Log in to the Dashboard.
2. Click and select Manage Reports. The Manage Reports page opens.
3. Go to the report template row you wish to edit. The Edit button appears at the end of the row.
4. Click Edit. The Edit Report Template window opens.
5. Follow steps 4-5 in Adding a Report Template.
6. Click Save to save the changes.

Copying a Report Template¶

To copy the report template:

1. Log in to the Dashboard.
2. Click and select Manage Reports. The Manage Reports page opens.
3. Go to the row of the report template you wish to copy. The Clone button appears at the end of the row.
4. Click Clone. The Clone Template window opens.
5. Enter a name for the cloned template.
6. Click Clone to clone the template.

Deleting a Report Template¶

To delete the report template:

1. Log in to the Dashboard.
2. Click and select Manage Reports. The Manage Reports page opens.
3. Go to the row of the report template you wish to delete. The Delete button appears at the end of the row.
4. Click Delete. The Delete Report Template window opens.
5. Click Yes to confirm the deletion of the report template.

System Settings¶

The System Settings dashboard allows the user to view and modify the tenant's general settings, users, notification settings, and integrations.

Accessing System Settings¶

To access system settings:

1. Log in to the Dashboard.
2. Click and select System Settings.

General¶

The General menu allows you to view and modify the following tenant information:

1. Country - The country in which the tenant is located.
2. City - The city in which the tenant is located.
3. State/Province - The state or province in which the tenant is located.
4. Zip/Postal Code - The zip or postal code in which the tenant is located.
5. Address - The specific address associated with this tenant.
6. Address 2 - Secondary information about the specific address associated with this tenant (suite number, floor number, etc.).
7. Phone - The primary phone number associated with this tenant.
8. Email - The primary email number associated with this tenant.
9. Start of Week - The day in which the tenant's working week primarily starts.

Click Save to save any changes made to the tenant's general settings.

Users¶

The Users menu allows you to view and modify users associated with the tenant.

Add a Tenant User¶

To add a tenant user:

1. Log in to the Dashboard.
2. Click and select System Settings. The System Settings page opens.
3. Click the Users tab at the top of the System Settings page.
4. Click the Add User button, the Add User window opens
5. From the Add User window, enter the following user information:
   • First Name - The first name of the user.
   • Last Name - The last name of the user.
   • Email - The email of the user.
   • Phone Number - The phone number of the user.
   • Units - Select whether information on the user's dashboard is displayed in metric or imperial units.
   • Alarm Notifications - Select the Email or SMS checkboxes to determine how the user will recieve alarm notifications.
   • Reports - Select the Email checkbox to enable sending reports via email to the user.
   • Activation Method - Select the method of activation for the user's account. Display activation link will display a link that the user must then open to finish activating the account. Send activation email will automatically send an email address with the activation link to the user's primary email address.
6. Click Add to create the new user.

Edit a Tenant User¶

To Edit the tenant user:

1. Log in to the Dashboard.
2. Click and select System Settings. The System Settings page opens.
3. Click the Users tab at the top of the System Settings page.
4. Go to the tenant user row you wish to edit. The Edit button appears at the end of the row.
5. Click Edit. The Edit User window opens.
6. From the Edit User window, the following information can be changed:
   • First Name - The first name of the user.
   • Last Name - The last name of the user.
   • Email - The email of the user.
   • Phone Number - The phone number of the user.
   • Units - Select whether information on the user's dashboard is displayed in metric or imperial units.
   • Alarm Notifications - Select the Email or SMS checkboxes to determine how the user will recieve alarm notifications.
7. Click Save to save changes to the user.

Delete a Tenant User¶

To delete the tenant user:

1. Log in to the Dashboard.
2. Click and select System Settings. The System Settings page opens.
3. Click the Users tab at the top of the System Settings page.
4. Go to the tenant user row you wish to delete. The Delete button appears at the end of the row.
5. Click Delete. The Delete User window opens.
6. Click Yes to confirm the deletion of the tenant user.

Notifications¶

The Notifications menu allows you to view and edit the SMS and email notification templates that are sent to the tenant's users. This menu is divided into three sections:

SMS Templates¶

Templates for vibration, tilt, and general event SMS notifications can be defined under SMS Templates. Insert variables into any notification by surrounding the variable name with ${} (e.g. ${projectName}).

Email Templates¶

Templates for email notifications can be defined under Email Templates. By default the Use system mail templates checkbox will be selected, these system mail templates are suitable for most use cases. To add custom email templates, uncheck the Use system mail templates checkbox, and fill out the following fields:

1. Report "From" Address - The email address from which the notification will be sent.
2. Mail Template - The currently selected template. This template can be viewed and modified through the Mail Body preview.
3. Mail Subject - The subject of the email notification.
4. Mail Body - The main content of the body of the email

Units / Time format / Time zone¶

The following unit and time properties can be modified under Units / Time format / Time zone:

1. Units - The measurement units used to display data on the platform.
2. Time Format - The format of time and timestamps displayed on the platform.
3. Time Zone - The time zone to which all measurements are converted.

Integrations¶

The Integrations menu allows you to connect the Inzwa Cloud Platform to other services. Currently Supported integrations include:

Geokon Integration¶

To integrate Geokon with Inzwa Cloud:

1. Click the Geokon API Keys dropdown menu.
2. Click Add. Enter your Geokon API key(s).
3. Click Save

Geokon Integration - Click the Geokon API Keys dropdown to add one or more api keys for Geokon integration.

Omnidots Integration¶

To integrate Omnidots with Inzwa Cloud:

1. Click the Omnidots Credentials dropdown menu.
2. Add your Omnidots username and password.

Data Parser Configs¶

The Data Parser Configs menu allows you to define custom parsing configurations for your user defined devices.

Add a Data Parser Config¶

To add a data parser config:

1. Log in to the Dashboard.
2. Click and select System Settings. The System Settings page opens.
3. Click the Data Parser Config tab at the top of the System Settings page.
4. Click the Add Data Parser Config button, the Add Data Parser Config window opens.
5. In the General Settings tab, enter the following config information:
   • Name - The name of the data parser config.
   • Date Format - The date format of the timestamps in the example file.
   • Time Zone - The time zone of the timestamps in example file.
   • CSV Delimeter - The delimeter used in the example file.
   • Example File - An example file from the device to use in the Data Parsing Configuration.
6. In the Data Parsing Configuration tab:
   • Select Starting Row from the top right switch.
   • Select the starting row (first row of data) in the example file.
   • Select Columns from the top right switch.
   • Select the row containing the data timestamps.
   • Select Timestamp from the switch in the pop up menu, then click Apply.
   • Select a column to assign a telemetry key to.
   • Select Telemetry from the switch in the pop up menu, enter the telemetry key and value type, then click Apply. Repeat for any additional telemetry keys.
7. Click Add to create the new data parser config.

Edit a Data Parser Config¶

To edit a data parser config:

1. Log in to the Dashboard.
2. Click and select System Settings. The System Settings page opens.
3. Click the Data Parser Configs tab at the top of the System Settings page.
4. Go to the row of the data parser config you wish to edit. The Edit button appears at the end of the row.
5. Click Edit. The Edit Dashboard Layout window opens.
6. Click Edit Mode to begin editing the dashboard layout.
7. From here you can edit the general settings and data parser configuration settings outlined in Add a Data Parser Config.
8. Click Save to save the changes to the data parser config.

Delete a Data Parser Config¶

To delete a data parser config:

1. Log in to the Dashboard.
2. Click and select System Settings. The System Settings page opens.
3. Click the Data Parser Config tab at the top of the System Settings page.
4. Go to the data parser config you wish to delete. The Delete button appears at the end of the row.
5. Click Delete. The Delete Data Parser Config window opens.
6. Click Yes to confirm the deletion of the data parser config.

Dashboard Layouts¶

The Dashboard Layouts menu allows you to define custom dashboards for your user defined devices.

Add a Dashboard Layout¶

To add a dashboard layout:

1. Log in to the Dashboard.
2. Click and select System Settings. The System Settings page opens.
3. Click the Dashboard Layouts tab at the top of the System Settings page.
4. Click the Add Dashboard Layout button, the Add Dashboard Layout window opens.
5. Click the Title to customize the title of the dashboard layout.
6. Click the Add New Widget button and select the type of widget you wish to add, the Add Widget window opens:
   • In the Data tab:
     • Under Timewindow, select whether or not to display the timewindow, additionally you can change set the default realtime or historical range of the timewindow, or change the timewindow's appearance by clicking the Timewindow Style button.
     • Under Series, select a series key to display on your widget, along with a color key, unit of measurement, and the number of decimal places.
     • For further customization of series keys, click the Series Settings button.
     • To delete a series key, click the Remove Series button on the row of the series key you wish to remove.
   • In the Appearance tab (optional):
     • Under Data Settings, set the default units, number of decimals, number of digits from a custom attribute (e.g. ${decimalNumber}), and an alternative message for when there is no date to display.
     • Under Common Settings, set whether or not to enable stacking mode, enable selection mode, enable zoom-out, display curved lines, and use state thresholds. You can also choose the size of the line shadows, line width for all thresholds, and the default font size and color.
     • Under Legend, choose to enable or disable the legend and set the legend direction, position, font size, and values. You can also choose whether or not to sort legend's datakeys.
     • Under Axis, set the vertical axis' title, maximum and minimum values, whether or not to include the y-axis scaling tool, and tick settings. You can also customize the title and tick settings of the horizontal axis.
     • Under Chart Background, toggle whether or not to show the vertical and horizontal grid lines, you can also customize the grid line, border, and background color.
     • Under Tooltip, toggle whether or not to display the tooltip. You can also set the tooltip to hover individual points, show cumulative values in stacking mode, hide zero/false values, and choose whether or not to order data in the tooltip by key or value. Lastly you can specify a custom tooltip value function .
     • Under Comparison Settings, toggle whether or not to enable comparisons, set the comparison period, and alter the comparison's x axis settings.
     • Under Custom Legend Settings, toggle whether or not to enable a custom legend. If the widget uses a custom legend, add keys to use as labels.
   • In the Widget Card tab (optional):
     • Under Card Title, set whether or not to display the card title, as well as the card title text, tooltip, and icon
     • Under Card Style, set the card's text color, background color, padding, margin, border radius, and whether or not to include a drop shadow.
     • Under Card Buttons, choose whether or not to enable the widget's fullscreen and data export buttons.
   • In the Mobile tab (optional):
     • Set whether or not to display the widget in mobile mode.
     • Set whether or not to display the widget in desktop mode.
     • Set the order of the widget in mobile mode.
     • Set the height of the widget in mobile mode.
7. Click Add to create the new widget, repeat steps 6-7 to add additional widgets.
8. Click Save once finished to save the dashboard layout.
9. Click Add to add the dashboard layout.

Edit a Dashboard Layout¶

To edit a dashboard layout:

1. Log in to the Dashboard.
2. Click and select System Settings. The System Settings page opens.
3. Click the Dashboard Layouts tab at the top of the System Settings page.
4. Go to the row of the dashboard layout you wish to edit. The Edit button appears at the end of the row.
5. Click Edit. The Edit Dashboard Layout window opens.
6. Click Edit Mode to begin editing the dashboard layout.
7. From here you can add new widgets, edit existing widgets, or delete existing widgets from the dashboard layout.
8. Click Save to save the changes.
9. Click Save again to apply the changes to your dashboard.

Delete a Dashboard Layout¶

To delete a dashboard layout:

1. Log in to the Dashboard.
2. Click and select System Settings. The System Settings page opens.
3. Click the Dashboard Layouts tab at the top of the System Settings page.
4. Go to the dashboard layout you wish to delete. The Delete button appears at the end of the row.
5. Click Delete. The Delete Dashboard Layout window opens.
6. Click Yes to confirm the deletion of the dashboard layout.