Proxy Setup

The Apex Proxy Agent is a software program that you use to install and configure both the Data Collector and the Proxy Agent. It enables the configuration of a Data Collector in the Customer Domain and a Proxy Agent in the client environment. You must configure a Data Collector on the Customer Domain to enable data communication between the Proxy Agent and the Apex Database, facilitating monitoring operations in the Customer Domain. The Proxy Agent configuration is more suitable for the client environment, allowing the discovery of devices or servers within the client network and the transfer of information about these discovered devices/servers to the Apex Database via the Data Collector. Data communication always occurs between the Proxy Agent and the Apex database through the Data Collector.

The Apex Proxy Agent's main components are the Proxy Service and the Apex Job Scheduler. The Proxy Service, a web service running in the IIS environment, receives, translates, and forwards monitored data. The Apex Job Scheduler, a Windows service running in the background of the Proxy Agent, performs similar tasks of receiving, translating, and forwarding monitored data. The Apex Proxy Agent offers a Graphical User Interface (GUI) for installing and configuring the Data Collector Service and Proxy Agents.

Typically, you configure the Data Collector Service in the Customer Domain. To configure the Data Collector, specify the database and SMTP details under the Update Config File tab. You can configure multiple Proxy Agents globally, all of which communicate with the central Apex Server through the Data Collector. To configure the Proxy Agent, specify the proxy details under the Proxy Credentials tab.

The Apex Proxy Agent provides a window to view error logs and perform high-level debug analysis under the View Log tab. You can also configure Single Sign-On for the Apex application using the Apex Proxy Agent. It supports Self-Healing Service, which monitors the status of the Apex Job Scheduler service. These two services support each other, ensuring that if one service fails, the other will automatically restart it within a minute, preventing data loss in the monitoring process.

For a Proxy Agent, you can configure agent-based and agentless monitoring modes for specific devices or servers. To set up agent-based monitoring through the Proxy Agent, install the Proxy Agent with web services on IIS using the SummitProxyAgent_vXXX_WithIIS.exe file. Install the Proxy Agent without web services using the SummitProxyAgent_vXXX.exe file for agentless monitoring. In agent-based mode, the data from each device or server is posted from the agent (Server Agent or Asset Agent) installed on each device or server to the Apex Database. In agentless mode, the Apex Server derives the data about each device or server without posting data from individual devices or servers. Configure the monitoring type (agent-based or agentless) for each device or server on their respective configuration pages.

Install Apex Proxy Agent

This section offers detailed instructions to guide you through installing and configuring the Data Collector Service and Proxy Agent using the Apex Proxy Agent.

To install Apex Proxy Agent, perform the following steps:

1. Create a folder on the machine where you plan to install the Apex Proxy Agent and copy the installer files.
   
   
2. Double-click the SummitProxyAgent_vXXX_WithIIS.exe file. The Welcome to Apex Installation Wizard window appears.
   
   
3. The License Agreement window will appear. Read the license agreement, and if you agree to the terms, select the "I accept the terms in the license agreement" option and click Next. You also have the option to print the license agreement if needed.
   Figure: License agreement
   
   
4. The Destination Folder window is displayed.
   Figure: Destination folder
   
   
5. Indicate the destination folder path for the installation of the Apex Proxy Agent Setup.
   
   
6. To change the destination folder, click the Change button, then choose the destination folder from the Look in drop-down list. Use the Up one level icon to select a folder. Once you have selected the desired path, click OK.
   
   
7. Click Next. The Ready to Install the Program window is displayed.
   Figure: Ready to install
   
   
8. Click Install. The Installing Summit Proxy Agent window is displayed.
   Figure: Install window
   
   
9. Click Next. The Installation Wizard Completed window is displayed.
   Figure: Installation wizard
   
   
10. The ApexAI Proxy Agent has been successfully installed. Now, you can configure the Proxy Agent either as a Data Collector Service or as a Proxy Agent.

Install Data Collector Service

This section offers detailed instructions to guide you through the installation and configuration of the Data Collector Service. 

To install Data Collector Service, perform the following steps:

1. Open the Proxy Setup Tool(v6.1.0.2). The Proxy Setup Tool window is displayed.
   Figure: Configure server
   
   
   • Data Collector Service: Choose this option to install the Data Collector within the Customer Domain. Enable Require SSL and Save Configuration.  All data communication between the Apex Server and the Proxy Agent or other agents (such as the Server Agent and Asset Agent) are routed exclusively through the Data Collector. Therefore, installing a Data Collector in the Customer Domain is essential to enable monitoring services.
     Add the key in web.config for the Data Collector Service - <addkey="SummitAPIConfBaseURL"value="https://qaapexv102gdpr.symphonysummit.com/config/api/Encryption/" />
     
     Note

     The Value field in the URL provided is just an example; the actual URL will depend on the configuration in each customer's environment. However, the format will remain consistent with the example shown.
     
     
   • Proxy Agent: This setting configures the Proxy Agent on one or more machines within the client environment. Typically, clients prefer to monitor their network or server components via these proxy machines. Depending on your network's size, the number of devices or servers to be monitored, and their locations, you may install the Proxy Agent across various parts of the organization.
     For instance, if an organization has operations in multiple global locations, it may choose to set up the Customer Domain in a central location and conduct monitoring from there. In this scenario, you would need to install the Data Collector at the central location and deploy Proxy Agents across the various other locations.
2. After selecting the Data Collector Service option, click Save. The application displays the following message: Updated Successfully.
   
   
3. On the Success message window, click OK.
   
   
4. Under the Update Config File tab, provide the DB and other details.
   Figure: Update config tab
   
   In the DB Details section, you must provide the configured Apexdatabase details:
   • Connection Key: This field displays the connection key for the configured Apex database.
     
     
   • Server Name: Enter the name of the configured Apex Database Server in this field.
     - If the Apex database and the Data Collector are installed on the same machine, specify the Server Name in this format: `Local\<SQL Server Name>`.
     - If the Data Collector is on a different machine than the Apex database server, enter the server details in this format: `<IP address of the Apex database server>\<SQL Server Name>`. For example: `10.99.8.101\SQL EXPRESS`.
     
     
   • Username and Password: Enter the user credentials that were configured during the SQL server setup in the respective fields.
     
     
   • Database: Provide the database name that was created during the SQL installation.
     
     
   • GDPR: In a GDPR-compliant environment, activate the GDPR tags in the DC web.config file.
     <add key="GDPR:NTP:IsColumnEncryptionEnabled" value="true" />
     <add key="GDPR:ClientId" value="xxxxxxxxxxxxxx" />
     <add key="GDPR:ClientSecret" value="xxxxxxxxxxxxxxx" />
     <add key="GDPR:TenantId" value="xxxxxxxxxxxxxxxxxx" />
     
     Note

     Input the actual values in the "value" field.
     
     
     
   • In the Other Details section, you need to specify the SMTP protocol and email information:
     SMTP IP: Enter the IP address for the SMTP protocol in this field.
     SMTP Port: The default SMTP Port number is displayed here. Do not make any changes.
     SSL: Select this option if the SMTP server has SSL enabled and provide the necessary user credentials.
     SMTP Username and Password: Enter the configured SMTP user credentials if required (optional).
     From Email ID: Provide a common or group email address that will be used to send all alerts, notifications, and other emails to the configured application users.
     Redirect All Mails: Enter the recipients' email address who should receive all communication emails from the application. This is primarily used during debugging by the testing team to verify whether the application's emails are being correctly sent to recipients.
     Internet Proxy (Optional): If the client network uses an Internet proxy to access websites, specify the proxy details here.
     Once you have entered all the necessary details in this tab, click the Save button to finalize the Data Collector configuration. If you need to modify the newly configured Data Collector details, click the Reset button.
5. Once you have entered all the details in this tab, click the Save button to finalize the Data Collector configuration.
   To reconfigure the new Data Collector details, click the Reset button.
   
   

Install Proxy Agent

This section offers detailed instructions to guide you through the installation and configuration of the Proxy Agent. 

To install Proxy Agent, perform the following steps:

1. Open the Proxy Setup Tool(v6.1.0.2). Select Proxy.
   Figure: Proxy
   Add the Proxy Key as - <add key="SummitAPIBaseURL" value="https://qaapexv102gdpr.symphonysummit.com/common/" /> in Proxy\bin\Summit_ProxyConfiguration.exe.config
   
   Add <add key="SummitAPIConfBaseURL" value=" https://qaapexv102gdpr.symphonysummit.com/config/" />
   
   Note

   The Value field in the URL provided is just an example; the actual URL will depend on the configuration in each customer's environment. However, the format will remain consistent with the example shown.
   
   
2. In the Proxy Credentials tab, enter the ApexURL and the authentication information.
   • SummitAI URL: Input the configured SummitAI application URL in the following format: http://<IP address of the Data Collector Server>//<Virtual Directory Name>. For example: http://10.99.8.101//SummitProxyService. Click Update. After updating the URL, provide the necessary information in the Authentication section.
   • In the Authentication section, specify the API key generated from the Apex application.
     Figure: Authentication
     Perform the following steps to generate the API key: 
     • Log in to Apex as an Admin.
     • Navigate to Service Management > Platform Studio > Access Control Center > Users. 
     • Click New to create a new user.
       Figure: New user
     •  Enter all the required details on the General Details page. Click Next. 
     • On the Authentication page, select Login Type as API Key. 
     • Click Generate on the API Key field for the API key to be generated. 
       Figure: API Key
     • Paste the generated API key into the Authentication section under Proxy Credentials.
3. In the Internet Proxy tab, choose one of the following options:
   • No Proxy: Select for no proxy settings.
   • Auto-detect: Select to auto-detect the proxy.
   • Custom: Select to customize the proxy settings. Type in the server's name. If you select the Credentials Required check box, you need to specify Domain, Username, and Password.
   • Click Update.
     Figure: Internet Proxy
     
     
     Note

     If an IIS environment is not available, you can use the "SummitProxyAgent_vXXX.exe" file to set up the Proxy Agent. This executable file allows you to configure only the Proxy Agent, not the Data Collector. When the Proxy Agent is configured using this executable file, the Update Config tab will not appear in the Proxy Setup Tool window.
     
     

View and Analyse Log Details

You can access the log details under the View Log tab in the Proxy Setup Tool window for both the Data Collector and the Proxy Agent. The log file contains information captured during monitoring, as well as during the installation or upgrade of the Proxy Agent or Data Collector.

To view the log details, perform the following steps:

1. Open the Proxy Setup Tool (v6.1.0.2). The Proxy Setup Tool window is displayed.
   
   
2. Click the View Log tab.
   Figure: View log
   The View Log tab has the following options:
   
   
   • View Log Text Area: In the View Log Text Area, you can see the log details recorded from monitoring activities or any installation or upgrade processes that have been carried out.
     
     
   • Enable Debug Log: Select the Enable Debug Log check box and click the Save button to view debug log details. This option allows you to perform high-level debug analysis related to any data communication issues or installation and upgrade problems.
     The log information helps analyze and determine if data communication is occurring between the Data Collector server and the Proxy Agent. If there is a connection loss, the logs display the error reason. Users can view the log information and attempt to rectify the error without technical support. For instance, if users change the application password but don't update it in the Proxy Agent tool, communication between the Data Collector server and the Proxy Agent is lost. The debug logs show the connection error and the reason for the connectivity loss, enabling users to rectify the problem by viewing and analyzing the logs.
     
     
   • Refresh In Sec: You can specify the time in seconds after which the log information refreshes in the View Log Text Area. By default, the logs refresh every 60 seconds. You can also configure the interval for data refresh. Additionally, you can click the Refresh button to instantly view the data in the View Log Text Area.
     
     
   • To view other log files and access the common log folder where all log files are stored, click Open Log Folder. The default log folder path is '..\\SUMMUS\Proxy Agent\bin\logs'.

Service Status Tab

You can view the Service Status tab in the Proxy Setup Tool window for both the Data Collector and the Proxy Agent. This tab displays two critical services: Summit Job Scheduler and Self-Healing Service, which are essential for data communication between the Proxy Agent and the Data Collector during monitoring. These services support each other; the Self-Healing Service monitors the Apex Job Scheduler service, ensuring it runs continuously by checking its status every minute and restarting it if stopped. The Apex Job Scheduler executes all jobs, and its failure halts Proxy Agent monitoring, so it must remain operational. If the Self-Healing Service stops, the Apex Job Scheduler will restart it. 

To view the Service Status tab, perform the following steps:

1. Open the Proxy Setup Tool (v6.1.0.2). The Proxy Setup Tool window is displayed.
   
   
2. Navigate to the Service Status tab.
   Figure: Service status tab
   • In the Proxy Service Process section, you can view the status of the Summit Job Scheduler service. 
   • In the Self-Healing Service section, you can view the status of the Self-Healing Service. 
   • You can start, stop, or restart both services using the Start, Stop, or Restart buttons, which help debug during the installation or upgrade of Data Collector or Proxy Agents. 
   • Use the Refresh option to view the current status of the services.

Tools 

The Tools section in the top ribbon offers the following options, each explained in detail below.

• Open Configuration Editor
• Open Unblock Tool
• Open SAM Auto Upgrade
• Open SSI Auto Upgrade
  Figure: Tools

Open Configuration Editor

1. Click Open Configuration Editor. The Application Settings section is displayed.
   Figure: Application settings
   
   
2. In the Application Settings section, there are two check boxes for Show Keys: Only If Exists and Not Exists. Select the Only If Exists check box to view the keys present in the Web.config file.
   
   
3. Enter or select the appropriate values in the right column for all the keys.
   
   
4. Click Save Settings. Next click Done.
   
   
5. If you select Do Not Exist, it displays the keys that are not present in the Web.config file. Choose the key you want to add, and click Add Config Key.
   Figure: Do not exist

Open Unblock Tool

1. Click Open Unblock Tool.
   
   
2. Type in the path of the file, that you want to unblock, in the Folder Path field.

   
   

3.  Click Unblock Tool.

Open SAM Auto Upgrade

1. Click Open SAM Auto Upgrade to display the SAM Auto Update Configuration window.
   Figure: Open SAM auto upgrade (image has summit name)
   
   
2.  Enter the version you want to upgrade to in the Agent Upgrade To Version field.
   
   
3. Enter the proxy server location in the SummitAI Proxy Base URL field.
   
   
4. Click 1. Enable Auto Update to activate the Auto Update settings.
   
   
5. Click 2. Validate Config.
   
   
6. You can click 3. Disable Auto Update to turn off the Auto Update.

Open SSI Auto Upgrade

1. Click Open SSI Auto Upgrade to display the SSI Auto Update Configuration window.
   Figure: Open SSI auto upgrade (image has summit name)
   
   
2.  Enter the version you want to upgrade to in the Agent Upgrade To Version field.
   
   
3. Enter the proxy server location in the SummitAI Proxy Base URL field.
   
   
4. Click 1. Enable Auto Update to activate the Auto Update settings.
   
   
5. Click 2. Validate Config.
   
   
6. You can click 3. Disable Auto Update to turn off the Auto Update.