Documentation Center

Syntax for reap_report

The reap_report command creates a list of inactive objects in the database.

  • The report is sent to stdout if not saved to a file by using the -o switch.
  • You can save the report to a file (by using the -o switch) and use it as input to the reap_delete command.
  • You can edit a report file to select specific objects to delete or to divide the deletion process into convenient portions.

The command should be issued in single user mode to ensure a static database. See the Contenta Sessions Command to verify that there are no users accessing the database.

OSCommand
Windowsreap_report -dbase dbname@DSN switches
Linuxreap_report -dbase dbname@DSN switches
SwitchDescription

Windows:

dbname@ODBC_DSN

—or—

Linux:

dbname@SID

Required: dbname.

The name of the Contenta database.

Optional: ODBC_DSN (Windows)

The ODBC data source name. If not specified, the default is used—as defined in the registry for XYV_PDM_ODBC_DSN

Optional: SID (Linux)

The system identifier. If not specified, the default is used—as defined in the registry for XYV_PDM_DATABASE_SID

-pltrim

Optional (recommended)

The -pltrim switch removes any deficient orphan entries in the parent_list that might prevent old removed objects from being deleted.

When this switch is used, the pltrim command is executed before doing the reap_report.

This switch requires exclusive access to the database (single-user mode).

Can be omitted if you issue the Parent List Trim Command before issuing the reap_report or reap_delete command.

Defaultpltrim is not executed.
-o outfileOptional

Where outfile is a directory path and filename for the reap_report file.

Creates the outfile file in the path specified.

If the directory path does not begin with a slash, the command creates the report file in the current working directory.

If the specified output file already exists, the reap_report output is appended to the end of the file. If the directory does not exist, an error appears.

SeeSyntax for reap_report.
DefaultStandard output (stdout).
-before MM/DD/YY[YY] [HH:MM[:SS]] Optional

where MM/DD/YY[YY] is the numeric representation of the month, day, and year—year can be entered as two digits (for example, 03) or four (for example, 2003).

Reports only inactive objects modified before the specified date and (optional) time.

Cannot be used with the -quick switch.

DefaultAll inactive objects in the database.
-objtype typename typename ...Optional

Report for inactive objects of the specified types (for example, configuration, project, custobj).

To include customized object types, specify the object type in the command line.

Object types are not case sensitive.

DefaultAll object types in the database
-nopaths

Optional

The report excludes the ID and the name of the controlling configurations for the object.

DefaultList the ID and name of each controlling container configuration from the given object’s checkpoint table (that is, all configurations that ever controlled the object).
-fullpathsOptional

Use this switch if you want the report to display every path to an inactive object that ever existed under the sysadmin desktop.

It also displays a path comprised of the object’s blob ID and the revision at which the next child in the path appeared. (The report does not include paths under other desktops or workpools.)

SeeThe Fullpaths switch
DefaultDo not display paths.
-max_proc_time HH:MMOptional

Runs the command for a specified length of time represented by <HH:MM> (hours and minutes) then stops.

Use the -max_proc_time switch to limit the amount of processing time for the current execution of the command.

This switch will help you to schedule report creation and subsequent deleting for convenient time periods when users are not accessing the system. It allows you to control the time necessary to report and delete.

DefaultNo maximum time; no timeout.
-quick

Optional

Runs report in quick mode. Last modified time is not read from the BLOb so BLOb is not loaded.

Date field in report appears as ‘*’.

DefaultReads and loads BLObs.