1. Introduction

Welcome to APIBridge.Metro, the professional graphical user interface for integrating with Genetec Security Center. This manual provides comprehensive guidance for installation, configuration, and operation of the application.

APIBridge.Metro is designed to simplify the management of cameras, analog monitors, and other security entities within your Genetec Security Center environment. It provides an intuitive interface for tasks that previously required command-line operations or manual configuration.

About WINK Streaming

WINK Streaming is an authorized partner of Genetec Security Center, specializing in video management and streaming solutions. Our tools are designed to enhance and extend the capabilities of Security Center installations.

2. Product Overview

Key Features

• Professional GUI Interface: Modern, intuitive interface built with WPF and MahApps.Metro
• Comprehensive Entity Management: View and manage cameras, analog monitors, and video units
• Automated Monitor Association: Distribute cameras across monitors evenly
• Data Export: Export configurations in XML format for documentation and backup
• Windows Service Integration: Automated monitoring with email or HTTP notifications
• Secure Credential Storage: Uses Windows DPAPI for encrypted credential storage

Target Audience

This application is designed for:

• Security Center administrators
• System integrators
• Technical support personnel
• Anyone managing Genetec Security Center deployments

Version Information

3. System Requirements

Minimum Requirements

• Operating System: Windows 10 (64-bit) or Windows Server 2016 or later
• Processor: Intel Core i3 or equivalent
• Memory: 4 GB RAM
• Storage: 500 MB available disk space
• .NET Framework: 4.8 or later
• Network: TCP/IP connection to Genetec Security Center

Recommended Requirements

• Operating System: Windows 11 or Windows Server 2022
• Processor: Intel Core i5 or better
• Memory: 8 GB RAM or more
• Storage: 1 GB available disk space
• Display: 1920x1080 resolution or higher

Genetec Security Center Requirements

• Security Center Version: 5.9 or later
• SDK License: Part # GSC-1SDK-WINK-FORGE
• SDK User Account: With appropriate permissions (see Configuration section)
• Network Access: Port 5500 (TCP) to Security Center server

4. Installation Guide

Prerequisites

1. Ensure all system requirements are met
2. Install Genetec Security Center SDK (version 5.9 or later)
3. Obtain administrator privileges on the target machine
4. Verify network connectivity to Security Center server

Installation Steps

1. Download the Application
   • Obtain the latest APIBridge.Metro installer from WINK Streaming
   • Verify the file integrity using provided checksums
2. Install the Genetec SDK
   • Default location: C:\Program Files (x86)\Genetec Security Center 5.12 SDK
   • Ensure all SDK components are installed
3. Run the Installer
   • Right-click the installer and select "Run as administrator"
   • Follow the installation wizard prompts
   • Accept the license agreement
   • Choose installation directory (default recommended)
4. Complete Installation
   • Allow installer to create desktop shortcuts
   • Launch application when installation completes

Post-Installation

• Verify application launches successfully
• Check that all tabs are visible in the interface
• Confirm SDK version in Settings tab
• Review activity log for any initialization errors

5. Genetec Security Center Configuration

Before using APIBridge.Metro, you must configure appropriate user accounts and permissions in Genetec Security Center. This section provides detailed instructions for setting up the required SDK user.

5.1 Creating the SDK User

APIBridge.Metro requires a dedicated SDK user account with specific permissions to access Security Center data.

Step 1: Open Config Tool

1. Launch Genetec Config Tool on your Security Center server
2. Log in with administrator credentials
3. Navigate to the User Management section

Step 2: Create New User

1. Click "Add User" or right-click and select "New User"
2. Enter the following information:
   • Username: winkSDK
   • First Name: WINK
   • Last Name: SDK User
   • Password: (Set a strong password)
   • Email: (Optional, for notifications)
3. Enable "User can log on using the SDK" option
4. Set "Password never expires" if appropriate for your security policy

Figure 1: Creating the winkSDK user in Genetec Config Tool

5.2 Configuring Permissions

The SDK user requires specific permissions to access and manage Security Center entities. Follow these steps to configure the necessary privileges.

Required Permissions

Setting Permissions

1. In Config Tool, select the winkSDK user
2. Navigate to the "Privileges" tab
3. Enable each required permission by checking the appropriate boxes
4. Pay special attention to:
   • "View role properties"
   • "View role resources"
   • "View access control unit properties"
   • "Modify ALPR unit properties" (if applicable)

Figure 2: Configuring role permissions for the SDK user

Figure 3: Setting unit permissions

Figure 4: Additional unit permissions configuration

Figure 5: Camera units and cameras permissions

Figure 6: SDK-specific privileges configuration

5.3 Setting Up Partitions

For enhanced security and organization, it's recommended to create a dedicated partition for WINK Streaming operations.

Creating a Partition

1. In Config Tool, navigate to "System" → "Partitions"
2. Click "Add Partition" or right-click and select "New Partition"
3. Configure the partition:
   • Name: winkStreaming
   • Description: WINK Streaming SDK Access
   • Parent Partition: (Select appropriate parent)
4. Save the partition configuration

Assigning User to Partition

1. Select the winkSDK user
2. Navigate to the "Partitions" tab
3. Add the winkStreaming partition to the user's accessible partitions
4. Set appropriate permission levels within the partition

Figure 7: Creating a partition in Config Tool

Figure 8: Adding entities to the partition

Partition Benefits

• Security Isolation: Limits SDK user access to specific entities
• Audit Trail: Easier tracking of SDK operations
• Resource Management: Control which cameras and monitors are accessible
• Multi-tenant Support: Separate different client configurations

5.4 Configuring Analog Monitors

If you're using analog monitors (virtual decoders), proper configuration in Security Center is essential for the association features in APIBridge.Metro.

Creating Analog Monitors

Figure 9: Creating analog monitors in Security Center

Naming Convention

Follow a consistent naming pattern for analog monitors:

• Use prefix like "WF" followed by numbers (WF001, WF002, WF003)
• Include UDP port or channel in the name for clarity
• Example: "WF001 - 8000" where 8000 is the UDP port

Figure 10: Analog monitor naming convention examples

Renaming Monitors

When renaming monitors through APIBridge.Metro:

Figure 11: Confirmation dialog when renaming related devices

Figure 12: Results after renaming analog monitors

6. Getting Started

6.1 First Launch

When you first launch APIBridge.Metro, you'll see the main interface with the following components:

Figure 13: APIBridge.Metro main interface on first launch

Interface Components

• Header: Shows WINK Streaming logo and connection status
• Navigation Panel: Left sidebar with numbered steps and utility tabs
• Content Area: Main area displaying current tab content
• Activity Log: Bottom panel showing real-time operation logs
• Footer: Links to privacy policy and company information

Initial Setup Checklist

1. Verify Genetec SDK is installed (check Settings tab)
2. Ensure you have Security Center connection details:
   • Server hostname or IP address
   • SDK username and password
   • Port number (default: 5500)
3. Check network connectivity to Security Center server
4. Review the help tips banner for important information

6.2 Connectivity Verification

Before attempting to connect and perform operations, use the Connectivity & Permissions Verification tab to ensure your environment is properly configured.

Figure 14: Connectivity & Permissions Verification tab

Running Connectivity Test

1. Click on "Connectivity & Permissions Verification" in the navigation panel
2. Enter your connection details:
   • Hostname/IP: Security Center server address
   • Username: SDK user (e.g., winkSDK)
   • Password: SDK user password
   • Domain Auth: Check if using Windows authentication
3. Click "Run Verification" button
4. Review the results in the verification report

Understanding Test Results

6.3 Connecting to Security Center

After verifying connectivity, proceed to establish a full connection to Security Center.

Figure 15: Step 1 - Connect to Security Center

Connection Process

1. Navigate to "Step 1: Connect to Security Center"
2. Enter connection details:
   • Hostname or IP: Your Security Center server
   • Username: SDK user credentials
   • Password: SDK user password
   • Port: 5500 (default)
3. Optional: Click "Test Connection" to verify before full connection
4. Click "Connect" to establish connection
5. Monitor the Activity Log for connection status

Connection States

• Disconnected (Red): No active connection
• Connecting (Yellow): Connection in progress
• Connected (Green): Successfully connected

Troubleshooting Connection Issues

7. Features

7.1 List Cameras

The List Cameras feature provides a comprehensive view of all cameras in your Security Center system.

Figure 16: Step 2 - List Cameras interface

Available Information

• Name: Camera display name
• Description: Additional camera details
• Status: Online/Offline indicator
• Resolution: Video resolution (e.g., 1920x1080)
• Model: Camera model information
• Manufacturer: Camera manufacturer

Features

• Sorting: Click column headers to sort
• Filtering: Use search box to filter cameras
• Export: Export list to CSV format
• Refresh: Update camera list from server

Usage Tips

• Double-click a camera row to view additional details
• Use Ctrl+Click to select multiple cameras
• Right-click for context menu options
• Export regularly for documentation purposes

7.2 List Decoders

The List Decoders feature displays all analog monitors (decoders) in your system with their current configurations.

Figure 17: Step 3 - List Decoders showing analog monitors

Decoder Information

Common Use Cases

• Identify unconnected monitors
• Verify monitor configurations
• Check network settings
• Export for network documentation

7.3 List Entities

The List Entities feature provides a comprehensive view of all entity types in Security Center.

Figure 18: Step 4 - List Entities showing all entity types

Entity Types

• Cameras: All video sources
• Analog Monitors: Decoder devices
• Video Units: Hardware units containing decoders
• Alarms: System alarms and events
• Areas: Logical groupings
• Doors: Access control points
• Custom Entities: User-defined types

Entity Details

For each entity, the following information is available:

• GUID (Unique identifier)
• Name and description
• Type classification
• Parent entity relationships
• Custom field values
• Current status

Navigation

• Use tabs to switch between entity types
• Expand tree nodes to view hierarchies
• Search across all entities
• Export selected entity types

7.4 Associate Monitors

The Associate Monitors feature automates the distribution of cameras across analog monitors.

Figure 19: Step 5 - Associate Monitors Evenly

How It Works

1. Load Current Configuration: Retrieves all cameras and monitors
2. Calculate Distribution: Evenly distributes cameras across monitors
3. Preview Changes: Shows proposed associations before applying
4. Apply Updates: Updates monitor names to reflect associations

Association Process

Important Limitations

Naming Convention

After association, monitor names follow this format:

Example: Front Entrance - WF301-8001

7.5 Review Data

The Review Data tab provides a comprehensive overview of your current configuration.

Figure 20: Step 6 - Review Data with tabbed interface

Review Sections

Cameras Tab

• Complete list of all cameras
• Status indicators
• Configuration details
• Export to CSV option

Monitors Tab

• All analog monitors
• Current associations
• Network information
• Connection status

Associations Tab

• Current camera-monitor pairs
• Unassociated devices
• Association history
• Configuration summary

Data Validation

Use this tab to:

• Verify configurations before export
• Identify configuration issues
• Check for unassociated devices
• Review system completeness

7.6 Export Data

The Export Data feature generates comprehensive XML documentation of your Security Center configuration.

Export Format

The export uses the "Forge" XML format with hierarchical structure:

<wink report_time="2025-01-24T10:30:00" generation_duration="2.5s">
    <monitors decoder_count="10" camera_count="40">
        <monitor_device ipaddress="192.168.1.100" macaddress="00:11:22:33:44:55">
            <monitor_unit>
                <decoder name="WF301-8001" udpport="8001">
                    <connectedcamera name="Front Entrance">
                        <!-- 58+ camera attributes -->
                    </connectedcamera>
                </decoder>
            </monitor_unit>
        </monitor_device>
    </monitors>
</wink>

Export Options

• Include Cameras: Export camera details
• Include Decoders: Export monitor information
• Include Offline: Include disconnected devices
• Custom Fields: Export user-defined attributes

Export Location

Files are saved to: %USERPROFILE%\Documents\GenetecForge_[timestamp].xml

8. Windows Service Configuration

8.1 Service Setup

The Windows Service enables automated monitoring and notification of Security Center changes.

Figure 22: Windows Service configuration tab

Service Features

• Automated Monitoring: Checks for changes every 20 minutes
• Change Detection: Identifies new, modified, or removed entities
• Notifications: Email or HTTP POST on changes
• History Tracking: Maintains 7-day change history

Configuration Steps

1. Enable "Use Windows Service" checkbox
2. Select delivery method:
   • Email notifications
   • Post to URL (Media Router)
3. Configure delivery settings
4. Enter Security Center credentials
5. Generate authentication key
6. Click "Install Windows Service"

Service Information

8.2 Delivery Methods

Email Notifications

Configure email delivery for change notifications:

Email Settings

• SMTP Server: Your mail server address
• Port: 587 (TLS) or 465 (SSL)
• Username: Email account username
• Password: Email account password (encrypted)
• Encryption: SSL/TLS, STARTTLS, or None
• To Address: Recipient email
• CC Addresses: Additional recipients (comma-separated)

Default WINK Configuration

HTTP POST (Media Router)

Configure HTTP POST delivery to a media router endpoint:

Media Router Settings

• Endpoint URL: Your media router API endpoint
• Authentication Key: 128-character key (auto-generated)
• Content Type: application/xml
• Method: POST

POST Format

POST /api/genetec HTTP/1.1
Host: your-media-router.com
Content-Type: application/xml
X-Auth-Key: [128-character-key]

<?xml version="1.0"?>
<signature>[authentication-key]</signature>
<wink>
    <!-- Genetec data XML -->
</wink>

8.3 Service Management

Installing the Service

1. Configure all settings in the Windows Service tab
2. Click "Install Windows Service" button
3. Accept UAC elevation prompt (required)
4. Wait for installation to complete
5. Service starts automatically after installation

Service Controls

Once installed, the following controls become available:

Service Status Indicators

• ● Running: Service is active and monitoring
• ● Stopped: Service is installed but not running
• ● Not Installed: Service is not present

Viewing Service Logs

Service activity is logged to Windows Event Log:

1. Open Event Viewer (eventvwr.msc)
2. Navigate to Windows Logs → Application
3. Filter by Source: "WINKSCDataMonitor"
4. Review service events and errors

9. Troubleshooting

Common Issues and Solutions

Connection Problems

Data Issues

Service Issues

Diagnostic Tools

Activity Log

The Activity Log provides real-time diagnostic information:

• Connection attempts and results
• API calls and responses
• Error messages with details
• Operation timings

To use the Activity Log effectively:

1. Enable verbose logging in Settings
2. Clear log before reproducing issue
3. Perform the failing operation
4. Export log for support

Permission Verification

Always run the Connectivity & Permissions test when troubleshooting to ensure all required permissions are granted.

10. Best Practices

Security Best Practices

1. Use Dedicated SDK Account
   • Create separate account for SDK access
   • Grant minimal required permissions
   • Use strong, unique password
   • Enable password expiration policies
2. Secure Network Communication
   • Use VPN for remote connections
   • Implement firewall rules for port 5500
   • Monitor SDK connection logs
   • Use encrypted email delivery
3. Credential Management
   • Never share SDK credentials
   • Rotate passwords regularly
   • Use Windows authentication when possible
   • Review stored credentials periodically

Operational Best Practices

1. Regular Maintenance
   • Export configurations weekly
   • Review unconnected monitors monthly
   • Update SDK to latest version
   • Clean up old export files
2. Change Management
   • Document all configuration changes
   • Test in non-production first
   • Use preview before applying changes
   • Maintain change log
3. Monitoring
   • Review Windows Service logs daily
   • Set up email alerts for changes
   • Monitor for unauthorized modifications
   • Track entity count trends

Performance Optimization

• Limit concurrent connections to Security Center
• Schedule exports during off-peak hours
• Use filtering to reduce data volume
• Close application when not in use
• Regular restart of Windows Service monthly

11. Appendix

Appendix A: XML Export Schema

The Forge XML export format follows this schema:

<wink report_time="datetime" generation_duration="duration">
    <monitors decoder_count="integer" camera_count="integer">
        <monitor_device ipaddress="string" macaddress="string" guid="guid">
            <monitor_unit commandport="integer">
                <decoder name="string" udpport="integer" 
                         IsOnline="boolean" guid="guid">
                    <description><![CDATA[text]]></description>
                    <custom_fields><![CDATA[text]]></custom_fields>
                    <connectedcamera name="string" guid="guid">
                        <!-- 58+ camera attributes -->
                    </connectedcamera>
                </decoder>
            </monitor_unit>
        </monitor_device>
    </monitors>
</wink>

Appendix B: Camera Attributes

The export includes these camera attributes:

Appendix C: Error Codes

Appendix D: Keyboard Shortcuts