Chapter 5: Registering New Items

Following the configuration outlined in Chapter 3, it is necessary to register Equipment, Systems and Dashboard.

This section describes the following;

• Register New Equipment

• Register New Systems

• Register New Dashboard

Register New Equipment

Equipment represents the assets which contain active data and have runtime points and attributes associated with them. In fact, Equipment is a wrapper around the Asset which adds the data acquisition and Real-time GUI capabilities to the Asset.

This section describes how to register new Equipment in the application.

Path Settings icon🡪Register section🡪New Equipment

1. Click the Settings icon and select New Equipment under Register section. New Equipment form will appear.

2. Select IBMS Zone. There are two ways to specify an IBMS Zone.

   1. Click in the input box which will display a list of IBMS Zones to select from.

   2. Click the Search icon and start typing in the Search Zones input box and it would filter the Zones matching the typed in text.

3. Select Asset. There are three ways to specify an Asset.

   1. Click in the input box which will display a list of Assets to select from.

   2. Click the pinboard icon to select from a list of Assets previously pinned to the pinboard.

   3. Click the Search icon and start typing in the Search Assets input box and it would filter the Assets matching the typed in text.

4. Select Equipment Template. Click in the input box which will display a list of Equipment Templates to select from. Click the Search icon and start typing in the Search Equipment Templates input box and it would filter the Equipment Templates matching the typed in text.

5. Type a Description for this Equipment.

6. Click Create to save the Equipment Configuration. New Equipment will be created and the detail page to configure further details of the Equipment will be displayed.

Equipment Details Page

After registering an Equipment, you need to configure/edit the other details related to Equipment on Equipment page.

Details Tab

To make changes to Asset Details;

1. Go to the Equipment detail page.

2. Mouse hover over the Details section and click Edit icon .

3. You can change Description while in edit mode.

4. Selecting Disable Subsystem Communication checkbox would stop data acquisition for points on this Equipment.

5. Type in the Trend Report Name if necessary.

6. After updating the details, click Save.

7. To disable all the alarms of points in a selected Equipment at once, refer to the Disable Alarms of all Points in a Selected Equipment section.

Points Tab

You can configure point details on Points tab on Equipment details page;

1. On the Equipment Details page, click on Points tab.

2. To edit a Point, click on the Edit icon of the point. Point Details dialog box appears.

3. You can configure the following attributes of a Point using the Point Details dialog box under General tab;

   1. Type – Determines the type of the point, whether it is ‘Sub system’, ‘Calculated’ or ‘Custom’.

   2. Address – Point Address is used to resolve the address, type and format of data to be acquired from the SCADA system. A Point Address is made up of Equipment Name, Point Name, Point Type, default value, etc. A point address should be left to be configured by a trained commissioning engineer for iviva.

   3. Enabled – Determines whether this Point is enabled or disabled during runtime.

   4. Enable Alarm – Select Enable Alarm check box to enable alarms from this particular point. (Depends on other configuration prerequisites)

   5. Enable Trend – Select Enable Trend check box to enable the trending of this point. (Depends on other configuration prerequisites)

   6. Enable Value Subscription and Disable comments in command options are discussed under the section Details Tab on Point Detail Page.

   7. Interface – This is the Sub System Interface with which this point communicates to acquire the data.

   8. Click Update to confirm the changes. Click the Close icon to discard changes and close dialog.

Links Tab

Link Template names created under the respective Equipment Template details page will be displayed under the “Links” tab of the Equipment details page. Links are to use in RT pages to direct the user to another page by clicking a control on the RT page, which has a link. To configure a Link displayed under the Links tab in Equipment detail page;

1. Click the respective Edit icon of the Link name. Link Details page will appear.

2. In the Link URL box, enter the required URL to link the equipment to the page with the specified URL.

3. Click Clear to erase the entered text if necessary.

4. After typing the required URL, click Update.

Alarms Tab

Alarms tab of Equipment displays all the alarms that have originated in the past from the alarm points of that Equipment.

Use Alarm Class or/and Alarm Severity to filter Alarms.

Use Date and Time to filter out the history data that you want to see.

Report: Select the Report Format from the Format box and click Generate to generate the respective report.

Trend Tab

Trend Tab displays all the Trend points on a chart, for for the respective Equipment.

You can save a Filter with filter conditions that will be used often.

To save a Filter;

1. On the Trend tab of the Equipment details tab, click the icon.

2. Select the required filtering criteria.

3. Click Save.

Register New Systems

A System represents a combination of Points that makes up a logical entity. Systems become useful when points from different equipment needs to be visualized, monitored together.

This section describes how to register new System in the application.

Path Settings icon🡪Register section🡪New System

1. Click the Settings icon and select New System under Register section. New System form will appear.

2. Enter a System Name which is unique and appropriate.

3. Select Location. There are two ways to specify the Location.

   1. Click in the input box which will display a list of locations to select from, or click the Search icon and start typing in the Search Locations input box and it would filter the Locations matching the typed in text.

   2. Click on the Pinboard icon to select from a list of Locations previously pinned to the pinboard.

4. Select a System Type from the preconfigured list.

5. Type a Description for this System.

6. Click Create to save the System Configuration. A new System will be created and the detail page to configure further details of the System will be displayed.

Configure Points for System

Refer Configure Point Templates section for more details on configuring points.

To configure Points for System:

1. Go to System Detail page. Click the Points tab.

2. Click the Add icon . Add Point window will appear.

3. Select the required Equipment and Point.

4. Type a relevant name under Display Name as the display name of the Point. This name will be displayed as the name of the Point.

5. Click Add.

6. To delete an already configured point, click the respective Delete icon .

Alarms Tab of System

Alarms tab of System displays all the alarms that have originated in the past from the alarm points under that System (Alarm History).

Trend Tab of System

Trend tab displays all the Trend points on a chart, for this Equipment.

You can save a Filter with filter conditions that will be used often.

Configure Monitoring Groups for System

Monitoring Group is used to create a group of Points, out of the points that have been configured under the respective System. This points group can be used in ‘read’ operations such as Avg/Sum/Max/Min. The points in Monitoring Group cannot be controlled.

To configure Monitoring Groups for the System:

1. Go to the required System’s detail page. Click the Monitoring tab.

2. Click the Add icon . Add Monitoring Group window will appear.

3. Type a Monitoring Group ID.

4. Select the required Aggregate Operator.

5. Click Add.

6. To edit an added monitoring group, click the Edit icon .

7. To delete an already configured monitoring group, click the respective Delete icon .

8. To add Points to the respective Monitoring Group, click the Assign Points link.

   1. In the Point box, select required Point from the drop-down list. Alternatively, click the Search icon and select a Point from the Search Points page.

   2. Click Assign. Point will be added and will be displayed on the page.

   3. Add all the required Points to the Monitoring Group.

   4. If you need to remove an added Point, click the respective Delete icon.

9. Click the Manual Read button, to manually read a monitoring value.

Configure Controlling Groups for the System

Controlling Group is used to create a group of Points, out of the points that have been configured under the respective System. New values can be set to the Points in Controlling Group and the points can be controlled.

To configure Controlling Groups for the System:

1. Go to the required System’s Detail page. Click the Controlling tab.

2. Click the Add icon . Add a Control Group window will appear.

3. Type a Control Group ID.

4. Click Add.

5. To edit an added Control Group, click the respective Edit icon .

6. To delete an already configured Control Group, click the respective Delete icon.

7. To add Points to the respective Controlling Group, click the Assign Points link.

   1. In the Point box, select required Point from the drop-down list. Alternatively, click the Search icon and select a Point from the Search Points page.

   2. In the New Value box, type the new value that you need to set for the respective Point.

   3. Click Assign. Point will be added and will be displayed on the page.

   4. Add all the required Points to the Controlling Group.

   5. If you need to remove an added Point, click the respective Delete icon.

8. Click the Manual Write button, to manually write a Controlling value.

Trend Tab of System

Trend Tab displays all the Trend points on a chart, for the respective Equipment. You can save a Filter with filter condition that will be used often.

RT GUI Tab of System

RT GUI tab allows users to:

1. Download the RT GUI page in raw RT page format.

2. Assign the RT page.

3. Download the current assigned Real-time GUI page in .json format and in raw Real-time page format.

Register New Dashboard

Dashboard is used to show a summary of configured points using Data Sources.

This section describes the following;

• Register a new Dashboard

• Edit Dashboard

• Delete Dashboard

Path Settings icon🡪Register section🡪New Dashboard

Register a New Dashboard

1. Click the Settings icon and select New Dashboard under Register section. New Dashboard registration page appears.

2. In the Dashboard Name box, type a name for the Dashboard that you are going to register.

3. Select Location. There are three ways to specify a location.

   1. Click in the Location box, which will display a list of locations. Start typing in the box and it would filter the locations matching the typed in text. Select the relevant location.

   2. Click on the Pinboard icon to select from a list of locations previously pinned to the pinboard.

   3. Click on the Search icon to bring up the location search popup window. Select a location from the location search page.

4. In the Description box, type any description related to the Dashboard.

5. Click Create. New Dashboard will be registered and its detail page will appear.

6. Go to Details tab,

   1. Mouse hover over the Details section and click the Edit icon .

   2. Edit the dashboard details while in edit mode and click Save.

   3. Upload Real-time GUI section: To add a relevant RT page to the Dashboard, drag and drop the respective RT page onto the given area and click Upload.

Adding Configured Points to Dashboard

1. On the Dashboard detail page, click the Points tab.

2. Click the Add icon to open the page to add configured points.

3. In the Data Source box, select the required Data Source from the list of Data sources that have been already created. Once the Data source is selected, its details will be displayed respectively.

4. Click Add. Respective point will be added and displayed under the Points tab.

5. Repeat 2-4 to add more configured points to the Dashboard.

6. To edit a configured point, click the relevant Edit icon .

7. To delete a configured point (Data source), click the relevant Delete icon.

Edit Dashboard

1. Click the Settings icon and select Dashboards under View section. Search Dashboard page appears.

2. Click the Dashboard Name you require to go to its detail page.

3. Hover over the Details tab area and click the Edit icon that appears.

4. Edit the Dashboard name, Location and Description as required.

5. If you do not want to display Summary Dashboard on the respective Equipment or System Real-time GUI, deselect the Enable Summary Dashboard (Appear on Equipment and System Real-time GUI) check box.

6. Click Save.

7. To upload a relevant RT page to the dashboard, drag and drop the RT page onto the given area and click Upload.

Delete Dashboard

1. Click the Settings icon and select Dashboards under View section. Search Dashboard page appears.

2. Click the Dashboard Name you require to go to its detail page. Go to Details tab.

3. Click Delete this Dashboard link or Delete icon, to delete the selected Dashboard.

4. A message will appear to confirm the deletion.