Document Outline

• Table of Contents
• Chapter 1. Introduction
  • Interface Limitations
  • Interface Requirements
  • Reference Manuals
    • Rockwell Automation
  • Supported Operating Systems
  • Supported Features
    • APS Connector
    • Supports Questionable Bit
    • Uses PI SDK
    • Maximum Point Count
    • Source of Timestamps
    • History Recovery
    • UniInt-based
    • SetDeviceStatus
    • Failover
    • Device Point Types
  • Diagram of Hardware Connection
• Chapter 2. Principles of Operation
  • Interface Startup
  • How FactoryTalk Historian to Historian Finds Source Points
  • Data Collection
  • History Recovery
  • Exception Data Collection
    • Maximizing Data Throughput
  • Archive Data Collection
    • Performance Considerations
      • Load Distribution
      • Scan Rates
  • Data Timestamps
  • Data Type Conversions
  • Interface Status Events
  • Adding, Removing and Editing Tags
  • Error Handling
  • Source Historian Server-Level Failover
  • Fault Conditions
    • Communication Failure
    • Detection of Stale Data
  • UniInt Failover
  • Interface Status Tags
  • Internal State Status
  • Failover Status
  • Deployment Scenarios
  • Historian to Historian within a Historian Collective
    • Tag Attribute Override Parameters
      • Example Architecture for Historian to Historian within a Historian Collective
      • Firewall Considerations
    • Historian to Historian between Historian Collectives
      • Limitations
        • Historian Collective Support
        • Data Latency and Source Historian Server Failover
        • UniInt Failover
• Chapter 3. Installation Checklist
  • Data Collection Steps
  • Interface Diagnostics
  • Advanced Interface Features
• Chapter 4. Interface Installation
  • Naming Conventions and Requirements
    • When Configuring the interface Manually
  • Interface Directories
    • PIHOME Directory Tree
    • Interface Installation Directory
  • Interface Installation Procedure
  • Installing Interface as a Windows Service
  • Installing Interface Service with Historian Interface Configuration Utility
    • Service Configuration
      • Service name
      • ID
      • Display name
      • Log on as
      • Password
      • Confirm password
      • Dependencies
      • - Add Button
      • - Remove Button
      • Startup Type
      • Create
      • Remove
      • Start or Stop Service
    • Installing Interface Service Manually
• Chapter 5. PointSource
  • Case-sensitivity for PointSource Attribute
• Chapter 6. Historian Point Configuration
  • Point Attributes
    • Tag
      • Length
    • PointSource
    • PointType
    • Location1
    • Location2
    • Location3
    • Location4
      • Scan-based Inputs
    • Location5
    • InstrumentTag
      • Length
    • ExDesc
      • Length
      • Performance Points
    • UserInt1
    • Scan
    • Shutdown
      • Bufserv and PIBufss
  • Exception and Compression
    • Interface Configurations
    • Recommended Tag Configurations
    • DataAccess, PtAccess
    • Zero, Span
• Chapter 7. Interface Status Tag Configuration
• Chapter 8. Startup Command File
  • Configuring the interface with ICU
    • FactoryTalk Historian to Historian Interface page
      • Required/General Tab
        • Required Parameters - Source host
        • Required Parameters - PIx Server
        • Required Parameters - Event counter
        • PI2 Security File – Use PI2 security file
        • PI2 Security File - Unique Part
        • PI2 Security File - User
        • PI2 security File - Password
        • Additional Parameters
      • History Recovery Tab
        • Maximum hours of history to recover
        • Hours of history to recover per cycle
        • Millisecond pause between history calls
        • Use history recovery only (no snapshot data collection)
        • History time range (dd-mmm-yy:hh:mm:ss,dd-mmm-yy:hh:mm:ss)
        • Start history recovery beginning with the first value prior to the start time.
      • Debug Tab
        • Debug Parameters
        • Interface Status Tag on Receiving Historian Server:
      • Location Tab
        • Override Location 1
        • Override Location 2
        • Override Location 3
        • Override Location 4
        • Override Location 5
      • Optional Tab
      • Apply tag’s compression specifications to data retrieved during history recovery.
      • Source tag definition attribute.
        • Specify maximum events to retrieve for a single point in each call to get history.
        • Specify maximum number of exception events retrieved per data request.
        • Set time interval between clearing exception queue during history recovery.
        • Specify the frequency that the interface calculates time offset between Historian Servers.
      • Opt Cont Tab
        • Source Host reconnection delay.
        • Receiving Host reconnection delay.
        • Suppress writing I/O Timeout to tags upon reestablishment of a lost connection to the source Historian Server
      • Source Historian Server Failover Tab
        • Enable PItoPI Failover
        • Source Server Interface Status Utility Tag
        • Secondary Source Server Node Name
        • Secondary Source Int Status Utility Tag
        • Number of connection attempts to source server
        • Enable failover status logging.
  • Configuring Interface Startup Files
  • Command-line Parameters
    • General Interface Operation
    • History Recovery and Archive Data Collection
    • Exception Data Collection
    • Tag Attribute Override
    • Server-Level Failover
  • Sample Startup Configuration Files
    • Sample PItoPI.bat File
    • Sample PItoPI.ini File
• Chapter 9. UniInt Failover Configuration
  • Introduction
    • Configuration
    • Prerequisites
  • Synchronization through a Shared File (Phase 2)
  • Configuring Synchronization through a Shared File (Phase 2)
  • Configuring UniInt Failover through a Shared File (Phase 2)
    • Start-Up Parameters
    • Failover Control Points
    • Historian Tags
      • Active_ID Tag Configuration
      • Heartbeat and Device Status Tag Configuration
      • Interface State Tag Configuration
  • Detailed Explanation of Synchronization through a Shared File (Phase 2)
    • Steady State Operation
  • Failover Configuration Using ICU
  • Create the interface Instance with ICU
  • Configuring the UniInt Failover Startup Parameters with ICU
  • Creating the Failover State Digital State Set
    • Using the ICU Utility to create Digital State Set
    • Using the SMT 3 Utility to create Digital State Set
  • Creating the UniInt Failover Control and Failover State Tags (Phase 2)
• Chapter 10. Interface node Clock
• Chapter 11. Security
  • Historian Server v3.3 and Higher
    • Security configuration using piconfig
    • Security Configuring using Trust Editor
  • Historian Server v3.2
  • Tag and Node Security
  • System Manager Responsibilities
    • Receiving System Manager
    • Source System Manager
  • Sample Security Files
    • Sample 1
    • Sample 2
• Chapter 12. Starting / Stopping the interface
  • Starting Interface as a Service
  • Stopping Interface Running as a Service
• Chapter 13. Buffering
  • Which Buffering Application to Use
  • How Buffering Works
  • Buffering and Historian Server Security
  • Enabling Buffering on an Interface Node with the ICU
    • Choose Buffer Type
    • Buffering Settings
      • PIBufss
        • Primary and Secondary Memory Buffer Size (Bytes)
        • Send rate (milliseconds)
        • Maximum transfer objects
        • Event Queue File Size (Mbytes)
        • Event Queue Path
      • Bufserv
        • Maximum buffer file size (KB)
        • Primary and Secondary Memory Buffer Size (Bytes)
        • Send rate (milliseconds)
        • Maximum transfer objects
    • Buffered Servers
      • PIBufss
      • Bufserv
    • Installing Buffering as a Service
      • Buffer Subsystem Service
      • API Buffer Server Service
• Chapter 14. Interface Diagnostics Configuration
  • Scan Class Performance Points
    • Create / Create ALL
    • Delete
    • Correct / Correct All
    • Rename
    • Column descriptions
      • Status
      • Scan Class #
      • Tagname
      • PS
      • Location1
      • Exdesc
      • Snapshot
  • Performance Counters Points
    • Performance Counters
    • Performance Counters for both (_Total) and (Scan Class x)
      • “Point Count” (.point_count)
      • “Scheduled Scans: % Missed” (.sched_scans_%missed)
      • “Scheduled Scans: % Skipped” (.sched_scans_%skipped)
      • “Scheduled Scans: Scan count this interval” (.sched_scans_this_interval)
    • Performance Counters for (_Total) only
      • “Device Actual Connections” (.Device_Actual_Connections)
      • “Device Expected Connections” (.Device_Expected_Connections)
      • “Device Status” (.Device_Status)
      • “Failover Status” (.Failover_Status)
      • “Interface up-time (seconds)” (.up_time)
      • “IO Rate (events/second)” (.io_rates)
      • “Log file message count” (.log_file_msg_count)
      • “Historian Status” (PI_Status)
      • “Points added to the interface” (.pts_added_to_interface)
      • “Points edited in the interface”(.pts_edited_in_interface)
      • “Points Good” (.Points_Good)
      • “Points In Error” (.Points_In_Error)
      • “Points removed from the interface” (.pts_removed_from_interface)
      • “Points Stale 10(min)” (.Points_Stale_10min)
      • “Points Stale 30(min)” (.Points_Stale_30min)
      • “Points Stale 60(min)” (.Points_Stale_60min)
      • “Points Stale 240(min)” (.Points_Stale_240min)
    • Performance Counters for (Scan Class x) only
      • “Device Scan Time (milliseconds)” (.Device_Scan_Time)
      • “Scan Time (milliseconds)” (.scan_time)
  • Interface Health Monitoring Points
    • [UI_HEARTBEAT]
    • [UI_DEVSTAT]
    • [UI_SCINFO]
    • [UI_IORATE]
    • [UI_MSGCOUNT]
    • [UI_POINTCOUNT]
    • [UI_OUTPUTRATE]
    • [UI_OUTPUTBVRATE]
    • [UI_TRIGGERRATE]
    • [UI_TRIGGERBVRATE]
    • [UI_SCIORATE]
    • [UI_SCBVRATE]
    • [UI_SCSCANCOUNT]
    • [UI_SCSKIPPED]
    • [UI_SCPOINTCOUNT]
    • [UI_SCINSCANTIME]
    • [UI_SCINDEVSCANTIME]
  • I/O Rate Point
    • Enable IORates for this Interface
      • Event Counter
      • Tagname
      • Tag Status
      • In File
      • Snapshot
    • Right Mouse Button Menu Options
      • Create
      • Delete
      • Rename
      • Add to File
      • Search
  • Interface Status Point
• Appendix A. Error and Informational Messages
  • Message Logs
  • Messages
  • Interface Startup Messages
  • Scan Summary
  • System Errors and Historian Errors
    • Error Descriptions
  • Historian to Historian Specific Error Messages
  • UniInt Failover Specific Error Messages
    • Informational
    • Errors (Phase 1 & 2)
    • Errors (Phase 2)
      • Unable to open synchronization file
      • Error Opening Synchronization File
• Appendix B. PI SDK Options
  • Disable PI SDK
  • Use the Interface’s default setting
  • Enable PI SDK
• Appendix C. Terminology
  • Buffering
  • N-Way Buffering
  • ICU
  • ICU Control
  • Interface Node
  • PI API
  • Historian Collective
  • PIHOME
  • PIHOME64
  • PI SDK
  • Historian Server Node
  • SMT
  • pipc.log
  • Point
  • Service
  • Tag (Input Tag and Output Tag)
• Appendix D. Technical Support and Resources
  • Technical Support
    • Knowledgebase
    • Worldwide Support
    • Training Programs
    • Consulting Services
    • TechConnect Support
    • Find the Version and Build Numbers
    • View Computer Platform Information