Product Documentation
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage
  1. Product Documentation
  2. /
  3. Assessment
  4. /
  5. Search Guide
  6. /
  7. Field Search

Field Search

Meta Field Properties

When performing a field name search, enter Meta Field Properties text with search terms and different operators as needed into the search bar.

You can specify field names using the following query syntax guide. Please note that the Meta Field Properties text is case-sensitive:

Description Meta Field Properties (Releases >3.0) Type of Field Normalizer Examples
Alt Workflow Tags meta.alt_workflow Keyword Lowercase meta.alt_workflow:<user-created-tags>
Archival Created Date/Time meta.archive_created_datetime Date meta.archive_created_datetime:<date>
meta.archive_created_datetime:"2001-01-30"
Archival Modified Date/Time meta.archive_modified_datetime Date meta.archive_modified_datetime:<date>
meta.archive_modified_datetime:"2001-01-30"
Audio Duration meta.audio_video_length Long meta.audio_video_length:<value in seconds>
meta.audio_video_length:>30.0
Auto-detected PII pii.[element search name] pii.<element search name>:<detected element>
pii.name:"Jane Doe"
Batch Set Name batching.batchset_name Keyword batching.batchset_name:<batch set name>
batching.batchset_name:"batch A"
Custodian meta.custodian Keyword Lowercase meta.custodian:<custodian name>
meta.custodian:"Jane Doe"
Custom Detection Rules meta.custom_tags Keyword Lowercase meta.custom_tags:<custom detection tags>
Decrypted File meta.is_password_protected Boolean meta.is_password_protected:1 or meta.is_password_protected:True
meta.is_password_protected:0 or meta.is_password_protected:False
Document ID meta.search_id
search_id
id		 Keyword Lowercase id:2FG2G55FGF
id:(2FG2G55FGF 2FG2G55CGF 3FG2G55FGF)
Document Page Count page_count Long page_count:<number>
page_count:1
Email Attachment has_attachment Boolean has_attachment:1 or has_attachment:True
has_attachment:0 or has_attachment:False
Email BCC meta.eml_bcc_displayname Keyword Lowercase meta.eml_bcc_displayname:<email>
Email CC meta.eml_cc_displayname Keyword Lowercase meta.eml_cc_displayname:<email>
Email Created Date/Time meta.eml_created_datetime Date meta.eml_created_datetime:<date>
Email From meta.eml_from
meta.eml_from_displayname
from		 Keyword Lowercase meta.eml_from:<name or domain>
meta.eml_from:johndoe or from:johndoe
meta.eml_from:.gmail.com or from:.gmail.com
Email Modified Date/Time meta.eml_last_modified_datetime Date meta.eml_last_modified_datetime:<date>
Email Provider Send Date/Time meta.eml_provider_submit_datetime Date meta.eml_provider_submit_datetime:<date>
Email Received Date/Time meta.eml_message_delivery_datetime Date meta.eml_message_delivery_datetime:<date>
meta.eml_message_delivery_datetime:"2001-01-30 00:00:00.000"
Email Recipient Number meta.eml_all_recipients_nos Long Lowercase meta.eml_all_recipients_nos:<number>
Email Report Date/Time meta.eml_report_datetime Date meta.eml_report_datetime:<date>
meta.eml_report_datetime:"2010-01-30"
Email Send Date/Time meta.eml_client_submit_datetime Date meta.eml_client_submit_datetime:<date>
meta.eml_client_submit_datetime:"2010-01-30"
Email Sender/Recipient Domain eml_domains_from
eml_domains_to		 Keyword Lowercase eml_domains_from:<email domain>
eml_domains_from:"gmail.com"
eml_domains_to:"gmail.com"
Email To meta.eml_to
meta.eml_to_displayname
to		 Keyword Lowercase meta.eml_to:<name or domain>
meta.eml_to:johndoe or to:johndoe
meta.eml_to:.gmail.com or to:.gmail.com
File Created Date/Time meta.metadata_created_datetime Date meta.metadata_created_datetime:<date>
File Extension meta.extension
filetype		 Keyword Lowercase filetype:.doc or meta.extension:.doc
filetype:.pdf or meta.extension:.pdf
File Modified Date/Time meta.metadata_modified_datetime Date meta.metadata_modified_datetime:<date>
File Size meta.size
size		 Long meta.size:<size in bytes> or size:<size in bytes>
meta.size:>1000 or size:>1000
Folder Path meta.full_name Keyword Lowercase meta.full_name:<searchwithwildcard?*>
Image Classification image_classification.image_class Keyword Lowercase image_classification.image_class:<image class>
Image Dimension (in pixels) meta.dimension.height
meta.dimension.width		 Long meta.dimension.height:<size in pixels> or meta.dimension.width:<size in pixels>
meta.dimension.width:>1000 or meta.dimension.height:>1000
Language meta.language Keyword meta.language:<language name>
meta.language:french
Language Confidence (in %) meta.language_confidence_level Long meta.language_confidence_level:<number 1-100>
meta.language_confidence_level:>80
MD5 Hash meta.md5 Keyword meta.md5:<hash value>
Master Created Date/Time meta.master_created_datetime Date meta.master_created_datetime:<date>
Master Created Date/Time Source Field meta.master_created_datetime_source_field Keyword Lowercase meta.master_created_datetime_source_field:<string>
Master Created Date/Time Source Search ID meta.master_created_datetime_source_document_id Keyword Lowercase meta.master_created_datetime_source_document_id:<id>
Master Modified Date/Time meta.master_modified_datetime Date meta.master_modified_datetime:<date>
Master Modified Date/Time Source Field meta.master_modified_datetime_source_field Keyword Lowercase meta.master_modified_datetime_source_field:<date>
Master Modified Date/Time Source Search ID meta.master_modified_datetime_source_document_id Keyword Lowercase meta.master_modified_datetime_source_document_id:<id>
Name meta.short_name
display_name		 Text meta.short_name:<file name or email subject> or display_name:<file name or email subject>
meta.short_name:Acadia* or display_name:Acadia*
OCR-Performed meta.ocr_performed Boolean meta.ocr_performed:true
meta.ocr_performed:false
PII Count By Element meta.pii_count.[element search name] Long meta.pii_count.<element search name>:<number>
meta.pii_count.aba:[100 TO 1000]
meta.pii_count.austria passport:[100 TO 1000]
PII Elements meta.tags
piitag		 Keyword Lowercase piitag:<pii element search name> or meta.tag:<pii element search name>
QA Batch Name N/A N/A
QA Change Reason N/A N/A
QA Created Date meta.batching.create_datetime Date meta.batching.create_datetime:<date>
QA Reviewer N/A N/A
QA Reviewer Email ID N/A N/A
QA Status N/A N/A
Reviewer N/A N/A
Reviewer Batch Name N/A N/A
Reviewer Email ID N/A N/A
SHA1 Hash N/A N/A
SHA256 Hash meta.sha256 Keyword meta.sha256:<hash value>
Source meta.source_path Keyword Lowercase meta.source_path:<your file with wildcards?*>
Tags meta.manual_tags
tag		 Keyword Lowercase tag:<user-created-tag> or meta.manual_tags:<user-create-tag>
tag:qa or meta.manual_tags:qa
Text Length (in number of characters) meta.length Long meta.length:<number>
meta.length:130
Total PII Count (number of PIIs in a document) meta.pii_total Long meta.pii_total:<number>
meta.pii_total:3
Uploaded Date/Time uploaded_datetime Date uploaded_datetime:<date>
uploaded_datetime:"2020-01-30 00:00:00.000"

Canopy Version < 3.0 vs > 3.0

In Version 3.0, Canopy integrates Elasticsearch (ES) version 8.0 into the application. This upgrade significantly improves search functionality within the Canopy application and provides a more robust user experience compared to the previous ES.

Elasticsearch does not exhibit backward compatibility. As a result, the Field Search feature in Canopy Version 3.0 and beyond will differ from that in earlier versions.

The following table compares the Field Search functionality in Version 3.0 and later with that in earlier versions, for those who may still be using the previous version of Canopy.

Column Name RegEx Shortcut Search Field (Releases >3.0) Search Field (Releases <3.0)
Alt Workflow Tags Yes meta.alt_workflow meta.workflow
Archival Created Date/Time meta.archive_created_datetime meta.archive_created_datetime
Archival Modified Date/Time meta.archive_modified_datetime meta.archive_modified_datetime
Audio Duration meta.audio_video_length meta.Audio_video_Length
Batch Set Name batching.batchset_name
Confirmed Entities Not Searchable
Custodian Yes meta.custodian custodian
Custom Detection Rules Yes meta.custom_tags meta.custom_tags
Decrypted File meta.is_password_protected meta.Is_password_protected
Document ID Yes id meta.search_id search_id
Document Page Count page_count
Email Attachment has_attachment is_Attachment
Email BCC Yes meta.eml_bcc_displayname meta.eml_Bcc_DisplayName
Email CC Yes meta.eml_cc_displayname meta.eml_Cc_DisplayName
Email Classification Yes N/A meta.eml_clsf_type
Email Created Date/Time meta.eml_created_datetime meta.eml_CreationTime
Email From Yes from meta.eml_from
meta.eml_from_displayname		 from
Email Modified Date/Time meta.eml_last_modified_datetime meta.eml_LastModificationTime
Email Provider Send Date/Time meta.eml_provider_submit_datetime meta.eml_ProviderSubmitTime
Email Received Date/Time meta.eml_message_delivery_datetime meta.eml_MessageDeliveryTime
Email Recipient Number meta.eml_all_recipients_nos meta.eml_AllRecipientsNos
Email Report Date/Time meta.eml_report_datetime meta.eml_ReportTime
Email Send Date/Time meta.eml_client_submit_datetime meta.eml_ClientSubmitTime
Email Sender/Recipient Domain eml_domains_from
eml_domains_to
Email To Yes to meta.eml_to
meta.eml_to_displayname		 to
File Created Date/Time meta.metadata_created_datetime meta.metadata_created_datetime
File Extension Yes filetype meta.extension filetype
File Modified Date/Time meta.metadata_modified_datetime meta.metadata_modified_datetime
File Size size meta.size size
Folder Path meta.full_name meta.full_name
Image Classification Yes image_classification.image_class img_clsf_filter
Image Dimension meta.dimension.height
meta.dimension.width
Language Yes meta.language Language
Language Confidence meta.language_confidence_level Language_confidence_level
MD5 Hash Yes meta.md5 md5
Master Created Date/Time meta.master_created_datetime meta.master_created_datetime
Master Created Date/Time Source Field meta.master_created_datetime_source_field meta.master_created_datetime_source_field
Master Created Date/Time Source Search ID meta.master_created_datetime_source_document_id meta.master_created_datetime_source_document_id
Master Modified Date/Time meta.master_modified_datetime meta.master_last_modified_datetime
Master Modified Date/Time Source Field meta.master_modified_datetime_source_field meta.master_modified_datetime_source_field
Master Modified Date/Time Source Search ID meta.master_modified_datetime_source_document_id meta.master_modified_datetime_source_document_id
Name Yes filename meta.short_name meta.short_name
OCR-Performed meta.ocr_performed
PII Count By Element meta.pii_count.[element search name] meta.pii_density.[element search name]
PII Elements Yes piitag meta.tags meta.tags
QA Batch Name N/A N/A
QA Change Reason N/A N/A
QA Created Date meta.batching.create_datetime
QA Reviewer N/A N/A
QA Reviewer Email ID N/A N/A
QA Status N/A N/A
Reviewer N/A reviewer
Reviewer Batch Name N/A N/A
Reviewer Email ID N/A N/A
SHA1 Hash Yes N/A sha1
SHA256 Hash Yes meta.sha256 sha256
Source Yes meta.source_path meta.sourcepath
Suggested Entities Yes suggestedType
Tags Yes tag meta.manual_tags tag
Text Length meta.length content.length
Total PII Count meta.pii_total meta.total_pii
Uploaded Date/Time uploaded_datetime uploaded_datetime