Manage Classes

The following sections explain how to manage Classes using the Admin Tool.

Creating Classes

To create a Class:

1. Go to the Class pane in the Admin Tool.

2. Select to select a Class in the Class Library.

3. In the Manager pane, select the icon to expand the Classes node, and then select Create Classes.

   

   The Create User Class pane opens in a new tab, displaying the selected class's Parent Class ID and New Class Type.

   Note: The auto-populated Parent Class ID and New Class Type are read-only. It indicates if the selected Class is System pre-defined or user-defined, and if it is a Characteristic, Property, or Ordinary Class.

4. Enter the details in the following boxes:

   The value in this box	Enables Display of the following in Dashboard
   New Class Name	Object type.
   New Plural Name	Object classification in the tree-view. Note: If not set, the Name is used. It is recommended that a plural name is set for better readability.
   New Open Icon	Class in the tree view, upon expanding the Class node.
   New Closed Icon	Class in the tree view, before expanding or after collapsing the Class node.
   New Object Icon	Object in the tree-view that is an instance of this Class.

5. Select or clear the following check boxes:

   Check Box	If selected,	If cleared,
   Attribute Template	The attribute template will be inherited from its parent class.	The attribute template will not be inherited from its parent class.
   Visible	A Class will be visible in the tree-view.	A class will be hidden, and will not appear in the tree-view. Note: This settings can be over-ridden during configuration. By default: All newly created Classes are set to be visible. Pre-configured system classes are set to invisible by default.
   Hidden	A Class will not be displayed in the drop-down list for Search/Advanced Search/Query Form designer.	A Class will be displayed in the drop-down list for Search/Advanced Search/Query Form designer.
   Non-searchable	The Class will not be searchable.	The Class will be searchable.
   Replace attributes	Replaces the selected attribute on any instances of the selected Class.	The selected attribute on any instances of the selected Class cannot be replaced.
   Allow invalid data type	Displays invalid data type.	Any invalid data type will not be displayed.

6. Select the Create New Class button.

   Editing Classes

To edit Classes:

7. Go to the Class pane in the Admin Tool.

8. Select to select a Class in the Class Library.

9. In the Manager pane, select the icon to expand the Classes node, and then select Edit Classes.

   

   The Selected Class Settings pane opens in a new tab, displaying the selected class's details.

   Note: The auto-populated Parent Class ID and Class Type are read-only. It indicates if the selected Class is System pre-defined or user-defined, and if it is a Characteristic, Property, or Ordinary Class.

10. You can edit the values in the following boxes:

    The values in this box	Enables Display of the following in Dashboard
    Class Name	Object type.
    Plural Name	Object classification in the tree-view.
    Open Icon	Class in the tree view, upon expanding the Class node.
    Closed Icon	Class in the tree view, before expanding or after collapsing the Class node.
    Object Icon	Object in the tree-view that is an instance of this Class.

    Note: A Class derived from Physical Property displays Units information, instead of Attribute Template.

11. To rename a Class, type a new name in the Class Name box, and then select the Update button.

    Important: You cannot create two Classes with the same name.

12. Select or Clear the following check boxes:

Check Box	If selected,	If cleared,
Attribute Template	The attribute template will be inherited from its parent class.	The attribute template will not be inherited from its parent class.
Visible	A Class will be visible in the tree-view.	A class will be hidden, and will not appear in the tree-view. Note: This settings can be over-ridden during configuration. By default: All newly created Classes are set to be visible. Pre-configured system classes are set to invisible by default.
Hidden	A Class will not be displayed in the drop-down list for Search/Advanced Search/Query Form designer.	A Class will be displayed in the drop-down list for Search/Advanced Search/Query Form designer.
Replace Attributes	Replaces the selected attribute on any instances of the selected Class.	The selected attribute on any instances of the selected Class cannot be replaced.
Subclass Objects	And then the Delete Objects button is selected, all the Objects of the selected Class and all of its subclasses are deleted.	And then the Delete Objects button is selected, only the Objects of a selected Class will be deleted, but not the subclasses.
Allow Invalid Data Type	Displays invalid data type.	Any invalid data type will not be displayed.
Non-searchable	The Class will not be searchable.	The Class will be searchable.

13. To delete all Objects of a selected Class, select the Delete Objects button.

    Note: You must delete all Objects in a Class, to be able to delete a Class itself.

14. To update any values entered in the boxes, or selections in the check boxes, select the Update button.

15. To view the properties of a selected Class, select the Class Properties button.

Creating Class Property (Class Scheme ID)

Class Scheme ID can be configured to be displayed in AIM in:

• Node labels in the Browse tree

• Search results

• Advanced Search

• Query Forms Designer

• Query Form search results:

  • Form View

  • Table View

• Export

• Content Card Details tab

An Item or Object can be classified under different names. For example, a pump can be classified under RDS and EID. The AIM EIA assumes these alternative names as Class Scheme IDs. The following are the characteristic features of the Class Scheme IDs:

• Character limit for a Class Scheme ID is 255.

• Multiple Class Scheme IDs can be assigned to a Class.

• Class Scheme ID assigned to a Class is a required field.

• Class Scheme ID can be assigned to any type of Class (Measure, Characteristic, Property and so on).

• Class Scheme IDs are not directly interrelated. For example, It cannot be inherited.

• Each Class Scheme ID has a SchemeName property.

• The Class ID is a Class's unique ID.

• Based on the configuration, the Class name displayed can be the Class ID, Class name, or Scheme name.

To create Class property:

16. Go to the Class pane in the Admin Tool.

17. Select to select a Class in the Class Library.

18. In the Manager pane, select the icon to expand the Classes node, and then select Class Properties.

    

    The Class Properties pane opens in a new tab, displaying the properties of the selected Class.

19. Double-click the boxes, and type the Scheme ID.

    The Class property is created, and committed to the database.

20. To remove a Class Property, select a Property, and then select the Delete Selected Property button.