# Monitor data with AWS IoT SiteWise Monitor
Monitor data with AWS IoT SiteWise Monitor
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
You can use AWS IoT SiteWise to monitor the data from your processes, devices, and equipment by creating SiteWise Monitor web portals. SiteWise Monitor is a feature of AWS IoT SiteWise that you can use to create portals in the form of a managed web application. You can then use these portals to view and share your operational data. You can create projects with dashboards to visualize data from your processes, devices, and equipment that are connected to AWS IoT.
Domain experts, such as process engineers, can use these portals to quickly get insights into their operational data to understand device and equipment behavior.
The following is an example dashboard that displays data for a wind farm.
![\[A sample SiteWise Monitor dashboard.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/monitor-wind-farm-dashboard-console.png)
Because AWS IoT SiteWise captures data over time, you can use SiteWise Monitor to view operational data over time, or the last reported values at specific points in time. This lets you uncover insights that might otherwise be difficult to find.
## SiteWise Monitor roles
Four roles interact with SiteWise Monitor:
**AWS administrator**
The AWS administrator uses the AWS IoT SiteWise console to create portals. The AWS administrator can also assign portal administrators and add portal users. Portal administrators later assign portal users to projects as owners or viewers. The AWS administrator works exclusively in the AWS console.
**Portal administrator**
Each SiteWise Monitor portal has one or more portal administrators. Portal administrators use the portal to create projects that contain collections of assets and dashboards. The portal administrator then assigns assets and owners to each project. By controlling access to the project, portal administrators specify which assets that project owners and viewers can see.
**Project owner**
Each SiteWise Monitor project has owners. Project owners create visualizations in the form of dashboards to represent operational data in a consistent manner. When dashboards are ready to share, the project owner can invite viewers to the project. Project owners can also assign other owners to the project. Project owners can configure thresholds and notification settings for alarms.
**Project viewer**
Each SiteWise Monitor project has viewers. Project viewers can connect to the portal to view the dashboards that project owners created. In each dashboard, project viewers can adjust the time range to better understand operational data. Project viewers can only view dashboards in the projects to which they have access. Project viewers can acknowledge and snooze alarms.
Depending on your organization, the same person might perform multiple roles.
The following image illustrates how these four roles interact in the SiteWise Monitor portal.
![\[AWS IoT SiteWise Monitor roles and what they do.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/monitor-roles.png)
You can manage who has access to your data by using AWS IAM Identity Center or IAM. Your data users can sign in to SiteWise Monitor from a desktop or mobile browser using their IAM Identity Center or IAM credentials.
### SAML federation
IAM Identity Center and IAM support identity federation with [SAML (Security Assertion Markup Language) 2.0](https://wiki.oasis-open.org/security). SAML 2.0 is an open standard that many external identity providers (IdPs) use to authenticate users and pass their identity and security information to service providers (SPs). SPs are typically applications or services. SAML federation enables your SiteWise Monitor portal administrators and users to sign in to their assigned portals with external credentials, such as their corporate usernames and passwords.
You can configure IAM Identity Center and IAM to use SAML-based federation for access to your SiteWise Monitor portals.
IAM Identity Center
Your portal administrators and users can sign in to the AWS access portal with their corporate usernames and passwords. They can then navigate to their assigned SiteWise Monitor portals. IAM Identity Center uses certificates to set up a SAML trust relationship between your identity provider and AWS. For more information, [SCIM profile and SAML 2.0 implementation](https://docs.aws.amazon.com/singlesignon/latest/userguide/scim-profile-saml.html) in the *AWS IAM Identity Center User Guide*.
IAM
Your portal administrators and users can request temporary security credentials to access their assigned SiteWise Monitor portals. You create a SAML identity provider identity in IAM to set up a trust relationship between your identity provider and AWS. For more information, see [Using SAML-based federation for API access to AWS](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html#CreatingSAML-configuring), in the *IAM User Guide*.
Your portal administrators and users can sign in to your company's portal and select the option to go to the AWS Management console. They can then navigate to their assigned SiteWise Monitor portals. Your company's portal handles the exchange of trust between your identity provider and AWS. For more information, see [Enabling SAML 2.0 federated users to access the AWS Management Console](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-saml.html) in the *IAM User Guide*.
When adding users or administrators to the portal, avoid creating IAM policies that restrict user permissions, such as limited IP. Any attached policies with restricted permissions will not be able to connect to the AWS IoT SiteWise portal.
## SiteWise Monitor concepts
To use SiteWise Monitor, you should be familiar with the following concepts:
**Portal**
An AWS IoT SiteWise Monitor portal is a web application that you can use to visualize and share your AWS IoT SiteWise data. A portal has one or more administrators and contains zero or more projects.
**Project**
Each SiteWise Monitor portal contains a set of projects. Each project has a subset of your AWS IoT SiteWise assets associated with it. Project owners create one or more dashboards to provide a consistent way to view the data associated with those assets. Project owners can invite viewers to the project to allow them to view the assets and dashboards in the project. The project is the basic unit of sharing within SiteWise Monitor. Project owners can invite users who were given access to the portal by the AWS administrator. A user must have access to a portal before a project in that portal can be shared with that user.
**Asset**
When data is ingested into AWS IoT SiteWise from your industrial equipment, your devices, equipment, and processes are each represented as assets. Each asset has properties and alarms associated with it. The portal administrator assigns sets of assets to each project.
**Property**
Properties are time series data associated with assets. For example, a piece of equipment might have a serial number, a location, a make and model, and an install date. It might also have time series values for availability, performance, quality, temperature, pressure, and so on.
**Alarm**
Alarms monitor properties to identify when equipment is outside of its operating range. Each alarm defines a threshold and a property to monitor. When the property exceeds the threshold, the alarm becomes active and indicates that you or someone on your team should address the issue. Project owners can customize the thresholds and notification settings for alarms. Project viewers can acknowledge and snooze alarms, and they can leave a message with details about the alarm or the action that they took to address it.
**Dashboard**
Each project contains a set of dashboards. Dashboards provide a set of visualizations for the values of a set of assets. Project owners create the dashboards and the visualizations that it contains. When a project owner is ready to share the set of dashboards, the owner can invite viewers to the project, which gives them access to all dashboards in the project. If you want a different set of viewers for different dashboards, you must divide the dashboards between projects. When viewers look at dashboards, they can customize time range to look at specific data.
**Visualization**
In each dashboard, project owners decide how to display the properties and alarms of the assets associated with the project. Availability might be represented as a line chart, while other values might be displayed as bar charts or key performance indicators (KPIs). Alarms are best displayed as status grids and status timelines. Project owners customize each visualization to provide the best understanding of the data for that asset.
# Get started with AWS IoT SiteWise Monitor (Classic)
Get started with AWS IoT SiteWise Monitor (Classic)
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
If you're the AWS administrator for your organization, you create portals from the AWS IoT SiteWise console. Complete the following steps to create a portal so that members of your organization can view your AWS IoT SiteWise data:
1. Configure and create a portal
1. Add portal administrators and send invitation emails
1. Add portal users
After you create a portal, the portal administrator can view your AWS IoT SiteWise assets and assign them to projects in the portal. Project owners can then create dashboards to visualize the properties of the assets that help project viewers understand how your devices, processes, and equipment are performing.
**Note**
When adding users or administrators to the portal, avoid creating AWS Identity and Access Management (IAM) policies that restrict user permissions, such as limited IP. Any attached policies with restricted permissions will not be able to connect to the AWS IoT SiteWise portal.
You can follow a tutorial that walks through the steps required to set up a portal with a project, dashboards, and multiple users for a specific scenario using wind farm data. For more information, see [Visualize and share wind farm data in SiteWise Monitor](monitor-wind-farm.md).
**Topics**
+ [
# Create a portal in SiteWise Monitor
](monitor-create-portal.md)
+ [
# Configure your portal in SiteWise Monitor
](monitor-configure-portal.md)
+ [
# Invite administrators in SiteWise Monitor
](monitor-invite-administrators.md)
+ [
# Add portal users in SiteWise Monitor
](monitor-add-portal-users.md)
+ [
# Create AWS IoT SiteWise dashboards (AWS CLI)
](create-dashboards-using-aws-cli.md)
+ [
# Turn on alarms for your portals in AWS IoT SiteWise
](monitor-enable-alarms.md)
+ [
# Enabling your AWS IoT SiteWise portal at the edge
](monitor-enable-edge.md)
+ [
# Administer your SiteWise Monitor portals
](administer-portals.md)
# Create a portal in SiteWise Monitor
Create a portal
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
You create a SiteWise Monitor portal in the AWS IoT SiteWise console.
**To create a portal**
1. Sign in to the [AWS IoT SiteWise console](https://console.aws.amazon.com/iotsitewise/).
1. In the navigation pane, choose **Monitor**, **Getting started**.
![\[The left navigation pane of the AWS IoT SiteWise console with Getting started highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/sitewise-choose-monitor-getting-started-console.png)
1. Choose **Create Portal**.
![\[The AWS IoT SiteWise Monitor Getting started page with Create portal highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/sitewise-choose-create-portal-console.png)
Next, you must provide some basic information to configure your portal.
# Configure your portal in SiteWise Monitor
Configure your portal
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
Your users use portals to view your data. You can customize a portal's name, description, branding, user authentication, support contact email, and permissions.
![\[The "Portal configuration" page used to create a portal.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/PortalConfiguration.png)
**To configure a portal**
1. Enter a name for your portal.
1. (Optional) Enter a description for your portal. If you have multiple portals, use meaningful descriptions to help you keep track of what each portal contains.
1. (Optional) Upload an image to display your brand in the portal. Choose a square, PNG image. If you upload a non-square image, the portal scales the image down to a square.
1. Choose one of the following options:
+ Choose **IAM Identity Center** if your portal users sign in to this portal with their corporate user names and passwords.
If you haven't enabled IAM Identity Center in your account, do the following:
1. Choose **Create user**.
1. On the **Create user** page, to create the first portal, enter the user's email address, first name, and last name, and then choose **Create user**.
![\[Enable IAM Identity Center if you haven't enable IAM Identity Center in your AWS account.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/SSOUserCreation.png)
**Note**
AWS automatically enables IAM Identity Center in your account when you create the first portal user.
You can configure IAM Identity Center in only one Region at a time. SiteWise Monitor connects to the Region that you configured for IAM Identity Center. This means that you use one Region for IAM Identity Center access, but you can create portals in any Region.
+ Choose **IAM** if your portal users sign in to this portal with their IAM credentials.
**Important**
Users or roles must have the `iotsitewise:DescribePortal` permission to sign in to the portal.
1. Enter an email address that portal users can contact when they have an issue with the portal and need help to resolve it.
1. (Optional) Add tags for your portal. For more information, see [Tag your AWS IoT SiteWise resources](tag-resources.md).
1. Choose one of the following options:
+ Choose **Create and use a new service role**. By default, SiteWise Monitor automatically creates a service role for each portal. This role allows your portal users to access your AWS IoT SiteWise resources. For more information, see [Use service roles for AWS IoT SiteWise Monitor](monitor-service-role.md).
+ Choose **Use an existing service role**, and then choose the target role.
1. Choose **Next**
1. (Optional) Enable alarms for your portal. For more information, see [Turn on alarms for your portals in AWS IoT SiteWise](monitor-enable-alarms.md).
1. Choose **Create**. AWS IoT SiteWise will create your portal.
**Note**
If you close the console, you can finish the setup process by adding administrators and users. For more information, see [Add or remove portal administrators in AWS IoT SiteWise](portal-change-admins.md). If you don't want to keep this portal, delete it so it doesn't use resources. For more information, see [Delete a portal in AWS IoT SiteWise](portal-delete-portal.md).
The **Status** column can be one of the following values.
+ **CREATING** - AWS IoT SiteWise is processing your request to create the portal. This process can take several minutes to complete.
+ **UPDATING** - AWS IoT SiteWise is processing your request to update the portal. This process can take several minutes to complete.
+ **PENDING** - AWS IoT SiteWise is waiting for the DNS record propagation to finish. This process can take several minutes to complete. You can delete the portal while the status is **PENDING**.
+ **DELETING** - AWS IoT SiteWise is processing your request to delete the portal. This process can take several minutes to complete.
+ **ACTIVE** - When the portal becomes active, your portal users can access it.
+ **FAILED** - AWS IoT SiteWise couldn't process your request to create, update, or delete the portal. If you enabled AWS IoT SiteWise to send logs to Amazon CloudWatch Logs, you can use these logs to troubleshoot issues. For more information, see [ Monitoring AWS IoT SiteWise with CloudWatch Logs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-cloudwatch-logs.html).
A message appears when your portal is created.
![\[An example successful portal creation message.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/sitewise-create-portal-success-console.png)
Next, you must invite one or more portal administrators to the portal. So far, you created a portal but no one can access it.
# Invite administrators in SiteWise Monitor
Invite administrators
To get started in your new portal, you must assign a portal administrator. The portal administrator creates projects, chooses project owners, and assigns assets to projects. Portal administrators can see all of your AWS IoT SiteWise assets.
Based on the user authentication service, choose one of the following options:
------
#### [ IAM Identity Center ]
If you're using SiteWise Monitor for the first time, you can choose the user that you created earlier to be the portal administrator. If you want to add another user as a portal administrator, you can create an IAM Identity Center user from this page. Alternatively, you can connect an external identity provider to IAM Identity Center. For more information, see the [AWS IAM Identity Center User Guide](https://docs.aws.amazon.com/singlesignon/latest/userguide/).
**To invite administrators**
1. Select the check boxes for the users that you want as your portal administrators. This adds the users to the **Portal administrators** list.
**Note**
If you use IAM Identity Center as your identity store, and you're signed in to your AWS Organizations management account, you can choose **Create user** to create an IAM Identity Center user. IAM Identity Center sends the new user an email for them to set their password. You can then assign the user to the portal as an administrator. For more information, see [Manage identities in IAM Identity Center](https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-identity-source-sso.html).
1. (Optional) Choose **Send invite to selected users**. Your email client opens, and an invitation is populated in the message body.
You can customize the email before you send it to your portal administrators. You can also send the email to your portal administrators later. If you're trying SiteWise Monitor for the first time and adding your new IAM Identity Center or IAM user or role as the portal administrator, you don't need to email yourself.
1. If you add a user that you don't want as an administrator, clear the check box for that user.
1. When you're finished inviting portal administrators, choose **Next**.
------
#### [ IAM ]
You can choose a user or role to be the portal administrator. If you want to add another user or role as a portal administrator, you can create a user or role in the IAM console. For more information, see [Creating an IAM user in your AWS account](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html) and [Creating IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html) in the *IAM User Guide*.
**To invite administrators**
1. Do the following:
+ Choose **IAM users** to add an IAM user as your portal administrator.
+ Choose **IAM roles** to add an IAM role as your portal administrator.
1. Select the check boxes for the users or roles that you want as your portal administrators. This adds the users or roles to the **Portal administrators** list.
1. If you add a user or role that you don't want as an administrator, clear the check box for that user or role.
1. When you're finished inviting portal administrators, choose **Next**.
**Important**
Users or roles must have the `iotsitewise:DescribePortal` permission to sign in to the portal.
**Note**
If you use IAM Identity Center as your identity store, and you're signed in to your AWS Organizations management account, you can choose **Create user** to create an IAM Identity Center user. IAM Identity Center sends the new user an email for them to set their password. You can then assign the user to the portal as an administrator. For more information, see [Manage identities in IAM Identity Center](https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-identity-source-sso.html).
------
You can change the list of portal administrators later. For more information, see [Add or remove portal administrators in AWS IoT SiteWise](portal-change-admins.md).
**Note**
Because only a portal administrator can create projects and assign assets to them, you should specify at least one portal administrator.
As the last step, you add users who can access your new portal.
# Add portal users in SiteWise Monitor
Add portal users
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
You control which users have access to your portals. In each portal, the portal administrators create one or more projects and assign portal users as owners or viewers for each project. Each project owner can invite additional portal users to own or view the project.
Based on the user authentication service, choose one of the following options:
------
#### [ IAM Identity Center ]
If you want to add a user to the **Users** list, complete the following steps.
**To add portal users**
1. Choose users from the **Users** list to add to the portal. This adds the users to the **Portal users** list. If you're using SiteWise Monitor for the first time, you don't need to add your portal administrator as a portal user.
**Note**
If you use IAM Identity Center as your identity store, and you're signed in to your AWS Organizations management account, you can choose **Create user** to create an IAM Identity Center user. IAM Identity Center sends the new user an email for them to set their password. You can then assign the user to the portal as a user. For more information, see [Manage identities in IAM Identity Center](https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-identity-source-sso.html).
1. If you add a user that you don't want to have access to the portal, clear the check box for that user.
1. When you're finished selecting users, choose **Assign users**.
![\[The assign IAM Identity Center users step of the portal creation process.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/SSOUserAssign.png)
------
#### [ IAM ]
If you see the user or role that you want to add in the **IAM users** or **IAM roles** list, complete the following steps.
**To add portal users**
1. Do the following options:
+ Choose **IAM users** to add an IAM user as a portal user.
+ Choose **IAM roles** to add an IAM role as a portal user.
If you're using SiteWise Monitor for the first time, you don't need to add your portal administrator as a portal user.
1. Select the check boxes for the users or roles that you want as portal users. This adds the users or roles to the **Portal users** list.
1. If you add a user that you don't want to have access to the portal, clear the check box for that user.
1. When you're finished selecting users, choose **Assign users**.
**Important**
Users or roles must have the `iotsitewise:DescribePortal` permission to sign in to the portal.
![\[The assign IAM users step of the portal creation process.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/IAMUserAssign.png)
![\[The assign IAM step of the portal creation process.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/IAMRoleAssign.png)
------
Congratulations\$1 You successfully created a portal, assigned portal administrators, and assigned users who can use that portal when invited to do so. Your portal administrators can now create projects and add assets to those projects. Then, your project owners can create dashboards to visualize the data for each project's assets.
You can change the list of portal users later. For more information, see [Add or remove portal users in AWS IoT SiteWise](portal-change-users.md).
If you need to make changes to the portal, see [Administer your SiteWise Monitor portals](administer-portals.md).
To get started in the portal, see [Getting started](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/getting-started.html) in the *SiteWise Monitor Application Guide*.
# Create AWS IoT SiteWise dashboards (AWS CLI)
Create dashboards (CLI)
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
When you define visualizations (or widgets) in dashboards using the AWS CLI, you must specify the following information in the `dashboardDefinition` JSON document. This definition is a parameter of the [CreateDashboard](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateDashboard.html) and [UpdateDashboard](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateDashboard.html) operations.
`widgets`
A list of widget definition structures that each contain the following information:
`type`
The type of widget. AWS IoT SiteWise provides the following widget types:
+ `sc-line-chart` – A line chart. For more information, see [Line charts](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/choose-visualization-types.html#line-charts) in the *AWS IoT SiteWise Monitor Application Guide*.
+ `sc-scatter-chart` – A scatter chart. For more information, see [Scatter charts](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/choose-visualization-types.html#scatter-charts) in the *AWS IoT SiteWise Monitor Application Guide*.
+ `sc-bar-chart` – A bar chart. For more information, see [Bar charts](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/choose-visualization-types.html#bar-charts) in the *AWS IoT SiteWise Monitor Application Guide*.
+ `sc-status-grid` – A status widget that shows the latest value of asset properties as a grid. For more information, see [Status widgets](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/choose-visualization-types.html#status-widgets) in the *AWS IoT SiteWise Monitor Application Guide*.
+ `sc-status-timeline` – A status widget that shows the historical values of asset properties as a timeline. For more information, see [Status widgets](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/choose-visualization-types.html#status-widgets) in the *AWS IoT SiteWise Monitor Application Guide*.
+ `sc-kpi` – A key performance indicator (KPI) visualization. For more information, see [KPI widgets](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/choose-visualization-types.html#kpi-charts) in the *AWS IoT SiteWise Monitor Application Guide*.
+ `sc-table` – A table widget. For more information, see [Table widgets](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/choose-visualization-types.html#table-widgets) in the *AWS IoT SiteWise Monitor Application Guide*.
`title`
The title of the widget.
`x`
The horizontal position of the widget, starting from the left of the grid. This value refers to the widget's position in the dashboard's grid.
`y`
The vertical position of the widget, starting from the top of the grid. This value refers to the widget's position in the dashboard's grid.
`width`
The width of the widget, expressed in number of spaces on the dashboard's grid.
`height`
The height of the widget, expressed in number of spaces on the dashboard's grid.
`metrics`
A list of metric structures that each define a data stream for this widget. Each structure in the list must contain the following information:
`label`
A label to display for this metric.
`type`
The type of data source for this metric. AWS IoT SiteWise provides the following metric types:
+ `iotsitewise` – The dashboard fetches data for an asset property in AWS IoT SiteWise. If you choose this option, you must define `assetId` and `propertyId` for this metric.
`assetId`
(Optional) The ID of an asset in AWS IoT SiteWise.
This field is required if you choose `iotsitewise` for `type` in this metric.
`propertyId`
(Optional) The ID of an asset property in AWS IoT SiteWise.
This field is required if you choose `iotsitewise` for `type` in this metric.
`analysis`
(Optional) A structure that defines the analysis, such as trend lines, to display for the widget. For more information, see [Configuring trend lines](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/configure-trend-lines.html) in the *AWS IoT SiteWise Monitor Application Guide*. You can add one of each type of trend line per property in the widget. The analysis structure contains the following information:
`trends`
(Optional) A list of trend structures that each define a trend analysis for this widget. Each structure in the list contains the following information:
`type`
The type of trend line. Choose the following option:
+ `linear-regression` – Display a linear regression line. SiteWise Monitor uses the [least squares](https://en.wikipedia.org/wiki/Least_squares) method to calculate the linear regression.
`annotations`
(Optional) An annotations structure that defines thresholds for the widget. For more information, see [Configuring thresholds](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/configure-thresholds.html) in the *AWS IoT SiteWise Monitor Application Guide*. You can add up to six annotations per widget. The annotations structure contains the following information:
`y`
(Optional) A list of annotation structures that each define a horizontal threshold for this widget. Each structure in the list contains the following information:
`comparisonOperator`
The comparison operator for the threshold. Choose one of the following:
+ `LT` – Highlight properties that have at least one data point less than the `value`.
+ `GT` – Highlight properties that have at least one data point greater than the `value`.
+ `LTE` – Highlight properties that have at least one data point less than or equal to the `value`.
+ `GTE` – Highlight properties that have at least one data point greater than or equal to the `value`.
+ `EQ` – Highlight properties that have at least one data point equal to the `value`.
`value`
The threshold value to compare data points with the `comparisonOperator`.
`color`
(Optional) The 6-digit hexadecimal code of the threshold color. The visualization displays property legends in this color for properties with at least one data point that meets the threshold rule. Defaults to black (`#000000`).
`showValue`
(Optional) Whether or not to show the value of the threshold in the margins of the widget. Defaults to `true`.
`properties`
(Optional) A flat dictionary of properties for the widget. The members of this structure are context-dependent. AWS IoT SiteWise provides the following widgets that use `properties`:
+ [Line charts](#monitor-line-chart), [scatter charts](#monitor-scatter-chart), and [bar charts](#monitor-bar-chart) have the following property:
`colorDataAcrossThresholds`
(Optional) Whether or not to change the color of the data that crosses the thresholds in this widget. When you enable this option, the data that crosses a threshold appears in the color that you choose. Defaults to `true`.
+ [Status grids](#monitor-status-grid) have the following property:
`labels`
(Optional) A structure that defines the labels to display on the status grid. The labels structure contains the following information:
`showValue`
(Optional) Whether or not to display the unit and value for each asset property in this widget. Defaults to `true`.
**Example dashboard definition**
The following example defines a dashboard from a payload stored in a JSON file.
```
aws iotsitewise create-dashboard \
--project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE \
--dashboard-name "Wind Farm Dashboard" \
--dashboard-definition file://dashboard-definition.json
```
The following JSON example for `dashboard-definition.json` defines dashboard with the following visualization widgets:
+ A line chart that visualizes total wind farm power in the upper left of the dashboard. This line chart includes a threshold that indicates when the wind farm outputs less power than its minimum expected output. This line chart also includes a linear regression trend line.
+ A bar chart that visualizes wind speed for four turbines in the upper right of the dashboard.
This example represents line and bar chart visualizations on a dashboard. This dashboard is similar to the [example wind farm dashboard](monitor-data.md).
```
{
"widgets": [
{
"type": "sc-line-chart",
"title": "Total Average Power",
"x": 0,
"y": 0,
"height": 3,
"width": 3,
"metrics": [
{
"label": "Power",
"type": "iotsitewise",
"assetId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
"propertyId": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
"analysis": {
"trends": [
{
"type": "linear-regression"
}
]
}
}
],
"annotations": {
"y": [
{
"comparisonOperator": "LT",
"value": 20000,
"color": "#D13212",
"showValue": true
}
]
}
},
{
"type": "sc-bar-chart",
"title": "Wind Speed",
"x": 3,
"y": 3,
"height": 3,
"width": 3,
"metrics": [
{
"label": "Turbine 1",
"type": "iotsitewise",
"assetId": "a1b2c3d4-5678-90ab-cdef-2a2a2EXAMPLE",
"propertyId": "a1b2c3d4-5678-90ab-cdef-55555EXAMPLE"
},
{
"label": "Turbine 2",
"type": "iotsitewise",
"assetId": "a1b2c3d4-5678-90ab-cdef-2b2b2EXAMPLE",
"propertyId": "a1b2c3d4-5678-90ab-cdef-55555EXAMPLE"
},
{
"label": "Turbine 3",
"type": "iotsitewise",
"assetId": "a1b2c3d4-5678-90ab-cdef-2c2c2EXAMPLE",
"propertyId": "a1b2c3d4-5678-90ab-cdef-55555EXAMPLE"
},
{
"label": "Turbine 4",
"type": "iotsitewise",
"assetId": "a1b2c3d4-5678-90ab-cdef-2d2d2EXAMPLE",
"propertyId": "a1b2c3d4-5678-90ab-cdef-55555EXAMPLE"
}
]
}
]
}
```
# Turn on alarms for your portals in AWS IoT SiteWise
Turn on alarms for your portals
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
**Note**
End of support notice: AWS ended support for AWS IoT Events. For more information, see [AWS IoT Events end of support](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html).
You can enable the alarms feature supported by AWS IoT Events for your portals so that portal administrators can create, edit, and delete AWS IoT Events alarm models in your SiteWise Monitor portals. Project owners can configure alarms. Project viewers can view alarm details. This section explains how you can use the AWS IoT SiteWise console to enable the alarms feature for your portals.
**Important**
You can't create external alarms in your portals.
If you want to send alarm notifications, you must choose IAM Identity Center for the user authentication service.
The alarm notifications feature isn't available in the China (Beijing) AWS Region.
When you configure and create a portal, you can enable alarms and alarm notifications in **Step 2 Additional features**. Based on the user authentication service, choose one of the following options:
------
#### [ IAM Identity Center ]
![\[Additional features page for enabling alarms for portals.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/portal-create-console-enable-alarms-sso.png)
**To enable alarms for a portal**
1. (Optional) Choose **Enable alarms**.
1. For **AWS IoT SiteWise access role**, use an existing role or create a role with the required permissions. This role requires the `iotevents:BatchPutMessage` permission and a trust relationship that allows `iot.amazonaws.com` and `iotevents.amazonaws.com` to assume the role.
1. (Optional) Choose **Enable alarm notifications**.
1. For **Sender**, choose the sender.
**Important**
You must verify the sender email address in Amazon SES. For more information, see [Verifying email addresses in Amazon SES](https://docs.aws.amazon.com/ses/latest/dg/verify-addresses-and-domains.html), in the *Amazon Simple Email Service Developer Guide*.
1. For **AWS Lambda role**, use an existing role or create a role with the required permissions. This role requires the `lambda:InvokeFunction` and `sso-directory:DescribeUser`permissions and a trust relationship that allows `iotevents.amazonaws.com` and `lambda.amazonaws.com` to assume the role.
1. For **AWS Lambda functions**, choose an existing Lambda function or create a function that manages alarm notifications. For more information, see [Managing alarm notifications](https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html) in the *AWS IoT Events Developer Guide*.
------
#### [ IAM ]
![\[Additional features page for enabling alarms for portals.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/portal-create-console-enable-alarms-iam.png)
**To enable alarms for a portal**
+ (Optional) Choose **Enable alarms**.
1. For **AWS IoT SiteWise access role**, use an existing role or create a role with the required permissions. This role requires the `iotevents:BatchPutMessage` permission and a trust relationship that allows `iot.amazonaws.com` and `iotevents.amazonaws.com` to assume the role.
------
For more information about alarms in SiteWise Monitor, see [Monitoring with alarms](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html) in the *AWS IoT SiteWise Application Guide*.
# Enabling your AWS IoT SiteWise portal at the edge
Enable your portal at the edge
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
After you enable your portal at the edge, this portal is available on all SiteWise Edge gateways with the data processing pack enabled in your account.
**To enable the portal at the edge**
1. In the **Edge configuration** section, turn on **Enable this portal at the edge**.
1. Choose **Create**.
# Administer your SiteWise Monitor portals
Administer your portals
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
You have the ability to manage and configure various aspects of the portal. This includes adding and removing users or administrators, setting user permissions and roles, customizing the portal's URL, name, setting a support contact information, and sending email invitations to portal administrators.
1. Sign in to the [AWS IoT SiteWise console](https://console.aws.amazon.com/iotsitewise/home).
1. In the navigation pane, choose **Monitor**, **Portals**.
![\[Left navigation pane in the AWS IoT SiteWise console with Portals highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/sitewise-choose-portals-console.png)
1. Choose a portal, and then choose **View details** (or choose the portal's **Name**).
1. You can perform any of the following administrative tasks:
+ [Change portal details in AWS IoT SiteWise](portal-change-details.md)
+ [Add or remove portal administrators in AWS IoT SiteWise](portal-change-admins.md)
+ [Send email invitations to portal administrators](send-email-invitations-to-portal.md)
+ [Add or remove portal users in AWS IoT SiteWise](portal-change-users.md)
+ [Delete a portal in AWS IoT SiteWise](portal-delete-portal.md)
For information about how to create a portal, see [Get started with AWS IoT SiteWise Monitor (Classic)](monitor-getting-started.md).
**Topics**
+ [
# Change portal details in AWS IoT SiteWise
](portal-change-details.md)
+ [
# Add or remove portal administrators in AWS IoT SiteWise
](portal-change-admins.md)
+ [
# Send email invitations to portal administrators
](send-email-invitations-to-portal.md)
+ [
# Add or remove portal users in AWS IoT SiteWise
](portal-change-users.md)
+ [
# Delete a portal in AWS IoT SiteWise
](portal-delete-portal.md)
# Change portal details in AWS IoT SiteWise
Change a portal's attributes
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
You can change a portal's name, description, branding, support email, and permissions.
1. On the portal details page, in the **Portal details** section, choose **Edit**.
![\[Portal details section of the portal details page with Edit highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/sitewise-view-portal-details-console.png)
1. Update the **Name**, **Description**, **Portal branding**, **Support contact email**, or **Permissions**.
1. When you're finished, choose **Save**.
# Add or remove portal administrators in AWS IoT SiteWise
Add or remove portal administrators
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
In a few steps, you can add or remove users as administrators for a portal. Based on the user authentication service, choose one of the following options.
------
#### [ IAM Identity Center ]
![\[Portal administrators section of the portal details page.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/SSOAdminDetail.png)
**To add portal administrators**
1. On the portal details page, in the **Portal administrators** section, choose **Assign administrators**.
1. On the **Assign administrators** page, select the check boxes for the users to add to the portal as administrators.
**Note**
If you use IAM Identity Center as your identity store, and you're signed in to your AWS Organizations management account, you can choose **Create user** to create an IAM Identity Center user. IAM Identity Center sends the new user an email for them to set their password. You can then assign the user to the portal as an administrator. For more information, see [Manage identities in IAM Identity Center](https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-identity-source-sso.html).
1. Choose **Assign administrators**.
![\[The "Assign administrators" page.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/SSOAdminAssign.png)
**To remove portal administrators**
+ On the portal details page, in the **Portal administrators** section, select the check box for each user to remove, and then choose **Remove from portal**.
**Note**
We recommend that you select at least one portal administrator.
------
#### [ IAM ]
![\[Portal administrators section of the portal details page.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/IAMAdminDetail.png)
**To add portal administrators**
1. On the portal details page, in the **Portal administrators** section, choose **Assign administrators**.
1. On the **Assign administrators** page, do the following:
+ Choose **IAM users**, if you want to add an IAM user as your portal administrator.
+ Choose **IAM roles**, if you want to add an IAM role as your portal administrator.
1. Select the check boxes for the users or roles that you want as your portal administrators. This adds the users or roles to the **Portal administrators** list.
1. Choose **Assign administrators**.
**Important**
Users or roles must have the `iotsitewise:DescribePortal` permission to sign in to the portal.
![\[The "Assign administrators" page.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/IAMUserAdminAssign.png)
![\[The "Assign administrators" page.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/IAMRoleAdminAssign.png)
**To remove portal administrators**
+ On the portal details page, in the **Portal administrators** section, select the check box for each user to remove, and then choose **Remove from portal**.
**Note**
Leaving a portal without a portal administrator is not recommended.
------
# Send email invitations to portal administrators
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
You can send email invitations to portal administrators.
1. On the portal details page, in the **Portal administrators** section, select the check boxes for the portal administrators.
![\[Portal administrators section of the portal details page with "Send invitations" highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/sitewise-select-portal-administrator-console.png)
1. Choose **Send invitations**. Your email client opens, and an invitation is populated in the message body.
You can customize the email before you send it to your portal administrators.
# Add or remove portal users in AWS IoT SiteWise
Add or remove portal users
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
You choose which users have access to your portals. Portal users appear in the list of users within a SiteWise Monitor portal. From this list, portal administrators can add project owners, and project owners can add project viewers.
**Note**
Your portal administrators and portal users might contact you through a portal's support email if they need you to add or remove a user.
Based on the user authentication service, choose one of the following options.
------
#### [ IAM Identity Center ]
![\[Portal administrators section of the portal details page.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/SSOUserDetail.png)
**To add portal users**
1. On the portal details page, in the **Portal users** section, choose **Assign users**.
1. On the **Assign users** page, select the check box for the users to add to the portal.
**Note**
If you use IAM Identity Center as your identity store, and you're signed in to your AWS Organizations management account, you can choose **Create user** to create an IAM Identity Center user. IAM Identity Center sends the new user an email for them to set their password. You can then assign the user to the portal as a user. For more information, see [Manage identities in IAM Identity Center](https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-identity-source-sso.html).
1. Choose **Assign users**.
![\[The "Assign users" page.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/SSOUserAssign2.png)
**To remove portal users**
+ On the portal details page, in the **Portal users** section, select the check box for the users to remove from the portal, and then choose **Remove from portal**.
------
#### [ IAM ]
![\[Portal administrators section of the portal details page.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/IAMRoleUserDetail.png)
**To add portal users**
1. On the portal details page, in the **Portal users** section, choose **Assign users**.
1. On the **Assign users** page, do the following:
+ Choose **IAM users** to add an IAM user as your portal user.
+ Choose **IAM roles** to add an IAM role as your portal user.
1. Select the check boxes for the users or roles that you want to add as your portal users. This adds the users or roles to the **Portal users** list.
1. Choose **Assign users**.
![\[The "Assign users" page.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/IAMUserAssign2.png)
![\[The "Assign users" page.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/IAMRoleAssign2.png)
**To remove portal users**
+ On the portal details page, in the **Portal users** section, select the check box for the users to remove from the portal, and then choose **Remove from portal**.
**Important**
Users or roles must have the `iotsitewise:DescribePortal` permission to sign in to the portal.
------
# Delete a portal in AWS IoT SiteWise
Delete a portal
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
You might delete a portal if you created it for testing purposes or if you created a duplicate of a portal that already exists.
**Note**
You must first manually delete all dashboards and projects in a portal before you can delete a portal. For more information, see [Deleting projects](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/delete-projects.html) and [Deleting dashboards](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/delete-dashboards.html) in the *SiteWise Monitor Application Guide*.
1. On the portal details page, choose **Delete**.
**Important**
When you delete a portal, you lose all projects that the portal contains, and all dashboards in each project. This action can't be undone. Your asset data isn't affected.
![\[Portal details page with Delete highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/sitewise-delete-portal-console.png)
1. In the **Delete portals** dialog box, choose **Remove admins and users**.
You must remove the administrators and users from a portal before you can delete it. If your portal doesn't have administrators or users, the button doesn't appear, and you can skip to the next step.
![\["Delete portals" dialog box with "Remove administrators and users" highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/sitewise-delete-portal-remove-users-console.png)
1. If you're sure that you want to delete the entire portal, enter **delete** in the field to confirm deletion.
![\["Delete portals" dialog box with "Delete" highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/sitewise-delete-portal-confirm-delete-console.png)
1. Choose **Delete**.
# Get started with AWS IoT SiteWise Monitor (AI-aware) - *preview*
Get started with AWS IoT SiteWise Monitor (AI-aware)
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
As an AWS administrator for your organization, you can create portals from the AWS IoT SiteWise console, enabling members of your organization to view your AWS IoT SiteWise data. Complete the following steps to get started.
1. Configure and create a portal.
1. Add portal administrators and send invitation emails.
1. Add portal users.
After you create a portal, the portal administrator can create projects and add user to the project. Project members then create dashboards to visualize the connected data on AWS IoT SiteWise, enable them to monitor how their connected devices, processes, and equipment are performing.
**Note**
When adding users or administrators to the portal, avoid creating AWS Identity and Access Management (IAM) policies that restrict user permissions, such as limited IP. Any attached policies with restricted permissions will not be able to connect to the AWS IoT SiteWise portal.
Create projects to share with your teams. Project owners can then create dashboards to visualize the properties of the assets that helps project viewers understand how devices, processes, and equipment are performing. It also provides a consistent view of operations to your teams.
Dashboards help visualize and understand your project data. It helps businesses and application users keep track of their AWS IoT devices and data. Choose a visualization type that best displays your data for your needs. Rearrange and re-size visualizations to create a layout that fits your team. Explore your device, process, and equipment assets and data, and quickly identify issues and improve operational efficiency.
**Topics**
+ [
# Create a portal
](monitor-create-ai-portal.md)
+ [
# Configure your portal
](monitor-configure-ai-portal.md)
+ [
# Administer your portals
](administer-portals-ai.md)
+ [
# Delete a portal
](portal-delete-portal-ai.md)
+ [
# Create dashboards with AWS CLI
](create-dashboards-ai-dashboard-cli.md)
+ [
# Portal login
](portal-login.md)
+ [
# Create a project
](create-project.md)
+ [
# Update a project
](edit-project.md)
+ [
# Delete a project
](delete-project.md)
+ [
# Create a dashboard
](create-dashboard.md)
+ [
# Update a dashboard
](update-dashboard.md)
+ [
# Delete a dashboard
](delete-dashboard.md)
+ [
# Configure dashboard
](configure-dashboard.md)
# Create a portal
Create a portal
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
You create a SiteWise Monitor portal in the AWS IoT SiteWise console.
**To create a portal**
1. Sign in to the [AWS IoT SiteWise console](https://console.aws.amazon.com/iotsitewise/).
1. In the navigation pane, choose **Monitor**, **Get started**.
1. Choose **Create portal (AI-aware)**.
![\[The AWS IoT SiteWise Monitor Getting started page with Create portal highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-create-portal-console.png)
Next, you must provide some basic information to configure your portal.
# Configure your portal
Configure your portal
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
Your users use portals to view your data. You can customize a portal's name, description, branding, user authentication, support contact email, and permissions.
**Steps to configure a portal:**
1. Enter a name for your portal.
1. (Optional) Enter a description for your portal. If you have multiple portals, use meaningful descriptions to help you keep track of what each portal contains.
1. (Optional) Upload an image to display your brand in the portal. Choose a square, PNG image. If you upload a non-square image, the portal scales the image down to a square.
1. Enter an email address in the **Support contact email** box for support issues.
1. In the **User authentication** box, choose the following option:
+ Choose **IAM Identity Center** if your portal users sign in to this portal with their corporate user names and passwords.
If you haven't enabled IAM Identity Center in your account, do the following:
1. Choose **Create user**.
1. On the **Create user** page, to create the first portal, enter the user's email address, first name, and last name, and then choose **Create user**.
**Note**
Support for IAM credentials is coming soon.
1. Choose from one of the following options in the **Service access** section:
+ Choose **Create and use a new service role**. By default, SiteWise Monitor automatically creates a service role for each portal. This role allows your portal users to access your AWS IoT SiteWise resources. For more information, see [Use service roles for AWS IoT SiteWise Monitor](monitor-service-role.md).
+ Choose **Use an existing service role**, and then choose the target role.
1. Choose to enable the AWS IoT SiteWise Assistant for this portal. The AWS IoT SiteWise Assistant provides fast data analysis, real-time insights, and guided recommendations.
**Note**
Enabling the AWS IoT SiteWise Assistant will incur charges. To use enterprise level knowledge solutions and guidance, you must have a dataset associated with Amazon Kendra index.
1. (Optional) Add tags for your portal. For more information, see [Tag your AWS IoT SiteWise resources](tag-resources.md).
1. Choose **Create portal**. AWS IoT SiteWise will create your portal.
**Note**
If you close the console, you can finish the setup process by adding administrators and users. For more information, see [Add or remove portal administrators](portal-change-admins-ai.md). If you don't want to keep this portal, delete it so it doesn't use resources. For more information, see [Delete a portal](portal-delete-portal-ai.md).
A message appears when your portal is created.
![\[An example successful portal creation message.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-sitewise-create-portal-success-console.png)
Once a portal is created, it is listed in the **Portals** section. The **Portal details** section lists the name, description, ID, URL, status, last updated and created dates, portal branding and support email for each portal.
The **Status** column can be one of the following values.
+ **CREATING** ‐ AWS IoT SiteWise is processing your request to create the portal. This process can take several minutes to complete.
+ **UPDATING** ‐ AWS IoT SiteWise is processing your request to update the portal. This process can take several minutes to complete.
+ **PENDING** ‐ AWS IoT SiteWise is waiting for the DNS record propagation to finish. This process can take several minutes to complete. You can delete the portal while the status is **PENDING**.
+ **DELETING** ‐ AWS IoT SiteWise is processing your request to delete the portal. This process can take several minutes to complete.
+ **ACTIVE** ‐ When the portal becomes active, your portal users can access it.
+ **FAILED** ‐ AWS IoT SiteWise couldn't process your request to create, update, or delete the portal. If you enabled AWS IoT SiteWise to send logs to Amazon CloudWatch Logs, you can use these logs to troubleshoot issues. For more information, see [ Monitoring AWS IoT SiteWise with CloudWatch Logs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-cloudwatch-logs.html).
# Administer your portals
Administer your portals
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
You have the ability to manage and configure various aspects of the portal. This includes adding and removing administrators, setting permissions and roles, customizing the name, description, setting up support email, and inviting to portal administrators.
1. Sign in to the [AWS IoT SiteWise console](https://console.aws.amazon.com/iotsitewise/home).
1. In the navigation pane, choose **Monitor**, **Portals**.
![\[Left navigation pane in the AWS IoT SiteWise console with Portals highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-sitewise-choose-portals-console.png)
1. Choose a portal, and then choose **Open portal** (or choose the portal's **Name**).
1. You can perform any of the following administrative tasks:
+ [Edit portal attributes](portal-change-details-ai.md)
+ [Add or remove portal administrators](portal-change-admins-ai.md)
+ [Send email invitations to portal administrators](send-email-invitations-to-portal.md)
+ [Delete a portal in AWS IoT SiteWise](portal-delete-portal.md)
# Edit portal attributes
Edit portal attributes
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
You can change a portal's name, description, branding, support email, and service access.
1. On the portal details page, in the **Portal details** section, choose **Edit**.
![\[Portal details section of the portal details page with Edit highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-sitewise-view-portal-details-console.png)
1. Update the **Name**, **Description**, **Portal branding**, **Support contact email**, **AWS IoT SiteWise Assistant** or **Service access**.
1. When you're finished, choose **Save changes**.
# Add or remove portal administrators
Add or remove portal administrators
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
In a few steps, you can add or remove users as administrators for a portal. Based on the user authentication service, choose one of the following options.
------
#### [ IAM Identity Center ]
![\[Portal administrators section of the portal details page.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-SSOAdminDetail.png)
**To add portal administrators**
1. On the portal details page, in the **Administrators** section, choose **Assign administrators**.
1. On the **Assign administrators** page, select the users to add to the portal as administrators.
**Note**
If you use IAM Identity Center as your identity store, and you're signed in to your AWS Organizations management account, you can choose **Create user** to create an IAM Identity Center user. IAM Identity Center sends the new user an email for them to set their password. You can then assign the user to the portal as an administrator. For more information, see [Manage identities in IAM Identity Center](https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-identity-source-sso.html).
1. Choose **Assign administrators**.
![\[The "Assign administrators" page.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-SSOAdminAssign.png)
**To remove portal administrators**
+ On the portal details page, in the **Portal administrators** section, select the check box for each user to remove, and then choose **Remove from portal**.
**Note**
The **Administrators(\$1)** lists the number of administrators for the portal. You can add multiple portal administrators to manage and work on projects.
------
# Send email invitations to portal administrators
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
You can send email invitations to portal administrators.
1. On the portal details page, in the **Administrators** section, select the check boxes for the portal administrators.
1. Choose **Send invitations**. Your email client opens, and an invitation is populated in the message body.
You can customize the email before you send it to your portal administrators.
# Delete a portal
Delete a portal
You might delete a portal if you created it for testing purposes or if you created a duplicate of a portal that already exists.
**Note**
You must first manually delete all dashboards and projects in a portal before you can delete a portal.
1. On the portal details page, choose **Delete**.
**Important**
When you delete a portal, you lose all projects that the portal contains, and all dashboards in each project. This action can't be undone. Your asset data isn't affected.
![\[Portal details page with Delete highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-sitewise-delete-portal-console.png)
1. In the **Delete portal** dialog box, choose **Remove admins and users**.
You must remove the administrators and users from a portal before you can delete it. If your portal doesn't have administrators or users, the button doesn't appear, and you can skip to the next step.
1. If you're sure that you want to delete the entire portal, enter **confirm** in the field to confirm deletion.
1. Choose **Delete**.
# Create dashboards with AWS CLI
Create dashboards with AWS CLI
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
When you define visualizations (or widgets) in dashboards using the AWS CLI, you must specify the following information in the `dashboardDefinition` JSON document. This definition is a parameter of the [CreateDashboard](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateDashboard.html) and [UpdateDashboard](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateDashboard.html) operations.
`displaySettings`
The display settings with the following parameters:
+ `numRows` – Number of rows in the dashboard layout. Each row is **cellSize** wide.
+ `numColumbs` – Number of columns in the dashboard layout. Each column is **cellSize** wide.
+ `cellSize` – (Optional) The size of a cell in the layout in pixels. It must be a positive number. Default is 10.
+ `significantDigits` – (Optional) Number of significan digits to display in the dashboard. Default is 4.
`querySettings`
The query information with the following parameter:
+ `refreshRate` – (Optional) The rate at which data refreshes in milliseconds. Accepts the following values - 1000, 5000, 10000, 60000, 300000.
`defaultViewport`
If not supplied, defaults to the last five minutes. Contains the following parameters:
+ `duration` – (Optional) Determines how far into the past to query data starting from the present time.
+ `start` – (Optional) It is of type Date. The start time range to query data. Needs an `end` date specified.
+ `end` – (Optional) It is of type Date. The end time range to query data. Needs an `start` date specified.
`widgets`
A list of widget definition structures that contain the following information:
`type`
The type of widget. AWS IoT SiteWise provides the following widget types:
+ `xy-plot` – A line chart or a scatter plot depending on the configuration.
+ `bar-chart` – A bar chart.
+ `kpi-chart` – A key performance indicator chart.
+ `status-timeline` – A status widget that visualizes and navigates time series data from one or more data sources.
+ `text` – A text widget.
+ `table` – A table widget.
`id`
An unique identifier for the widget.
`x`
The horizontal position of the widget, starting from the left of the dashboard. This value refers to the widget's position in the dashboard's grid.
`y`
The vertical position of the widget, starting from the top of the dashboard. This value refers to the widget's position in the dashboard's grid.
`z`
The relative ordering of the widgets. A larger Z value widget is displayed in front of the lower Z value widget, if they overlap.
`width`
The width of the widget, expressed in number of cells on the dashboard.
`height`
The height of the widget, expressed in number of cells on the dashboard.
`properties`
A list of properties of the widget. It varies by the type of widget. See [IoT App Kit](https://awslabs.github.io/iot-app-kit/?path=/docs/components-statustimeline--docs) for details.
**Example dashboard definition**
The following example defines a dashboard from a payload stored in a JSON file.
```
aws iotsitewise create-dashboard \
--project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE \
--dashboard-name "Example Dashboard" \
--dashboard-definition file://dashboard-definition.json
```
The following JSON example for `dashboard-definition.json` defines dashboard with the following visualization widgets:
```
{
"displaySettings": {
"numColumns": 200,
"numRows": 1000,
"cellSize": 20,
"significantDigits": 4
},
"widgets": [{
"id": "Ot73JcxUoc6oEXAMPLE",
"type": "xy-plot",
"width": 33,
"height": 20,
"x": 0,
"y": 0,
"z": 0,
"properties": {
"aggregationType": "AVERAGE",
"queryConfig": {
"source": "iotsitewise",
"query": {
"assets": [{
"assetId": "97c97abf-e883-47bb-a3f4-EXAMPLE",
"properties": [{
"propertyId": "97cc61f4-57a4-4c5f-a82c-EXAMPLE",
"refId": "692ce941-f3d9-4074-a297-EXAMPLE",
"aggregationType": "AVERAGE",
"color": "#7d2105",
"resolution": "1m"
}]
}],
"properties": [],
"assetModels": [],
"alarms": [],
"alarmModels": []
}
},
"line": {
"connectionStyle": "linear",
"style": "solid"
},
"symbol": {
"style": "filled-circle"
},
"axis": {
"yVisible": true,
"xVisible": true
},
"legend": {
"visible": true,
"position": "right",
"width": "30%",
"height": "30%",
"visibleContent": {
"unit": true,
"asset": true,
"latestValue": true,
"latestAlarmStateValue": true,
"maxValue": false,
"minValue": false
}
}
}
}, {
"id": "fto7rF40Ny1EXAMPLE-G",
"type": "bar-chart",
"width": 33,
"height": 20,
"x": 0,
"y": 20,
"z": 0,
"properties": {
"aggregationType": "AVERAGE",
"queryConfig": {
"source": "iotsitewise",
"query": {
"assets": [{
"assetId": "97c97abf-e883-47bb-a3f4-EXAMPLE",
"properties": [{
"propertyId": "c84ca8f3-3dea-478a-afec-EXAMPLE",
"aggregationType": "AVERAGE",
"refId": "2960b958-2034-4d6e-bcc2-EXAMPLE"
}]
}],
"properties": [],
"assetModels": [],
"alarms": [],
"alarmModels": [],
"requestSettings": {
"aggregation": "AVERAGE"
}
}
},
"axis": {
"showX": true,
"showY": true
},
"styleSettings": {
"2960b958-2034-4d6e-bcc2-360f1f02e505": {
"color": "#7d2105"
}
}
}
}],
"querySettings": {
"refreshRate": 5000
}
}
```
# Portal login
Portal login
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
**User login**
1. On your browser, enter the application URL.
1. Input your user name and password and click the **Sign in** button.
1. You are now logged into the application.
![\[The IoT dashboard Login page with Create project and Create dashboard.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-dashboard-homepage.png)
# Create a project
Create a project
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
**Create project**
1. A project is created in two ways:
1. In the Home page, in the **Welcome** section under **Quick start**, choose **Create project**.
1. From the left navigation pane, choose **Projects**. Choose **Create** in the top right hand corner to create a project.
1. In the **Create Projects** section, enter a **Project name**, and give an optional **Description**.
1. Choose **Create**.
![\[The IoT dashboard Project page with Create highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-dashboard-project.png)
# Update a project
Update a project
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
**Edit project**
1. Choose the **Update** button on the top right hand corner of the **Project** page, to edit project details.
1. Change the name of the project by editing **Project name**.
1. Change the description of the project by editing the **Description** details.
1. Select **Update** to save your changes.
![\[The IoT dashboard Project details page with Update highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-dashboard-project-update.png)
# Delete a project
Delete a project
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
**Delete project**
1. You can only delete the project after all the dashboards in the project are deleted.
1. Select the **Delete** button on the top right of the **Project** page.
1. Confirm again that you want to delete the project.
1. Select **Delete** to delete the project.
![\[The IoT dashboard Project details page with Delete highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-dashboard-project-delete.png)
# Create a dashboard
Create a dashboard
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
**Create a dashboard**
1. Create a dashboard in two ways:
1. Create a dashboard from **Build a dashboard** in the **Home** page.
1. To create the dashboard in an existing project, choose a project name from the drop down menu in the **Choose a project to host the dashboard**.
1. If you don’t have a project, choose **Create project** and select **Confirm**.
![\[The IoT dashboard Create dashboard page with Create highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-new-project-create-dash.png)
1. Create a dashboard from a project in the **Projects** section, under **Dashboards**.
![\[The IoT dashboard Create dashboard page with Create highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-existing-project-new-dash-create.png)
1. Select **Create** in the upper right corner.
1. Enter a **Dashboard name**, and give an optional **Dashboard description**.
1. Select **Create**.
![\[The IoT dashboard Create dashboard page with Create highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-existing-project-new-dash-name.png)
1. Configure your newly created dashboard.
# Update a dashboard
Update a dashboard
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
The **Dashboards** section lists the dashboards in the project. Select a dashboard from the list.
**Update a dashboard**
1. Select a dashboard to update.
![\[The IoT dashboard Dashboards page with Update highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-dashboard-choose-update.png)
1. Update the **Dashboard name ** and optionally the **Dashboard description**. Select **Update** to save changes.
![\[The IoT dashboard Dashboards page with update text.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-dashboard-update.png)
# Delete a dashboard
Delete a dashboard
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
The **Dashboards** section lists the dashboards in the project. Select a dashboard from the list.
**Delete a dashboard**
1. Select a dashboard to delete.
![\[The IoT dashboard Dashboards page with Delete highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-dashboard-choose-delete.png)
1. Select **Delete** to delete the dashboard. This cannot be undone.
# Configure dashboard
Configure dashboard
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
The **Dashboards** section lists the dashboards in the project. Select a dashboard from the list. The **Edit** mode allows you to configure your dashboard by adding widgets and configuring them. The **Preview** button lets you visualize your changes.
![\[The IoT dashboard Project page with Edit highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-dashboard-edit.png)
Steps to configure your dashboard:
+ Drag and drop different type of data widgets to the dashboard canvas for data visualization.
+ Add data to the desired widgets, from the **Resource explorer** on the left. The **Resource explorer** consists of **Modeled**, **Unmodeled**, and **Dynamic assets** sections. Search by asset name or property name. Select the property to add and choose **Add**.
+ Fine tune the layout and style by changing the **Configurations** on widgets. Configure components including title, thresholds and other configuration specifics.
+ Configure the time range over which data is displayed.
+ Choose the time range over which data is displayed. Choose a **Time range** and **Refresh rate** from the top right hand corner, and personalize the range. Choose a rate at which the data is to be refreshed from the menu.
+ Select the **Time range** on a widget, by using your trackball mouse scroll wheel or Right-click. This moves the time range of display.
+ Choose **Save**.
**Topics**
+ [
# Resource explorer
](resource-exp.md)
+ [
# Widgets
](dashboard-widgets.md)
+ [
# Configure widgets
](dashboard-widgets-conf.md)
+ [
# Use widgets
](dashboard-widgets-manip.md)
+ [
# Alarms in widgets
](alarm-widgets.md)
+ [
# AWS IoT SiteWise Assistant use in widgets
](assistant-widgets.md)
+ [
# Sample questions to ask AWS IoT SiteWise Assistant
](assistant-questions.md)
# Resource explorer
Resource explorer
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
This section describes **Modeled**, **Unmodeled**, and **Dynamic assets**. Choose assets from any of the three and add them to your widgets and visualize them.
**Topics**
+ [
# Modeled
](resource-exp-modeled.md)
+ [
# Unmodeled
](resource-exp-unmodeled.md)
+ [
# Dynamic assets
](resource-exp-dynamic.md)
# Modeled
Modeled
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
This section describes the process of selecting and visualization of modeled assets.
## Selection of assets
Selection of assets
Assets can be queried as follows:
+ Search for an asset name. Use a wildcard `*`. For example, `Wind*` returns asset names that start with the text `Wind`. You must [integrate with AWS IoT TwinMaker](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/sql.html#prereqs) to avail this feature.
+ All assets are listed by default.
From the assets listed, filter by name, description, ID, or asset model ID. Select one asset to list its properties (data streams) and alarms.
### Data stream selection
Selection of data stream assets
Data streams are listed below the **Data Streams** menu. Filter the data streams listed by [Property](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Property.html) metadata in the *https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/*. Select one or more data streams depending on the selected widget.
+ **KPI** and **Gauge** support only a single data stream.
+ The remaining widgets support multiple data streams with multi-selection.
### Alarm selection
Selection of alarm assets
AWS IoT SiteWise alarms are listed below the **Alarm Data Streams** menu. Filter the alarm data streams listed by alarm metadata. **name**, **input property**, and **composite model ID** are some metadata used for filtering. Select one or more data streams depending on the selected widget.
+ **KPI** and **Gauge** support only a single alarm.
+ The remaining widgets support multiple alarms with multi-selection.
## Modeled assets visualization
Modeled assets visualization
1. Drag the widget to the canvas. Select the properties for each widget panel to construct a dashboard.
1. The **Filter** option filters the assets to choose the asset to visualize. Filtering is done by text, property or value. Filtering is for assets loaded into the browser, and not backend filtering.
1. **Search** to list an asset to add to your widget.
1. **Add** the asset to the widget in the canvas.
1. Choose **Reset** to select another asset, or make modifications to the asset chosen.
1. Save the dashboard. In the **Preview** mode, choose different assets from the drop down menu to monitor the properties under each asset without reconstructing the data panels.
**Note**
The configuration settings wheel on the right hand side displays **Preferences** for the user to choose like **Page size**, **Sticky first columns**, **Sticky last columns**, and **Column preferences**. Customize your preferences, and choose **Confirm** to apply the changes.
![\[The IoT dashboard Project page with modeled assets shown.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-dashboard-modeled-assets.png)
# Unmodeled
Unmodeled
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
This section describes searching for unmodeled data streams and adding them to the widgets to visualize.
**Unmodeled data streams visualization**
1. Drag the widget to the canvas. Select the properties for each widget panel to construct a dashboard.
1. Unmodeled data streams are listed under the **Time series** section. They have properties that are customizable.
1. The **Filter** option filters the data streams to visualize. Filtering is for data streams loaded into the browser, and not back end filtering.
1. **Add** the data stream to the widget in the canvas.
1. Choose **Reset** to deselect the data stream.
1. Save the dashboard. In the **Preview** mode, choose different assets from the drop down menu to monitor the properties under each asset without reconstructing the data panels.
**Note**
The configuration settings wheel on the right hand side displays **Preferences** for the user to choose like **Page size**, **Sticky first columns**, **Sticky last columns**, and **Column preferences**. Customize your preferences, and choose **Confirm** to apply the changes.
![\[The IoT dashboard Project page with unmodeled assets shown.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-dashboard-unmodeled-assets.png)
# Dynamic assets
Dynamic assets
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
The new SiteWise Monitor allows customers to dynamically switch assets for a selected asset model. You can visualize properties from different assets by selecting from a drop down menu.
**Dynamic assets visualization**
1. Choose the **Dynamic assets** tab on the resource explorer.
1. Select an **Asset model** to list assets for from the drop down menu.
1. Select the **Default asset** from the drop down menu.
1. Choose **Set asset model** to select the asset model.
1. Save the dashboard. In the **Preview** mode, choose different assets from the drop down menu to monitor the properties under each asset, without reconstructing the data panels.
![\[The IoT dashboard Project page with dynamic assets shown.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-dashboard-dynamic-assets.png)
# Widgets
Widgets
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
Widgets supports a wide range of features, including alarms, high-performance live-streaming, and smooth synchronization with other IoT App Kit components. The dashboard supports the following widgets:
+ **Line** – The Line widget is a visualization widget that displays trends and changes over time. It consists of a series of data points, each represented by a dot or marker, connected by straight line segments to create a line graph. It supports a wide range of features, including alarms, thresholds, high-performance live-streaming, and smooth synchronization with other IoT App Kit components. This widget is customizable to communicate complex data clearly and concisely.
+ **Bar chart** – The Bar chart is a powerful visualization tool that displays time-series data. It supports a wide range of features, including alarms, high-performance live-streaming, and smooth synchronization with other IoT App Kit components.
+ **Timeline** – The Timeline widget provides a way to visualize and navigate time series data from data sources. It is unique for displaying data stream values are distinct colors on the timeline. It supports a rich set of features including alarms, high performance live-streaming and smooth syncing across other IoT App Kit components. It is best used for displaying non-numerical data types/
+ **KPI** – The Key Performance Indicator (KPI) component provides a compact representation of an overview of your asset properties. It supports alarms and thresholds. This overview provides critical insights into the overall performance of your devices, equipment, and processes. KPI only supports a single data stream or alarm, and not multiple data streams.
+ **Gauge** – The Gauge component provides a compact representation of an overview of your asset properties. It is used to visualize critical insights into the overall performance of your devices, equipment, or processes. It is functionally the same as KPI, but visually different. Gauge displays the data stream value, threshold, and range of values. You can interact with AWS IoT data from one or more data sources with Gauge.
+ **Table** – The Table component provides a compact form for viewing one or more data streams from one or more time series data sources. It displays assets with **Property**, **Latest value** and **Unit** in a tabular form. Supports AWS IoT SiteWise alarms.
+ **Text** – The Text widget helps write text with various colors and fonts. You can create a link by associating a text with an URL. The **Properties** and **Thresholds** fields are not enabled for this widget.
![\[The IoT dashboard Project page with widgets shown.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-dashboard-widget-list.png)
# Configure widgets
Configure widgets
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
Once the widget is added to the dashboard, you can configure the widget by choosing the **Configuration** icon in the right panel.
+ **Style** – Add a title in the **Widget title**. Different widgets have different configurations. A few examples are listed below.
+ **Bar** widget :
+ **Resolution and Aggregation** – Set values for resolution and aggregation here.
+ **Format data** – Set **Decimal places** to the number of decimals to display.
+ **Display style** – Select values to display.
+ **Axis** – Choose to display the axis.
+ **Line** widget :
+ **Resolution and Aggregation** – Set values for resolution and aggregation here.
+ **Format data** – Set **Decimal places** to the number of decimals to display.
+ **Y-axis** – Add a **Label**, and **Min** and **Max**values.
+ **Widget style** – Select **Line type**, **Line style**, **Line thickness**, and ** Data point shape**values.
+ **Legend** – Choose **Alignment**, and **Display**.
+ **Gauge** widget :
+ **Resolution and Aggregation** – Set values for resolution and aggregation here.
+ **Format data** – Set **Decimal places** to the number of decimals to display.
+ **Display style** – Select values to display.
+ **Y-axis** – Add a **Label**, and **Min** and **Max** values.
+ **Fonts** – Select **Font size**, **Unit font size**, and **Label font size** values.
![\[The IoT dashboard widget configuration page with style shown.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-dashboard-widget-style.png)
+ **Properties** – All the properties of widgets are listed in this section. Different widgets have different properties. A few examples are listed below.
+ **Line** widget :
+ **Label** – Choose to use the default datastream name or give a new name.
+ **Style** – Set **Line type**, **Line style** to the number of decimals to display.
+ **Y-axis** – Select values to default style, show Y-axis controls and set the **Min** and **Max** values.
+ **Table** widget :
+ **Label** – Choose to use the default datastream name or give a new name.
+ **Table** widget :
+ **Label** – Choose to use the default datastream name or give a new name.
![\[The IoT dashboard widget configuration page with properties shown.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-dashboard-widget-properties.png)
+ **Thresholds** – Add a **Threshold** for a widget. Different widgets have different configurations. A few examples are listed below.
+ **Bar chart** widget :
+ Choose **Add a threshold** to add to the widget.
+ Choose **Operator** and give a **Value** for the threshold. Customize the threshold with a color from the color palette.
+ You can choose to apply the threshold across all data.
+ **Line** widget :
+ Choose **Add a threshold** to add to the widget.
+ Choose **Operator** and give a **Value** for the threshold. Customize the threshold with a color from the color palette.
+ Choose how to **Show thresholds** from the drop down menu.
+ **Gauge** widget :
+ Choose **Add a threshold** to add to the widget.
+ Choose **Operator** and give a **Value** for the threshold. Customize the threshold with a color from the color palette.
![\[The IoT dashboard widget configuration page with style shown.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-dashboard-widget-thresh.png)
# Use widgets
Use widgets
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
You can use widgets in the dashboard individually or by multi-selecting them.
## Edit widgets in the dashboard
Edit widgets
Choose a single widget and edit it. To edit multiple widgets in the dashboard, **Shift \$1 Left-click** and select all the widgets in the dashboard. Once selected, users can add new data-streams, and modify **Widget title** in the **Style** configuration settings. The title is changed for all the widgets in the dashboard.
**Right-click** on the canvas, and do the following:
+ **Copy** – Add a copy of the widget to the canvas.
+ **Delete** – Delete the widget.
+ **Bring to front** – Bring the selected widget to the front of the canvas.
+ **Send to back** – Send the selected widget to the back of the canvas.
## Resize widgets
Resize widgets
Re-size widgets individually, or in a group by multi-selecting the widgets in the dashboard.
To change the size of widgets:
+ To change the size of a single widget, select the widget, and drag it by a corner to change its size.
+ To change the size of multiple widgets, select multiple widgets by **Shift \$1 Left-click**, and drag it by a corner to change its size.
## Delete widgets in the dashboard
Delete widgets
Delete widgets individually, or in a group by multi-selecting the widgets in the dashboard.
To delete widgets:
+ To delete a single widget, select the widget, and **Right-click** and choose **Delete**. You can also select, and click **X** on the right hand top corner to delete the widget.
+ To delete multiple widgets, select multiple widgets by **Shift \$1 Left-click**, then **Right-click** and choose **Delete**.
# Alarms in widgets
Alarms in widgets
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
Alarms alert you and your team when equipment or processes perform sub-optimally. Optimal performance of a machine or process means that the values for certain metrics should be within a range of high and low limits. When these metrics are outside their operating range, equipment operators must be notified so that they can fix the issue. Alarms help you quickly identify issues and notify operators to maximize performance of your equipment and processes.
You can find an alarm associated with an asset in the **Modeled** tab of the **Resource explorer**.
+ Search for and select an asset.
+ Scroll down past the **Data Streams** table to the **Alarm Data Streams** section and expand it.
+ Select an alarm in the **Alarms** table and choose **Add**.
**Topics**
+ [
# Alarms in different widgets
](alarm-in-different-widgets.md)
# Alarms in different widgets
Alarms in different widgets
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
For all widgets:
+ Data stream property settings are dependent on what type of property is added to a widget. Data stream properties have full property setting support while alarm properties do not currently allow property setting configurations.
+ If you add an alarm data stream, its associated input property data stream is added to the chart as well. If you remove the alarm data stream, then its input property is also removed.
+ To individually control the input property data stream of an alarm, you must **add them both** separately.
The below examples state how some widgets use alarms.
+ **Line Chart**
+ The alarm and its input property data stream are added to the chart.
+ You can see alarm state in the chart legend, and as icons hovering over the data stream when the alarm changes state.
+ You can toggle off alarm icons from the chart settings.
![\[The alarms in a linechart widget.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-dashboard-chart-settings.png)
+ **KPI** and **Gauge**
+ The alarm and its input property data stream are added to the chosen widget.
+ The alarm threshold is added to the widget, which changes color based on its configuration.
+ You can select the alarm state on the widget, see the alarm details, and click **Generate summary** to call the AWS IoT SiteWise to get an alarm summary.
![\[The alarms in a KPI and Gauge widget.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-dashboard-gauge-settings.png)
+ **Table**
+ The alarm and its input property are added as a row on the table.
+ **Bar chart**
+ The alarm is added as a threshold to the chart, which changes the color of any data stream breaching the threshold.
+ You can add any associated data streams separately.
+ You cannot interact with the AWS IoT SiteWise Assistant from the widget.
![\[The alarms in a Bar chart widget.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-dashboard-bar-settings.png)
+ **Status timeline**
+ The alarm is added as a threshold to the timeline.
+ Adding the alarm state and its input property data to the timeline is work in progress.
+ You cannot interact with the AWS IoT SiteWise Assistant from the widget.
# AWS IoT SiteWise Assistant use in widgets
AWS IoT SiteWise Assistant use in widgets
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
The AWS IoT SiteWise Assistant is a generative AI-powered assistant. It allows users like plant managers, quality engineers, and maintenance technicians to gain insights, solve problems, and take actions directly from their operational and enterprise data. The AWS IoT SiteWise Assistant consolidates information from AWS IoT data, asset models, manuals and documentation into understandable summaries of critical events. It also enables interactive deep dive question and answer sessions for easy diagnosis, root cause explorations and guided recommendations.
The AWS IoT SiteWise Assistant button is on the top right corner of the dashboard. Click on it to activate the Assistant. Can only be used with the **Preview** mode of the dashboard.
![\[Assistant widget in dashboard\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-dashboard-assistant.png)
Use the AWS IoT SiteWise Assistant in the following scenarios:
**Topics**
+ [
# Use case - Alarm summaries
](assistant-widgets-alarm.md)
+ [
# Use case - Situational summaries
](assistant-widgets-situation.md)
+ [
# Use case - Deep dive summaries
](assistant-widgets-deepdive.md)
# Use case - Alarm summaries
Use case - Alarm summaries
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
Summarize the current alarm for a selected panel on the dashboard. Alarms are supported by **Line, KPI, Gauge** and **Table** widgets. Choose a widget with an alarm and summarize it.
+ Select **Active alarm** on widget.
+ The **Severity** and **Rule expression** is displayed for the alarm.
+ Choose **Generate summary** to generate a summary.
![\[alarm summarization in gauge widget in dashboard\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-dashboard-alarm-summary.png)
# Use case - Situational summaries
Use case - Situational summaries
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
Select up to three widgets to summarize. They can be a combination of widgets and properties. If more than three are selected, the Assistant returns an error.
**Generate a situation summary with AWS IoT SiteWise Assistant**
1. Click on **AI Assistant**. It displays a menu with three options.
1. **Items selected** – Select only three. You cannot select more than three.
1. **Clear all** – Clear your selection.
1. **Generate summary** – Generate a summary about items selected.
1. Choose **Generate summary** to generate the summary about the selected items.
The image below has a widget selected and a summary from the AWS IoT SiteWise Assistant.
![\[sitatuation summarization in gauge widget in dashboard\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-dashboard-situation-summary.png)
# Use case - Deep dive summaries
Use case - Deep dive summaries
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
This is the use case where the user can do a deep dive, and access SOPs (Standard Operation Procedure), manuals, documentation, and consider next steps of action. For the example in the previous section, if the user chooses to learn more about the SOP for this property, ask the Assistant about the SOP for this property. This displays the deep dive information about SOP to the user.
The example below displays the answer for "**Is there any SOP for the alarm windSpeedAlarm?**"
![\[deep dive summarization in gauge widget in dashboard\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/ai-dashboard-deepdive-summary.png)
# Sample questions to ask AWS IoT SiteWise Assistant
Sample questions to ask AWS IoT SiteWise Assistant
**Note**
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).
**Note**
The AWS IoT SiteWise Assistant must use a dataset with an [Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/what-is-kendra.html) index for enterprise level knowledge and guidance. If you do not have a Amazon Kendra index, see [Creating an index](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) to create one. Adding a [dataset](concept-overview.md#concept-dataset) improves the quality of the Assistant's response. See [Create a dataset](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/assistant-console-create-dataset.html) to learn more.
Some questions require AWS IoT TwinMaker integration. See [Integrate AWS IoT TwinMaker and AWS IoT SiteWise](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/integrate-tm.html) for details.
Some follow up questions to ask the Assistant after getting an alarm summary in the dashboard, as part of the same conversation.
+ Show the details of the asset from the summary above?
+ What is the hierarchical path from root to the mentioned asset?
+ What are the dependent descendant assets of the mentioned asset?
+ What are the dependent assets of the mentioned asset that have active alarms?
+ Find all assets that have active alarms.
Some follow up questions to ask the Assistant after getting an property summary in the dashboard, as part of the same conversation.
+ Perform the same analysis for the last 24 hours.
+ Find documentation related to the above mentioned properties.
+ Provide the details of asset id 1da67d28-14f8-4f71-a06a-386f0425a21d/asset name Demo Turbine Asset 1.
Invoke the AWS IoT SiteWise Assistant from the API.
+ Generate alarm summary for alarm name **windSpeedAlarm** in asset id `d591e153-e5cf-4206-96bb-ce3c119d9d2d`.
+ Generate alarm summary for the last 12 hours/2 days/1 week for alarm name **windSpeedAlarm** in asset id `d591e153-e5cf-4206-96bb-ce3c119d9d2d`.
+ Generate property summary for property id `ab187fb7-d74b-44d9-bd9b-f2f19a9137cc` in asset id `d591e153-e5cf-4206-96bb-ce3c119d9d2d`
+ Generate property summary for the last 12 hours/2 days/1 week for property id `ab187fb7-d74b-44d9-bd9b-f2f19a9137cc` in asset id `d591e153-e5cf-4206-96bb-ce3c119d9d2d`.
+ Find the assets with asset name Turbine.
+ Give me the current property values of property id `5356168c-3390-456f-802c-9f6e047810d4` in asset id `d591e153-e5cf-4206-96bb-ce3c119d9d2d`, `3cbb084e-1ded-4b08-9f21-1b47b2fb86fd`.
+ What is the relationship between asset id `d591e153-e5cf-4206-96bb-ce3c119d9d2d` and asset id `3cbb084e-1ded-4b08-9f21-1b47b2fb86fd`.
+ Find documentation on how to fix wind turbine low RPM issue.
+ Generate a property summary for property alias **WindSpeed**.
+ What are the pre-operation checks according to my knowledge base?