| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
Components
The Windows version of the Synergy Agent consists of multiple components. The components are communicating with each other via gRPC.
| Note |
|---|
Starting from agent version v4.5 the PlatformHub is deprecated. It is replaced by AgentEngine. |
Name
Path
AgentUI
%appdata%\GVClient.AgentUI\logs
Auto-Update Service
C:\Windows\SysWOW64\config\systemprofile\AppData\Roaming\GVClient.AutoUpdateService.Windows\Logs
Name | Role | |
|---|---|---|
AgentEngine | The backbone of the Agent. Runs in the context of the current user. | |
AgentEngine DotNetFrameworkBridge | Acts as a bridge between .NET 6 and .NET Framework. | |
AgentUI | The User Interface of the Agent. Runs constantly in the background (in the context of the current user). Icon in tray bar. | |
Auto-Update Service | A Windows Service responsible for running auto-update. Runs as a Service (system). | |
Platform Hub | The backbone of the Agent. Runs as a Windows Service (Local Service). | |
Classifier | Is started by AgentUI and acts as a bridge used by AgentUI to classify files (via explorer classification). | |
CLI | A lightweight .exe file used to execute CLI CLI | A lightweight .exe file used to execute CLI commands. |
Shell | An entry point for various commands. | |
Outlook Plugin | VSTO Plugin for Microsoft Outlook. | |
Excel Plugin | VSTO Plugin for Microsoft Excel. | |
PowerPoint Plugin | VSTO Plugin for Microsoft PowerPoint. | |
Word Plugin | VSTO Plugin for Microsoft Word. | |
Windows Shell Extension | A Shell Extensions used to add the right-click classification option in Windows Explorer. | |
Health Check Task | A Windows Scheduler Task for running health checks. |
Log and installation paths
Version 3.*
|
|
|
|
Log and installation paths
Name | Path | ||
|---|---|---|---|
AgentEngine | %appdata%\GVClient.AgentEngine.Windows\Logs | ||
AgentUI | %appdata%\GVClient.AgentUI\logs | ||
Auto-Update Service | C:\Windows\SysWOW64\ServiceProfilesconfig\LocalServicesystemprofile\AppData\Roaming\GVClient.PlatformHub.Windows\Logs | Classifier | %appdata%\GVClient.Classifier.AutoUpdateService.Windows\Logs |
CLI | %appdata%\GVClient.CLI.Windows\Logs | ||
Outlook Plugin | %appdata%\OutlookClassifier\Logs | ||
Excel Plugin | %appdata%\ExcelClassifier\Logs | ||
PowerPoint Plugin | %appdata%\GVClient.Powerpoint\Logs | ||
Word Plugin | %appdata%\WordClassifier\Logs | ||
Windows Shell Extension | Logging must be manually enabled: sharpshell/docs/logging/logging.md at main · dwmkerr/sharpshell (github.com) | ||
Health Check Task | C:\Windows\SysWOW64\config\systemprofile\AppData\Roaming\GVClient.Healtcheck.Windows\Logs |
...
|
|
|
|
Steps to generate logs for installation: Synergy Support: Generate Installation Logs - Getvisibility - Confluence (atlassian.net) /wiki/spaces/GS/pages/313491462
Logs structure overview
| Code Block |
|---|
12/06/2022 10:29:51.009 [ T4\AgentEdgeConnectivityManager.ManageConnection] [OfficeVersionNumber: 16.0.15726.20196, OfficeVersionName: O365BusinessRetail] [CpuCores: 1] [TotalMemory: 7.92GB] INFORMATION: Connection was aborted: System.AggregateException: One or more errors occurred. (No such host is known.)
---> System.Net.Http.HttpRequestException: No such host is known.
---> System.Net.Sockets.SocketException (11001): No such host is known.
at System.Net.Http.ConnectHelper.ConnectAsync(String host, Int32 port, CancellationToken cancellationToken)
--- End of inner exception stack trace ---
.
.
.
12/06/2022 10:29:51.015 [ T4\AgentEdgeConnectivityManager.ManageConnection] [OfficeVersionNumber: 16.0.15726.20196, OfficeVersionName: O365BusinessRetail] [CpuCores: 1] [TotalMemory: 7.92GB] INFORMATION: Waiting 10s before trying to reconnect
12/06/2022 10:30:00.262 [ T12\ConfigurationProviderService.GetConfiguration] [OfficeVersionNumber: 16.0.15726.20196, OfficeVersionName: O365BusinessRetail] [CpuCores: 1] [TotalMemory: 7.92GB] WARNING: Configuration missed: PluginConfigurationEvent
...
12/06/2022 10:30:01.035 [ T8\AgentEdgeConnectivityManager.ManageConnection] [OfficeVersionNumber: 16.0.15726.20196, OfficeVersionName: O365BusinessRetail] [CpuCores: 1] [TotalMemory: 7.92GB] INFORMATION: Creating new channel to https://3.253.33.11-jirka:443
12/06/2022 10:30:01.035 [ T8\AgentEdgeConnectivityManager.ManageConnection] [OfficeVersionNumber: 16.0.15726.20196, OfficeVersionName: O365BusinessRetail] [CpuCores: 1] [TotalMemory: 7.92GB] INFORMATION: Keycloak token endpoint: https://3.253.33.11-jirka/auth/realms/gv/protocol/openid-connect/token, clientId: agent, userName: agent
12/06/2022 10:30:01.119 [ T8\AgentEdgeConnectivityManager.ManageConnection] [OfficeVersionNumber: 16.0.15726.20196, OfficeVersionName: O365BusinessRetail] [CpuCores: 1] [TotalMemory: 7.92GB] INFORMATION: Connection was aborted: System.AggregateException: One or more errors occurred. (No such host is known.)
^^^ "Component's name + component's action". ^^^ some metadata ^ log level ^ log message |
...
https://getvisibility.atlassian.net/wiki/spaces/KBTES/pages/117735425/Getvisibility+Reseller+Keycloak+Manual+Installation+Guide#Configuring-the-Agent-Client Agent: Alternative authentication methods for agent
c. HTTP 2.0 disabled
Some proxies are blocking HTTP 2.0 requests, resulting in error messages like below:
...
6. Missing suggestions
Please consult Synergy Support: Basic troubleshooting guide for missing suggestions - Getvisibility - Confluence (atlassian.net) /wiki/spaces/GS/pages/380928010 for troubleshooting steps.
...
A commonly reported bug is footers not appearing in PowerPoint in some or all slides. This is nearly always due to the custom settings for that file’s slide layouts. Slide layouts in ppt (Title Slide, Title and Content, Blank, etc) can be modified or added to by end users. One of these options is to disable footers for the slide layout. In this case, we assume it is deliberate from the user, and we respect this by not adding the GV footer. If you see this issue, please go to View → Slide Master and check the specific slide layout(s) to see if the footer is disabled, as shown in the screenshot below. If the footer shows as enabled here still (and you can’t appear to uncheck the box) then check the master slide layout as in the second screenshot.
...
Points to Remember:
One Drive Sync: Please keep in mind we can't detect if the save is a legitimate one or caused by OneDrive. There's nothing exposed in Office API to check this. In fact MS recommends to disable auto-save for office applications. The options are either to disable the warnings or use default classification.
Agent is not using VBA - VSTO seems to be somehow referencing it under the hood. Link to MS issue: https://answers.microsoft.com/en-us/msoffice/forum/all/should-word-vsto-add-ins-be-able-to-run-with/45755190-fef1-45f2-93e0-de635426a521
It is recommended to you Office 365 subscription Plans only for Windows and Mac
Information for AV Scans
Paths to Exclude for AV scans to avoid slowness during installation are as below:
Please be sure that the Getvisibility application is excluded from the below:
Real Time Scans
Scheduled Scans
Manual Scans
Paths and executables to be excluded:
C:\Program Files (x86)\GVClient\
C:\Program Files (x86)\GVClient\\PlatformHub\GVClient.PlatformHub.Windows.exe
C:\Program Files (x86)\GVClient\\AgentEngine\GVClient.AgentEngine.Windows.exe
C:\Program Files (x86)\GVClient\\GVClient.AutoUpdateService.Windows.exe
C:\Program Files (x86)\GVClient\\GVClient.Classifier.Windows.exe
C:\Program Files (x86)\GVClient\\AgentUI\GVClient.AgentUI.exe
C:\Program Files (x86)\GVClient\\PlatformHub\Proxy\grpcwebproxy.exe
Add the below list to the Trusted Applications
C:\Program Files (x86)\GVClient\
C:\Program Files (x86)\GVClient\\PlatformHub\GVClient.PlatformHub.Windows.exe
C:\Program Files (x86)\GVClient\\AgentEngine\GVClient.AgentEngine.Windows.exe
C:\Program Files (x86)\GVClient\\GVClient.AutoUpdateService.Windows.exe
C:\Program Files (x86)\GVClient\\GVClient.Classifier.Windows.exe
C:\Program Files (x86)\GVClient\\AgentUI\GVClient.AgentUI.exe
C:\Program Files (x86)\GVClient\\PlatformHub\Proxy\grpcwebproxy.exe