Skip to content

PI Interface Lineage Management

Overview

PI Interface lineage provides an automated approach to creating lineage relationships for PI-to-PI interface connections. This feature recognizes that many industrial environments use PI Interfaces to transfer data between different PI Data Archives, creating predictable patterns that can be automatically managed.

Understanding PI-to-PI Interfaces

How PI Interfaces Work

PI Interfaces are a common solution for data integration in industrial environments:

  • Data Collection: PI Interfaces collect data from source PI Data Archives
  • Transfer Process: They transfer selected tags to target PI Data Archives
  • Metadata Setting: Tags in the target system often have specific metadata that identifies their source
  • Standard Attributes: The interface typically sets standard attributes like PointSource and Location1

Automated Lineage Benefits

Scale: - Handle hundreds or thousands of interface tags automatically - Eliminate manual effort for repetitive relationship patterns - Support large-scale data integration projects

Accuracy: - Reduce human error in defining repetitive relationships - Ensure consistent application of lineage rules - Maintain accuracy as interface configurations change

Consistency: - Apply standard patterns across all interface connections - Ensure uniform documentation across similar systems - Support enterprise-wide lineage standards

Maintenance: - Automatically manage relationships as interface configurations change - Update lineage when new tags are added to interfaces - Remove relationships when tags are decommissioned

When to Use PI Interface Lineage

Large-Scale Interface Deployments

Multiple PI Data Archives: - Environments with multiple PI Data Archives connected via PI-to-PI interfaces - Centralized data collection architectures - Distributed systems with regional data aggregation - Enterprise-wide data consolidation projects

Standard Interface Patterns

Consistent Configurations: - Interfaces using consistent PointSource naming conventions - Standard Location1 values for interface identification - Predictable tag naming patterns between source and target systems - Regular interface configurations across multiple connections

Automated Maintenance Requirements

Dynamic Environments: - Dynamic interface configurations that change frequently - Large numbers of tags that would be impractical to manage manually - Need for consistent lineage documentation across similar interfaces - Integration with automated deployment and configuration processes

How to Configure PI Interface Lineage

Step 1: Understand Your Interface Configuration

Before configuring interface lineage, gather information about your PI-to-PI interface:

Required Information: - Source PI Data Archive Name: The hostname or identifier of the source system - Target PI Data Archive Unique ID: The full unique identifier of the target system - PointSource Value: The PointSource attribute value set on interface tags - Location1 Value: The Location1 attribute value set on interface tags

Example Configuration: - Source: PIBYTN001 (source PI server hostname) - Target: \\PIServers[CentralNAPI] (target PI server unique ID) - PointSource: PIBYTN001_Interface - Location1: 1001 (numeric identifier)

Step 2: Access PI Interface Configuration

  1. Navigate to Lineage Management
  2. Select the PI Interface tab
  3. Review the section description and understand the configuration requirements

Step 3: Configure Interface Definition

Source PI Data Archive Name: - Enter the name/hostname of the source PI system - This should match how the source system identifies itself - Often the same as the PI server hostname

Target PI Data Archive UniqueID: - Enter the complete unique identifier of the target system - Use the format: \\PIServers[ServerName] - This must match exactly how the target system is identified in Osprey

PointSource for PItoPI Tags: - Enter the PointSource value used by the interface - This value is set on all tags transferred by the interface - Often includes the source system name for identification

Location1 for PItoPI Tags: - Enter the numeric Location1 value - This is typically a numeric identifier unique to each interface - Used to distinguish between multiple interfaces on the same target system

Step 4: Submit and Verify

  1. Click "Add Interface Definition" to create the configuration
  2. Verify the new definition appears in the "Existing PI Interface Definitions" table
  3. Check that all values are accurate
  4. Test the configuration by verifying that new interface tags generate appropriate lineage

How PI Interface Lineage Works

Automatic Relationship Creation

Once configured, the PI Interface lineage system:

  1. Monitors New Tags: Watches for new tags added to the target PI Data Archive
  2. Matches Criteria: Identifies tags with matching PointSource and Location1 values
  3. Finds Source Tags: Locates corresponding tags in the source PI Data Archive
  4. Creates Relationships: Automatically generates lineage relationships between source and target tags
  5. Maintains Currency: Updates relationships as interface configurations change

Relationship Patterns

The system creates relationships based on tag name matching:

Direct Matches: - Tags with identical names in source and target systems - Most common pattern for standard PI-to-PI interfaces

Pattern Recognition: - Handles common naming conventions and prefixes - Supports systematic tag naming modifications

Metadata Correlation: - Uses tag attributes to improve matching accuracy - Considers additional metadata when available

Managing PI Interface Lineage

Viewing Interface Definitions

The PI Interface table displays: - Source Archive: Name of the source PI Data Archive - Target Archive: Unique ID of the target PI Data Archive - Point Source: PointSource value used for matching - Location1: Location1 value used for matching - Actions: Delete option for each definition

Modifying Interface Definitions

To modify an existing interface definition: 1. Delete the current definition using the delete button 2. Create a new definition with the updated values 3. Verify that existing relationships are updated appropriately

Deleting Interface Definitions

  1. Locate the definition in the table
  2. Click the delete (trash) icon in the Actions column
  3. Confirm the deletion when prompted
  4. Note that existing relationships created by this definition may be preserved

Best Practices for PI Interface Lineage

Configuration Planning

Documentation First: - Document interface configurations before setting up lineage - Coordinate with PI administrators to understand interface patterns - Maintain records of interface design decisions

Testing Approach: - Test configurations with a small subset of tags before full deployment - Verify automatic relationship creation works as expected - Monitor initial deployment for any issues

Naming Conventions: - Maintain consistent naming conventions across interfaces - Use descriptive PointSource values that identify the interface purpose - Establish standards for Location1 values across the organization

Monitoring and Maintenance

Regular Verification: - Regularly verify that automatic lineage creation is working correctly - Monitor for new interface deployments that need lineage configuration - Review interface definitions when PI systems are upgraded or reconfigured

Alert Configuration: - Establish alerts for interface failures that might affect lineage accuracy - Monitor for changes in interface configuration that might break lineage - Set up notifications for new interface deployments

Performance Monitoring: - Monitor system performance impact of automatic lineage creation - Optimize configurations for environments with high tag volumes - Consider batch processing for large interface deployments

Integration Considerations

Process Integration: - Coordinate with automated PI deployment processes - Ensure lineage configurations are included in disaster recovery procedures - Plan for interface decommissioning and cleanup procedures

Change Management: - Consider the impact of interface changes on existing lineage relationships - Establish procedures for updating lineage when interfaces are modified - Coordinate lineage updates with system change management processes

Documentation Standards: - Maintain comprehensive documentation of interface lineage configurations - Include business justification for automated lineage patterns - Keep records of configuration changes and their rationale

Advanced Configuration Scenarios

Multiple Interfaces Per Target

Scenario: Multiple source systems feeding into a single target PI Data Archive

Configuration Approach: - Create separate interface definitions for each source system - Use unique Location1 values to distinguish between interfaces - Ensure PointSource values clearly identify each source

Example: - Interface 1: Source=PLANT_A_PI, Location1=1001 - Interface 2: Source=PLANT_B_PI, Location1=1002 - Interface 3: Source=PLANT_C_PI, Location1=1003

Cascading Interfaces

Scenario: Data flows through multiple PI systems in sequence

Configuration Approach: - Create interface definitions for each stage of the cascade - Ensure consistent tag naming through the cascade - Consider the cumulative impact on lineage depth

Example Flow: - Regional PI → Corporate PI → Analytics PI - Each stage requires its own interface definition - Final lineage shows complete data path

Complex Naming Patterns

Scenario: Interface modifies tag names during transfer

Considerations: - Document naming transformation rules - Test pattern matching with representative tags - Consider supplementing with manual lineage for exceptions

Troubleshooting PI Interface Lineage

Common Problems and Solutions

No Automatic Relationships Created: - Cause: PointSource and Location1 values don't match interface configuration - Solution: Verify configuration values match actual interface settings - Prevention: Coordinate with PI administrators during configuration

Missing Source Tags: - Cause: Source PI Data Archive is not properly scanned or accessible - Solution: Ensure source system is properly configured in Osprey scanners - Prevention: Verify scanner configuration before setting up interface lineage

Incorrect Tag Matching: - Cause: Tag naming patterns don't match between source and target - Solution: Review tag naming patterns and interface configuration - Prevention: Test with representative tags before full deployment

Performance Issues: - Cause: Large number of interface tags causing processing delays - Solution: Optimize scanner schedules and consider batch processing - Prevention: Plan capacity for high-volume interface environments

Validation Procedures

Configuration Validation: 1. Verify interface definition values match actual PI Interface configuration 2. Test with a small number of representative tags 3. Confirm automatic relationship creation works as expected 4. Monitor for any error messages or processing issues

Relationship Verification: 1. Sample check created relationships for accuracy 2. Verify that source and target tags are correctly identified 3. Confirm that relationship direction is appropriate 4. Test lineage visualization to ensure relationships display correctly

Integration with Osprey Features

Impact on Explorer Page

Enhanced Navigation: - Interface lineage relationships improve asset discovery - Related assets are easier to find across PI systems - Data flow context enhances asset management decisions

Search Capabilities: - Search can traverse interface lineage relationships - Find source data for interface tags more easily - Discover all targets fed by a source system

Issue Management Enhancement

Root Cause Analysis: - Trace interface data quality issues back to source systems - Understand which target systems are affected by source problems - Plan coordinated fixes across interface boundaries

Impact Assessment: - Quickly identify all systems affected by interface failures - Understand downstream impact of source system issues - Plan maintenance windows considering interface dependencies

Reporting and Analytics

System Integration Reports: - Document interface connections for compliance purposes - Generate reports on data flow patterns across PI systems - Support capacity planning and performance analysis

Business Intelligence: - Provide complete data lineage for analytics initiatives - Support data governance with comprehensive interface documentation - Enable advanced analytics across integrated PI environments