File Search web app reference

Overview

The File Search web app allows authorized individuals to search users' backed up files. This article provides reference information for the File Search web app.

To use the File Search web app, an administrator must:

File Search web app

To access the File Search web app:

Version 6.5 and later

Select Search > File Search in the left menu.

Version 6.0.x and earlier

Select Settings > Indexing in the left menu.

File Search

Item		Description
a	Search type	Specifies the type of search to perform: File Contents: Finds files that contain text that matches the search query. File Hash: Finds files that have an MD5 hash that matches the search query. File Name: Finds files that contain the search query in their filename or file path.
b	Search query	Specifies the search term(s) to look for. When your Search type (item a) is set to File Contents or File Name, enter a search query. When your Search type (item a) is set to File Hash, enter an MD5 hash. At least one search term is required to run a search query.
c	Source type	Defines the scope to search: User: Allows you to search a specific user's backed up files. Device GUID: Allows you to search the files backed up from a specific device. Plan UID: Deprecated - no effect. Archive GUID: Allows you to search the files in a specific archive.
d	Source	Identifies the specific object to search based on the selected Search type (item a). A source is required to run a search query.
e	Search	Runs your search query.
f	Export	Runs your search query and exports the results to a CSV file.
g	Add Filter	Adds a filter to refine the results. Available filter types: Archive: Limits the results to files contained by the specified archive GUID. Date Modified: Limits the results to files modified before, after, between, or on the specified date(s); or files modified in the last specified number of minutes, hours, days, or months. Deleted: Limits the results based on file deletion status and/or deletion time. Device: Limits the results to files backed up from the specified device globally unique identifier (GUID). File Extension: Limits the results to files that have the specified file extension. File Hash: Limits the results to files that match the specified MD5 hash. Filename: Limits the results to files that match the specified filename. Path: Limits the results to files that contain the specified text in their path. File type: Limits the results to files that are the specified MIME type.
h	Results	Displays the results for your search query. The following information is displayed for each matching file: Filename: The name of the file. Location: The path to the folder that contains the file on the device that backed it up. Date Modified: The date and time at which the file was last modified. Archive GUID: The GUID of the archive that contains the file. Click a file to view more details or download a copy of the file.
i	Table Configuration Options	Opens Table Configuration Options. Select an option to display that content in the results.

Table configuration options

Item	Description
Filename	Name of the file.
Location	Path to the file on the source device.
Date Modified	Date and time when the file was last modified.
Last Backup Date	Date and time when the file was last copied to the backup archive.
File Type	MIME content type. Indicates the type of data within the file.
Extension	File extension.
Archive GUID	Globally unique identifier for the archive in which the file is contained.
Plan UID	Deprecated - no effect.
User UID	Globally unique identifier for the user associated with the file.
File ID	Globally unique identifier for the file.
Version UID	Globally unique identifier for the version of the file.
Device GUID	Globally unique identifier for the device associated with the file.
Checksum (MD5)	MD5 hash for the file.
Deleted?	Indicates if that version of the file has been deleted form the device associated with the file. True: Deleted False: Not deleted
Latest?	Indicates if the file has been updated. True: This is the latest version of the file, and it has not been updated. False: This is not the latest version of the file. An updated version of the file exists.

File details

The file details appear when you click a file in the search results.

Item		Description
a	File name	Name of the file.
b	Close	Closes the file details.
c	File type	MIME file type.
d	File details menu	Opens file details menu.
e	File extension	Extension of the file.
f	Path	Path to the file on the source device.
g	File size	Size of the file.
h	Last modified on	Date at which the file was last modified.
i	MD5	Hash of the file: Files backed up from the Code42 app have an MD5 hash. Files backed up from cloud services have an MD5 hash.
j	Archive ID	Globally unique identifier (GUID) of the archive containing the file.
k	Device Name	Name of the source device.
l	Device GUID	The globally unique identifier (GUID) of the source device.
m	Owned by	Username of the user who backed up the file.

File details menu

Item		Description
a	Find all copies of this file	Searches the archive associated with the file for other files that match the MD5 hash.
b	Download file	Downloads the file to your device.

Basic query syntax

File contents

From the Search for menu, select the search type File Contents. Provide a search query in one of the following forms:

Query Form	Example Query	Finds Files That Contain
Single terms	`financial`	the word financial
Multiple terms	`financial results`	either financial or results or both, in any order, with anything in-between
Phrases, precise literal strings	`"financial results"`	both words, one after the other, in the order specified
OR	`financial OR results`	either financial or results or both, in any order, with anything in-between
AND	`financial AND results`	both financial and results, in any order, with anything in-between
NOT	`financial NOT results`	the word financial but not the word results
Wild cards: one or more question marks ( ? ) to match any one character	`financia?` `?inancial` `fin?ncial` `fin?ncia?`	the word financial
Wild cards: one or more asterisks ( * ) to match any string of characters, including no characters	`fanc`	the words financial, financier, freelance, fancy
Wild cards: any combination of * and ?	`?in*nci?l`	the word financial

Tips for searching file contents

Do not use wild cards in quotes: A quoted query strings indicate a precise, literal search. In a search for "financia?" or "fin*" the question mark and asterisk are not wild cards. Those searches will not find files that contain financial.
Query whole words: Searches of file contents look at whole words only.
A search for fin, in*, or financi? will not find files that contain financial.

File hash

From the Search for menu, select the search type File Hash.
For the search query, provide a complete, valid MD5 checksum. Do not use wild cards ( * ? ) or boolean operators (and, or, not)

File name

From the Search for menu, select the search type File Name. Provide a search query that is one or more parts of a file name, separated by spaces. The search will find any file name that contains the parts you write in the order you write them. Do not use wild cards ( * ? ) or boolean operators (and, or, not).

Query Form	Example Query	Finds Files Named
Complete name, no spaces	`fishpond.txt`	fishpond.txt
Any one part of name	`fish`	fishpond.txt, goldfish.jpg, fish care.docx
Any two or more parts of name	`fish txt`	fishpond.txt
Quote marks are ignored.	`"fish txt"`	fishpond.txt
A single asterisk ( * )	`*`	all file names

Filters: Archive, date modified, deleted, device, file extension, file hash

From the Add Filter menu, select Archive, Date Modified, Deleted, Device, File Extension, or File Hash.

For the search query, provide a compete, valid value. Do not use spaces ( ), wild cards ( * ? ), quotation marks ( " " ), or boolean operators (and, or, not).
When you select Date Modified or Deleted, the Code42 server will prompt for values in the correct form.

Filters: Filename, path, file type

From the Add Filter menu, select Filename, Path, or File type. For the search query, provide all or part of a name, path, or type. Do not use spaces ( ), wild cards ( * ? ), quotation marks ( " " ), or boolean operators (and, or, not).

Filter	Example	Finds Files
Filename	`fish`	Named fishpond.txt, goldfish.jpg, fish care.docx
Path	`pet`	In folders named petcare, petfood, mypets
Path	`/petcare/fishpond`	Named fishpond.txt in folder named petcare (for search purposes, the file path includes the file name)
File type	`txt`	Named fishpond.txt, planning.txt

Advanced syntax

For more precise searching, add parameter:value pairs to the end of a basic query, separated by spaces:

query parameter:value

Use spaces ( ), wild cards ( * ? ), and quotation marks ( " " ) only as illustrated by the examples below. Boolean operators (and, or, not) do not apply.

Advanced search examples

The following table contains advanced search examples and explains how they behave:

Search Type	Search Query	Finds Files
File Name	`Customers.rtf content:"ACME Tire"`	Named Customers.rtf and containing the phrase ACME Tire
File Contents	`"Q1 Finance" fileName:plans.xls`	Containing the phrase Q1 Finance and named plans.xls

Advanced search parameters

Advanced file searches support the following parameters:

Search Parameter	Description	Example Usage
archiveGuid	Limits results to files contained by the specified archive GUID.	`archiveGuid:712687676501403618`
checksumMd5	Limits results to files that match the specified MD5 checksum.	`checksumMd5:208174bc7e3ca372406ae539a12dc868`
checksumSha256	Limits results to files that match the specified SHA-256 checksum.	`checksumSha256:5e488e8b7ed5adc4b98a036e851d97de55a8ac453f3b4ded9aacbecbb3a808c7`
content	Limits results to files that contain the specified word or phrase.	`content:"mergers and acquisitions"`
contentType	Limits results to files that match the specified MIME type.	`contentType:"application/rtf"`
deviceGuid	Limits results to files backed up from the specified device.	`deviceGuid:681099810721783680`
extension	Limits results to files with the specified file extension.	`extension:rtf`
fileName	Limits results to files with names that match the specified word or phrase.	`fileName:"Q1 Plan.rtf"` `fileName:Q1*`
filePath	Limits results to files with paths that match the specified word or phrase.	`filePath:"/Users/bob.smith/Documents/Q1 Plan.rtf"`
isDeleted	Limits results to files that are or are not deleted.	`isDeleted:true` `isDeleted:false`
isLatest	Limits results to the latest version of matching files.	`isLatest:true`
lastModifiedAt	Limits results to files modified during, before, or after the specified time.	Files modified between two dates: `lastModifiedAt:["2015-05-30" TO "2015-05-31"]` Files modified before a date: `lastModifiedAt:[* TO "2015-05-31"]` Files modified after a date: `lastModifiedAt:["2015-05-30" TO ]` Use date format YYYY-MM-DD (ISO 8601).*
planUid	Deprecated - no effect
special:ssn	Limits results to files that contain number patterns that match social security numbers. For example, the following numbers match the pattern: 123-45-6789 123456789 AB-123-45-6789-CD	`special:ssn`
userUid	Limits results to files backed up by the specified user UID.	`userUid:8b852f494e4f2574`