Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 Unified Namespace Tutorial: Add Tags to UNS.

TutorialsUnified Namespace | Tutorial | How-to Guide | Reference


This Tutorial Teaches you to:

Learn how to create and organize real-time data tags in FrameworX's Unified Namespace (UNS). Tags are the foundation of any solution, representing data points from devices, calculations, or user inputs.

What You'll Learn

  • Create different tag types
  • Organize tags with folders
  • Configure tag properties
  • Use UserTypes (UDTs)

Prerequisites:

Tags created here providing the foundation for all other tutorials.

Table of Contents
maxLevel2
minLevel2
indent10px
excludeTutorial
stylenone

1. Create Tank Farm Tags

  1. Open Unified Namespace → Asset Tree
  2. Create folder structure:
    • Right-click → New Asset Folder: TankFarm
    • Create subfolder: Tank1
  3. Create Tank1 tags:
  • Right click the Tank1 folder, then click the New Tag button
  • The Tag will be created inside that folder
  • If you create in a wrong place, just drag drop to the correct location



NameTypePathMinMaxUnitsDescription
LevelDoubleTankFarm/Tank10100%Tank level percentage
TemperatureDoubleTankFarm/Tank10150°CTank temperature
PressureDoubleTankFarm/Tank1050PSITank pressure
PumpStatusDigitalTankFarm/Tank1---Pump running status
ValvePositionIntegerTankFarm/Tank10100%Valve position

Quick duplication for Tank 2 & 3

  1. Select the Tank1 Folder
  2. Right-click the mouse and Copy (Ctrl+C)
  3. Select the TankFarm
  4. Paste (Ctrl+V)
  5. Rename the folder
  6. Repeat the process to create Tank3
  7. Paste again and replace for Tank3

2. Create Production Tags

Used for counters, batching, and KPI calculations:

  1. Add production tags:
NameTypePathDescription
Production_CountIntegerProductionUnits produced
Production_RateDoubleProductionUnits per hour
Batch_IDTextProductionCurrent batch identifier
Batch_StartDateTimeProductionBatch start time
Shift_NumberIntegerProductionCurrent shift (1-3)
Quality_ScoreDoubleProductionQuality percentage

    

Info
titlePaste to the Tags Table

In order to create those tags quicker, just copy copy-paste this table

  1. Select the entire table, include the titles (Name, Type, Path, Description)
  2. Open Unified Namespace →Tags
  3. Right-Click on the first row (insertion) row and execute PASTE
    1. if by mistake you left-click, instead of right click, you selected one specific cell to edit
    2. If that happen, either press ESC, or click with the mouse outside the grid area, to close that editing. 
  4. This command will automatically create the Production folder, and the tags.
  5. Navigate to Unified Namespace →Asset Tree to confirm the tags are in the expected folder



3. Create Equipment Tags

For motor control and equipment status:

  1. Create folder: Equipment
  2. Add equipment tags:
NameTypePathDescription
MotorRunningDigitalEquipmentMotor on/off
MotorSpeedDoubleEquipmentMotor RPM
MotorCurrentDoubleEquipmentMotor current (Amps)
MotorHoursDoubleEquipmentRun hours
ConveyoSpeedDoubleEquipmentBelt speed (m/s)


Info

Use similar expedite process you used for the other tags


4. Configure Tag Properties

Set Retentive Values

For production counters:

  1. Select Production_Count
  2. Enable Retentive checkbox
  3. Preserves value through restart



5. Create Motor UserType

Build a reusable template:

tag templates

Prerequisites

  • FrameworX Designer installed
  • Basic understanding of data types

Step 1: Understanding Tag Types

FrameworX supports these fundamental tag types:

TypeUse CaseExample
DigitalOn/Off statesMotor_Running
IntegerWhole numbersProduct_Count
DoubleDecimal valuesTemperature
TextStringsBatch_ID
DateTimeTimestampsLast_Update

Step 2: Create Your First Tags

  1. Open Unified Namespace → Tags
  2. Click first empty row to add tag
  3. Create these example tags:

Digital Tag:

  • Name: Motor1_Running
  • Type: Digital
  • Description: Main motor status

Analog Tag:

  • Name: Tank1_Level
  • Type: Double
  • Min: 0, Max: 100
  • Units: %
  • Description: Tank level percentage

String Tag:

  • Name: Current_Recipe
  • Type: Text
  • Initial Value: "Recipe_001"

Step 3: Organize with Folders

  1. Right-click in tag grid → New Folder
  2. Name: Production_Line_1
  3. Drag tags into folder
  4. Create hierarchy:
Production_Line_1/
  ??? Motors/
  ?   ??? Motor1_Running
  ??? Tanks/
  ?   ??? Tank1_Level
  ??? Recipes/
      ??? Current_Recipe

Step 4: Configure Tag Properties

Select a tag and configure:

Scaling (for analog tags):

  • Engineering Units: Set Min/Max
  • Raw Scale: Device Min/Max
  • Auto-scales between device and engineering values

Retentive:

  • Enable to preserve value through restart

Initial Value:

  • Starting value when solution runs
Step 5: Create Tag Template

  1. Navigate to Unified Namespace → UserTypes
  2. Create new type: Motor MotorType
  3. Add members:
    • Running (Digital)
    • Speed (Double, 0-3600 RPM)
    • Current (Double, 0-100 Amps)
    • Hours (Double, retentive)
    • Fault FaultCode (DigitalInteger)
  4. Return to Tags
  5. Create tag from templateinstances:
    • Name: Motor2, Type: MotorType
    • Type: Select your Motor template

Testing Your Tags

    • Name: Motor3, Type: MotorType

6. Create System Tags

For scripts and calculations:

NameTypeDescription
System_RunningDigitalSystem status
Calc_AverageDoubleCalculated average
Alarm_CountIntegerActive alarm counter
Report_TriggerDigitalReport generation trigger


7. Test Your Tags

  1. go to Runtime → Startup
  2. Click Run StartupClick Run (F5)
  3. Open Unified Namespace → Monitor
  4. See your tags updating
  5. Double-click to modify values

Best Practices

  • Use consistent naming: Area_Equipment_Signal
  • Group related tags in folders
  • Document with descriptions
  • Set appropriate engineering units
  • Use templates for repeated structures

Next Steps

  • [Connect to Devices] - Get real data
  • [Define Alarms] - Add alarm conditions
  • [Operator UI Design] - Display tag values
    1. Asset Tree
    2. Verify:
      • Tag values 
      • Folder structure visible
      • UserType instances expanded

    Excerpt Include
    Unified Namespace
    Unified Namespace
    nopaneltrue


    In this section...

    Page Tree
    root@parent