Creating and deleting objects - Metasys - LIT-12011953 - Server - Metasys UI - 7.0.50

Metasys UI Help

Product name
Metasys UI
Document type
User Guide
Document number
LIT-12011953
Version
7.0.50
Revision date
2024-03-19
Product status
Active

What is the Create and Delete Object feature?

With this feature you can manage objects in Metasys UI and JCT. You can create and delete single or multiple objects, discover objects under integrations, and fully configure objects.
Note: Object discovery is not available in JCT.
Note: In Views, you can create and delete extensions only.
Note: When creating a new folder, do not include a $ as the last character in the unique identifier. Folders that have an item reference ending with a $ character cannot be deleted through Metasys UI. Use SCT or SMP to delete these cases.

What do the Create and Delete Object feature icons look like?

The following table outlines the Create and Delete Object feature icons.

Table 1. Create and Delete Object feature icons
Icon Icon name Icon description

Add Network Item Opens the Create Item

Delete Network Item wizard, where you can create an object. Opens the Delete Item window, where you can delete an object.
Note: You can also use the Delete Network Item functionality to remove an offline engine from a site.

How do I access the Create and Delete Object feature?

  1. Click the Network tab to open the Network tree, or click the Views tab to open the Views navigation.
  2. The Create and Delete Object feature is represented by a toolbar over the navigation tree. The toolbar contains the Add Network Item icon, the Tree Settings icon, and the Delete Network Item icon.

Who can access and use the Create and Delete Object feature?

This feature is accessible to both Administrator and Non-Administrator users.

You require the Configure Items permission for at least one authorization category to view the Create and Delete Object toolbar in the Network tree. If you do not have this permission for any of the authorization categories, the Add Network Item icon and the Delete Network Item icon do not display. In addition, to view the Network tree, you require the User Can View The Item Navigation Tree (Default Tree) property in your User Details within the User Management feature in Metasys UI.

The available actions depend on your authorization. The following table outlines the actions and required authorization.
Table 2. Create and Delete Object feature required authorization
Action Required authorization and other requirements
Creating an object Configure Items permission for at least one of the authorization categories. This applies to all object types and to all means of object creation, including discovery.
Creating an extension on an object Configure Items permission for the authorization category of the parent object, as extensions inherit the parents' authorization category.
Deleting an object
  • Configure Items permission for the authorization category of the object you wish to delete.
  • An object that has one or more child objects is deletable only if all of its child objects are also deletable.
  • An object is only deletable if you can create that object with Metasys UI.

Which object types are supported?

Depending on the object that you select from the Network tree, the Create Item wizard displays the available object types. For example, when you select an Analog Value object, one of the options for General Type is Extension, and the corresponding options for Object Type are Alarm, Trend, Averaging, Totalization, or Load . The following table outlines these different options in more detail.

Table 3. Create Item wizard - type options
Network tree selection General Type options Object Type options
Site None
Metasys Server Integration (OAS, NAE85, and LCS85 only)
  • BACnet Integration
  • Field Bus MSTP
  • VND Integration
Object
  • Folder
Additionally, OAS only:
  • AV
  • BV
  • Calendar
  • MV
  • Schedule
Extension
  • Alarm
  • Averaging
  • Totalization
  • Trend
Engine Integration
  • BACnet Integration
  • Field Bus MSTP
  • LON Trunk
  • N2 Trunk
  • VND Integration
Object
  • AV
  • Accumulator
  • Auto Shutdown
  • BV
  • Calendar
  • Data Broadcast
  • Electric Demand Control
  • Event Enrollment
  • Folder
  • Generator Load Control
  • Global Data
  • Group
  • Interlock
  • Loop
  • MV
  • Multiple Command
  • Notification
  • Optimal Start
  • Program (Control System)
  • Pulse Meter
  • Schedule
  • Signal Select
  • Solar Clock
  • Trend Log
Extension
  • Alarm
  • Averaging
  • Totalization
  • Trend
Integration Field Device
Note: The Object Type field appears when you select Manual instead of Discovery.

The object types depend on the selected field device. The following object types are supported:

  • For BACnet IP: General BACnet Device or JCI Family IP BACnet Device
  • For Field Bus MSTP: General BACnet Device or JCI Family BACnet Device
  • For LON Trunk: LON Controller
  • For N2 Trunk: Controller
  • For VND Integration: VND Controller
Object Folder
Extension
  • Alarm
  • Averaging
  • Totalization
  • Trend
Field Device Field Point
Note: The Object Type field appears when you select Manual instead of Discovery
The object types depend on the selected field point. The following object types are supported:
  • For General BACnet Device: Accumulator, AI, AO, AV, Averaging, BI, BO, BV, Calendar, Characterstring Values, Command, Electric Demand Control, Event Enrollment, Generator Load Control, Group, Integer Value, Life Safety Point, Life Safety Zone, Load Control, Loop, MI, MO, MV, Notification, Positive Integer Value, Program (Control System), Pulse Converter, Schedule, Trend Log Multiple, and Trend Log
  • For JCI Family IP BACnet Device: Accumulator, AI, AO, AV, BI, BO, BV, Calendar, MV, Notification, Schedule, and Trend Log
  • For JCI Family BACnet Device: Accumulator, AI, AO, AV, BI, BO, BV, Calendar, MV, Notification, Schedule, and Trend Log
  • For VND Controller: AI, AO, BI, BO, MI, and MO
  • For N2 Controller: AI, AO, BI, BO, MI, MO, Accumulator, and N2 Pulse Counter
  • For LON Controller: AI, AO, BI, BO, MI, and MO
Object Folder
Extension
  • Alarm
  • Averaging
  • Totalization
  • Trend
Folder Object
  • AV
  • Accumulator
  • Auto Shutdown
  • BV
  • Calendar
  • Data Broadcast
  • Electric Demand Control
  • Event Enrollment
  • Folder
  • Generator Load Control
  • Global Data
  • Group
  • Interlock
  • Loop
  • MV
  • Multiple Command
  • Notification
  • Optimal Start
  • Program (Control System)
  • Pulse Meter
  • Schedule
  • Signal Select
  • Solar Clock
  • Trend Log
Note: When you select a folder under an integration, you can add a field device within that folder. When you select a folder under a field device, you can add field points.
Any object type that supports alarm, trend, or other listed extension type. For example, AV, BV, extensions, etc.
Note: When you choose Extension as the General Type, the Object Type options include only the extension types supported for the selected object.
Extension
  • Alarm
  • Averaging
  • Totalization
  • Load
  • Trend
You can also view and edit the following objects:
Table 4. Objects available for viewing and editing or viewing only
General Type Object
Integration View and edit the following objects after creation in SMP or SCT:
  • N1 Migration
  • Wireless Supervisor
  • XL5K Integration
  • SA Bus (internal object)
  • External Data Connector integration on 12.0 engines for MQ Telemetry Transport (MQTT)
Field point on BACnet IP and MS/TP devices View and edit the following object after creation in SMP or SCT: Electric Demand Monitoring
Field point on LON and N1 controllers View and edit the following objects after creation in SMP: Generic Integration Object (GIO)
Object

View and edit the following objects after creation in SMP or SCT:

  • Demand Limiting Load Rolling (DLLR)
  • Electric Demand Monitoring

View and edit the following objects after creation in CCT:

  • Activity Sequencer
  • Local Application
  • Local Hardware
Extension Resource File
Other

View the following objects after creation in SMP or SCT:

  • Summary Definition
  • Views

View the following objects after creation in SCT: UGT / GGT Graphics

How do I manually create and configure an object or integration?

  1. Select the location (object) in the Network tree where you wish to create the new object.
  2. Click or tap the Create icon in the upper left of the Network tree. The Create Item wizard opens.
  3. Select a general type from the General Type drop-down list.
  4. Select an object type from the Object Type drop-down list.
  5. Review the unique identifier in the Unique Identifier field and change it, if required.
    Note: A default value is used for the unique identifier. The unique identifier is used to form part of the Item Reference of the object, which cannot be modified after creation. You can change the object's name in the Configuration tab of the wizard. The object's name displays in the Network tree.
  6. Click or tap NEXT.
  7. Complete the required fields in the Configuration tab and, if applicable, the fields for any additional tab in the wizard. For example, if you create a Multiple Command object, complete the fields under the Action Tables tab. If you create a Schedule object, complete the fields under the Schedule tab. If you create an Event Enrollment object, complete the fields under the Event tab next to the Configuration tab.
  8. Click or tap CREATE.
Note: To completely configure objects such as Schedule, Interlock, Multiple Command, and others; for example, you need to complete the configuration in the edit mode of the newly created object. The system automatically navigates to the new object after creation.

How do I manually create and configure an extension?

  1. Select the location (object) in the Network tree, or Views, where you wish to create the new extension.
  2. Click or tap the Create icon in the upper left of the tree. The Create Item wizard opens.
  3. Select a general type from the General Type drop-down list.
  4. Select an object type from the Object Type drop-down list.
  5. Select an attribute from the Attribute drop-down list.
  6. Enter a unique identifier in the Unique IdentifierWhich extensions can I create? field.
    Note: A default value is used for the unique identifier. The unique identifier is used to form part of the Item Reference of the object, which cannot be modified after creation. You can change the object's name in the Configuration tab of the wizard. The object's name displays in the Network tree.
  7. Click or tap NEXT.
  8. Complete the required fields in the Configuration tab to configure the extension.
  9. Click or tap CREATE.

Which extensions can I create?

From Metasys Release 12.0, you can create alarm, trend, averaging, load, and totalization extensions. See Alarm extensions, Trend extensions, Totalization extensions, Averaging extensions, and Load extensions for more information about these extension types.

How do I add a field device with the discovery feature?

You can use the discovery feature to add a field device to an existing integration. To add a field device to an integration, complete the following steps:
  1. Select an existing integration from the Network tree.
  2. Click or tap the Create icon in the upper left of the Network tree. The Create Item wizard opens.
  3. From the General Type drop-down list select Field Device.
  4. Discovery is selected by default.
  5. Modify the integration attributes as appropriate.
  6. Click or tap DISCOVERY.
  7. Select the devices that you want to add to the integration.
    Note: If you add only a single device with the field device discovery workflow, you can add field points to this device in the same workflow. If you add more than one device, you can follow the steps outlined in How do I add a field point with the discovery feature? to add field points in a separate workflow.
  8. Review and configure the selected devices as appropriate.
  9. Click or tap CREATE.

How do I add a field point with the discovery feature?

You can use the discovery feature to add a field point to an existing field device. To add a field point to a field device, complete the following steps:
  1. Select an existing field device, or a folder under a field device, from the Network tree.
    Note: The maximum number of field points in a folder or directly under a field device is 1000. To add more than 1000 field points to a field device, or to organize your field points within folders under a field device, create the folders before adding the field points. Select the desired target folder when you create the field points.
  2. Click or tap the Create icon in the upper left of the Network tree. The Create Item wizard opens.
  3. From the General Type drop-down list select Field Point.
  4. Discovery is selected by default.
  5. Click or tap DISCOVERY.
  6. When the discovery is completed, select the points that you want to add to the field device by clicking or tapping the check boxes.
  7. Click or tap NEXT.
  8. Review and configure the selected field points as appropriate. For example, you can add alarm and trend extensions to the points by selecting the check box with the alarm icon or the check box with the trend icon, respectively.
    Note: On a site with an engine at version 9.0, you may get an error when you add more than 20 alarm and trend extensions. Reduce the number of extensions that you want to add in one batch and add the remaining extensions in another batch.
  9. Click or tap CREATE.

Where does a newly created object appear in the network tree?

When you create a new object on the server, an engine, or a controller, the newly created object is appended to the bottom of the list of its parent object. You can reorganize the list with the Organize Tree functionality. See Tree settings for more information.

How do I delete an object?

  1. Select an object in the Network tree or Views that you want to delete. In Views, you can delete extensions only.
    Important: The object's child objects are also deleted by this action.
  2. Click or tap the Delete icon. The Delete Item window opens.
  3. Review the information pertaining to the deletion of a single object and its children.
  4. Click or tap DELETE.
Note: If the object you selected or any of its child objects cannot be deleted, a message displays to tell you why the object cannot be deleted, including the reason why any child objects are non-deletable.
Note: From Metasys Release 12.0, you can also remove offline engines from the site by using the Delete icon. You can remove an offline engine of any type and release.

See also Who can access and use the Create and Delete Object feature? for more information about authorization to delete an object.

Who can see the results of a create or delete operation?

The result of any create or delete operation takes effect immediately for the user who performed the action. However, all other users have to refresh the web browser to see the changes in their Network tree.

Is the Create and Delete Object feature supported on all devices?

Yes, the Create and Delete Object feature is supported on desktop, tablets, and smartphones.