Documentation Index

Fetch the complete documentation index at: https://support.nectarcorp.com/llms.txt

Use this file to discover all available pages before exploring further.

IPC Unigy VKM Configuration Guide

  • Published on Jun 6, 2022
  • 10 minute(s) read
Prev Next

Overview

IPC Unigy VKM provides a single, integrated platform for trading communications and applications. The IPC Unigy Vendor Knowledge Module (VKM) provides health and performance monitoring, system inventory, call history, and QoS data collections, dependency trees, and dashboards for the IPC Unigy platform. The VKM uses the Blue Wave API to collect all required information from the Blue Wave director. The VKM provides system monitoring as part of the Nectar Foundation solution and used by the Nectar Call Analysis Module (CAM).

About this Guide

This guide provides the instructions to configure the monitoring and management of the IPC Unigy system using the Nectar IPC Unigy VKM, a component of Nectar Foundation.

This guide explains how to:

Configure the IPC Unigy VKM
Configure VKM Options
View Events
View Collections
View Inventory Data
Export Historical Collections
IPC Unigy VKM and Nectar UCMP
Manage Server Configurations
Manage Collections

Audience

This guide is intended for system administrators or engineers who have system administration access and technical knowledge of the IPC Unigy system along with a familiarity with deploying Nectar Foundation.

Supported Software Versions

  • Nectar v8.7

Configure the IPC Unigy VKM

The Nectar IPC Unigy VKM is configured to monitor the system using alarm information received via SNMP traps and using the Blue Wave API to collect call and inventory data.

Configuring IPC Unigy VKM includes the following tasks:

Enable the IPC Unigy VKM
Add Permissions to a Group
Add a Server Configuration

Enable the IPC Unigy VKM

Follow these steps to enable the IPC Unigy VKM:

  1. Navigate to RIG > Module Configuration. The Module Configuration window appears.

Figure 2-1Enable IPC Unigy VKM

  1. Select IPC Unigy; then click Apply.

Note

Contact Nectar for the proper license.

The number of servers that can be onboarded is limited.

  1. To restart the RIG and apply the changes:
    1. Navigate to RIG > Admin > Restart.

The Restart confirmation window appears.


    1. Click Yes.

Figure 2-2Restart Confirmation

Note

If you log out and log in or start a new session, the newly selected module will not be enabled.

After you enable this module, IPC Unigy is now a module under the Modules

menu.

Add Permissions to a Group

Follow these steps to add permissions to a particular group of users to allow interaction with the VKM:

  1. Navigate to RIG > Permissions.

The Permissions - Users window appears.

  1. Click the Groups tab.
  2. Select a group in the Groups pane.

  1. Click Add Permission.

Figure 2-3Add Permission

The Add Permission to window appears.

Figure 2-4Add Permission

  1. Select a permission; then click Add.

The new permission appears in the Permissions pane when the Group is selected.

Figure 2-5Group Permissions

Add a Server Configuration

Before you can deploy the IPC Unigy VKM, you must onboard the server to be monitored by the Nectar. This server hosts the Blue Wave API.

Follow these steps to add a server configuration:

  1. Navigate to Modules > IPC Unigy.

The IPC Unigy - Directors window appears.

Figure 2-6Add Director

  1. Right-click in the Directors pane and select Add. The Add Director window appears.

Figure 2-7Add Director

  1. Enter the following information:

Parameter

Description

Name

Enter the name of the onboarding server configuration.

Description

Enter the description of the server configuration.

Enable

Enables collection and alarm generation for the server.

Select whether or not to enable the server configuration.

Note: If you choose not to enable at this time, you can enable later. To enable later, right-click on the server configuration and select Enable. To disable, right-click on the server configuration and select Disable.

Host Name

Enter a fully qualified domain name (FQDN) or IP address for the server.

Scheme

Select one of the following supported schemes:

  • http
  • https

Port Number

Enter the port number for the server, such as 80.

Username/Password

Enter the name and password credentials for the Blue Wave API user.

  1. Click OK.

Table 2-1 System Configuration

Note

For information on editing or removing a server configuration, see Manage Server Configurations.

3.Configure VKM Options

Follow these steps to configure the VKM options for the IPC Unigy system:

  1. Navigate to Modules > IPC Unigy.

The IPC Unigy - Directors window appears.

  1. Select the Options tab.

The IPC Unigy - Options window appears.

Figure 3-1IPC Unigy - VKM Options

  1. View a list of the following parameters:

Parameter

Description

collectionCronString

  • Used to specify the collection schedule using a Cron expression

eventRetention

  • Specifies the number of days to keep event data.
  • The default value is 60 days.

exportEnable

  • Specifies whether or not exporting files to the ETL server is enabled. Values include:
    • true
    • false
  • The default value is false.

exportInterval

  • Identifies the interval in seconds between exports.
  • The default value is 900 seconds.

exportSeqNum

  • Identifies the last export sequence number.

Note: This parameter should not be changed manually.

fileRetention

  • Defines the number of days to store the exported files or the files that fail before deleting them.
  • The default value is 10 days.

heartbeatMissedCount

  • Defines the number of heartbeatTimeout intervals that can be missed before a heartbeat event with an alert level 5 is sent.
  • The default value is 2.

heartbeatTimeout

  • Defines the interval after which the server heartbeat event changes the alert level to 5, if no new heartbeat event for the server is received.
  • The default value is 300 seconds.

historyInterval

  • Applies to historic data collections:
    • Communication History Collection
    • VoIP Quality CDR Collection
  • Defines the history collection interval in minutes.
  • The default value is 5 minutes.

historyRetention

  • Historical Data Retention

queryExecutorCount

  • Defines the number of data export tasks (threads) that can be executed at once.
  • The default value is 5 threads.

requestExecutorCount

  • Defines the number of threads used to process the requests to the server.
  • The default value is 5 threads.
  • Used to manage server requests.

Table 3-1 VKM Options

Parameter

Description

requestTimeBuffer

  • Defines the buffer time in seconds to modify the end time of the data query.
  • Provides the ability to overcome any time difference as well as the time it takes to produce the records that will be monitored.
  • The default value is 10 seconds.

responsePageSize

  • Defines the number of records requested at a time.
  • Applies to any type of request to the director for the tables.
  • Requests support pagination, so automatically downloads the designated number of pages at once.
  • The default value is 250 pages.

retentionFrequency

  • Defines the files retention frequency in hours.
  • The default value is 12.

statusInterval

  • Applies to all device-related collections (such as Media Gateway, Pulse, Server, Turret, or UDA) and logon session and user collections.
  • Defines the status collection interval in minutes.

userDataRetention

  • Defines the number of days to store user data before deleting.
  • The default value is 10 days.

Table 3-1 VKM Options

The following parameters are used to configure where the files will be sent for processing (CAM):

Parameter

Description

uploadDstDir

  • Identifies the destination directory.
  • The default value is /.

uploadEnable

  • Specifies whether or not upload is enabled.
  • The default value is false.

uploadHost

  • Identifies the host IP address of the CAM.

uploadPassword

  • Identifies the password that is used to establish connection to the CAM.

uploadPort

  • Identifies the port number of the CAM.

uploadScheme

  • Specifies the scheme to be used for upload:
    • ftp
    • ftps
    • sftp
  • The default value is ftp.

uploadUsername

  • Identifies the user name that will be used to establish connection to the specified host.

Table 3-2 VKM Options

  1. To change a value, select the VKM option, right-click and select Edit.

The Edit VKM Option window appears for that option/parameter.

Figure 3-2Edit VKM Option

  1. Enter the new value for the parameter; then click Update.

The new value appears for the parameter in the Options > Value list.

Note

Generated files upload automatically. However, before uploading, you must configure the following VKM parameters:

  • Destination Host (uploadHost)
  • Port (uploadPort)
  • Directory (uploadDstDir)

For more information on configuring VKM options, see Table 3-1.

4.View Events

The IPC Unigy VKM allows you to view specific event(s) that are created when a IPC Unigy trap is received.

Follow these steps to view specific events for a server:

  1. Navigate to Modules > IPC Unigy.

The IPC Unigy - Directors window appears.

  1. Select the Events tab.

The IPC Unigy - Events window appears.

  1. View the Events and associated information.
  2. Right-click on an event and select one of the following:

Figure 4-1Event Commands

Table 4-1 Event Commands

Command

Description

Edit

  • Opens the IPC Unigy Event Comments window.
  • Used to enter or edit comments about an event.

Take Ownership

Sets the Owner field for the event to the current user name (who selected the menu option).

Release Ownership

  • Clears the Owner field for the event, if the user who selected the menu option is the current owner.
  • If the user is not the current owner, the action has no effect.

Manually Attend

  • Sets the Status field to clear and stops the Elapsed Time field from incrementing.
  • Sets the event alert level to 1.

View Collections

The IPC Unigy VKM collects system inventory, call history, and QoS data via the Blue Wave API.

Note

The interval between collections is specified in the VKM Options.

For more information, see Configure VKM Options.

Follow these steps to view Collections for a server:

  1. Navigate to Modules > IPC Unigy.

The IPC Unigy - Collections window appears.

  1. Select the Collections tab.

The IPC Unigy - Collections window appears.

  1. Select a server in the Directors pane.

Figure 5-1Collections

  1. View the associated Collections in the Collections pane to the right along with detailed information about the status of each collection.

Note

For information on managing collections, see Manage Collections.

6.View Inventory Data

Follow these steps to view and verify collected inventory data:

  1. Navigate to Reports > Inventory > IPC Unigy. The IPC Unigy Inventory window appears.

Figure 6-1IPC Unigy Inventory

  1. Select a server in the Directors pane.
  2. View associated data in the right pane.
  3. Notice the different tabs at the top of the right pane.
  4. Select a tab, such as Communication History or Logon Session, to view the corresponding data.

Export Historical Collections

The IPC Unigy VKM generates a CSV file for the collected Call History and QoS data for a server.

When a CSV file is generated, it is stored in the cdr\unigy folder until it is transferred to the destination CAM. After a CSV file is successfully transferred, it is then stored in the archive\unigy folder. Any file that remains in the cdr\unigy folder did not transfer.

Note

At this time, if a file does not transfer, there is no attempt to re-transfer that file.

cdr folder

Follow these steps to navigate to the cdr\unigy folder:

  1. Navigate to RIG > File Manager.

The File Manager window appears, Figure 7-1.

  1. Navigate to the folder where the application is installed, such as:

C:\Apps\nectar\

  1. Double-click the cdr folder in the application folder.

Figure 7-1cdr Folder

  1. Double-click the unigy folder to view a list of CSV files.

Figure 7-2unigy Folder

Note

Each CSV file contains the data for one director.

archive folder

Follow these steps to navigate to the archive folder:

  1. Navigate to RIG > File Manager. The File Manager window appears.
  2. Navigate to the folder where the application is installed, such as:

C:\Apps\nectar\

  1. Double-click the archive folder in the application folder.

Figure 7-3archive Folder

  1. Double-click the unigy folder in the archive folder.

Figure 7-4unigy Folder

  1. View a list of archived files in the unigy folder.

IPC Unigy VKM and Nectar UCMP

After deployment, the IPC Unigy VKM creates the following:

Dependency Trees
Agents
Events

Dependency Trees

After deployment, the IPC Unigy VKM adds a dependency tree for each configured server. All alarms generated by the VKM are represented in the dependency tree via respective device names.

Follow these steps to view the dependency tree:

  1. Navigate to Configure > Dependency Trees. The Dependency Trees window appears.
  2. Double-click on a dependency tree.

View the dependency tree in the pane to the right.

Figure 8-1Dependency Tree

  1. View IPC Unigy data based on your server configuration.

Agents

After deployment, the IPC Unigy VKM adds an agent for each server. Follow these steps to view the agents:

  1. Navigate to Health > Elements. The Elements window appears.

Figure 8-2Elements

  1. Click on Agents.
  2. View a list of agents.

Figure 8-3Agents

Note

You should have an agent for each server.

  1. Select an agent; then view the following about the agent, if available:

Poll Functions

Trap Groups

Interfaces

VKM Collections

Events

You can view any events reported for the servers. Follow these steps to view events:

  1. Navigate to Health > Events.
  2. View a list of events in the Current Events pane.
  3. Select an event, right-click, and select View Event.

Figure 8-4Events

The View Event pane appears with the event details.

Figure 8-5View Event

Manage Server Configurations

Managing director configurations also includes the following tasks:

Edit a Server Configuration
Remove a Server Configuration
Sort Server Information

Note

For information on adding a system configuration, see Add a Server Configuration.

Edit a Server Configuration

Follow these steps to edit a server configuration:

  1. Navigate to Modules > IPG Unigy.

The IPG Unigy - Directors window appears.

  1. Right-click on the IPG Unigy system configuration you want to change and select Edit. The Edit Server window appears.

Figure A-6Edit Director

  1. Make changes, as needed.
  2. Click OK.

Remove a Server Configuration

Follow these steps to remove a server configuration:

  1. Navigate to Modules > IPC Unigy.

The IPC Unigy - Directors window appears.

  1. Right-click on the server configuration you want to remove and select Remove. The Removal Confirmation window appears.

  1. Click Yes.

Figure A-7Removal Confirmation

The server configuration is removed.

Sort Server Information

Follow these steps to change how the server information is displayed in the Directors pane:

  1. Select an existing server.
  2. Click theicon located to the far right of the Directors pane. The Configure Table window appears.

Figure A-8Configure Table

  1. Select a data field and specify how you want the information sorted:

Option

Click to ...

Visible

Show the parameter in the table.

Numerical

Sort in numerical order.

Sort Order

Select one of the following for each parameter:

  • None - Leave the information unsorted.
  • Ascending - Sort in ascending order.
  • Descending - Sort in descending order.
  1. Click OK.

Table A-1 Sort Options

The data in the pane appears according to parameters specified in the Edit List window.

Manage Collections

Managing collections also includes the following tasks:

Disable a Collection
Enable a Collection
Change a Collection Schedule
Execute a Collection

Note

For information on viewing a collection, see View Collections.

Disable a Collection

Follow these steps to disable a collection for a particular server:

View Collections.
  1. Select the collection you want to disable.
  2. Right-click on the collection and select Disable.

Figure B-9Disable a Collection

The Enabled column for the director changes to No.

Enable a Collection

Follow these steps to enable a collection for a particular server:

View Collections.
  1. Select the collection you want to enable.
  2. Right-click on the collection and select Enable.

Figure B-10Enable a Collection

The Enabled column for the director changes to Yes.

Change a Collection Schedule

Follow these steps to change the collection schedule for a particular server:

View Collections.
  1. Select the collection you want to change.
  2. Right-click on the collection and select Change Cron String.

Figure B-11Change Cron String

The Update Cron String window appears.

Figure B-12Update Cron String

  1. Enter the new collection schedule using a Cron expression.
  2. Click OK.

Execute a Collection

Follow these steps to execute a collection:

View Collections.
  1. Select the collection you want to execute.
  2. Right-click on the collection and select Execute Now.

Figure B-13Execute Now