Plant Model

Overview

Plant Model is a hierarchical structure management system that allows you to organize your enterprise assets in a tree structure. Each node in the tree represents an organizational unit such as Enterprise, Site, Area, Production Line, or Work Cell.

To access the Plant Model management page, click on the Plant Model menu in the left navigation panel.

Page Layout

The Plant Model page is divided into two sections:

• Left Panel (1/3 width) - Tree navigation for browsing and managing the hierarchical structure

• Right Panel (2/3 width) - Detail view with tabs for Properties, Systems, and Knowledges

Node Types

The following node types are available, organized in a hierarchical structure:

Tree Structure Management

Create a Root Node

To create a new root node (Enterprise level):

1. Click the + button in the upper right corner of the left panel.

2. A dialog will appear. Enter the Name for the node (required).

3. Optionally enter an Original ID to reference an external system identifier.

4. The Type will be set to "Enterprise" for root nodes.

5. Add Tags if needed (optional, up to 10 tags).

6. Click Save to create the node. The new node will appear in the tree.

Add a Child Node

To add a child node to an existing node:

• Right-click on the parent node in the tree, or hover over it and click the + icon that appears.

• Fill in the node details. The available Type options will be filtered based on the parent node's type.

• Click Save to create the child node.

Edit a Node

To edit an existing node:

1. Select the node you want to edit in the tree.

2. Click the Edit button (pencil icon) that appears next to the node.

3. Modify the Name, Original ID, or Tags as needed. Note that the Type cannot be changed after creation.

4. Click Save to apply your changes.

Delete a Node

To delete a node from the tree:

1. Select the node you want to delete in the tree.

2. Click the Delete button (trash icon).

3. A confirmation dialog will appear. Click Confirm to delete the node.

4. Warning: Deleting a node will also delete all its child nodes.

Search Nodes

Use the search box at the top of the left panel to find nodes by name. The tree will automatically filter to show matching nodes and their parent hierarchy.

Properties Tab

The Properties tab allows you to view and edit detailed information about the selected node, including uploading a photo.

Upload Node Photo

To upload or change the photo for a node:

1. Select a node and go to the Properties tab.

2. Click on the photo placeholder or the existing photo at the top of the panel.

3. Select an image file from your computer. Supported formats: JPG, PNG, GIF. Maximum size: 5MB.

4. The photo will be uploaded automatically and displayed in the panel.

Edit Node Properties

To edit the properties of a node:

1. Select a node and go to the Properties tab.

2. Edit the following fields:

• Name (required) - The display name of the node

• Description (optional) - A detailed description, up to 500 characters

• Location (optional) - The physical or logical location

3. Click Save to apply your changes. The Save button is only enabled when you have made changes to the form.

Systems Tab

The Systems tab allows you to connect external data sources (such as MaintainX) to the selected node. This enables the node to access and query data from these systems.

View Connected Systems

The Systems tab displays a table of all connected systems for the selected node, showing the ID, Data Source name, Type, and available actions.

Assign a System

To connect a new system to the node:

1. Click the Assign button in the upper right corner of the Systems tab.

2. A dialog will appear showing available systems. Each system card displays the system name, connection status, and number of available resources.

3. Select the system you want to connect and click Next: Config.

4. In the configuration step, select the resources you want to integrate by checking the checkboxes.

5. For each selected resource, click Load IDs to choose specific data items from that resource.

6. Click Save to complete the assignment. The system will appear in the Systems table.

Configure a Connected System

To modify the configuration of an existing system connection:

1. In the Systems table, click the Config button (gear icon) for the system you want to configure.

2. The configuration dialog will open with the current settings pre-loaded.

3. Add or remove resources and their IDs as needed.

4. Click Save to apply your changes.

Remove a System Connection

To remove a system connection, click the Delete button (trash icon) in the Actions column. A confirmation dialog will appear. Click Confirm to remove the connection.

Knowledges Tab

The Knowledges tab allows you to assign knowledge base data sources to the selected node. This enables the node to access documents and files from SharePoint, Box, or Standalone Box.

View Assigned Knowledge Sources

The Knowledges tab displays a table of all assigned knowledge sources, showing the ID, Name, Type (with color-coded labels), and available actions.

Assign a Knowledge Source

To assign a new knowledge source to the node:

1. Click the Assign button in the upper right corner of the Knowledges tab.

2. A dialog will appear showing available knowledge sources as cards.

3. Select a knowledge source. The next steps depend on the source type:

• SharePoint: Click Save directly - no additional configuration needed.

• Box: A file tree will appear. Navigate through folders and select the files/folders you want to include, then click Save.

• Standalone Box: A list of Box users will appear. Select the users whose content you want to include, then click Save.

4. After saving, the knowledge source will appear in the Knowledges table.

Edit Knowledge Source Configuration

To modify the configuration of an assigned knowledge source (Box or Standalone Box only), click the Config button (gear icon) in the Actions column. Update the selected files, folders, or users as needed, then click Save.

Remove a Knowledge Source

To remove a knowledge source assignment, click the Delete button (trash icon) in the Actions column. A confirmation dialog will appear. Click Confirm to remove the assignment.

Important Notes

• Permissions required: You need the "metadata:edit" permission to create, edit, or assign resources. You need the "metadata:delete" permission to delete nodes or remove assignments.

• Node type restrictions: The type of a node cannot be changed after creation. Child node types are restricted based on the parent node's type.

• Cascading delete: Deleting a parent node will delete all its child nodes. Please use caution when deleting nodes.

• Photo requirements: Node photos must be in JPG, PNG, or GIF format and no larger than 5MB.

• Tags limit: Each node can have up to 10 tags. Tags must be unique within a node.