Scan Options

When you set up a new scan, you are presented with a number of options to use to tailor your scan. This topic describes these scan options. You can also find this information in the tooltips for each setting within Spirion Sensitive Data Platform.

Overview

When you set up a new scan, you are presented with a number of Basic and Advanced options to use to tailor your scan.

The options vary by the type of Target you are scanning: Cloud, Local or Remote Files & Folders, Email, Collaboration Tools, or Website.

Several of the Target types share Basic and Advanced options.
This document also contains email-related options and discovery team settings.

Basic Options

Note: These settings are not available for Database Targets.

Basic options apply to the following Target types:

Cloud
Files & Folders (Local & Remote Scans)
Email
Collaboration Tools
Website

Additional Information

For information on the target type-specific options, see the individual Target type sections in How to Create a New Sensitive Data Scan.
The following Target types all have options specific to their type: Cloud, Files & Folders, Email, Collaboration Tools, and Website Target types all have options specific to their type.

Select Files by Extension

A list of extensions to include or exclude during the search.
Values are entered one per line as "ext;1" to specify that the extension "ext" should be enabled for the list
Enter file extensions in lowercase
File types to search:
- Common file
- - Microsoft Windows
  - - Only search Microsoft Office, Adobe Acrobat PDF, text, web, and other common formats.
    - File types include:
    - - .1st, .asm, .asp, .aspx, .btm, .c, .cc, .cpp, .cs, .css, .cxx, .def, .dic, .h, .hpp, .hxx, .idl, .idq, .inc, .inf, .ini, .inx, .java, .jsl, .log, .me, .rc, .reg, .rels, .snippet, .text, .txt, .url, .wtx, .xml, .xsl, .pdf, .edn, .fdf, .xdp, .xfd, .xfdf, .htm, .html, .rtf, .7z, .gz, .tar, .z, .rar, .bz, .bz2, .tgz, .tbz, .tbz2, .zip, .doc, .dot, .xls, .xla, .xlb, .xlc, .xld, .xlk, .xll, .xlm, .xlt, .xlv, .xlw, .dif, .slk, .ppt, .pot, .ppa, .pps, .pwz, .docx, .docm, .dotx, .dotm, .xlam, .xlsx, .xlsm, .xltm, .xltx, .pptm, .pptx, .potx, .potm
  - macOS
  - - Mac Agent uses Spotlight to detect how to process files
    - Common extensions include:
    - - Plugin name:/System/Library/Spotlight/PDF.mdimporter
      - Plugin key:PDF
      - UTIs:
      - com.adobe.pdf
      - Plugin name:/System/Library/Spotlight/RichText.mdimporter
      - Plugin key:RichText
      - UTIs:
      - public.rtf
        public.html public.xml
        public.plain-text
        com.apple.traditional-mac-plain-text
        com.apple.rtfd com.apple.webarchive
        org.oasis-open.opendocument.text
        public.comma-separated-values-text
        public.delimited-values-text
        public.comma-separated-values-text
        public.delimited-values-text
        public.text
        public.html
        public.xml
        public.plain-text
        com.apple.traditional-mac-plain-text
        org.oasis-open.opendocument.text
      - Plugin name:/System/Library/Spotlight/Office.mdimporter
      - Plugin key:Office
      - UTIs:
      - org.openxmlformats.wordprocessingml.document
        org.openxmlformats.wordprocessingml.template
        org.openxmlformats.wordprocessingml.document.macroenabled
        org.openxmlformats.wordprocessingml.template.macroenabled
        org.openxmlformats.spreadsheetml.sheet
        org.openxmlformats.spreadsheetml.template
        org.openxmlformats.spreadsheetml.sheet.macroenabled
        org.openxmlformats.spreadsheetml.template.macroenabled
        org.openxmlformats.presentationml.presentation
        org.openxmlformats.presentationml.template.macroenabled
        org.openxmlformats.presentationml.template
        org.openxmlformats.presentationml.presentation.macroenabled
        org.openxmlformats.presentationml.slideshow
        org.openxmlformats.presentationml.slideshow.macroenabled
        com.microsoft.powerpoint.ppt
        com.microsoft.powerpoint.pot
        com.microsoft.powerpoint.pps
        com.microsoft.excel.xls
        com.microsoft.excel.xlt
        com.microsoft.excel.xla
        com.microsoft.word.doc
        com.microsoft.word.dot
        com.microsoft.excel.openxml.addin
        com.microsoft.excel.openxml.template
        com.microsoft.excel.openxml.workbook
        com.microsoft.excel.openxml.template.macro-enabled
        com.microsoft.excel.openxml.workbook.binary
        com.microsoft.excel.openxml.workbook.macro-enabled
        com.microsoft.powerpoint.openxml.presentation
        com.microsoft.powerpoint.openxml.presentation.macro-enabled
        com.microsoft.powerpoint.openxml.slideshow
        com.microsoft.powerpoint.openxml.slideshow.macro-enabled
        com.microsoft.powerpoint.openxml.template
        com.microsoft.powerpoint.openxml.template.macro-enabled
        com.microsoft.word.openxml.document
        com.microsoft.word.openxml.document.macro-enabled
        com.microsoft.word.openxml.template.macro-enabled
        org.openxmlformats.presentationml.presentation.macroenabled
        org.openxmlformats.presentationml.slideshow
        org.openxmlformats.presentationml.slideshow.macroenabled
        org.openxmlformats.presentationml.template
        org.openxmlformats.presentationml.template.macroenabled
        org.openxmlformats.spreadsheetml.sheet
        org.openxmlformats.spreadsheetml.sheet.macroenabled
        org.openxmlformats.spreadsheetml.template.macroenabled
        org.openxmlformats.wordprocessingml.document
        org.openxmlformats.wordprocessingml.document.macroenabled
        org.openxmlformats.wordprocessingml.template
        org.openxmlformats.wordprocessingml.template.macroenabled
- All Filterable
- - In addition to Common and image files, also search files for which you have a Windows IFilter.
- Custom
- - Search the files with the extensions you choose.
- All
- - Search all extensions.
- Images (with OCR)
- - Only search image files such as JPG and GIF with Optical Character Recognition (OCR).

Note: "Images (with OCR)" is only available for the Windows endpoint and is a valid option only in a policy when the endpoint is licensed to and includes the OCR Image Search Module.

- - - If the OCR Image Search Module is not licensed or the OCR files are not present and "Images (with OCR)" is selected, the search defaults to "Common."
- All but common binary
- - Search all files except binary files such as EXE, DLL, or MP3.

File Extension List

A list of extensions to include during the search.
The values are entered one per line as ext;1 to specify that the extension "ext" should be enabled for the list.
Extensions should be entered in lowercase.
To make the list a list of excluded extensions check the box next to Extension list is exclude list.

Use Advanced File Identification

By default, the endpoint application uses file extensions to identity file types and select an appropriate filter.
To change that behavior and use advanced file type identification, set this value to something other than, "Disable" (0).
When enabled, the client will look at the header information of files (magic numbers) to determine their type.
While this method is more accurate, it will also cause a decrease in search speed due to the increased processing.
- Valid values:
- - 0: Disable - File extensions are used to determine file type
  - 1: E-Mail Attachment Compressed Files - Analysis is only performed on e-mail attachments to determine if they are renamed compressed files
  - 2: Included File Types - Analysis is performed on any file whose extension is included in the list of file types to search.
  - - The file is searched if its type in included in the list of file types to search.
  - 3: All Files - Analysis is performed on all files and any file whose type is included in the list of file types to search is searched

Analyze Files by

The type of analysis to perform when analyzing files.
Use this setting to enable or disable one or more of the analysis types when searching files.
"Analyze file content" is enabled by default and represents the behavior of search prior to version 8.0.
The analyze files options:
- Analyze File Content - Default search to look through all data within a file for sensitive data.
- Compare File Hash - Search for a representation of a file regardless of name or location.
  Note: It is not possible to get a file hash match on compressed files or access databases.
- Analyze File Name - Search for sensitive data within file names.
- Analyze File Metadata - Search for sensitive data within the metadata of Office and PDF files.

Advanced Options

NOTE: These settings are not available for Database Targets.

Advanced options apply to the following Target types:

Cloud
Files & Folders (Local & Remote Scans)
Email
Collaboration Tools
Website

Skip files as text free binary

This setting determines the identification method used to skip a file type.
By default, when advanced file identification is enabled via the setting Use Advanced File Identification and a file is determined to be a common binary file type, it is searched if the file type is included in the scope of files to search as determined by the setting File Type Search Option.
- For example, if the setting File Type Search Option is configured to search all files, the file is searched.
- To skip the file in this instance, set this value to "Skip" (1).
Note: The list of common text free binary file types is noted in the settings file located at: Locations\Files\FileExtensions\TextFreeBinaryFileExtensionExcludeList
This setting is supported by Windows Agents only

Disable max file size for Access Database files

This setting disables testing the size of Microsoft Access database files.
By default, all file types (other than PST E-Mail files and compressed archive files) are tested against the MaxFileSize setting to determine if they should be searched.
Because Access database files are not searched under the same memory requirements as other file types, large Access database files can be searched.
To ignore the MaxFileSize setting for Access database files, set this to "Do not test file size" (1)
This setting is supported by Windows Agents only

Set Max Memory File Size

This setting sets the maximum size of files that are stored in memory (in bytes).
Default: 32 MB
Because the value is specified in bytes, multiply the desired number of megabytes by 1048576 to determine the appropriate number of bytes.
- For example, the default value of 33554432 bytes is 32*1048576.
The maximum value for this setting is 134217728 which equals 128 MB
- A value greater than 128 MB can cause stability issues as the amount of memory that can be allocated to a process is controlled by windows.
- Spirion strongly recommends that this number be less than 134217728 (128 MB).
This setting is supported by Windows Agents only

Max File Size

This setting specifies the maximum file size to search (in bytes).
To search files greater than the default (32 MB), change this value.
Because the value is specified in bytes, multiply the desired number of megabytes by 1048576 to determine the appropriate number of bytes.
- For example, the default value of 33554432 bytes is 32*1048576.
The maximum value for this setting is 134217728 which equals 128 MB
- A value greater than 128 MB can cause stability issues as the amount of memory that can be allocated to a process is controlled by windows.
- Spirion strongly recommends that this value be less than 134217728 (128 MB).
This setting is supported by Windows Agents only

Enable Max Compressed File Size

This setting specifies the maximum size of compressed files to search (in bytes).
By default, any searchable file is extracted from compressed files regardless of the size of the archive itself.
To skip the processing of archives larger than a specified size, set this value to a number greater than 0.
This value is only read when the setting Enable Max Compressed File Size is set to "Enable" (1).
Because the value is specified in bytes, multiply the desired number of megabytes by 1048576 to determine the appropriate number of bytes
This setting is supported by Windows Agents only

Enable Scan Byte Limit

This setting controls whether to enforce a size limit on each file scanned (in bytes)
By default, the endpoint application searches each file in its entirety.
To search only the first specified number of kilobytes in each file, set this value to "Enable" (1) and set the value of Search Byte Limit to a number greater than 0.

OCR

Enable OCR for Files

Search supported file types via OCR.
By default, when OCR is licensed, the supported file types are searched via the OCR module.
To disable searching with OCR, set this to "Do not search" (0).
This setting is supported by Windows Agents only

Decomposition Mode

The method used to perform page analysis.
Different methods/algorithms can be used to analyze the page before performing the OCR.
By default, the method is selected automatically, but if the default setting is not producing acceptable output at an acceptable speed, a specific method can be forced.
Valid options are:
- Auto (0):
- - The engine automatically determines the algorithm to use.
  - This is the default setting and produces the best output for the widest array of images and image types.
- Legacy (1):
- - The engine uses simple page decomposition which generally executes faster than standard but does not produce as accurate results.
- Standard (2):
- - The engine uses standard page decomposition which generally produces better results than legacy but may execute slower.
- Fast (3):
- - The engine uses fast page decomposition which generally executes the fastest of the methods
  - Produces the least accurate results unless the images are very simple representations of text.
  - Performs the least amount of page analysis
  - Does not work well for forms, tables, differing font sizes, and so on
This setting is supported by Windows Agents only

Deskew

Automatically align skewed text.
By default, if an image appears to be skewed or angled, an attempt is made to straighten the image to improve the likelihood of obtaining accurate text.
To disable deskewing (which will increase speed if it is known that no images are skewed), set this to "Off" (0).
This setting is supported by Windows Agents only

Despeckle

Enhance image quality to reduce pixel artifacts.
It may be possible to improve the accuracy of text extracted from certain images by first attempting to remove information that does not appear to be part of a valid character.
This setting specifies whether the adaptive noise removal algorithm will be activated for black and white images with a resolution of 280 DPI or higher.
This setting might influence the recognition accuracy.
To enable despeckling, set this to "On" (1).

Document Type

The type of text included in the Target locations.
Machine Text - By default, the OCR module recognizes machine generated text and does not recognize handwritten characters.
Handwritten Characters - If the desired data is known to be comprised of only handwritten characters, set this to "Handwritten Characters" (2).
Both Machine Text and Handwritten Characters - If is it necessary to identify both machine text and handwritten characters, set this to "Both Machine Text and Handwritten Characters" (3).
Note: If the input text type is known, it is more efficient to specify Machine Text or Handwritten Characters, as appropriate.
This setting is supported by Windows Agents only

Scan Only This Page

Search all pages or only search the specified page number.
By default, all pages of an image are processed with OCR.
In some cases, it may be desirable to only search a specific page such as the first or second page.
To only search a specific page for all files processed via OCR, set this value to a number greater than 0.
This setting is supported by Windows Agents only

OCR PDFs

The method to use for searching PDF files when OCR is enabled.
The OCR PDFs setting (often labeled as "Search Image-only PDFs" or similar in the Console) determines whether the Spirion agent should treat PDF files as images when they do not contain a selectable text layer.
This setting performs the following functions:

- Extracts Hidden Data: Enables the agent to discover sensitive information (like SSNs, birthdates, or Student IDs) that is "trapped" inside scanned images within a PDF wrapper.
- Triggers High-Resource Processing: Because OCR is computationally expensive, enabling this setting tells the agent to use more CPU and memory to perform the pixel-to-text conversion.
- Applies OCR Cleanup: Once enabled, the agent applies other OCR-related settings (like the Unknown Character Replacement and Additional Languages we discussed earlier) to the text it extracts from the PDF.

Performance Impact: This is one of the most resource-intensive settings in Spirion. If you enable it, expect your scan times to increase significantly, especially if the target contains many large, scanned PDF files.
"Image-Only" vs. "All" PDFs:
- Some versions allow you to OCR only image-only PDFs (saving time on PDFs that already have text).
- Other configurations allow you to OCR every PDF. This is more thorough (in case the text layer is corrupt or incomplete) but much slower.
Platform Support: While the Windows agent has robust, built-in OCR capabilities for PDFs, the Mac and Linux agents have different dependencies for OCR. Always verify your specific agent version's requirements (some may require a separate OCR license or component).
Summary for your FERPA Playbook: If your FERPA data includes scanned student records or historical transcripts saved as PDFs, OCR PDFs must be enabled, or those files will be completely skipped by your sensitive data definitions.

By default, an attempt is made to extract readable text from a PDF file. If there are both text and images in the PDF, only the text or the images are searched, based on the method selected:

Text only - To prevent OCR from being used when there is no text, set this to value to "Text only" (0).
OCR when no text - If there is no readable text, OCR is used to attempt to identify text.
OCR Always - To always use OCR and not attempt to extract readable text, set this value to "OCR Always" (2).
This setting is supported by Windows Agents only

Fax Correction

Enhance scanned faxes.
Most OCR engines are optimized to recognize dark text on a light background (example: black ink on white paper). The Invert setting instructs the Spirion agent to "flip" the color values of an image or PDF page before the OCR engine analyzes it.
- Original: White text on a black or dark blue background.
- Inverted: Black text on a white or light background.
The Invert setting is a specialized image pre-processing tool used during Optical Character Recognition (OCR) to improve the detection of sensitive data in documents with non-standard styling.
This setting performs the following functions:
- Improves Recognition of "Reverse" Text: In many industries, specific documents use inverted styles for headers, highlighted sections, or specialized forms. For example:
- - Blueprints or Technical Schematics: Often feature white text on dark backgrounds.
  - Web-captured Screenshots: If a user uses "Dark Mode," text that appears sensitive may be white-on-black.
  - Government/University Forms: Some older or stylized forms use dark header blocks with white lettering for field labels (e.g., "STUDENT NAME").
- Reduces OCR Failure: Without Invert, the OCR engine may see a dark block with white text as a solid "blob" or a graphical element, completely skipping any sensitive data contained within it.
Best Practice Recommendation:
- Selective Use: Do not enable Invert globally for every scan unless you know your data contains many "dark mode" or scanned negative documents. Inverting a standard black-on-white document makes it white-on-black, which will actually prevent the OCR engine from reading it correctly.
- Performance: Like all OCR settings, Invert adds a small amount of processing time as the agent must manipulate the image in memory before scanning.
Check the checkbox to enable fax correction - When fax correction is enabled, the resolution of black and white images with an approximate resolution of 200 x 100 DPI is doubled in the 'y' direction (vertically) in an attempt to improve character recognition.
This setting is supported by Windows Agents only

Invert

Swap black and white pixels before performing OCR.
When enabled, black and white images are inverted from black on white to white on black.
In some cases, this can improve the recognition.
Check this checkbox to enable inversion.
This setting is supported by Windows Agents only

Recognition Mode

The method to use for character recognition.
When performing character recognition, there is a trade-off between speed and accuracy.
- Favor accuracy - Default. By default, accuracy is favored over speed.
- Favor speed - Favor speed over accuracy.
This setting is supported by Windows Agents only

Resolution Enhancement

Enhance resolution when recognizing color images.
When enabled, the resolution enhancement algorithm results in an image whose resolution is higher than the resolution of the original image.
This is done on the basis of information taken from the extra pixel depth in the grayscale and color images and may impact recognition accuracy.
Enable (1) - Enables resolution enhancement.
Note: This setting only applies to non-black and white and non-palette color images.
This setting is supported by Windows Agents only

Rotation

Rotate images before performing OCR.
By default, an attempt will be made to determine if an image is rotated 90, 180, or 270 degrees before recognition.
To disable automatic rotation (which will increase speed if it is known that all text is "right-side-up"), set this to "Off" (0).
This setting is supported by Windows Agents only

Unknown Character Replacement

The character to use when a character is not recognized.
When the Spirion engine performs OCR on an image (like a scanned PDF, a JPG of a Driver's License, or a fax), it attempts to identify every character in the image. If the engine encounters a character it cannot confidently identify due to low image quality, pixel artifacts, or unusual fonts, it must still place a "placeholder" in the resulting text string so that the search patterns (AnyFinds/Regular Expressions) can continue to evaluate the surrounding data.

Common Use Cases

Driver's License / ID Scans: As noted in internal guides for searching Driver's Licenses, this character ensures that even if a single letter in a name or ID number is blurry, the rest of the record is extracted and indexed.
Legacy UTF-8 Handling: Historically, in some older agent versions, characters outside the standard ASCII range in UTF-8 files were sometimes replaced with spaces (as noted in engineering tickets like AL-22825) if a proper parser wasn't available. The replacement setting helps standardize what that "fallback" character is.
Fax and Low-Res Documents: It is often paired with other OCR enhancements like Deskew (straightening), Despeckle (removing noise), and Invert (swapping black/white) to improve overall recognition.

The values that correspond to the settings in the endpoint UI are:

No Character - By default, no character is displayed.
Space - Enter a space character to see which characters were not recognized.
- (dash) - Enter a dash character to see which characters were not recognized.
~ (tilde) - Enter a tilde character to see which characters were not recognized.
Other characters may be specified - A space or question mark are commonly used and recommended by archTIS.
- Most administrators set this to a space or a question mark. These are the safest characters.
- A space is often best because many Spirion patterns are already designed to handle or ignore whitespace between characters.
- Using a unique character like a question mark (?) can be helpful when reviewing logs or "Match Context" in the console, as it makes it immediately obvious that the OCR engine struggled with that specific part of the document.
This setting is supported by Windows Agents only

Important Notes

Don't Use Numbers or Letters: Never use 0, X, or * as replacement characters, as these are frequently used in actual sensitive data (e.g., "X" in redacted IDs or "0" in account numbers), which will spike your false positive rate.
Pair with "Max Substitutions": If your custom data type allows it, limit how many "unknowns" are acceptable in a single string. Allowing 1 unknown character in a 10-digit ID is usually safe; allowing 5 would lead to massive inaccuracy.

Additional Languages

The Additional Languages setting dictates which character sets and linguistic dictionaries the OCR engine uses to interpret text from images and PDFs.
When Spirion performs OCR, it doesn't just look for shapes; it uses "language packs" to increase the probability of a correct match.
- For example, if the engine sees a shape that could be an "n" or an "ñ," selecting Spanish as an additional language tells the engine that "ñ" is a valid and likely character, whereas in an English-only scan, it might be misinterpreted as a pixel artifact or a standard "n."
Enables Non-English Character Recognition: It enables the engine to recognize accented characters, umlauts, cedillas, and other diacritics specific to languages like French, German, Spanish, and others.
Improves Dictionary Validation: The OCR engine uses these languages to "guess" words more accurately. If a word is partially blurry, the engine compares it against the dictionaries of the selected languages to find the most likely match.
Expands Search Scope: By default, many Spirion versions are optimized for English. Adding languages ensures that sensitive data embedded in foreign language documents (example: a French "Numéro de Sécurité Sociale") is extracted correctly for the search engine to evaluate.
By default, only English characters are recognized when performing a search with OCR.
To recognize characters from additional languages, select each desired language.
- Spanish
- French
- German
Note: Each additional language has an impact on the performance of the recognition and therefore languages that are known not to be present in the target locations should not be enabled.
This setting is supported by Windows Agents only

Impact on Performance and Accuracy

Accuracy (Recall): Increases. It significantly reduces the number of "unknown characters" (the ? placeholders mentioned previously) in non-English documents, making it more likely that sensitive data will be found.
Scan Speed: Decreases. Adding more languages requires the OCR engine to perform more "checks" against more dictionaries for every single image processed.
Best Practice: Only enable the specific languages you expect to find in your environment. Do not select "All Languages" unless necessary, as it can substantially slow down your scan window.
OCR Compensation: This setting often works in tandem with OCR Compensation logic, which handles common misinterpretations (like "8" vs "B") across the character sets of the selected languages.

Higher Education Environments

If you are an organization with international operations or a university (handling FERPA data for international students), you should ensure the languages relevant to those students' primary documents are enabled to ensure high-fidelity data extraction.

SharePoint On-Premise/Online Options

Use the following steps to complete the settings on both the "Select SharePoint options" and "Select advanced SharePoint options" pages.

Under "Search this SharePoint Site Content" select the types to search within SharePoint sites.
Specify the search types to include when searching SharePoint sites.
- By default, all file types in the SharePoint document library are searched.
- Alternately, searches can be enabled for tasks, calendar events, or contacts that have been synchronized with Outlook or input into SharePoint.

When using this setting outside of the console, note that the value for this setting is a bitmask of the logical OR of any of these values.

When created in the Windows Registry, they are of type REG_DWORD.
When entered into the Windows Registry or a configuration XML file, they should be entered as hexadecimal values.
When entered into a security template (.inf) file, they should be entered in decimal.

Name	Value	Default
Documents/Files	0x00000001	On
Tasks	0x00000002	Off
Calendar	0x00000004	Off
Contacts	0x00000008	Off
Item	0x00000010	Off

On the Select advanced SharePoint options, select the settings to use.

SSL Settings

The SSL settings to use when searching SharePoint sites.

Ignore untrusted root: Continue searching if the root certificate of the SSL chain is not currently in the trust store.
Ignore invalid date: Continue searching if the SSL certificate for the URL has an invalid or expired date.
Ignore mismatched CN: Continue searching if the domain name on the SSL certificate does not match the URL configuration.
Ignore incorrect usage: Continue searching if the SSL certificate is intended for a purpose other than verifying the identity of the sender and encrypting server communications.

When using this setting outside of the console, note that the value for this setting is a bitmask of the logical OR of any of these values.

When created in the Windows Registry, they are of type REG_DWORD.
When entered into the Windows Registry or a configuration XML file, they should be entered as hexadecimal values.
When entered into a security template (.inf) file, they should be entered in decimal.

Name	Value	Default
Ignore untrusted root	0x00000001	False
Ignore invalid date	0x00000002	False
Ignore mismatched CN	0x00000004	False

Subsite Search Depth

This setting controls the number of subsites from a specified SharePoint site to search.

By default, SharePoint subsites are not searched.
To search subsites, specify the depth to traverse.
- For example, when set to 1, only subsites directly below the site specified in the search is searched.
If the value is 3, subsites that are subsites of subsites of a site specified in the search is searched.

Note: Subsites are treated as though they were explicitly specified in the SharePoint search configuration.

Subsites are searched after completing the search of the parent site.

SQL Advanced Options

The SQL advanced options page appears only for the following SQL database Targets:

Microsoft SQL Server
SQLBase
SAP SQL Anywhere
MySQL
SQLite

Include Primary Key Data

If a database includes a Primary Key column, it is possible to return the data in the cell of the Primary Key column for the row in which a result was found.
The data will be displayed in the Preview window along with the list of columns in which the result was found.
Do not include Primary Key data - Include the data from the cell of the Primary Key column for the row in which a result was found.
Include Primary Key data - Include the data from the cell of the Primary Key column for the row in which a result was found.

Set Non-Matching cells limit

When searching structured data (files or databases searched via a connection string), the endpoint application looks within a column for data that matches the specified data type.

After a specified number of cells in that column are searched without finding any matches, the search will move on to the next column.
The counter is started at the first row and continues until the limit is hit or a match is found.
If a match is found, all subsequent rows in that column will be searched.
To disable this limit and search all cells, use a value of 0.

Exclude Column Types

Specify which column types are excluded when searching databases.
When using this setting outside of the console, note that the value for this setting is a bitmask of the logical OR of any of these values.
When created in the Windows Registry, they are of type REG_DWORD.
When entered into the Windows Registry or a configuration XML file, they should be entered as hexadecimal values.
When entered into a security template (.inf) file, they should be entered in decimal.

Log Level

When searching databases via the Database Search Module, it is desirable to see detailed logging information during configuration or troubleshooting.

The logging specified via this setting only applies when logging has been enabled and only specific log entries are displayed if their corresponding log type has been enabled (for example, Info, Error)

The following log levels are available:

Default logging: Standard logging. Includes basic information such as the name of the table being searched and errors.
Additional logging: Standard logging plus information about the status of the search for the current row.
Comprehensive logging: Additional logging plus details about each table, column and row.
Debug logging: Comprehensive logging plus the actual cell data for each cell searched.
Full logging: Data from the database is written in clear text to the client log file.

Note: Data from the database is written in clear text to the client log file.

Note: Logging beyond the default level, especially the maximum level, creates very large log files and may contain sensitive information.

Row Count Start - Logging

When the setting Settings\Locations\ Databases\LogLevel is set to 1, it is possible to specify a row at which additional, detailed column information can be logged.

To enable this logging, specify the row number at which to start
This setting should be set only after consulting with the Support Team

Row Count Start

The row number at which to start detailed column logging:

When Log Level (Settings\Locations\Databases \LogLevel) is set to 1, it is possible to specify a row at which additional, detailed column information can be logged.
To enable this logging, specify the row number at which to start.
This setting should only be set after consulting with the Support Team.

Row Count Stop

By default, all rows in a Target database is searched.
To specify the maximum number of rows to search in each table, set this to a value greater than 0.
Once that number of rows have been searched, the search of that table is stopped and searching resumes with the next appropriate table.

Scan Column Names

By default, the column names listed in the field "Column Names to Include/Exclude" must match exactly to be included or excluded from the search.

Allow partial match - Enable partial name matching - for example, allow the value "zip" (when specified in "Column Names to Include/Exclude") to match the column "ZipCodes"
Require exact match - Default. If selected, the scanned column names must match exactly those specified in "Column Names to Include/Exclude".