External Models- Add, Edit, Delete & Change Logs

4 Minute read

| Overview

New External models can be added, and existing External models can be edited or deleted from the Domain Modeler tool.

The Domain Modeler tool is so developed to check for certain criteria while adding/deleting an External model. The criteria are so set up that the user is not missing any aspect during the External model addition or deletion.

The following is achieved with the check criteria set up

• No repetitive External models are added
• No new External model can be added with the same External model name.

| View Modbus Models

From the Modbus Models home screen.

• Click on the view icon to view any Modbus model.

The model details window displays details like the Manufacturer, Model name, description, Tags & Points constituting.

| Confirm the Availability of an External Model

Before adding a new External Model, from the domain modeler External Models screen 

• Search for the External model you wish to add, to confirm the availability of the External model or a similar External model

The search results are displayed.

Note: The tool displays the search results, based on the keyword search in both the External model's name and Description field columns.

| Add a New External Model

To add a new External Model, from the domain modeler External model's screen.

• Click Add Model.

The Add External model window is displayed.

• Enter the Manufacturer's Name
• Enter the External model name

Note: The tool displays a message as to what is to be added as an External model name as below:

When different format names are entered.

Note: The tool displays a message for a unique name to be used for the new point

When already existing names are entered

• Enter a valid External model name
• Enter a valid description for the External model

Selecting An Existing Model as Base for New Model

• Select an existing model, to reference the data as a base for the new External model. 

Once an existing model is selected as a base for the new External model, the points that constitute the Model and all the tags that constitute the points are displayed.

Note: The base model can be selected from all the existing External and Domain Models in the library.

Note: The tags associated with the point are displayed, with a distinction between the tags that can be deleted and tags that cannot be deleted.

• Delete the tags that are not required, simply by clicking the cross on the tag.
• Type and add more required tags as below.

More tags added

Editing and Deleting Points from Existing Model

• Edit the points added from the base model by clicking the edit  icon.

• Make the necessary and possible edits to the points, like adding more tags, modifying the description, and modifying the kind of the point.

• Click Done to confirm the changes to the point.

• Delete the points added from the base model by clicking the delete  icon.

The point from the base model is deleted as below.

Adding More Points to the Model

• Add more points to the model using the Add Points field option.

The points list box displays.

• Search for specific points or locate them by scrolling through the list.

• Select the required point from the list below

• Click Done to confirm the additional points.

The points are added to the list of points.

Adding Child Equips to the Model

• Add equips to the model using the Add Child Equips option.

The child equips list box displays.

• Search for specific child equips or locate them by scrolling through the list.

• Select the required equip from the list below.

• Click done to confirm the associated equips.

The equips are added to the list and the model gets associated with the models as above.

You can further add points or edit or delete the equipment by clicking the add, edit and delete icon shown below as done for the points.

• Click Submit to confirm the new External model addition.

The new External model is added.

Note: Child equips of the same type can be added multiple times to the existing external model.

A similar child equip has been selected multiple times in the above External model from the add child equip list.

Editing Child Equips

The External model has the option to edit child equips for the corresponding equips which have been added as per requirement.

• Select the required child equip/equips to edit.

 

• Click on Edit

Edit Child Equip Page is displayed.

The child equip name and description can be edited to suit the user's requirements.

| Edit Existing External Model

To edit an existing External Model, from the domain modeler External Models screen.

• Locate the External Model to be edited
• Click the edit  icon.

• Make the necessary edits, using the steps specified in the Add New External Model Section.

• Click Save as Draft to save it as a draft for later.

• Click Publish to confirm the edit and publish the changes.

| Delete Existing External Model

To delete an existing External Model, from the domain modeler External Models screen,

• Locate the model to be deleted
• Click the delete icon.

A confirmation window is displayed to confirm the External model deletion.

• Click Submit to confirm the deletion.

The External model gets deleted breaking its association with the equips.

| Viewing Change Logs

To view the change logs for External Model, from the domain modeler External Models screen.

• Locate the model to view the change logs
• Click the change logs  icon.
• Select the dates for the first version and the second version.

The change logs for the selected model and versions are displayed.

| Download External Models

To download the External models in the library.

• Click the Download icon.

The window to specify the download format displays.

Select the version which you want to download.

Select the format in which you want to download.

 

You can download the models in JSON, TRIO, and Zinc formats.

 

A sample for a JSON format downloaded:

 

A sample for a TRIO format downloaded:

 

A sample for a Zinc format downloaded: