Sync Operational Intelligence Sites

This feature is not available in DWS Mode.

Overview

The Operational Intelligence Site Sync process synchronizes the VoiceConsole site hierarchy with Operational Intelligence and maintains consistent site data and configuration across both platforms.

The VoiceConsole license must support Operational Intelligence.

Key Benefits

  • Automatically downloads and associates onboarding XML files.

  • Onboarding files are automatically renewed when synchronization is enabled, preventing expiration issues.

  • Mappings use site IDs rather than site names. Therefore, renaming a site in either platform does not disrupt existing synchronization.

Generating API Credentials

Before starting the synchronization in VoiceConsole, you must generate credentials from the Operational Intelligence portal:

  1. Log in to Operational Intelligence.

  2. Select the Profile icon and open Subscription.

  3. Navigate to APIs Manager.

  4. Generate API credentials and record the Username and Password.

If you have forgotten your password, use the Reset Password feature in the APIs Manager.

Synchronize the Operational Intelligence Sites

  1. Open VoiceConsole and click the Administration tab.

  2. In the Administrationsection, click Sites.

  3. Under Site Actions, click Sync Operational Intelligence Sites.

  4. Provide API Credentials: Enter the API Username and Password generated in the Prerequisites step.

    If credentials are invalid, a red banner displays the error message.

  5. Select Root Site: Select the required Root Site from the Select Root Site drop-down list to begin the site selection process. After you select a root site, all the associated sites within the selected root are displayed. You can either synchronize the entire site hierarchy or filter and select only the sites you want to synchronize.

  6. Filter Sites: To synchronize the entire site hierarchy, select the checkbox in the Site Name column header to select all sites in the list. To synchronize specific sites, select the corresponding site checkbox. Only selected sites are available for mapping in the next step.

  7. Map Operational Intelligence Sites: Map each selected Operational Intelligence site to the corresponding VoiceConsole site.

    • Automatic Mapping: Click Match to map sites with matching names. VoiceConsole automatically maps Operational Intelligence site names that match VoiceConsole site names.

    • Manual Mapping: If the site is not automatically mapped, select the appropriate VoiceConsole site from the drop-down list.

    • New Operational Intelligence Site Creation: If a site does not exist in Operational Intelligence, select New Operational Intelligence Site from the drop-down list. During synchronization, VoiceConsole creates the site in Operational Intelligence and maps it to the corresponding VoiceConsole site.

    • New VoiceConsole Site Creation: If you need to map more Operational Intelligence sites than existing VoiceConsole sites, select the unmapped Operational Intelligence sites and complete the synchronization. The application creates new VoiceConsole sites and uses the corresponding Operational Intelligence site names.

  8. Review Synchronization Summary: Review the site mappings and sites to be created.

    • Verify that the Operational Intelligence Site and VoiceConsole Site pairings are correct.

  9. Confirm and Complete Synchronization: Click Confirm to validate the site mappings and prepare the synchronization queue. Click Continue to initiate synchronization.

  10. Review Results: View the success or failure report for site creations and XML retrievals.

  11. Click Finish to update the Sites table with the newly synchronized Operational Intelligence mappings.

Post-Synchronization Behavior

After synchronization is complete, the View Sites table displays the following Operational Intelligence Configuration details:

  • The associated Operational Intelligence Site name.

  • The Configuration Expiration Date for the onboarding file.

  • The current Mapping Relationship status.

Device Onboarding Behavior

After synchronization, devices onboarded using the configuration associated with their assigned VoiceConsole site:

  • A device receives the onboarding XML file associated with its current VoiceConsole site and automatically registers with the mapped Operational Intelligence site.

  • If a device is moved to a different VoiceConsole site, it onboards to the Operational Intelligence site mapped to that new site.

Expiration Handling

The behavior for onboarding file expiration depends on whether Site Sync is enabled:

  • Without Site Sync: When an onboarding file is about to expire, VoiceConsole generates a notification. Manually download the renewed onboarding file from the Operational Intelligence portal and upload it to VoiceConsole.

  • With Site Sync enabled: VoiceConsole manages the expiration logic automatically and retrieves renewed onboarding files before the current files expire, ensuring uninterrupted device onboarding.

Troubleshooting and Icons

  • Green Check: Synchronization successful.

  • Red X: Synchronization failed. Click the icon to view the specific error (e.g., "XML retrieval failed").

  • Login Errors: Verify credentials in the Operational Intelligence API Manager if the sign-in banner appears.

Renaming a site in either VoiceConsole or Operational Intelligence does not break existing mappings. All synchronization relationships are maintained using internal Site IDs, not site names.