Search and Retrieve Command Line

Previous Next  Print this Topic

Use SrchRtrvCl to find and retrieve data anywhere in your Information Repository.

To search for and retrieve data in the Information Repository, ensure that the Phoenix EXP installation folder is in your command path, open a command prompt, and run SrchRtrvCl at the command line. As needed, use the commands listed below.

Access SrchRtrvCl from your suite of application products.

Command Line Options

As needed, append the following options to the application execution path. You can enter a single option, a single option and -usage or -version, or a combination of several options and -usage or -version. When you run SrchRtrvCl, the command line is formed as follows:

SrchRtrvCl <option> <option> . . .

Option

Description

-admin_pn "<pathname>"

The path for the directory that contains the Target and Process log files.

Default = "<install-dir>/JobHistory/"

-diag

Enable or disable the displays of all internal activity on the connected terminal.

-diag enables display
-nodiag disables display

Default = -nodiag

-nodiag

-error_log "<pathname>"

The path for the error log file.

Default = "<install-dir>/SrchRtrv.log"

-out_of_band

Enable or disable out of band transferring.

-out_of_band enables out of band transferring.
-noout_of_band disables out of band transferring.

Default = –out_of_band

-noout_of_band

-metadata_list_pn "<pathname>"

Input file containing metadata to be used as search criteria. The option's <pathname> refers to the path where the file is located. There is no limit on the number of files to list.

The format of each line is:

key="value"[key="value"]<tab><Pathname>

Where,

key="value" = the metadata being searched for. Multiple key/value pairs can be used in the search.

<Pathname> = the pathname where the file is stored to.

<tab> = a tab character used as a field delimiter.

All values in all fields are taken as literal. For example, if a quote or space is contained in the pathname, it is taken as part of the pathname.

Ex: AssetId="111111" e:/Temp/Test/test.mov  5  45

-retrieve_list_pn "<pathname>"

Enable automatic retrieval of listed files. The option's <pathname> refers to the path where the file is located.

To use this option, you must first have a .txt file that lists all of the files you want retrieved. The .txt file can reside anywhere on your computer, and it should include the FileID of each file to be retrieved followed by a space and the path to where it should be retrieved:

FileID <pathname>

FileID <pathname>

FileID <pathname>

You can find FileIDs in the Target and Process activity log.

There is no limit on the number of files to list.

The format of each line is:

<FileID><tab><Pathname>

Where,

<FileID> = the file id of the file in the repository (required).

<Pathname> = the pathname where the file is stored to (required).

<tab> = a tab character used as a field delimiter.

All values in all fields are taken as literal. For example, if a quote or space is contained in the pathname, it is taken as part of the pathname.

-usage

List all valid parameters.

-version

Display the current version information.

Interactive Commands and their Arguments

After starting the application, you can enter the following arguments at the prompt.

Argument

Description

dest <toggle>

Set the destination path for retrieved files. If you specify new, you must also set the opath and npath options, or the npath option only, to reflect the new destination for retrieved files.

Valid values = orig | new

orig - original path
new - new path

Default = orig

filter <pattern>

Set the current search pattern employed when listing files.

Default = * (any)

fs logs

Set the file source for retrieval.

fs logs - Access the Target and Process log files to create a list of files eligible for retrieval.
fs media - Query the Vault to generate a list of files. Use this option when Target and Process log files aren't available.

Default = logs

fs media

h[elp]

Displays a list of valid commands.

ll

List available job log files.

Use the sl command to select a log file.
Use the lf command to list files associated with a Target and Process log file.

lf

List files available for retrieval. To select any number of files for retrieval, enter sf.

lsf

List files selected for retrieval.

logpath "<pathname>"

Set the path for job log files.

Default = "<install-dir>/JobHistory/"

lsva

Display the name of the currently selected Vault.

lsvo

Display a list of currently selected volumes.

lva

Display a list of available Vaults.

lvo

Display a list of available volumes associated with the selected Vault.

mdfile<toggle>

Generate metadata xml files for output along with video.

Output can be in the form of a single xml file for all video files, or generate multiple xml files - an output file for each video.

Valid values = multi | single<pathname> | off

multi - Output generates multiple xml files (an output file for each video).
single<pathname> - Output generates one xml file for all video files to the pathname entered
off - no output

Default = off

npath "<pathname>"

Set the new path for retrieved files. Use this command with dest new.

If both npath and opath (below) are specified, the opath entered is replaced with the npath pathname.
If only npath is specified, all files are retrieved in the pathname entered.
If the specified path contains components that do not exist and are not part of the current file set, these directory components are created with the same default ownership and rights as the current process.

opath "<pathname>"

Set the original pathname for files that are retrieved. Use this command with dest new and npath. The original file is replaced with the pathname specified with npath (above).

overwrite <boolean>

Sets the overwrite policy for retrieved files.

Valid values =

on - Always overwrite existing files.
off - Never overwrite existing files.
cond - Overwrite existing files only when the stored copy has been modified more recently than the existing file.

Default = off

q[uit]

Exit the application.

retrieve

Retrieve selected files.

sall

Select all files for retrieval.

sf <numbers>

Select the files associated with <line numbers> for retrieval. Subsequent retrieve commands are based on these selections.

Valid values = Any number or range of numbers separated by white space. Separate ranges of numbers with dashes. (ex. 1 2 5 8-12 17 20-25).

sl <line number>

Select the job log file associated with the <line number>. Subsequent lf commands are based on the log you select with this option.

status

A summary of the current settings.

sva <line number>

Select the Vault associated with <line number>. Subsequent lvo commands are based on the Vault you select with this option.

svo <line number>

Select the volume associated with <line number>. Subsequent lf commands are based on the volume you select with this option.

time <toggle>

Set the time stamp for retrieved files. Indicate either the original time stamp or the present time.

Valid values =

orig - original time stamp.
present - current time.

Default = orig