Contents
Document Details
Prepared By | Reviewed By | Date | Document Version | Software Version |
Ashima Agarwal | Artem Kalaitan | 13-June-2022 | V 1 | V 2.8 |
Ashima Agarwal | 25-July-2022 | V2 | V 2.10 | |
Ashima Agarwal | 10-Aug-2022 | V4 | V 2.10 |
Synergy
This document has two major sections
Agent
Agent Configuration
Agent Management
Reports
Administration
Pattern Matching
User Management
Agent
Deployment
A link to the agent deployment document is added below:
Configuration best practices
Please see the below document for best practices:
Agent Configuration
Login into system and navigate to the agent configuration
Login into the Getvisibilityapplication using the credentials given to you
The agent configuration page will be opened by default.
The dashboard UI offers a wizard to set/update an agent configuration. There are three possible ways to setup the configuration:
Configuration Import Mode: Using this mode, the user can upload an existing configuration from local files. Please note that only JSON format is accepted. A validity check will be done, and an error message is shown in case the file does not have valid JSON content. This mode is usually used by Getvisibility professional services as a part of their personalisation work.
Expert Mode: This mode is useful when the user wants to manually edit the agent configuration at their own risk. Like the previous mode, if the content is not a valid JSON or is not a valid agent configuration structure, a list of errors will be displayed to the user.
Configuration Wizard Mode: This mode is the easiest to use and guides the user through configuring the rules and uses for the agents. When the user chooses this mode, they will be guided through a few steps to set agent configuration fields one by one.
The three configuration modes are displayed as below:
The first option of Configuration Import can be used by simply uploading the config file. Select the Configuration Import option and the dialog box will open where the user must select a JSON file.
The configuration will be uploaded. When the user Selects Finish the new config will be saved
In the below section we will go through the various configurable options that can be applied to the agent using both Expert mode and Wizard mode:
Compliance
Compliance is the act of conforming to a company directive, rule, policy, or standard or law. Some common compliance regulations and labels are: GDPR, PII, HIPAA, PHI, PCI. Getvisbility agent gives the user two options to customise and configure compliance as per their requirements.
Expert Mode
Using Expert Mode, the user can add compliance tags by making changes in the agent configuration JSON file. One can add custom compliance or any of the standard compliance tags.
Select Expert Mode
Scroll down to the compliance section
Add the values
It can be seen below that EAR/US and CustomCompliaceExample have been added
Select Finish
‘Configuration saved successfully’ message will be displayed on the screen along with the OK button.
Select the OK button and the user is returned to the main Getvisibility agent configuration page.
To verify the Configuration, open a word document, Select the Getvisibility icon in the top-right of the ribbon. The user will be able to see the custom tags.
Wizard Mode
Using Wizard Mode, the user can select the compliance tags selecting the check box on screen.
Select Configuration Wizard Mode
Below, GDPR/PII has been selected as a compliance tag. Select Next.
Keep Selecting on Next to only change the compliance tags. The Last step of the wizard is displayed below.
Select Finish and following message will be displayed
To verify the Configuration, open a Word document, Select the Getvisibility icon on the top-right of the ribbon. The user will be able to see the selected tags.
Classification
Data classification is broadly defined as the process of organising data by relevant categories so that it may be used and protected more efficiently. On a basic level, the classification process makes data easier to locate and retrieve. By default, the Getvisibility classification is Public, Internal and Confidential.
Expert Mode
Using Expert Mode, the user can add compliance tags by making changes in the agent configuration JSON file. One can add custom compliance or any of the standard compliance tags.
Select Expert Mode
Scroll down to the classification section
Add the values.
It can be seen below that CustomClassification has been added in Expert Mode
Select the Finish button
‘Configuration saved successfully’ message will be displayed on the screen along with the OK button.
Select the OK button.The user is returned to the main Getvisibility agent configuration page.
To verify the Configuration, open a Word document, Select the Getvisibility icon on the top-right of the ribbon. The user will be able to see the custom tags.
Wizard Mode
The user can select the classification by selecting the radio button on screen.
Select the Configuration Wizard Mode
The user has selected Commercial Option as classification
Select Next.
Keep Selecting on Next to only change the compliance tags.The Last step of the wizard the agent will be displayed.
Select Finish and following message will be displayed
To verify the Configuration, open a Word document, Select the Getvisibility icon on the top-right of the ribbon. The user will be able to see the selected tags.
MS Office Plugins
This functionality will allow the user to select which MS Office application the configuration will be applicable to.
Expert Mode
Using Expert mode, the user can enable/disable the Office Plugins by making changes the agent configuration JSON file.
Select Expert Mode
Scroll down to the Office Configuration section
Add the values.
It can be seen below that wordPluginActive is set to FALSE
Select the Finish button
To verify the Configuration, open a Word document, the user will see that the Getvisibility icon on the top-right is disabled. The user will not be able to Select it.
Wizard Mode
Using Wizard Mode, the user can select the which application the configuration will be applicable to by selecting the check-box on screen.
Select Configuration Wizard Mode
As seen below, the user has selected only Word Plugin as the option. Select Next.
Keep Selecting on Next to only change the compliance tags. The Last step of the wizard the agent will display:
Select Finish and the settings will be applied.
To verify the Configuration, open a Word document, and the user should be able to view the Getvisibility icon and if the user Selects on the icon the compliance and classifications box will be displayed.
To verify the Configuration, open a Excel document, user will see that the Getvisibility icon on the top-right is disabled, and user will not be able to Select it
MS Office Policies & Visual Tagging
This functionality allows the user to set various policies to enforce on documents in MS Office applications.
Expert Mode
Using Expert mode, the user can enable/disable the policies related to MS Office by making changes agent configuration JSON file.
Select Expert Mode
Scroll down to the OfficeConfiguration section
The available policies:
Header: - This will add a Header to the document. The user can leave it empty or customise it as needed
Footer: - This will add a Footer to the document. The user can leave it empty or customise it as needed
Watermark: - This will add a Watermark to the document. The user can leave it empty or customise it as needed
TagBeforePrint: - This option will Force, Warn or Log & Ignore (allow) the user to classify any document before printing
TagDirtyBufferOnSave: - This option will Force, Warn or Log & Ignore (allow) the user to classify any document before saving
AllowDescalation: - This option allows the user to lower the classification level of a classified document.
ExcelTextForwardingActive: This is a scraping feature, it tells the plugin to scrape the text from within an app like Word or Excel and then forward it to the classifier for a suggestion. This option can be set using True or False.
PowerpointSubtitle:- This will add a Subtitle to the PowerPoint. This policy is optional.
PowerpointTitle:- This will add a title to the PowerPoint. This policy is optional.
Example of Config:
OfficeConfiguration :-
"header": "<span>Classified as {classification} by Getvisibility®</span>", "footer": "", "watermark": "", "tagDirtyBuffersOnSave": "force", "tagBeforePrint": "ignore", "allowDeEscalation": false, "excelTextForwardingActive": false,
Select the Finish button
Verify the documents based on the config above
As per the config the user should be able to see the header and footer. The watermark should be blank.
If the user has manually edited the header or footer and then changed the classification of the document the agent will show a dialog box showing a notification for placing the new location of the classification.
Header Corner has been selected and the classification is placed in the corner without overriding the original header.
As tagDirtyBuffersOnSave = Force
is configured, the user cannot save the document without classifying it. The option to Dismiss the notification is disabled which will be enabled when tagDirtyBuffersOnSave = Warn
is used.
As tagBeforePrint = Warn
is configured, the option to Dismiss the notification is enabled which will be disabled when the tagBeforePrint = Force
is used. There will be no notification when tagBeforePrint = Log & Ignore
is used.
As allowDeEscalation = False
is configured, the user will not be allowed to lower the level of classification on the document and all the lower classification options will be disabled:
As
excelTextForwardingActive = False
is configured, text from the MS Office app will not be sent to classifier for suggestions.
Wizard Mode
Using Wizard Mode, the user can easily enable/disable the policies related to MS office.
Select Configuration Wizard Mode
Navigate to Word, Excel, PowerPoint Policies
Keep Selecting on Next to only change the compliance tags. Last step of the wizard the agent will display:
Select Finish and the settings will be applied.
Verify the documents based on the selection above
The user should be able to see the header and footer, the watermark should be blank:
The Force option has been selected. The user cannot save the document without classifying it. The option to Dismiss the notification is disabled which will be enabled when the user selects Warn.
Warn option has been selected,user can Dismiss the notification before printing. This will be disabled when the user selects Force. There will be no notification for the Log & Ignore.
The lower classification option has not been selected. So user is not allowed to lower the level of classification on the document and all the lower classification options are disabled:
Outlook Plugins
This functionality will allow users to configure Outlook classification plugin.
Expert Mode
Using Expert mode, users can enable/disable Outlook Plugins by editing the agent configuration JSON.
Select Expert Mode
Scroll down to OutlookConfiguration section
Add values
OutlookPluginActive is set to True in the example
Select the Finish button
'Configuration saved successfully’ message will be displayed on screen along with the OK button.
To verify the Configuration, open Outlook, the user will see the Getvisibility icon on the top-right is enabled. The user will be able to Select it and classify the email, if
OutlookPluginActive = false
is configured the icon will be disabled.
Wizard Mode
Using Wizard Mode, the user can enable/disable Outlook Plugins by making changes in the Focus UI
Select Configuration Wizard Mode
There are total of 12 steps in the Wizard and Outlook Plugin is selected on the third step.
Select Outlook
Then Select Next
Select Finish to apply configuration
To verify the Configuration, open a Word document
The Getvisibility icon will be enabled
Selecting on the icon will show the compliance and classifications box where the user to classify document
Outlook Policies & Visual Tagging
This functionality will allow the user to set various policies that they can enforce on emails when using Outlook.
Expert Mode
Using Expert mode, the user can enable/disable the policies related to Outlook by editing the agent configuration JSON.
Select Expert Mode
Scroll down to OutlookConfiguration section
The available policies:
Header: - This will add a Header to the email. The user can leave it empty or customise it as needed
Footer: - This will add a Footer to the email. The user can leave it empty or customise it as needed
TagOnPrint: - Using this option will Force, Warn, or Log & Ignore (allow) users to classify any modified email before printing
TagOnSend: - Using this option will Force, Warn, or Log & Ignore (allow) users to classify any modified email before sending
allowUnclassifiedAttachments - Using this option will Block, Warn, or Log & Allow (allow) users to send unclassified attachments in emails
minAttachmentsTag - This option will allow users to Inherit the minimal classification from a classified attachment to the email
allowDescalation: - This option allows users to lower the classification level of a classified email
autoClassifyReplyForwardEmails - This option allows users to inherit the classification level when replying or forwarding an email
Example config:
"outlookPluginActive": true, "header": "<h2 style=\"font-style:italic\"><span style=\"font- size:14px\">Classified as {classification} by Getvisibility® Ashima</span></h2>", "footer": "", "tagOnSend": "force", "tagOnPrint": "force", "allowUnclassifiedAttachments": "block", "minAttachmentsTag": "block", "allowDeEscalation": true, "autoClassifyReplyForwardEmails": true,
Select the Finish button
As per the config, the header and footer should be blank:
Adding a footer to an Outlook email using the configuration file:
header": "<span style=\"color:#008004;\"><h2 style=\"font-style:italic\"><span style=\"font-size:14px\">Classified as {classification} by Getvisibility® </span></h2></span>", "footer": "<span style=\"color:#008004;\"><span><strong>Classified as {classification} by Getvisibility® </strong></span></span>"
When tagOnSend = force
is configured users cannot send emails without classifying. Select Dismiss to keep editing or OK to classify.
When
tagOnSend = Warn
is configured users will be able to send email without classifying. Select Dismiss to send the email or OK to classify.If
tagOnSend = Log&Ignore
is set no notification will be displayed.
When tagOnPrint = force
is configure users cannot print emails without classifying. Select Dismiss to keep editing the email or OK to classify.
If tagOnPrint = Warn, the user will be able to send the email without classifying it. The option to Dismiss is to send the email and OK is to classify the email.
And if the tagOnPrint = Log&Ignore then no notification will be displayed.
allowUnclassifiedAttachments = Block, the user cannot send any attachment in the email without classifying it.
allowUnclassifiedAttachments = Warn, In this case user will be able to send the attachment in the email without classifying it but agent will give a warning.
allowUnclassifiedAttachments = Log&Allow, the user will be able to send the attachment in the email without classifying without any warning.
minAttachmentsTag = Block, in this case the attachment is highly confidential, and the email is on lower level of classification, so the agent will not allow sending the email. The user will have to change the classification of either the attachment or the email, else will not be able to send the email.
minAttachmentsTag = Warn, in this case the attachment is highly confidential, and the email is on lower level of classification, so the agent will only warn the user, but the user will still be able to send the email.
minAttachmentsTag = Log&Allow, the user will be able send any attachment in the email without any warning.
allowDeEscalation = False, the user will not be allowed to lower the level of classification on the document and all the lower classification options will be disabled.
autoClassifyReplyForwardEmails = False, the user has the option to set the classification for the forwarding/reply email and as seen below the original email is classified as internal but that is not inherited while forward/reply email.
autoClassifyReplyForwardEmails = True, As seen below while forwarding the email, it has inherited the classification from the original email.
Wizard Mode
Using Wizard mode, user can enable/disable policies related to Outlook by making changes on the screen.
Select the Configuration Wizard Mode
Below we will see the settings on the wizard and the result for the same.
The Header is selected on wizard and footer is left blank
Verify the setting on outlook we can see the header but not the footer.
If the user changes the setting and footer is added the config and the wizard and outlook will look as below:
Moving on to set Outlook polices, the user has selected Force to classify and send the email, user cannot send the email without classifying it. The option to Dismiss is to keep editing the email and OK is to classify the email.
If the user Changes it to Warn to classify and send the email, user will be able send the email without classifying it but with a warning. The option to Dismiss is to send the email and OK is to classify the email.
The last option is of Log & ignore where user can send the email without classification and without any warning.
As the user has selected Force to classify and print the email, user cannot print the email without classifying it. The option to Dismiss is to keep editing the email and OK is to classify the email.
The other two options are Warn, Log&Ignore where the user will be able to print the email without classifying it. The option to Dismiss is to print the email and OK is to classify the email. And with the Lo&Ignore there will be no warning at all.
As user has selected Block, the user cannot send the any attachment in the email without classifying it.
The other two options are Warn where the user will be able send the attachment in the email without classifying it but the agent will give a warning like shown below and Log&Allow where the user will be able send the attachment in the email without classifying and without any warning.
The user has selected Block for the 4th option, in this case the attachment is highly confidential, and the email is on lower level of classification, so the agent will not allow to send the email. The user will have to change the classification of either the attachment or the email, else will not be able to send the email as shown in the screen shot.
If user has selects Warn, in this case the attachment is highly confidential, and the email is on lower level of classification, so the agent will only warn the user, but the user will still be able to send the email.
The final option here also is Log&Allow, where the user will be able send any attachment in the email without any warning.
The checkbox User lowers classification level of a classified email in unchecked, the user will not be allowed to lower the level of classification on the document and all the lower classification options will be disabled.
The checkbox Inherit classification when Reply and Forward emails in unchecked, the user has the option to set the classification for the forwarding/reply email and as seen below the original email is classified as internal but that is not inherited to while forward/reply email.
The checkbox Inherit classification when Reply and Forward emails in checked, As seen below while forwarding the email, it has inherited the classification from the original email.
Configure Emails
Expert Mode
Using Expert Mode, the user can enable/disable default policies related to email by making changes in the JSON file on the agent itself.
Select Expert Mode
Scroll down to the configurationOverrides section
The policies that we can set are as below:
Classification: - Here the user can select which type of email he wants to configure. The options are Public/Internal/Confidential/Highly Confidential
DefaultEmailPolicy: - Here the user can set the policy to Block/Allow/Warn about the email.
BlockList: - The agent gives the option to create a blocklist of specific recipients. User will just have to add the email id of recipient in the list.
WarnList: - The agent gives the option to create a warnlist of specific recipients. User will just have to add the email id of recipient in the list.
AllowList: - The agent gives the option to create an allowlist of specific recipients. User will just have to add the email id of recipient in the list.
Sample config file is as below:
"configurationOverrides": [
"classification": "Public"
"defaultEmailPolicy": "block",
"blockList": [],
"warnList": ["aagarwal@getvisibility.com],
"allowList": []
The above configuration says that for Public type emails are blocked for sending, except for the recipient aagarwal@getvisibility.com, whom the email can be sent but with a warning message.
Validating the configuration as below. Since all the Public emails are blocked from sending and the recipient lab user is not on the Allow or Warn list the email cannot be sent.
If we change the recipient to aagarwal@getvisibility.com, agent will give only a warning as the recipient was in the warn list, but the email can still be sent.
Wizard Mode
Using the Wizard mode, the user can enable/disable the policies related to Outlook by making changes in the on the screen directly.
Select the Configuration Wizard Mode
There is total 12 steps in Wizard and Outlook polices starts from 8th step.
As shown below the Public emails are by default set to Block but 1 recipient is allowed to send the email with a warning.
Validating the configuration as below. Since all the Public emails are blocked from sending and the recipient lab user is not on the Allow or Warn list the email can be sent.
If we change the recipient to aagarwal@getvisibility.com, agent will give only a warning as the recipient was in the warn list, but the email can still be sent.
The same settings can be done for Internal/Confidential/Highly Confidential emails as well with one additional option to copy the configuration from the previous classification.
Generic Settings
WriteMetadataTags :-
This property will capture the details about the agent in office applications. The below screenshot is from the config file.
In the MS Word the details can be seen as below:
SelectableByWhitelist:
Based on the distribution list, the email addressed in this list will be the once that Outlook plugin will allow sending emails to.
AllowInternalToExternal:
Based on the distribution list, this property allows to share a file in outlook irrespective of the distribution value.
MaxNumberOfRecipients:
This property allows to set the maximum number of people the user wants to send the email to.
SuggestionOptions:
This tag will allow the user to configure the options user want to show while showing the suggestion box on Ms office or Outlook.
AgentDialogConfiguration
This tag will allow the user to customize the options user want to show while show like compliance, classification etc.
DistributionTags:
Additional feature to classify the documents/emails. Few examples are: Internal/Restricted/ External/Limited
AutoLabelling
This optional feature allows to automatically classify with a default label all newly created docs in Word, Excel,Powerpoint and Outlook emails. It is possible to individually set the default label for each plugin individually. User will be able to select the classification label that he wants to apply to documents and email and when there is edit or change in the file and the file is saved the selected classification will be applied. Setting Autolabelling will allow the user to not to classify the documents every time the file is printed or saved, the classification will happen automatically.
Expert Mode:
The property used in Expert Mode are: defaultClassificationValue. We can see below that the defaultClassificationValue is set for Outlook, Word,Excel and PoperPoint.
Wizard Mode for Word, Excel and PowerPoint:
Wizard Mode for Outlook:
Caution
While using Expert Mode the user has to be extra careful about the small details like punctuations and formatting of the file, else the agent will through and error like below.
Reports
There are two reports related to Synergy as shown below:
Agent Activity Report
For users of Getvisibility Synergy that want an overview of the users' events using GVClient agents in MS Office and Outlook. Extensive tables detailing classification and email events are provided.
Agent Incident Report
For users of Getvisibility Synergy, this report gives an overview of the security related activity undertaken by users of GVClient agents. It visualises data such as: de-escalations, mis-classifications, and confidential data in infographic form to give organisation’s a quick understanding of the data their users are passing through their network.
Agent Management
Agent Management gives the user a high-level status of all the agents installed. Details like Name of agent, the IP address and When was the agent last seen is shown on this dashboard. User can also see if the agent is Online or not. The facility to filter the agent based on Name, Health and State also is provided.
Administration
Pattern Matching
Using Pattern Matching UI you can view, save, create and edit regex pattern, then the backend will process it and agent give suggestions based on the regex created.
Select the Add New button to create a new Regex pattern, a new window will open to enter the regex pattern
Add a new regex pattern, we are creating a regex for Student ID which is made of 7 digits and 2 letters
The tags and be added for the new regex as shown below and Select Create
As you can see the new pattern in created but right now it is unpublished
User also has the option to Edit/Delete the regex pattern
After Selecting on Publish, the classification services starts so that the backend can process the new regex pattern
User can see the confirmation message for published changes:
Once the changes are published wait for few minutes, then open the document and enter the regex pattern you had created, in this example we had created for 7 digits and 2 letters.
As you can see below we have entered the student ID as per the regex and we can see the agent giving us the suggestion that is is GDPR/PII:100% and Classification as Confidential.
User can then Select Use Suggested; GDPR/PII and Confidential will get selected and the documents will be classified.
User also has the option to ignore the suggestion and use any other values to classify.
User Management
Using the user management users will be able to create new users to access the application. There are 2 ways to create new users:
Using the portal
Select the User Management option of the portal
User will be asked to login into keycloak portal (Credentials will be shared separately)
Navigate to the User Section and Select the Add User button
Select the Save:
Select in credentials user will be able to set the password for the new login, using this method we can create a new user or view the existing users.
Using LDAP method
For the LDAP method please refer the below document for details:
End of Document