Table of Contents

DOCMANPROPS Command

DESCRIPTION

The docmanprops command is used to export and update SOLIDWORKS file custom properties without opening SOLIDWORKS.

This command supports two primary modes:

  • Export Mode (Default) — Reads properties from SOLIDWORKS files and writes them to a CSV file

  • Update Mode — Reads a CSV file and writes the properties back into the SOLIDWORKS files (Same CSV from Export mode)

  • Refresh Mode — Reads a CSV file and refreshes the content of the csv.

Important

?This command works with the file system and requires files to be locally cached. It reads and writes files both inside and outside the vault. Relative paths only work in the vault directory (and requires you to be logged in).

SYNTAX

docmanprops -directory <path> -csv <csvPath> [-recursive] [-configNames] [-update] [-refresh][extensions]

PARAMETERS

directory

Specifies the folder containing SOLIDWORKS files.

Example:

`-directory "C:\Vault\Projects"`

csv

Specifies the CSV file path.

Used for:

  • Export destination
  • update source

Example: -csv "C:\temp\props.csv"

update

When specified, the command runs in Update Mode.

Reads the CSV file and writes the properties back into the SOLIDWORKS files.

refresh

When specified, the command runs in Refresh Mode.

Reads the CSV file and refreshes the content of the properties in the csv file.

recursive

When specified, searches subfolders.

configNames

Specifies which configurations to include.

Default: All configurations

Example: -configNames "Default,Config1" Use space for custom property.

extensions

Specifies which file extensions to include when exporting or updateing properties.

Default: * (all files)

Supports wildcards and multiple values separated by commas.

Special value for all solidworks file extensions is: solidworks

Examples:

#all solidworks files
-extensions "solidworks"

-extensions "*.sld*"

-extensions "*.sldprt,*.sldasm"

-extensions "*.sld*,*.pdf"

-extensions "*"

If an extension filter contains spaces, wrap it in quotes.

Example:

-extensions "*.sld*,*.step,*.pdf"

Use *.* to include all files regardless of extension.

CSV FORMAT

The CSV contains the following columns:

Folder  
FullPath  
FileName  
Extension  
Configuration  
Property  
Value  
EvaluatedValue  
Type  
Success  
Exception

Example:

C:\Vault\Part, C:\Vault\Part\Part1.SLDPRT, Part1, .SLDPRT, Default, Description, Plate, Plate, Text, True,

EXPORT MODE

DESCRIPTION

Reads properties from files and writes them to CSV.

Properties include:

  • File custom properties
  • Configuration properties
  • Evaluated values
  • Property types

EXAMPLE

docmanprops -directory "C:\Vault\Parts" -csv "C:\temp\props.csv" -recursive

OUTPUT

export mode

update MODE

DESCRIPTION

Reads CSV file and writes properties back into files.

Features:

  • Opens each file once
  • Updates all properties
  • Saves file
  • Updates CSV Success and Exception columns
  • Parallel processing

Implementation reference: :contentReference[oaicite:1]{index=1}

EXAMPLE

docmanprops -csv "C:\temp\props.csv" -update

OUTPUT

updatemode

Note

Temporary files start with ~ are ignored.

SUCCESS AND ERROR TRACKING

The CSV is updated during update:

Success column:

True — Property updated successfully
False — Property update failed

Exception column:

Contains error message

Example:

Property,Success,Exception
Description,True,
PartNumber,False,Configuration Default not found

PERFORMANCE

Typical performance:

Files Time
1,000 seconds
10,000 under 1 minute
100,000 few minutes
Edit this page