User Guide
Working with Policies
Overview
Policies govern how Agents, which are worker processes, scan and evaluate locations for sensitive data such as social security numbers and phone numbers.
-
For more about Agents and how they work, see What is an Agent?
The Policies page is where you manage all your organization's policies.
To access this screen:
-
From the left menu, click Agents.
-
Click Policies.
View a Policy
Use the following steps to view an Agent policy:
-
Select an option from the Policy Configuration drop-down list.
-
The selected policy displays just below the Default Policy section.
-
Click the down arrow (
) to expand a section and up arrow (
) to collapse a section.
Each section displays a summary of the following:
- Agent Operations
- Additional Options
- Additional Settings
- Basic Options
- Advanced Options
- Local Reporting
- Local Logging
- Basic Options
- Advanced Options
Add a New Policy
To add a new policy use the Add New Policy wizard:
-
In the top right of the screen, click Add Policy.
-
On the Policy Setup Basics screen, fill the Policy Name and click Next.
-
On the Agent Operations screen, set the time interval (in seconds) for the following:
-
Check for Policy Updates intervals (all versions)
-
Set the interval for the Agent to report policy updates to the console
-
Minimum value: 5 seconds
-
Maximum value: 86,400 seconds
-
-
-
Search Agent Progress Update intervals (version 13.5+)
-
Set the interval for the Agent to report progress updates to the console
-
Minimum value: 5 seconds
-
Maximum value: 86,400 seconds
-
-
-
Discovery Agent Progress Update intervals (version 13.5+)
-
Set the interval for the Discovery Agent to report progress updates to the console
-
Minimum value: 5 seconds
-
Maximum value: 86,400 seconds
-
-
-
-
Click Next to proceed, Previous to return to the previous screen, or Exit Without Saving
to discard. -
Click Advanced Options to input more detailed settings.
-
Expand the section for more information:
-
Agent Operations - Advanced Options
Use the table below to help you fill in the Agent Operations - Advanced Options page.
-
Select the blue Advanced Options button to access these settings.
Setting Name | Options | Description |
---|---|---|
Enable Startup Check |
|
Enable the console to verify the endpoint performs at startup.
|
Use FQDN |
|
The computer name format.
|
Results Storage Mode |
|
Specify how Spirion stores results during a search.
|
Location Shred Intensity |
|
Controls how a file is deleted when a location is remediated using shred to prevent the deleted file from being recovered.
|
Temp File Shred Intensity |
|
Controls how a file is deleted when a location is remediated using shred to prevent the deleted file from being recovered.
|
Shred Passes (Intense Shred only) |
|
The number of passes to use when Shredding files:
|
Temp File Location |
|
The Agent operation uses the Temp File Location, but only if it has an assigned value.
|
Cloud Remediation (Previous File Versions): |
|
By default, the version/revision of the file located in the cloud storage that was searched is deleted after an action is performed.
|
Allow Configuration File to Override System Setting |
|
Enable (or prevent) settings in a configuration file to override system settings.
|
Target Watcher User Selection* |
|
The end user's service behavior selection. * This is a Sensitive Data Watcher (File and Email Watcher) setting only. |
Search API Plugins Path (version 13.5 and later) |
|
Full path to custom search plug-ins.
|
Disable Integration |
|
Specify whether classifications are editable via integration add-ins.
|
Auto Save On Close |
|
Automatically save error reports when the dialog is closed.
|
Window Body |
|
The text to display in the body of an error report dialog.
|
Window Header |
|
The text to display in the header of an error report dialog window.
|
Log Capture Window |
|
The number of days of logs to include when using the Gather Data function
|
Max Data Gathering Size |
|
The maximum size - in MB - of the output of the Gather Data function.
|
Results Compression |
|
Instructs the Agent to compress JSON payloads.
|
Plugins (all versions pre-13.5) |
|
Full path to custom search plug-ins.
|
Temp Files
-
The Agent Operation uses the Temp File Location if it has an assigned value.
-
The file location must have a Windows file path and cannot be a mapped network drive.
Set up temp file options for clean-up, either:
-
To begin shredding temp files immediately or delay until the scan is complete.
-
To asynchronously shred temp files, or shred in sync with the scan.
When scanning, compressed files can be downloaded to the Temp File.
-
To save processing time, the compressed file is decompressed one file at a time and the same set of decompressed files are used for each discovered location.
-
The file is not compressed or decompressed again.
-
The Temp File is shredded intermittently to limit space usage and processing time.
-
The settings for the Temp File are in the Scan option selection.
Procedure:
-
Click Next to proceed, Previous to return to the previous screen, or Exit Without Saving
to discard. -
On the Additional Settings screen, you can input additional settings.
-
Expand for more information:
Additional Settings
Use the table below to help you fill in the Additional Settings screen:
Setting Name | Options | Description |
---|---|---|
Show Help Menu |
|
Show the Help item in the Windows Shell Extension.
* This option is specific to searches initiated from Windows Agent UI. This is a Windows-only option. Mac/Linux are excluded. |
Show Search Menu |
|
Show the Search item in the Windows Shell Extension
* This option is specific to searches initiated from Windows Agent UI. This is a Windows-only option. Mac/Linux are excluded. |
Show Secure Menu |
|
Show the Encrypt item in the Windows Shell Extension
* This option is specific to searches initiated from Windows Agent UI. This is a Windows-only option. Mac/Linux are excluded. |
Show Shred Menu |
|
Show the Shred item in the Windows Shell Extension
* This option is specific to searches initiated from Windows Agent UI. This is a Windows-only option. Mac/Linux are excluded. |
Show Sub Menu |
|
Show Shell Extension items in a Windows sub-menu
* This option is specific to searches initiated from Windows Agent UI. This is a Windows-only option. Mac/Linux are excluded. |
Show Wizard |
|
Displays or hides the Search Wizard when the endpoint application launches in interactive mode.
* This option is for Windows and Mac. Linux is excluded. |
Disable Results Wizard
|
|
Disable/Enable the Results Wizard feature
* This option is specific to searches initiated from Windows Agent UI. This is a Windows-only option. Mac/Linux are excluded. |
Startup Wizard Add OnlyFind Option |
|
Set the default option for OnlyFind in the Search Wizard
* This option is specific to searches initiated from Windows Agent UI. This is a Windows-only option. Mac/Linux are excluded. |
Startup Wizard Search Option |
|
Set the default option for the Search Wizard
* This option is specific to searches initiated from Windows Agent UI. This is a Windows-only option. Mac/Linux are excluded. |
Search Completion Option |
|
Specify the user experience when a search completes
Note: If this option is set in the system container to Show Results Wizard or Show Advanced Mode, the user does not have the opportunity to sign in with their profile password when the search is completed. |
Show Preview Pane |
|
Mask all matches in preview pane
|
Show Results Pane |
|
Select check remote files for existence to prompt to remove remote files from the view if they do not exist
Use Flat Report - Present search results in a flat report without a parent/child hierarchy
|
Classification Display Preference |
|
The style of display for the classification column in the endpoint UI
|
Display Results |
|
Display results collapsed rather than expanded:
* This option is a Windows and Mac option. Linux is excluded. |
-
Click Advanced Options to input more detailed options.
-
Expand the section for more information:
Additional Settings - Advanced Options
Use the table below to help you fill in the Additional Settings - Advanced Options screen:
Setting Name | Options | Description |
---|---|---|
Always Prompt for Profile Password |
|
When the endpoint starts, the default action is to prompt for the user's Profile Password.
|
Disable Change Profile Password |
|
To prevent users from changing their profile password, set this value to "Prevent change" (1).
* This option is specific to Windows and Mac. Linux is excluded. |
Disable Delete Profile |
|
To prevent users from deleting their profile, set this value to "Prevent delete" (1).
* This option is specific to Windows and Mac. Linux is excluded. |
Disable Export Profile |
|
To disable the use of the export profile button, set this value to "Disable" (1).
* This option is specific to searches initiated from Windows Agent UI. This is a Windows-only option. Mac/Linux are excluded. |
Disable Import Profile |
|
To disable the use of the import profile button, set this value to "Disable" (1).
* This option is specific to searches initiated from Windows Agent UI. This is a Windows-only option. Mac/Linux are excluded. |
Enable Password Strength |
|
By default, there are no requirements on the length or composition of passwords used for the Profile Password or with the Encrypt action.
* This option is specific to Windows and Mac. Linux is excluded. |
Include Default Settings On Profile Export |
|
By default, when exporting the profile, all settings are included in the profile export.
* This option is specific to Windows and Mac. Linux is excluded. |
Use Profile Password for Secure Action |
|
Use Profile Password the Encrypt action.
|
Require Profile Login |
|
Users can login to the endpoint using their Profile Password or skip login and use the Guest Profile.
Note: This setting cannot be specified in an XML configuration file. * This option is specific to Windows and Mac. Linux is excluded. |
Use Profile Password |
|
Use Profile Password for sign on, Encrypt, Open, Save, and other actions that require a password.
* This option is specific to Windows and Mac. Linux is excluded. |
Use Profile Password For Save |
|
Use Profile Password Save.
* This option is specific to Windows and Mac. Linux is excluded. |
Allow Sort During Search in Disk Mode |
|
When using the on-disk database to store results during the search rather than holding them in memory, the sort operation can be very slow. Because of this, sort is disabled by default in this scenario.
* This option is specific to Windows and Mac. Linux is excluded. |
Exclude Identity Matches in Results Data |
|
After a match is found, it is displayed in the results view.
Note: When this setting is enabled, the Redact action cannot be used as the match information is required for redact to operate. Note: If preview is enabled, the first character of the match is highlighted in the Preview pane when a result is selected in the Results pane. * This option is specific to Windows and Mac. Linux is excluded. |
Row Cache Size |
|
When using on-disk database mode to store results during the search, the results are batch inserted into the database to manage disk I/O.
* This option is specific to searches initiated from Windows Agent UI. This is a Windows-only option. Mac/Linux are excluded. |
Update Timer |
|
When using on-disk database mode to store results during the search, the results are batch inserted into the database to manage disk I/O.
* This option is specific to searches initiated from Windows Agent UI. This is a Windows-only option. Mac/Linux are excluded. |
Other |
|
Select one or more options.
* This option is specific to searches initiated from Windows Agent UI. This is a Windows-only option. Mac/Linux are excluded. |
-
Click Next to proceed, Previous to return to the previous screen, or Exit Without Saving
to discard. -
On the Local Reporting screen, you can input additional settings.
Local Reporting Options
Use the table below to help you fill in the Local Reporting screen:
Setting Name | Options | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Exit on Complete |
|
By default, when the endpoint application is executed as a scheduled task in the context of the logged on user, it remains open and enables the user to interact with those results.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Save Key |
|
Specify the encrypted password to be used when automatically saving an IDF results file
Note: This value must be created using the endpoint GUI. Reference documentation is available at Creating a Password Hash for Auto Saving Results During Scheduled Task Searches |
|||||||||||||||||||||||||||||||||||||||||||||||||||
Save Key 2 |
|
Specify the encrypted password to use when automatically saving a secondary IDF results file
Note: This value must be created using the endpoint GUI. Reference documentation is available at Creating a Password Hash for Auto Saving Results During Scheduled Task Searches |
|||||||||||||||||||||||||||||||||||||||||||||||||||
Save Location |
|
The folder path and file name for the saved IDF file.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Save Location 2 |
|
The folder path and file name for the secondary saved IDF file.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Save Locations Are Folder Names |
|
Specify that saveFolderLoc/saveFolderLoc2 are folder names rather than file names.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Settings Source |
|
Specify the location of the settings for the scheduled task.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Auto Save Results |
|
Enable the ability to automatically save search results.
Note: In Version 7.0.x of the endpoint software, this setting only applies to interactive, user searches and cannot be used with background user searches or system searches. This was updated in version 7.1 to apply to all search types. |
|||||||||||||||||||||||||||||||||||||||||||||||||||
Auto Save Secure Results 2 |
|
Enable the ability to automatically save results to a secondary file of type IDF.
Note: In Version 7.0.x of the endpoint software, this setting only applies to interactive, user searches and cannot be used with background user searches or system searches. This was updated in version 7.1 to apply to all search types. |
|||||||||||||||||||||||||||||||||||||||||||||||||||
Configuration File Location |
Path to a configuration file |
Specify the path to a configuration file
* This option is specific to searches initiated from Windows Agent UI. This is a Windows-only option. Mac/Linux are excluded. |
|||||||||||||||||||||||||||||||||||||||||||||||||||
Create Folder Location |
|
Automatically create the folder for saved results file.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Create Folder Location 2 |
|
Automatically create the folder for secondary saved results file
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
CSV Report Options |
Format: Name/(value)/default/Platform (All/Windows/Mac/Linux)
|
The elements and options to save in the Text Export.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
CSV Save Repeat All Data |
|
Save all information of each row of the Text Export.
* This option is specific to Windows and Mac. Linux is excluded. |
|||||||||||||||||||||||||||||||||||||||||||||||||||
CSV Save Show Multi Rows |
|
Save the "Multiple Match" rows in the Text Export
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
HTML Report Options |
Format: Name/(value)/default/Platform (All/Windows/Mac/Linux)
|
The elements and options to save in the Web Page Report.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
HTML Report Type |
|
The options for saved Web Page Report
* This option is specific to Windows and Mac. Linux is excluded. |
|||||||||||||||||||||||||||||||||||||||||||||||||||
Spirion Report Options |
|
The elements and options to save in the Encrypted IDF file.
* This option is specific to Windows and Mac. Linux is excluded |
|||||||||||||||||||||||||||||||||||||||||||||||||||
Disable Feature - Save Spirion Files |
|
Disable the ability save encrypt IDF results files.
* This option is specific to Windows and Mac. Linux is excluded. |
|||||||||||||||||||||||||||||||||||||||||||||||||||
Disable Save Feature in Clear Text |
|
Disable the ability to save results in clear text
* This option is specific to Windows and Mac. Linux is excluded. |
|||||||||||||||||||||||||||||||||||||||||||||||||||
Check Previous Results |
|
Automatically check previous file results for existence.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Automatically Save & Load Results |
|
Enable the ability to automatically save search results. To automatically save results to an IDF file upon search completion, set to "Save as IDF," or "Save as HTML."
Note: In Version 7.0.x of the endpoint software, this setting only applies to interactive, user searches and cannot be used with background user searches or system searches. This was updated in version 7.1 to apply to all search types. |
|||||||||||||||||||||||||||||||||||||||||||||||||||
Show Results in Client UI |
|
Automatically display previous search results in the endpoint (workstation, laptop, etc.) UI on startup.
* This option is specific to searches initiated from Windows Agent UI. This is a Windows-only option. Mac/Linux are excluded. |
-
Click Next to proceed, Previous to return to the previous screen, or Exit Without Saving
to discard. -
On the Local Logging screen, you can input logging settings.
-
Expand the section for more information:
Local Logging Options
Use the table below to help you fill in the Local Logging screen:
Setting Name | Options | Description | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Types | |||||||||||||||||||||||||||||||||||
Auto Action - Do Messages |
|
Log informational messages when performing auto-actions.
|
|||||||||||||||||||||||||||||||||
Auto Action - Do Errors |
|
Log error messages when performing auto-actions.
|
|||||||||||||||||||||||||||||||||
Do Messages |
|
Log informational messages.
|
|||||||||||||||||||||||||||||||||
Do Errors |
|
Log error messages.
|
|||||||||||||||||||||||||||||||||
Do Debug |
|
Log debug messages.
|
|||||||||||||||||||||||||||||||||
Do Secure Items Skipped |
|
Log items skipped because they were secure.
|
|||||||||||||||||||||||||||||||||
Enable Logging |
|
Log information when performing updates
* This option is specific to searches initiated from Windows Agent UI. This is a Windows-only option. Mac/Linux are excluded. |
|||||||||||||||||||||||||||||||||
Retention |
|
The method for creating new logs.
|
|||||||||||||||||||||||||||||||||
Do Locations Searched |
|
Log each location searched.
|
|||||||||||||||||||||||||||||||||
Do Matching Locations |
|
Log each location with a match.
|
|||||||||||||||||||||||||||||||||
Do User Actions |
|
Log user actions when performing auto-actions
|
|||||||||||||||||||||||||||||||||
Log Format |
|
The format for the logs.
|
|||||||||||||||||||||||||||||||||
Log Types |
|
Log message types read by the console.
|
|||||||||||||||||||||||||||||||||
Send Logs |
|
Send logs to the console.
|
|||||||||||||||||||||||||||||||||
Standard Operations |
|
When using Sensitive Data Watcher's Email component (internally email change monitor service), it may be desirable to see detailed logging information during configuration or troubleshooting. The logging specified via this setting applies only when logging has been enabled and specific log entries are displayed only if their corresponding log type has been enabled (for example, Info, Error). The following log levels are available:
Note: Logging beyond the default level, especially the maximum level, creates very large log files and may contain sensitive information. |
|||||||||||||||||||||||||||||||||
Discovery Teams |
|
The level of detail to log when searching with Discovery Teams. When searching with Discovery Teams, it may be desirable to see detailed logging information during configuration or troubleshooting. The logging specified via this setting applies only when logging has been enabled and specific log entries are displayed only if their corresponding log type has been enabled (example: Info, Error) . The following log levels are available:
*This setting applies Windows and Linux. Mac OS is excluded. |
|||||||||||||||||||||||||||||||||
Location Based Operations |
|
The level of detail to log when an Agent acting upon a location (example: c:\private files\psswd\passwords.txt) such as scanning, remediation, etc.. If an error is thrown when trying to scan a specific file set one of the following log levels:
Note: Logging beyond the default level, especially the maximum level, may create very large log files and may contain sensitive information. |
-
Click Advanced Options to input more detailed options.
-
Expand the section for more information:
Local Logging - Advanced Options
Use the table below to help you fill in the Local Logging - Advanced Options screen:
Name | Options | Description |
---|---|---|
Auto Delete More Than Max Logs on Exit |
|
Keep only a specified number of endpoint service logs
|
Auto Delete More Than Max Logs On Exit Threshold |
|
The number of endpoint logs to retain.
|
Auto Delete Old Logs On Exit |
|
Automatically delete endpoint service logs older than a specified number of days.
|
Auto Delete Old Logs Threshold |
|
The number of days to retain endpoint service logs.
|
Last Log Name |
|
The name of the previous log file.
|
Log Path |
|
The path for saved log files.
|
Disable Delete Logs |
|
Disable the use of the Clear Logs buttons to delete existing logs.
|
Disable Reset Log Path |
|
Disable the use of the Use Default button to reset the log path.
|
Do Verbose Registry Logging |
|
Specify additional logging for the registry search.
|
-
Click Next to proceed, Previous to return to the previous screen, or Exit Without Saving
to discard. -
On the first Review Policy screen you can review policy settings for the below sections.
-
Click the pencil icon (
) to edit any of the sections:
-
Policy Setup Basics
-
Activity Monitor & File Watcher
-
Email Watcher
-
Proxy Policy
-
Agent Operations
-
Additional Settings
-
Advanced Options
-
-
Click Next to proceed, Previous to return to the previous screen, or Exit Without Saving
to discard. -
On the second Review Policy screen, you can review policy settings for the below sections.
-
Click the pencil icon (
) to edit any of the sections:
-
Policy Setup Basics
-
Agent Operations
-
Additional Settings
-
Local Reporting
-
Local Logging
-
-
Click Finish & Save to save the policy, Previous to return to the previous screen, or Exit Without Saving to discard.
Edit a Policy
To edit a Policy, do the following:
-
Click the Policy Configuration drop-down list, locate and click the policy you want to edit.
-
Click Edit this Policy.
-
Make needed changes to each section. See Add a New Policy for more information.
-
Policy Setup Basics
-
Agent Operations
-
Agent Operations - Advanced Options
-
Additional Settings
-
Additional Settings - Advanced Options
-
Local Reporting
-
Local Logging
-
Review Policy Settings 1
-
Review Policy Settings 2
-
-
Review the policy changes, and then click Save to save the changes or Exit Wizard to discard.
Delete a Policy
To delete a Policy, do the following:
-
Click the Policy Configuration drop-down list, locate and click the policy you want to delete.
-
Click Delete Policy.
-
On the Delete Policy pop-up window, click Confirm to delete the policy or else click Cancel.