Skip to main content

Integration

Integration guides for connecting Sigmafine with external systems and data sources.

Overview​

Sigmafine and SigmafineHub can integrate with various external systems including PI System, databases, Excel, and web services. This section provides guidance for setting up and troubleshooting these integrations.

Integration Categories​

PI System Integration​

Connecting to OSIsoft PI Data Archive and PI Asset Framework.

Database Connections​

Integrating with SQL Server, Oracle, and other databases.

Excel Integration​

Using Excel Add-In and importing/exporting data.

Web Services & APIs​

Connecting to external web services and REST APIs.

Common Integration Scenarios​

PI Data Archive Integration​

Key Features:

  • Real-time tag data retrieval
  • Historical data queries
  • Event frame integration
  • PI AF hierarchy navigation

Configuration Steps:

  1. Install PI SDK on Sigmafine server
  2. Configure PI connection in Sigmafine settings
  3. Set up PI trust on PI Server
  4. Test connection and tag access

Detailed PI Integration Guide

SQL Database Integration​

Supported Databases:

  • Microsoft SQL Server 2016+
  • Oracle Database 11g+
  • Other ODBC-compliant databases

Common Use Cases:

  • Import reconciliation data
  • Export calculated results
  • Query reference data
  • Custom data sources

Database Integration Guide

Excel Add-In Integration​

Features:

  • Direct data access from Excel
  • Formula-based queries
  • Refresh capabilities
  • Template-based reporting

Requirements:

  • Microsoft Excel 2016 or later
  • .NET Framework 4.7.2+
  • Sigmafine Excel Add-In installed

Excel Integration Guide

Third-Party System Integration​

Integration Methods:

  • REST API calls
  • SOAP web services
  • File-based import/export
  • ODBC connections

Integration Best Practices​

Security​

  1. Use Service Accounts

    • Create dedicated service accounts for integrations
    • Apply principle of least privilege
    • Regularly rotate credentials

  2. Secure Connections

    • Use encrypted connections (HTTPS, TLS)
    • Configure firewall rules appropriately
    • Enable authentication and authorization

  3. API Key Management

    • Store API keys securely (Key Vault, encrypted config)
    • Never hardcode credentials in scripts
    • Implement key rotation policies

Performance​

  1. Query Optimization

    • Use appropriate time ranges
    • Implement paging for large datasets
    • Cache frequently accessed data

  2. Connection Pooling

    • Enable database connection pooling
    • Configure appropriate pool sizes
    • Monitor connection usage

  3. Error Handling

    • Implement retry logic with exponential backoff
    • Log errors for troubleshooting
    • Set appropriate timeout values

Maintenance​

  1. Monitor Integration Health

    • Track connection status
    • Monitor data flow rates
    • Set up alerts for failures

  2. Version Compatibility

    • Verify compatibility before upgrades
    • Test integrations in staging environment
    • Document version dependencies

  3. Documentation

    • Document integration architecture
    • Maintain configuration records
    • Keep credential inventory updated

Data Flow Patterns​

Real-Time Data​

graph LR
    A[PI Data Archive] -->|Real-time| B[Sigmafine Server]
    B --> C[SigmafineHub]
    C --> D[Dashboard]

Characteristics:

  • Sub-second latency
  • Streaming updates
  • Event-driven processing

Batch Processing​

graph LR
    A[External DB] -->|Scheduled| B[Sigmafine DataLoader]
    B --> C[Sigmafine Database]
    C --> D[Reconciliation Engine]

Characteristics:

  • Scheduled execution
  • Large data volumes
  • Transform and validate

Hybrid Approach​

Combination of:

  • Real-time process data (PI System)
  • Batch laboratory data (Excel/Database)
  • On-demand calculations (API calls)

Common Integration Issues​

Authentication Failures​

Symptoms:

  • "Access Denied" errors
  • 401/403 HTTP status codes
  • Login failures

Solutions:

  • Verify credentials are current
  • Check account permissions
  • Confirm trust/security settings
  • Review firewall rules

Data Sync Issues​

Symptoms:

  • Missing or delayed data
  • Duplicate records
  • Data inconsistencies

Solutions:

  • Check timestamp handling (time zones)
  • Verify data mapping configuration
  • Review transformation logic
  • Check for network interruptions

Performance Problems​

Symptoms:

  • Slow query responses
  • Timeout errors
  • High resource usage

Solutions:

  • Optimize query filters
  • Implement result paging
  • Reduce query frequency
  • Scale resources as needed

Integration Tools​

Sigmafine Data Loader​

Purpose: Batch import of data from various sources

Features:

  • Template-based configuration
  • Scheduled execution
  • Error logging and retry
  • Data validation

Data Loader Documentation

Sigmafine Data Importer​

Purpose: Import data from Excel and CSV files

Features:

  • Interactive file selection
  • Column mapping
  • Preview and validate
  • Manual or automated import

Data Importer Documentation

Web API​

Purpose: Programmatic access to Sigmafine data and functions

Features:

  • RESTful endpoints
  • JSON responses
  • Authentication via API keys
  • Comprehensive documentation

Testing Integrations​

Connection Testing​

# Test SQL connection
Test-SqlConnection -ServerInstance "server\\instance" -Database "Sigmafine"

# Test network connectivity
Test-NetConnection -ComputerName piserver -Port 5450

# Test web service
Invoke-RestMethod -Uri "https://api.example.com/health" -Method Get

Data Validation​

  1. Compare Source and Destination

    • Record counts
    • Sample data verification
    • Checksum validation

  2. Test Edge Cases

    • Null values
    • Special characters
    • Date/time boundaries

  3. Load Testing

    • High volume scenarios
    • Concurrent connections
    • Long-running queries

Additional Resources​

Need Help?​

For integration assistance:

  • Review Support Articles
  • Contact Sigmafine Support
  • Check vendor documentation for third-party systems
Last updated on