Filters

Previous Next  Print this Topic

The two main types of filters used in Phoenix RSM are file and directory and can be applied in several of the product applications. Use filters to pinpoint the inclusion or exclusion of specific (or groups) of files or directories. Wildcards may also be used when formulating a filter. For more information, see Wildcards.

File filters operate on file names and directory filters operate on directory names. If a policy features both file and directory files, then both types are used. File filters and directory filters can complement each other but the product processes them separately, first applying any directory filters and then applying any file filters.

Exclude filters - Implies "include all", meaning that everything is processed in the job unless files or directories are explicitly excluded.

Include filters - Implies "exclude all", meaning that only the files or directories specified by an include filter are included in a job.

Filters process exactly what you type. For example, if you create an include filter for .doc, then the processed files are literally named .doc. If you want to process all files that are of a .doc type, the filter would include a wildcard: *.doc.

File Filters

If a file filter does not have a path delimiter, the product matches the pattern against the last leaf of the path, which is the file name itself. If the file filter does have a path delimiter, the product matches the pattern against the entire path, including the file name.

File filters are read from the top down. For example, if you have an exclude file filter that excludes all .jpg files followed by a filter that includes all .jpg files, the .jpg files are excluded.

Directory Filters

If a directory filter does not have a path delimiter, the product tries to match the pattern against the last leaf of the path separately and looks for the first match. If a directory filter does have a path delimiter, the product matches the pattern against the entire path.

Directory filters are read from the top down. For example, if you have an exclude directory filter that excludes all folders named Pictures followed by a filter that includes Pictures/2003Convention, the first filter takes precedence and Pictures/2003Convention is not included.

When typing paths or path searching patterns, use the forward slash (/).

Create File Filters and Directory Filters

File filters enable you to include or exclude particular files by file name or file type. Directory filters enable you to include or exclude directories and their contents. It is possible to use file and directory filters at the same time.

1.In the Files to Include/Exclude or Directories to Include/Exclude group, click the Add button.

Use the Add Filter window to Apply Filters for Searching

2.Select a filter type. Use Include to ensure the inclusion of files, directories, and file types. Use Exclude to exclude files, directories, and file types. This text box supports characters, numbers, and symbols needed to define filters.
3.Type a filter, and then click OK. For example, in the Files to Include/Exclude, if you type *.vsd and then *.xls, the text box would appear as follows. Include filters are preceded by a green check mark, and exclude filters by a red x.

The Files to Include/Exclude or Directories to Include/Exclude group boxes display the values entered from the Add Filter dialog box. Wildcards are supported.

To assign priority to filters, move them up and down using the up arrow button and down arrow button.

Inlcude/Exclude text box - Displays Applied Filters

Delete File Filters and Directory Filters

In the Files to Include/Exclude or Directories to Include/Exclude group, select a filter, and click the Delete button.

Understanding Directory Filters

The following table demonstrates how directory filters work and includes some uses of wildcards.

Filter - The filter applied in the Criteria tab. This can be either an Include or Exclude filter.

Pathname - The current file or directory being looked at to determine the next step of processing.

Process? - Determine if the file or directory at that pathname is a match to the applied filter. If Yes, use the Include/Exclude value of the filter to determine the final process value. If No, the directory can still be walked to look for further matches.

Walk? - Determine if the tree will be walked further down in search of a match. Files are never walked.

Filter

Pathname

Process?

Walk?

//H1/#

//H1

No

Yes

//H1/D1

Yes

Yes

//H1/D1/F1

Yes

No

//H1#

//H1

No

Yes

//H1/D1

Yes

Yes

//H1/D1/F1

Yes

No

//H1/D1/D2/#

//H1/D1

No

Yes

//H1/D1/D2

No

Yes

//H1/D1/D2/D3

Yes

Yes

//H1/D1/D2/F1

Yes

No

//H1/D1/D2/D3/F1

Yes

No

//H2/D1

No

No

//H1/D1

//H1/D1

Yes

Yes

//H1/D1/F1

Yes

No

//H1/D1/D2

Yes

No

//H1/D1/D2/F1

No

No

//H1/*

//H1/D1

Yes

Yes

//H1/F1

Yes

No

//H1/D1/D2/D3

No

No

//H1/D1/D2/*

//H1/D1/D2/D3

Yes

Yes

//H1/D1/D2/D3/D4

No

No

//H1/D1/D2/D3/F1

No

No

//H1/D1/D2/F1

Yes

No

D1

//H1

No

Yes

//H1/D1

Yes

Yes

//H1/D1/D2

Yes

Yes

//H1/D1/F1

Yes

No

D2

//H1/D1

No

Yes

//H1/D1/D2

Yes

Yes

//H1/D1/D2/D3

Yes

Yes

//H1/D1/D2/D3/F1

Yes

No

//H1/D1/F1

No

No

H = Host

D = Directory

F = File

Understanding File Filters

The following table demonstrates how file filters work and includes some uses of wildcards. If Process? is Yes, use the Include/Exclude value of the filter to determine the final process value.

Filter - The filter applied in the Criteria tab. This can be either an Include or Exclude filter.

Pathname - The current file or directory being looked at to determine the next step of processing.

Process? - Determine if the file or directory at that pathname is a match to the applied filter. If Yes, use the Include/Exclude value of the filter to determine the final process value. If No, the directory can still be walked to look for further matches.

Walk? - Determine if the tree will be walked further down in search of a match. Files are never walked.

Filter

Pathname

Process?

Walk?

//H1/#

//H1/D1/F1

Yes

No

//H1#

//H1/D1/F1

Yes

No

//H1/D1/D2/#

//H1/D1/D2/F1

Yes

No

//H1/D1/D2/D3/F1

Yes

No

//H1/D1/D2/*

//H1/D1/D2/D3/F1

No

No

//H1/D1/D2/F1

Yes

No

D1

//H1/D1/F1

Yes

No

D2

//H1/D1/D2/D3/F1

Yes

No

//H1/D1/F1

No

No

H = Host

D = Directory

F = File

Filter Examples

If you had a directory that contained several different file types and you want to process all of the files in the directory except .jpg files, you can create an exclude filter for files with a .jpg extension. In the following example, denotes "exclude"; * (asterisk) is the wildcard symbol for "all"; .jpg is the file extension subject to the prefixed symbols. The left column lists all the directory files, the center column shows the applied filter, and the right column shows the processed files. Notice that the .jpg files are not processed.

Files in specified directory

Filter

Files that are processed

Elevator design 12502.vsd

Elevator design rev 20502.vsd

Elevator design rev 21502.vsd

Part345X.xls

Part236.xls

Part 532.xls

Ref-guide rev21502.doc

Ref-guide rev21802.doc

Install guide 21502.ind

Illustration 532.psd

Illustration 236.psd

Vacation 1.jpg

Vacation 2.jpg

Vacation 3.jpg

*.jpg

Elevator design 12502.vsd

Elevator design rev 20502.vsd

Elevator design rev 21502.vsd

Part345X.xls

Part236.xls

Part 532.xls

Ref-guide rev21502.doc

Ref-guide rev21802.doc

Install guide 21502.ind

Illustration 532.psd

Illustration 236.psd

Filter strings can contain wildcard symbols, making the Information Repository very flexible. Use several filters together to create almost any include/exclude combination.

Using the same file set as an example, the only files processed are the .vsd and .xls files.

Files in specified directory

Filter

Files that are processed

Elevator design 12502.vsd

Elevator design rev 20502.vsd

Elevator design rev 21502.vsd

Part345X.xls

Part236.xls

Part 532.xls

Ref-guide rev21502.doc

Ref-guide rev21802.doc

Install guide 21502.ind

Illustration 532.psd

Illustration 236.psd

Vacation 1.jpg

Vacation 2.jpg

Vacation 3.jpg

*.vsd

*.xls

Elevator design 12502.vsd

Elevator design rev 20502.vsd

Elevator design rev 21502.vsd

Part345X.xls

Part236.xls

Part 532.xls