Manufacturing Tag Catalog Template (Interactive)

{ "Title": "Manufacturing Tag Catalog Entry", "IntroductionHtml": "

Use this form to create or update a canonical entry for a sensor, PLC signal, historian point, calculated KPI, or other shopfloor data element. Capture consistent names, ownership, units, timestamp rules, quality checks, and example queries so dashboards, MES integrations, and analytics are reliable and discoverable.

Fill required fields and provide examples where possible. This form is a living record: update it whenever mappings, calculations, owners, or lifecycle status change.

", "SubmitLabel": "Save Tag Entry", "SuccessMessage": "Tag catalog entry saved. Consider linking this entry to related dashboards, MES mappings, and an automated governance review schedule.", "DataType": "manufacturing.tag.catalog.v1", "SchemaVersion": "1.0", "Fields": [ { "Key": "canonical_tag_id", "FieldType": "text", "Label": "Canonical Tag ID (unique)", "HelpText": "A stable identifier used across systems (example: PLT1.PLC1.AI_1234 or plant.asset.signal). Must be unique.", "Required": true }, { "Key": "canonical_tag_name", "FieldType": "text", "Label": "Canonical Tag Name", "HelpText": "Human-friendly canonical name (example: Motor A - Vibration RMS).", "Required": true }, { "Key": "alias_names", "FieldType": "textarea", "Label": "Alias / Legacy Names", "HelpText": "Other names used historically or in upstream systems (comma- or newline-separated)." , "Required": false}, { "Key": "source_system", "FieldType": "select", "Label": "Primary Source System", "HelpText": "Where the raw data originates.", "Required": true, "Options": [ {"Value": "plc", "Label": "PLC"}, {"Value": "hist", "Label": "Historian"}, {"Value": "scada", "Label": "SCADA"}, {"Value": "mes", "Label": "MES"}, {"Value": "iot_gateway", "Label": "IoT Gateway / Edge"}, {"Value": "manual", "Label": "Manual Entry / Log"}, {"Value": "calculated", "Label": "Calculated / Derived"} ]}, { "Key": "physical_point_description", "FieldType": "textarea", "Label": "Physical Point / Signal Description", "HelpText": "Describe the physical sensor, PLC tag, or calculation in plain language. Include terminal, module, channel, or I/O details if known.", "Required": false }, { "Key": "location", "FieldType": "text", "Label": "Location / Area", "HelpText": "Plant, line, cell, bay, or equipment (example: Plant 1 - Line B - Cell 3)." }, { "Key": "equipment_asset_id", "FieldType": "text", "Label": "Related Equipment / Asset ID", "HelpText": "Link to the asset registry or CMMS asset id if applicable." }, { "Key": "units", "FieldType": "text", "Label": "Units", "HelpText": "Units of measure (example: mm, °C, m/s, amps). Use SI where practical.", "Required": true }, { "Key": "data_type", "FieldType": "select", "Label": "Data Type", "HelpText": "How the value behaves.", "Required": true, "Options": [ {"Value": "analog", "Label": "Analog / Continuous"}, {"Value": "digital", "Label": "Digital / Boolean"}, {"Value": "enumeration", "Label": "Enumeration / Discrete"}, {"Value": "string", "Label": "String / Text"}, {"Value": "derived", "Label": "Calculated / Derived"} ]}, { "Key": "sample_rate", "FieldType": "text", "Label": "Nominal Sample Rate", "HelpText": "Typical sampling frequency or event cadence (example: 1s, 100ms, on-change). Include units.", "Required": false }, { "Key": "timestamp_source", "FieldType": "select", "Label": "Timestamp Source / Precision", "HelpText": "Where the timestamp is assigned (device, historian, MES) and precision expectations.", "Options": [ {"Value": "device", "Label": "Device / PLC"}, {"Value": "historian", "Label": "Historian / Collector"}, {"Value": "mes", "Label": "MES"}, {"Value": "application", "Label": "Application / Calculation"} ]}, { "Key": "retention_policy", "FieldType": "text", "Label": "Retention Policy / Archive", "HelpText": "How long raw and aggregated data are retained (example: raw 90 days, aggregated 7 years)." }, { "Key": "quality_checks", "FieldType": "textarea", "Label": "Quality Checks & Validation Rules", "HelpText": "Describe automated quality rules (range checks, stuck-value detection, plausibility rules) and recommended alert thresholds.", "Required": false }, { "Key": "valid_low", "FieldType": "number", "Label": "Expected Minimum (optional)", "HelpText": "Lower bound for data quality/validation." }, { "Key": "valid_high", "FieldType": "number", "Label": "Expected Maximum (optional)", "HelpText": "Upper bound for data quality/validation." }, { "Key": "calculation_logic", "FieldType": "textarea", "Label": "Calculation or Transformation Logic", "HelpText": "If this is a derived KPI, provide the calculation (pseudocode, SQL, or formula) and dependencies (source tags).", "Required": false }, { "Key": "example_queries", "FieldType": "textarea", "Label": "Example Queries / SQL / Historian Call", "HelpText": "Include example queries or scripts that analysts and dashboards can reuse. Provide time range, aggregation, and filters if relevant.", "Required": false }, { "Key": "example_visualizations", "FieldType": "textarea", "Label": "Example Visualizations / KPIs", "HelpText": "Suggested charts, aggregations, or KPIs that use this tag (OEE inputs, trend charts, alarms).", "Required": false }, { "Key": "associated_kpis", "FieldType": "textarea", "Label": "Associated KPIs / Dashboards", "HelpText": "List KPIs, dashboards, or reports that depend on this tag (links or identifiers)." }, { "Key": "owner_name", "FieldType": "text", "Label": "Owner / Responsible Person", "HelpText": "Person accountable for correctness and stewardship (name).", "Required": true }, { "Key": "owner_contact", "FieldType": "text", "Label": "Owner Contact (email / phone)", "HelpText": "Best contact method for questions or change requests.", "Required": true }, { "Key": "steward_team", "FieldType": "text", "Label": "Steward Team / Department", "HelpText": "Team responsible for managing access, quality, and onboarding (example: Controls, Reliability, IT)." }, { "Key": "access_classification", "FieldType": "select", "Label": "Access / Privacy Classification", "HelpText": "Controls who can see or use the data.", "Options": [ {"Value": "public", "Label": "Public (non-sensitive)"}, {"Value": "internal", "Label": "Internal"}, {"Value": "confidential", "Label": "Confidential"}, {"Value": "restricted", "Label": "Restricted / Safety-Critical"} ], "Required": true }, { "Key": "lifecycle_status", "FieldType": "select", "Label": "Lifecycle Status", "HelpText": "Current lifecycle state for the tag.", "Required": true, "Options": [ {"Value": "active", "Label": "Active"}, {"Value": "proposed", "Label": "Proposed"}, {"Value": "deprecated", "Label": "Deprecated"}, {"Value": "archived", "Label": "Archived"} ]}, { "Key": "deprecation_date", "FieldType": "text", "Label": "Deprecation / Replacement Date (optional)", "HelpText": "If deprecated, when and what replaces it?" }, { "Key": "replacement_tag", "FieldType": "text", "Label": "Replacement Tag ID (optional)", "HelpText": "Canonical ID of the replacement tag if relevant." }, { "Key": "notes_and_history", "FieldType": "textarea", "Label": "Notes, Change History & Links", "HelpText": "Record important changes, approvals, or links to design documents, change requests, or tickets." }, { "Key": "tags", "FieldType": "text", "Label": "Freeform Tags / Categories", "HelpText": "Keywords to help discovery (example: vibration, temp, safety, throughput)." }, { "Key": "created_by", "FieldType": "text", "Label": "Created By", "HelpText": "Who created this entry." }, { "Key": "created_date", "FieldType": "text", "Label": "Created Date", "HelpText": "Date of initial creation." }, { "Key": "last_updated_by", "FieldType": "text", "Label": "Last Updated By", "HelpText": "Name of person who last updated the entry." }, { "Key": "last_updated_date", "FieldType": "text", "Label": "Last Updated Date", "HelpText": "Date of last update." } ] }