Nectar DXP - RIG Agent Configuration Guide

Overview

About this Guide

This guide provides the instructions to configure the Nectar DXP RIG agent for Nectar Foundation, including:

• Enable Nectar DXP RIG Agent
• Configure Nectar DXP RIG Agent
• Install PowerShell Module

Audience

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

Supported Software Versions

• Nectar UCMP v8.7
• Nectar DXP

Enable Nectar DXP RIG Agent

To start or enable the RIG agent as part of Nectar Foundation APM, you must manually configure the application.properties file and restart the RIG service

1. Navigate to Apps > <RIG install folder>.
2. Locate and open the application.properties file using Notepad.
3. Locate the following line of text:
   spring.profiles.active = derby
4. Add the following text to that line to enable the agent as part of the RIG:
   spring.profiles.active = derby, rigagent
5. Save the file.

Configure Nectar DXP RIG Agent

To configure the RIG agent, you must manually configure the application-rigagent.yml file.

1. Locate and open the application-rigagent.yml file.
   
   Note

   You already navigated to RIG installation folder.
   
   Use YAML editor, such as https://codebeautify.org/yami-validator, to make changes to application-rigagent.yml file.
2. Enter the following information to configure the RIG agent connection (see also Example). 

Example - application-rigagent.yml

# Folder to keep rig agent specific data such as Cisco CMS CDR files
agentDirectory: C:\Apps\nectar\RigAgent\data

# Datagate config for rig agent connection
datagate:
    url: https://cap-datagate-develop.app.ambrosia.lab.nectarvoip.com
    agent: develop_agent
    password: 1234
    proxy:
        socks:
          active: false
          host:
          port:
          username:
          password:

# To import certificates from the Nectar DXP main client URL for the rig agent to make HTTPS
# connection to data gate service in Nectar DXP
sslcertificate:
    url: https://develop.ambrosia.lab.nectarvoip.com
    alias: NectarCorpCloud

# For active directory polling
active-directory:
    # To connect to AD using Windows service account
    username:
    password:
    # Set up key store and trust store for AD LDAPS. Foundation Rig trust store (and key store) file can be specified
    # here if required SSL certificate can be imported into it.
    ssl:
        key-store:
        key-store-password:
        trust-store:
        trust-store-password:

3. Save the file.

4. After configuration is completed, restart the RIG service to enable the Nectar DXP RIG agent.

Install PowerShell Module

For tenants who have AD polling configured, the PowerShell module can be imported into the RIG. However, this is not mandatory, as it is not applicable for Linux RIGs.

1. From the RIG, right-click Start and select Windows PowerShell > Run as administrator.
2. If the following message appears, click Yes.
   Do you want to allow the following program to make changes to this computer,
3. Execute the following command:
   Import-Module ServerManager

4. Execute the following command:
    Add-WindowsFeature -Name RSAT-AD-PowerShell

    The message, Collecting Data ..., appears.

5. When the process completes, close the PowerShell window.