Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Version 1.0

Last updated - March 3, 2023

Table of Contents

Table of Contents

...

This user guide introduces you to using and administering ClearBlade’s Intelligent Assets application. This overview section introduces Intelligent Assets, its use, and how data flows through the system. The rest of this document details how you can use the Intelligent Assets system for your business.

Intelligent Assets is ideal for many industries to track, monitor, control, and report on their operational activities.

Image Removed

...

Intelligent Assets is an out-of-the-box-ready application designed to be customizable for various use cases like tracking & monitoring railcars, controlling industrial equipment, reporting machine failures, and controlling microclimate environments. The application ingests raw data and makes it interpretable. The application requires no coding to configure any use case. It can extend and integrate data directly into existing business systems. This video will give you a better understanding of Intelligent Assets.

...

You may have view or edit privileges that allow you to look across all the instance’s defined assets and areas. This is valuable if you want to view specific equipment, see the state of an existing asset, etc.

...

With monitoring readily available, it is advantageous to create rules that automatically track when certain thresholds are reached, creating or triggering an event, and taking possible actions. The rules workflow allows for automating business processes and reduces the time required to monitor the assets to only what is essential.

...

As the data from assets and areas aggregate or build up information over time and events have occurred, reports allow for sharing that information in an easily consumable way. Reports can be customized weekly or monthly to show business stakeholders what is essential.

...

One of the most potent elements of the Intelligent Assets Application is to ingest data from a wide range of connected devices, make it relevant for you, and turn it into something your systems can process.

...

Intelligent Assets can also communicate with field devices, sending configuration and control commands to them. Note: this requires custom configuration.

...

Create your Intelligent Assets account.

Image Removed

You may also be invited to an existing instance via existing authorized users inside Intelligent Assets. You will receive this email:

Image Removed

1. Accept the invitation.

...

Image Removed

...

When you sign up for Intelligent Assets, there is a popup for a quick welcome tour of the solution. You can step through it, manage tour items to revisit later, or skip it altogether.

Image Removed

...

The Intelligent Asset’s homepage has a map showing the locations of assets and areas. Assets and areas can be searched and filtered by their types. This video describes how to navigate the homepage.

Image Removed

You can view your assets and areas here. Here is an example:

Image Removed

You can search and filter for what you are looking for by using the search,

...

, and filter,

...

. You can also switch from assets to areas by

clicking the dropdown. Input the rows you want to see within the rows field.

...

  1. Click this icon on the top right of the page

...

  1. :

...

Once done, click Search in Bounds on the top of the map.

Click the Controls icon to see other options. You can view the map in satellite mode,

...

, move to your specific location on the map,

...

, and view the page in full screen,

...

.

View your entities on the map. Specific icons mark them:

Image Removed

You can click on an entity to see its details:

Image Removed

...

Click

...

on the top right of the page.

Click Settings.

  1. Image Added

2. Click Settings.

3. You can update your profile and your preferences on this page:Image Removed

...

4. Click the Security tab on the left of the page to change your password:Image Removed

...

5. Click the System tab on the left of the page to view and modify the rest of your settings:

Image RemovedImage Removed

...

An asset is a device, equipment, or gateway to be monitored by the solution. An asset can belong to a single asset type that best matches the type’s characteristics. Click the asset to see the location and event history.

...

Click Assets,

...

, on the left menu.

Click the plus button,

...

, on the top right of the screen.

Fill out the information and click create:

Image Removed

Required values

...

Value

...

Definition

...

Type

...

Assign an asset type that is created previously

...

ID

...

The asset’s unique ID. Once this is created, it cannot be edited

...

Label

...

The asset’s name

...

Group

...

Grouped by related users, assets, and area

Optional values

...

Value

...

Definition

...

Children

...

Secondary assets that have been created previously

...

Owners

...

Email of the user(s) managing the asset

...

Image

...

The asset’s image to be kept on record

...

Last updated

...

Timestamp of the asset’s most recent update

...

Location updated

...

Timestamp of the asset’s location update

...

Latitude

...

The latitude of the asset’s map location

...

Longitude

The longitude of the asset’s map location

...

Description

...

The asset’s description

Here is an asset creation video.

...

Click Assets,

...

, on the left menu.

Your assets display. You can search,

...

, or filter,

...

the assets you are looking for.

Here is a test asset example:

Image Removed

Data information is listed within the data tab:

Image Removed

In this example, click the attribute history icon,

...

, to view the attribute’s history.

History information is listed within the history tab:

Image Removed

As can be seen, you can switch from plots to timeline maps or tables. You can

also specify a date range and search for certain attributes.

The controls information is listed within the controls tab:

Image Removed

Controls allow you to interact with and perform various actions on an asset (turn

on/off a light, request logs, etc.)

The events information is listed within the events tab:

Image Removed

The refresh icon on the top right of the table refreshes it. The ellipsis icon allows

you to edit the table’s columns.

You can add comments within the comments tab:

Image Removed

You can add an image within the images tab:

Image Removed

Click the simulate icon,

...

, on the top right of the asset’s page to simulate your asset.

...

Areas are similar to assets but include a geofence better defining their location in cartesian (XYZ) or polar (latitude/longitude) coordinates. Like assets, areas can be configured to have multiple types and rules that run against them. This is in addition to monitoring things like temperature and movement of assets inside or outside of them.

...

Click Areas,

...

, on the left menu.

Click the plus sign on the top right of the page to add a new area.

Fill out the information and click create:

...

Required values

...

Value

...

Definition

...

Geometry Type

...

The type of model view of the location (GPS, Indoor Model, and Indoor Area)

...

ID

...

The area’s unique ID

...

Label

...

The area’s name

...

Group

...

Grouped by related users, assets, and area

Optional values

...

Value

...

Definition

...

Type

...

Assign an area type that is created previously

...

Owners

...

Email of the user(s) managing the area

...

Last updated

...

Timestamp of the area’s most recent update

...

Image

...

An asset’s image to be kept on record

...

Latitude

...

The latitude of the area’s map location. Click the marker tool on the map to define this.

...

Longitude

...

The longitude of the area’s map location. Click the marker tool on the map to define this.

...

Polygon

...

An array of cartesian coordinates. Click the polygon tool on the map to define these.

...

Assets

...

The assets assigned to the area

...

Description

...

The area’s description

Here is a create area video tutorial.

...

Click Areas,

...

, on the left menu.

You can search,

...

, or filter,

...

the areas you are looking for.

Here is an example of an area that displays:

Image Removed

You can zoom in and out by clicking the plus and minus buttons on the top right of the map.

Click an area to view its details.

Click the controls icon,

...

, to view just a selected area or the map in satellite mode.

The area’s history can be seen by clicking on the history tab. This is an example of what it looks like when Plots is selected:

...

This is an example of what it looks like when Table is selected:

Image Removed

You can display the history by date range by selecting that field:

Image Removed

...

Rules allow you to define conditions that trigger events/alarms. For example, a rule could be defined to trigger an event when the internal temperature of a boiler is greater than 200 degrees. Rules can be associated with actions. An event is created when the rules engine detects the conditions of a rule are met. Upon creation of an event, an associated action can be triggered. Examples of actions are sending an email, sending an SMS message, sending data to a webhook, sending a message to Microsoft Teams, etc.

...

Click Rules,

...

, on the left menu.

Click the plus button on the top right of the page to add a rule.

Fill out the information and click Create:

Image Removed

...

Click Rules,

...

, on the left menu.

Search or filter a rule you are looking for.

Here is an example:

Image Removed

You can edit, clone, or delete the rule from the icons on the top right of it:

...

These videos will show you how to navigate through the Area rules:

Creating area rules

Testing area rules

Creating state rules

Testing state rules

...

Click Events,

...

, on the left menu.

You can search and filter the events you want to view.

Here is an example of an event that displays:

Image Removed

You can click on links (such as rules) to view the information within them.

...

The reports page is used to generate insights on your data. A report code service handles the logic for formatting the data retrieved from the database. Report code services can accept a time range to apply to database queries. Schedules on the reports page are used to regularly email the reports to relevant stakeholders.

...

Click Reports,

...

, on the left menu.

Click the plus button on the top right of the page and choose Heatmap or Advanced.

This page displays when you choose Heatmap:

Image Removed

Fill out the information and click Create Heatmap.

This page displays when you choose Advanced:

Image Removed

Fill out the information and click Schedules at the top of the page to enter schedule information:

Image Removed

Click Create when done entering information within the two tabs.

...

Click Reports,

...

, on the left menu.

Search or use the filter to find the reports you are looking for.

Here is a report example:

Image Removed

In this example, you can update the report’s settings and click Update Heatmap.

...

Click Dashboards,

...

, on the left menu.

Click the plus button on the top right of the screen.

Fill out the information and click create:

Image Removed

...

Click Dashboards,

...

, on the left menu.

Search or use the filter to find the dashboards you are looking for.

Here is a dashboard example:

Image Removed

Click on the Past 1 day button on the top right of the page to view information from a different time:

Image Removed

Specify the range and click apply:

...

Click the refresh button on the top right of the page,

...

, to refresh the dashboard.

You can specify the auto-refresh interval by clicking the arrow button next to it:

...

You can specify the dashboard groups by clicking the Groups dropdown:

...

Click on My Tab 2 to see different dashboard information.

Click the ellipsis icon on the top right of the page to delete the dashboard or view

its settings.

...

Click Device Config,

...

, on the left menu.

Click the plus icon on the top right of the screen.

Select the device type for the configuration you want to create.

Step through the configuration workflow to create and specify the required device configuration options. Here is an example configuration:

Image Removed

You can start from a new configuration, existing template, or uploaded file by clicking the respective button:

Image Removed

Choose whether to save the configuration as a template and click the next button.

In this example, click Enabled and fill out the information for the OPC UA (Unified Architecture) Connection Settings and click the next button:

Image Removed

You can apply the configuration to the devices on this page:

Image Removed

Click the save button when done.

...

Click Device Config,

...

, on the left menu.

Devices appear in the devices tab, and device config templates appear within the templates tab.

You can search for devices and templates as well as filter them.

...

Click Store,

...

, on the left menu to shop for bundles and products.

Click Shop Bundles to shop for bundles or Shop Products to shop for products:

Image Removed

This is what the Shop Products page looks like:

Image Removed

You can switch to shopping for bundles by clicking bundles at the top right of the page:

Image Removed

You can search and filter the products you are looking for:

Image Removed

Click the product you want to view or purchase.

The product’s details appear:

Image Removed

Click Add to Cart if you want to purchase the product.

Select Go to Cart if you are ready to make your purchase:

Image Removed

...