Table of Contents

dump

alias dmpFree

Description

Dumps all session text into a log file and check it back into the vault.

Syntax

dump filePath

Use -id as an alternative to -filePath for the same operand. A required target still needs one selector, even though each alternative is optional individually. See File IDs and paths for selection rules and command-specific exceptions.

Parameters

Parameter Alias Required Description
-filePath (default) -f No The log file to dump session details into.
-id No Positive PDM file ID instead of -filePath, identifying the same file that -filePath describes (including a macro, input CSV or existing output file). Requires a connected vault. Shared files with multiple locations require an exact -filePath. Resolving the ID itself does not download, check out or check in the file; the requested command still performs its normal operation.

Examples

dump -filePath "$release_script_$yyyy_$mm_$dd_$guid.txt"

Remarks

  • To make sure your logs are always unique, use $guid or the date/time place holders. You can get more information about these place holders here.

  • If you start PDMShell as a Windows administrator with the -winlog or /winlog parameter, PDMShell will create logs in the Windows event viewer.