This guide
P1: Unified Namespace (How-to Guide) walks you through configuring the Unified Namespace (UNS) - the data foundation of your FrameworX solution. You'll create tags, build templates, organize your asset tree, and connect to external data sources.
Prerequisites:
- Solution created in Solution Center
- Designer open with solution loaded
- Understanding of your data requirements
In this page:
Table of Contents maxLevel 2 minLevel 2 indent 10px exclude Steps style none
Configuration Workflow
- Define UserTypes (UDTs) - Create reusable data structures
- Build Asset Tree - Organize hierarchical structure
- Create Tags - Add variables using templates or basic types
- Configure Enumerations - Define discrete state values
- Add UNS Services (Optional) - Connect external data sources
Step 1: Create UserTypes (UDTs)
Creating a New UserType
- Navigate to Unified Namespace → UserTypes
- Click New
- In the "Create New UserType" dialog:
- Enter Name (e.g., Motor_VFD)
- Add Description
- Click OK
- Add members to the template:
- Type in the first row of the table
- Press Enter after each member
- Configure properties (same as tag properties)
Example Motor UserType
Member | Type | Units | Min | Max | Description |
---|---|---|---|---|---|
Running | Boolean | - | - | - | Motor running status |
Speed_SP | Float | % | 0 | 100 | Speed setpoint |
Speed_PV | Float | % | 0 | 100 | Actual speed |
Current | Float | A | 0 | 200 | Motor current |
FaultCode | Integer | - | 0 | 999 | Error code |
Step 2: Build Asset Tree
Creating Asset Structure
- Go to Unified Namespace → Asset Tree
- Create folders using one of these methods:
- Click "Add Asset Folder" icon in toolbar
- Right-click on root or existing folder → New Asset Folder
- Right-click in tree area
Note: The "RootTags" folder is pre-defined and contains all tags not assigned to other folders.
Example Structure
Plant
??? WaterTreatment
? ??? Intake
? ??? Processing
? ??? Distribution
??? PowerHouse
??? Boilers
??? Generators
Step 3: Create Tags
Method A: Using Create New Tag Dialog
- Click New Tag icon in top toolbar
- In the dialog, configure:
- Name: Tag identifier
- Type: Select data type or UserType
- Properties: Optional device, alarm, historian settings
- Click OK
Method B: In Asset Tree
- Navigate to Unified Namespace → Asset Tree
- Select target folder
- Right-click → New Tag or use toolbar icon
- Configure tag properties in dialog
Method C: In Tags Grid
- Navigate to Unified Namespace → Tags
- Create tags by:
- Click in empty row and type name
- Press Insert key
- Click "New Item" in grid controls
- Paste from Excel (must have "Name" column)
Method D: Copy and Paste
- Select existing tags
- Right-click → Copy Selected Rows (or Ctrl+C)
- Right-click empty row → Insert Rows (or Ctrl+V)
Step 4: Configure Tag Properties
Essential Properties
Property | Description | Example |
---|---|---|
Name | Unique identifier | PUMP01_SPEED |
Type | Data type or UserType | Float |
StartValue | Initial value at startup | 0 |
Min/Max | Value limits | 0 to 100 |
Units | Engineering units | RPM |
Format | Display format | N2 (2 decimals) |
Retentive | Keep value through restart | ValueOnly |
Tag Types Available
- Digital - Binary (0 or 1)
- Integer - Whole numbers (-2,147,483,648 to 2,147,483,647)
- Long - Large integers (64-bit)
- Double - Floating point
- Decimal - High precision
- Text - String values
- DateTime - Date and time
- Timer - Built-in timer functions
- DataTable - In-memory table
- Reference - Dynamic tag pointer
Step 5: Configure Enumerations
- Navigate to Unified Namespace → Enumerations
- Click New in grid toolbar
- Enter enumeration name
- Add values:
0 = Stopped 1 = Running 2 = Fault
- Apply to tags by selecting enumeration in tag properties
Step 6: Import Tags
From Excel
- Copy Excel data including column headers
- Ensure "Name" column exists
- Paste directly into Tags grid
From CSV
- Use Import button when grid is in focus
- Select CSV file
- Map columns to properties
Using Solution Import Tools
Navigate to Solution → Import for:
- OPC Server browsing
- ControlLogix import
- PI System import
- SQL database import
Step 7: Add UNS Services (Optional)
Creating Connection
- Navigate to Unified Namespace → UNS Services
- Click New UNS Service or use File → New → UNS Service Connection
- Configure connection parameters
- Test connection
Linking to Asset Tree
- Select asset folder
- Right-click → "Link Data from UNS Service"
- Browse and select remote data
- Data appears dynamically in tree
Testing Your Configuration
Test Mode
- Press F5 or click Run Test
- Monitor values in Asset Tree (Value column appears)
- Use Property Watch for detailed monitoring
Accessing Tags
Direct Tag Access:
Tag.PUMP01.Running
Tag.Area1/Line1/Temperature
Asset Method (for dynamic paths):
Asset("/Area1/Line1/Temperature")
Asset(client.Context.AssetPath + "State1")
Common Issues
Cannot see data in Asset Tree
- Click Refresh button to reload tree
Tag not updating
- Check device mapping if using Device Module
- Verify UNS Service connection if using external data
Changes to UserType not reflected
- UserType changes don't auto-update existing instances
- Must recreate or manually update instances
Best Practices Checklist
?- Create UserTypes before tags for consistency
- Organize Asset Tree to match physical/logical structure
?
- Use consistent naming conventions
- Set appropriate retentive settings for critical values
- Configure security at tag level when needed
- Use enumerations for state-based tags
Next Steps
- [P2: Process Modules →] Configure devices and alarms
- [Devices Module →] Connect to field equipment
- [DataExplorer →] Browse and import external data
In this section...
Page Tree | ||||
---|---|---|---|---|
|