Agent V4 - Configuration Options for Expert Mode
Tagset
ID
Tagset is a set of one or more tags. E.g. certain tags belong to certain types of compliance, so these tags will be grouped together.
id - Universally Unique Identifier for the whole tagset.
Tagset
name
Name of the tagset, e.g. “Classification” or “Compliance” or Distribution
Tagset
displayname
The name of the tagset that users wants to be displayed on the UI. Eg the tagset is Classification but on Agent UI it will be displayed as Classification GV.
Tagset
required
This property meant for binary tags, if the type is binary and required: true, then the user will have to select at least 1 tag, otherwise a red text “is required” will appear below the column
Tagset
tagType
There are two tagtypes categorical which is single select option like radio button and binary are multiselect option like check boxes.
Tagset
tags
The list of tags for each type like for classification it can be Public, Confidential or custom tags. For Distribution it can be Internal, External and for Compliance it can be GDPR/PII etc.
Tagset
tagAliases
The name of the tagset that users wants to be displayed on the UI. Eg the tag Public but on Agent UI it will be displayed as Public for GV.
Tagset
visualMarkingOder
This property defines the order of the tags in tagset that will be shown to the user in the agent UI. This property is not applicable for Distribution and Compliance.
Agent
classificationDialogColumnTagsetIds
The tagsetId of the column should be displayed here. So if you want to show Classification and Distribution on UI then the tagsetid of these fileds should be added here.
Agent
blockServerAddressEdit
Does Not allow the user to edit the Server Address displayed on the Configuration Dialog Box
Agent
disableConfigurationMenu
Allows the user to disable the configuration menu so the end user cannot change it.
Agent
ribbonTitlePrefix
User can set the custom ribbon title using this property. If the field is left empty, will be displayed default title “Classification”.
Agent
orderTagsTopToBottom
It will show the order of classification tags on Agent UI.
Agent
helpUrl
Global
autoUpdateCheckRate
The duration after which the server will check for auto update in mins
Global
autoUpdateEnabled
When set to True the property will update to a new version when its available
Global
autoUpdateServerUrl
Server address to where auto update artifact is stored
Global
autoUpdatePackageNameRegex
Regex that the customer can add to to fetch the auto update artifact
Global
betaAgentsEnabled
Flag indicating if beta agents are enabled.
Global
betaAgentEndpoints
List of machines which should auto-update to latest beta agent.
Global
availableLanguages
It shows the language that is set on the language setting page of dashboard
Global
suggestionsDebounceRate
Delay before we fetch suggestions in secs
Global
suggestionsMinConfidenceThreshold
This property decides after which % of suggestion confidence the suggestion will be shown in dailog box. Eg: If the threshold is set to 50% and the ML returns suggestion as 30% then this will not be displayed to user
Global
"suggestionsMapping": [ {"backendId": , "tagsetId": "", "tag": "" }
suggestionsMapping: This is used to map the suggestion to the tags
backendId: This is the id we get from the ML model.
tagsetId: The tag id of the tags from agent
tag: Name of the tag
Global
heartbeatRate
This determines how often the heartbeat of the should be sent to server, its defined in secs
Global
sentryUrl
URL to Sentry, this field is hardcoded for now.
Global
"aipConfiguration": "siteId": "“, "labels": {[ "labelId": "“, "name": "Public" }, ],,
Azure Information Protection Metadata Configuration.
siteId -Specifies the AIP Site ID.
labels - Array of AIP Label.
labelId - the ID of this AIP label.
Name - the plaintext name of this AIP label.
Global
"mappings": [ { "classificationTag": "", "labelId": "" }] },
mappings - Array of AIP Mapping Entry (Specifies the mappings between classification tags and AIP labels).
classificationTag - the ID of the tag which is used to decide when the mapping entry is hit.
labelId - the id field of the AIP Label which is written when the mapping entry is hit
Global
"externalLabelMappings": [ { "regex": "", "tagsetId": "", "tag": "" }, ],
A simple mapping to map old meta data from different tool to our meta data. At present its used only by CLI.
Regex defined will be used to identify tags for different tools.
Tagsetid and tags will be used to replaces the tags identified using regex.
Global
featureToggles
This property if set to true will allow to test a new feature based on the config rather than a global release. if set to false it will navigate back to the old logic.
Global
metadataWriterConfiguration": [ { "name": "", "handle": "" } ],
Meta data for DLP software, this is configurable and has different placeholders like username, date etc.
Excel, Word, PPT, Outlook, PDF
enabled
Setting this property to true will enable the plugin for classification
Excel, Word, PPT
suppressShareAndExport
Setting this property to true will not show the share and export option on excel plugin file menu..
Excel, Word, PPT, Outlook
suggestionsEnabled
Setting this property to true will enable the plugin to received suggestion as per the content.
Excel, Word, PPT, Outlook
suppressSuggestionsDialog
Setting this property to true will not show the suggestion dialog box on plugin
Excel, Word, PPT, Outlook
suppressRibbonButton
Setting this property to true will not show the ribbon button on plugin
Excel
suggestionsMaxRowsAndCols
Number of rows and columns to analyze to generate suggestion. So if the value is set 100 then 100 rows and 100 columns will be analyzed.
Outlook
maxNoOfRecipients
Number of recipients allowed to send email at any particular time
Outlook
allowedEmailsOrDomains
If some emails/domains are set here, then only those accounts will be allowed to receive an email.
Outlook
blockEmailsOrDomains
If some emails/domains are set here, then those accounts will be completely blocked to receive any email.
Outlook
warnEmailsOrDomains
If some emails/domains are set here, then before sending email to these account the sender will be warned about it.
Outlook
permissionToSendEmailsOrDomains
If some emails are set here, and the sender is not within this list, then he won't be able to send the email. The list is about the sender and not recipient.
Outlook
"customAlertMessages": { "enabled": true, "warnings": [ { "classificationTag": "rq6obyDuFM", "message": "PyPDHPaQj4" }, ] },
User can set additional warning message for classification types
Outlook
"excludeFileExtensions": [ ".pdf", ],
It is used to exclude any particular attachment extension from validation, like if pdf is selected in the list then pdf can be sent in email without classification.
Note: The file type should be added with a Dot. Eg: [.pdf,.jpeg]
Outlook
showPrefixClassificationSubject
On email subject a prefix will be added based on the classification
Outlook
showSuffixClassificationSubject
On email subject a suffix will be added based on the classification
Outlook
defaultEmailPolicy
By default should the email be allowed, blocked or warned before sending the emails to recipients
Outlook
unclassifiedAttachmentsPolicy
Based on the value set unclassified attachments will be allowed, blocked, or ignored.
Outlook
attachmentsSetMinimalClassification
Based on the value set attachments having higher classification value than the email will be allowed, blocked or ignored
Outlook
autoClassifyOnReplyForward
The property if set to true will auto classify the email when replying or forwarding as per the original email
Outlook
classifyAttachmentsSameAsEmails
When set to true the attachment will be classified same as email if on sending the attachment is not classified
Outlook
classifyEmailsSameAsAttachments
When set to true the email will be classified same as attachment if on sending the email is not classified
Excel, Word, PPT, Outlook
“tagsetWhitelists": [ { "members": [“GV.com“], "tagName": "Public", ”tagsetId": "“ } ],
Users/domain in whitelist property will only see the tags that are defined in the property for that plugin.
Excel, Word, PPT, Outlook
aIClassificationDeescalationPolicy:
Policy
Threshold
Policy: This property allows the user to decide if they want to block or warn when the user lowers the classification level from the classification suggested by AI.
Threshold: This property allows the user to decide the confidence % after which if they want to block or warn when the user lowers the classification level from the classification suggested by AI. So eg: Block the user to lower the classification on when the confidence % is less 50. This property works for only for Categorical tag types.
Excel, Word, PPT, Outlook
aiClassificationMismatchPolicy
This property allows the user to decide if they want to block or warn when the user selects a different value from the the classification suggested by AI based on the % set by admin. This property works for Both Binary and Categorical tag types.
Excel, Word, PPT, Outlook
aiDistributionMismatchPolicy
This property allows the user to decide if they want to block or warn when the user selects a different value from the the distribution suggested by AI based on the % set by admin. This property works for Both Binary and Categorical tag types.
Excel, Word, PPT, Outlook
aiComplianceMismatchPolicy
This property allows the user to decide if they want to block or warn when the user selects a different value from the the compliance suggested by AI based on the % set by admin. This property works for Both Binary and Categorical tag types.
Excel, Word, PPT, Explorer, Outlook
allowClassificationDeescalation
The property if true allows the user to lower the classification value after saving and re-opening the document.
Excel, Word, PPT, Explorer, Outlook
allowDistributionDeescalation
The property if true allows the user to lower the distribution value after saving and re-opening the document.
Excel, Word, PPT, Outlook
defaultClassification
User will be able to enable default classification using this value. The trigger for this is save and close.
Excel, Word, PPT, Outlook
defaultClassificationValue
This property allows the user to select the default classification that can be applied to the document
Excel, Word, PPT, Outlook
defaultDistributionValue
This property allows the user to select the default distribution that can be applied to the document
Excel, Word, PPT, Outlook
"autoClassificationConfiguration": [ { "tagsetId": "", "threshold": } ],
The document will be classified based on the context of the file when this property is enabled. Users can set this property for Distribution, Compliance and Classification. The Triger is Save and Send.
Excel, Word, PPT, Outlook
policyBeforePrint
Using this property user can decide level of enforcement that should be applied while printing an unclassified document
Excel, Word, PPT, Outlook
policyBeforeSave
Using this property user can decide level of enforcement that should be applied while saving an unclassified document
Excel, Word, PPT, Outlook
footer
User can add customized footerusing this property
Excel, Word, PPT, Outlook, PDF
header
User can add customized header using this property
Excel, Word, PPT, Outlook
showFooter
When set to true this property enables the user to show footer on the classified document
Excel, Word, PPT, Outlook, PDF
showHeader
When set to true this property enables the user to show header on the classified document
Excel
alwaysShowPopup
Users will be able to see the option of choosing where to apply header/footer at run time when they are working on document if this property is set to true
Excel
enforceSheetLayoutOption
When set to true the visual label will be applied as per the option selected in the dropdown
Excel
sheetLayoutOptions
By default, where visual tags should be applied. This dropdown has 2 values All sheets and Sheet Range
Excel
fromSheet
Enables the user to select from which sheet number to apply visual marking.
Excel
toSheet
Enables the user to select to which sheet number the visual markings should be applied
Excel
enforceOverwriteOption
When set to true the visual label will be applied as per the option selected in the dropdown below
Excel
overwriteOption
This drop down allows the user to select if they want to overwrite or append the existing H/F
PPT
titlePageShowTitle
Enables the user to add an additional slide and add title to it as per the classification value
PPT
titlePageTitle
User can add customized title using this property
PPT
titlePageShowSubtitle
Enables the user to add an additional slide and add subtitle to it as per the classification value
PPT
titlePageSubtitle
User can add customized subtitle using this property
PPT
enforceSlideLayoutOption
When set to true the visual label will be applied as per the option selected in the dropdown below
PPT
slideLayoutOptions
By default, where visual tags should be applied. This dropdown has 3 values All slides, Title Slide Only and Slide Range
PPT
triggerSlidesNumber
Only applies visual labels when the number of slides is greater than or equal to the specified threshold
PPT
fromSlide
Enables the user to select from which slide number to apply visual marking.
PPT
toSlide
Enables the user to select to which slide number the visual markings should be applied
labelWidth
This property defines the width of the PDF header text box
labelHeight
This property defines the height of the PDF header text box
Word
headerFooterHeight
Default size for floating header and footer
Word
showWatermark
When set to true this property enables the user to show watermark on the classffied document
Word
watermark
User can add customised header using this property
Word
enforceHeaderFooterType
When set to true the visual label will be applied as per the option selected in the dropdown below
Word
headerType
By default, how the visual tags should be applied for header. This dropdown has 2 values Fixed and Floating
Word
footerType
By default, how the visual tags should be applied for footer. This dropdown has 2 values Fixed and Floating
Word
pageLayoutOptions
By default, where visual tags should be applied. This dropdown has 3 values All pages , Title Page Only and All pages except title
Word
triggerPagesNumber
Only applies visual labels when the number of pages is greater than or equal to the specified threshold
Custom Rules
Multiple
Enabled: Setting this property to true will enable the Macro for use
id: Unique ID associated with each Macro
Name: Marco Name given by the user or if migrated from old config it will be numbered as shown in example.
Note: If the user wants to add any description for the Macros it should be added here.
Target: This property will mention the plugin that will be affected by this Macro, other than the target plugin all other plugins will be Null. For Eg: In this scenario the target is Outlook so other Plugins like Word, Excel and PowerPoint are Null.
Trigger: Using this property user can select what should be the combination of compliance, classification and/or distribution should call this macro.
footerOverwriteOption: This property allows to choose if the macro should overwrite or append to the default footer with the text.
headerOverwriteOption: This property allows to choose if the macro should overwrite or append to the default header with the text.
watermarkOverwriteOption: This property allows to choose if the macro should overwrite or append to the default watermark with the text.
Endpoint Discovery
Enabled
Enable or disable the scanning for all agents
Endpoint Discovery
excludedFileAttributes
Endpoint Discovery is designed to include only relevant files and folders in scan results, automatically excluding system files using carefully chosen Windows file/folder attributes. While these default settings provide optimal results, users can modify the attributes if needed, such as including system files or excluding hidden files, though changes should only be made if fully understood.
Endpoint Discovery
excludedPaths
File paths to exclude from scanning. For example, it may be desired to scan the entire C: drive, but to exclude the Windows and Program Files folders, etcFile paths to exclude from scanning. For example, it may be desired to scan the entire C: drive, but to exclude the Windows and Program Files folders, etc
Endpoint Discovery
includedFileAttributes
Endpoint Discovery is designed to include only relevant files and folders in scan results, automatically excluding system files using carefully chosen Windows file/folder attributes. While these default settings provide optimal results, users can modify the attributes if needed, such as including system files or excluding hidden files, though changes should only be made if fully understood
Endpoint Discovery
rootPath
The folder location to scan. It may be desired to scan the entire C: drive or to just scan the user folders, etc. This is a required field and must be populated for the scan to start. Must be in the format of an absolute Windows path
Endpoint Discovery
scanOnStart
Enable to always start a scan on system start in addition to the scheduled time. This includes on the installation of the agent
Endpoint Discovery
scanSchedule
How often the scan should run (every day, week, 2 weeks or month)
Last updated
Was this helpful?