Table of Contents

runtask

Free

Description

The runtask command allows you to execute a PDM task on a specific file or via search in the PDM vault.

Syntax

runtask -taskName -filePath -search -recursive

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
-taskName Yes Task name. This can be found in under Tasks in the Administration tool.
-filePath No Path to the affected file.
-search No Search query to find files to run the task on.
-recursive No If set, search will include subfolders.
-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.

More about parameters

The command requires the following parameters:

Examples

# runtask
 taskrun -TaskName "PrintPDF" -filePath "Assembly.sldasm"  

Search results report

Add -csv "C:\Reports\results.csv" when using -search to save operation results. The first columns are file ID, parent folder ID, file name and output, followed by status and error details. The report folder must exist. New vault reports are added to PDM; existing vault reports must be checked out by you on this computer and remain checked out. External reports are replaced. See CSV operation reports for command-specific outcomes.