Utility App

Locating the Utility App

The Utility App is available at the following location in every Arrayent Cloud environment: https://SUBDOMAIN.arrayent.com:8081/Utility Where SUBDOMAIN is the subdomain of your Arrayent Cloud environment. Always use https, not http, and always send the request to port 8081 (:8081).

Logging In to the Utility App

To log in to the Utility App:

1. Enter your Customer Account username.
2. Enter your Customer Account password.
3. Enter your App ID. This is the App ID of the System Account that created this Customer Account.
4. Click Login.

Overview

The Devices page contains the following components.

1. The Add button enables you to add devices to your account.
2. The Delete button enables you to remove devices from your account.
3. The table lists out all devices which are currently owned by this Customer Account.

Note that the table will be blank if you have no devices associated to this account.

Adding a Device

The section below explains how to add a device to your Customer Account.

1. Click the Devices tab.

Once you are at the Devices page, complete the following procedure to add the device to your account:

1. Click the Add button.

1. Enter the Device Name of your device.
2. Enter the Device Password of your device.
3. Select a Device Type for your device.
4. Click the Save button.

If the device is successfully added to your account you will see the following message: The following message means that another Customer Account already owns this device, and therefore you cannot add it to your own. The following message means that the Device Code you provided does not exist in the Arrayent Cloud database. You will need to contact Arrayent Support in order to get the Device Code registered in the Arrayent Cloud.

Deleting a Device

This section describes how to “delete” a device from a Customer Account using the Utility app. You must be logged in as the Customer Account that owns the device.

1. Click the Devices tab to go to the Devices Page of the Utility Tool.

1. Click the row containing the device which you want to delete. This will highlight the row.
2. Click the Delete button.

1. Click the Yes button to confirm the action.

Montior and Control Page Overview

The screenshot and descriptions below summarize the main components of the Monitor and Control page.

1. The Device Code dropdown menu enables you to select which device you want to monitor and control. Once you select a device, the table of the Monitor and Control page updates to display that device’s information. All of the information that you see on the Monitor and Control page is the information for this particular device.
2. The number next to the label Device ID is the Device ID of the currently displayed device. This is a random, unique integer that the Arrayent Cloud generates for the device.
3. The text next to the label Device Type is the Device Type of the currently displayed device. This is the device data model.
4. The Attribute Name of the column lists out the name of the device’s attributes. Each attribute gets a row.
5. The Active Value column displays the current value of this attribute or operation.
6. The Update Time column displays a timestamp indicating when this attribute was last updated.
7. Attributes that have been defined as time-series attributes will have a View History button in the last column. If this column is empty, then the attribute has not been defined as a time series attribute.
8. Clicking the View History button takes you to a separate view of the Monitor and Control page, which will enable you to view the history of the attribute either as a chart or a table. The View History button is only available for Device Attributes that have been defined as time-series.

Monitoring and Controlling Devices

Accessing the Monitor and Control Page

The Device Monitor and Control features of the Utility app are accessed via the Monitor and Control page. To access that page:

1. Click the Monitor and Control tab to go to the Monitor and Control Page of the Utility Tool.

Selecting Devices

The Monitor and Control page of the Utlity app only enables you to monitor and control one device at a time. Follow the instructions below to learn how to switch between devices.

1. Click the Device Code dropdown menu.The dropdown menu will display all devices currently owned by this user account.

1. Select the device which you wish to monitor and control from the dropdown menu.

The Utility app will refresh the Monitor and Control page to display the device that you selected. After you select a device, all of the information that you see on the Monitor and Control page only applies to this particular device.

Controlling Devices

When you define an attribute using the Configurator, you specify the direction of the attribute. Attributes that have been defined as “To Device”, meaning they are sent from the device to the cloud, will be displayed on the Utility app as editable fields. Integer and string attributes are represented as text fields. Boolean attributes are represented as radio buttons. You use these text fields and radio buttons to update the values of your devices attributes. To change the values of integer and string attributes, follow the instructions below:

1. Click the button that looks like a pencil.

1. Enter the new value in the text field.
2. Click the button that looks like a checkmark.

To change the value of boolean attributes, follow the instructions below:

1. Click the radio button to change the value of the attribute.

Viewing Time Series Data

This section describes how to interact with time series data using the Utility app. The Time Series page of the Utility app is accessed via the Monitor and Control page. To access the Monitor and Control page:

1. Click the Monitor and Control tab to go to the Monitor and Control Page of the Utility Tool.

The user interface that enables you to interact with Time Series data is called the “Time Series page” of the Utility App. Complete the following steps to access the Time Series page:

1. In the last column of the Device Monitor and Control table, click the View History button next to the attribute that you want to view.

The Time Series page only displays one time series attribute of a single device at a time. You can see which attribute of which device is currently being displayed by looking at the Device section. If you want to view the time series data for a particular time frame, follow the instructions below:

1. In the section labelled Date Range click the text box next to From:. This text box enables you to select the beginning of the time range that will be displayed, down to the minute. See below for more information on using this interface.
2. Click Done when you have finished setting up the starting point for the time range.
3. Click on the text box next to To: and repeat steps one and two above. This text box enables you to select the end of the time range that will be displayed.
4. Click Generate Graph when finished configuring the time range.

The screenshot and description below explain how to configure the time range:

1. The two caret symbols at top enable you to toggle between months. Click the left caret to go back in time a month. Click the right caret to go forward a month.
2. The list of numbers represents the days for the currently displayed month. Click on one of these numbers to select a particular day.
3. The two sliderbars enable you to select the hour and minute.
4. Click Done when finished to store your changes. Remember that you still need to click Generate Graph after this in order to actually generate the time series data onto the Utility app.

You can also view the time series data as a table, rather than a graph. To view time series data as a table:

1. Click the Table button.

You can click Graph to return to the graphical view of the time series data.

Creating Alerts

This section describes how to create alerts using the Utility app. The Create Alerts feature of the Utility app is located on the Alerts page. To access the Alerts page:

1. Click the Alerts tab to go to the Alerts page of the Utility Tool.

Once you are at the Alerts page, complete the following procedure to create a new alert:

1. Click the Add button.This will bring up the Create Alerts form.

Repeat the procedure above every time that you want to create a new alert. The remainder of this section explains how to use the Create Alert form to configure your alert.

1. Select the device which the alert applies to.
2. Select the action which you want the Arrayent Cloud to execute when the alert is triggered.Note that the user interface of the form will change if you specify Mobile Notification or Attribute as your action. These are discussed in the sections below.
3. Select the attribute of the device which the alert applies to.
4. Select the comparison operator which you want the Arrayent Cloud to use when it compares the attribute value against the threshold value.
5. Enter the threshold value.
6. If you are creating an HTML Email or Email alert, enter the email address which will receive the notification. If you are creating a SMS alert, enter the phone number which will receive the notification. Leave the Address field blank if you are creating a Mobile Notification alert or Attribute alert.The format for phone numbers is a plus sign character (‘+’), followed by the country code, followed by the phone number. E.g. “+16503334444” (omit the quotes).
7. If you are creating an HTML Email, Email, or SMS alert, enter the message which you want to send to the recipient of the notification. Leave this blank if you are creating an Attribute alert.
8. Select the checkbox to enable Auto Disarm. Deselect the checkbox to disable Auto Disarm.
9. Select the checkbox to enable Auto-Delete. Deselect the checkbox to disable Auto Delete.
10. Select the checkbox to enable the alert. Deselect the checkbox to disable the alert.
11. Select the checkbox to enable the Auto-Disable feature. Deselect the checkbox to disable the Auto Disable feature.
12. If you are creating a push notification alert or attribute alert, see the instructions below before completing this last step.Click Save.

Editing Alerts

This section explains how to edit an alert using the Utility app. The Edit Alerts feature of the Utility app is located on the Alerts page. To access the Alerts page:

1. Click the Alerts tab to go to the Alerts page of the Utility Tool.

Once you are at the Alerts page, complete the following procedure to edit the alert:

1. Click on the row containing the alert you wish to edit. This will highlight the row.
2. Click the Edit button.

1. Edit the alert as needed.
2. Click Save when finished.

Deleting Alerts

This section explains how to delete an alert using the Utility app. The Delete Alert feature of the Utility app is located on the Alerts page. To access the Alerts page:

1. Click the Alerts tab to go to the Alerts page of the Utility Tool.

Once you are at the Alerts page, complete the following procedure to delete an alert:

1. Click the row containing the alert you wish to delete. This will highlight the row.
2. Click the Delete button.

Resetting Alerts

The Reset button of the Utility app enables you to bypass the Auto Disarm functionality of the Arrayent Cloud and manually “re-arm” an alert. The Reset Alert feature of the Utility app is located on the Alerts page. To access the Alerts page:

1. Click the Alerts tab to go to the Alerts page of the Utility Tool.

You can view the armed status of an alert by looking at the “Disarmed” column of the table that contains all the alerts that you have defined. Complete the following procedure to reset an alert:

1. Click the row containing the alert you wish to reset. This will highlight the row.
2. Click the Reset button.

Creating Scheduled Alerts

See Scheduled Alerts Guide

Changing a Username

This section describes how to change a user account username using the Utility app. The Change Username feature of the Utility app is located on the Customer Info page. To access that page:

1. Click the Customer Info tab to go to the Customer Info page of the Utility Tool.

Once you are at the Customer Info page, complete the following procedure to change your user account username:

1. Enter your new username in the textbox next to Customer Account Name.
2. Click Save.

After you change your username, you will be logged out of the Utility app.

Changing a Password

This section describes how to change a user account password using the Utility app. Note that you can only change the password of the account which you are currently logged in to the Utility app as. The change password form is located on the Customer Info page of the Utility app. To access that page:

1. Click the Customer Info tab to go to the Customer Info page of the Utility Tool.

Once you are at the Customer Info page, complete the following procedure to change your user account password:

1. Click the checkbox next to Save New Password.
2. Enter your new password in the textbox next to Customer Account Password.
3. Click Save.

Once you change the password for the user account, you will be logged out of the Utility app. The next time that you login to the Utility app as this user account, the Arrayent Cloud will expect the new password.

Changing User Attributes

This section describes how to change the current value of your user attributes using the Utility app. The Change User Attributes feature of the Utility app is located on the Customer Info page. To access that page:

1. Click the Customer Info tab to go to the Customer Info page of the Utility Tool.

On the right side of the Customer Info page you will see a form with the title Change Customer Account Attributes. Complete the following procedure to change the current value of each of these user attributes:

1. Edit your user attributes as needed.
2. Click Save.