Skip to content

Commit 4fb5ceb

Browse files
committed
docs: sync pdmshell-docs from upstream
1 parent 66f2172 commit 4fb5ceb

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

server/utils/pdmshell-docs.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ export const pdmshellDocs: DocChunk[] = [
200200
{
201201
"id": "docmanprops",
202202
"title": "DOCMANPROPS Command",
203-
"content": "DESCRIPTION\n\nThe `docmanprops` command is used to **export and update SOLIDWORKS file custom properties** without opening SOLIDWORKS.\n\nThis command supports two primary modes:\n\n- **Export Mode (Default)** — Reads properties from SOLIDWORKS files and writes them to a CSV file\n- **Update Mode** — Reads a CSV file and writes the properties back into the SOLIDWORKS files (Same CSV from Export mode)\n\n- **Refresh Mode** — Reads a CSV file and refreshes the content of the csv.\n\n?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).\n---\n\n# SYNTAX\n\ndocmanprops -directory <path> -csv <csvPath> [-recursive] [-configNames] [-update] [-refresh][extensions]\n\n---\n\n# PARAMETERS\n\ndirectory\n\nSpecifies the folder containing SOLIDWORKS files.\n\nExample:\n```bash \n`-directory \"C:\\Vault\\Projects\"`\n\n---\n\ncsv\n\nSpecifies the CSV file path.\n\nUsed for:\n\n- Export destination\n- update source\n\nExample: `-csv \"C:\\temp\\props.csv\"`\n\n---\n\nupdate\n\nWhen specified, the command runs in **Update Mode**.\n\nReads the CSV file and writes the properties back into the SOLIDWORKS files.\n\n---\nrefresh\n\nWhen specified, the command runs in **Refresh Mode**.\n\nReads the CSV file and refreshes the content of the properties in the csv file.\n\n---\nrecursive\n\nWhen specified, searches subfolders.\n---\n\nconfigNames\n\nSpecifies which configurations to include.\n\nDefault: All configurations\n\nExample: `-configNames \"Default,Config1\"` Use space for custom property.\n\n---\n\nextensions\n\nSpecifies which file extensions to include when exporting or updateing properties.\n\nDefault: `*` (all files)\n\nSupports wildcards and multiple values separated by commas.\n\nSpecial value for all solidworks file extensions is: `solidworks`\n\nExamples:\n\n#all solidworks files\n-extensions \"solidworks\"\n\n-extensions \"*.sld*\"\n\n-extensions \"*.sldprt,*.sldasm\"\n\n-extensions \"*.sld*,*.pdf\"\n\n-extensions \"*\"\n\nIf an extension filter contains spaces, wrap it in quotes.\n\nExample:\n\n-extensions \"*.sld*,*.step,*.pdf\"\n\nUse `*.*` to include all files regardless of extension.\n--\n\n# CSV FORMAT\n\nThe CSV contains the following columns:\n\nFolder \nFullPath \nFileName \nExtension \nConfiguration \nProperty \nValue \nEvaluatedValue \nType \nSuccess \nException \n\nExample:\n\nC:\\Vault\\Part, C:\\Vault\\Part\\Part1.SLDPRT, Part1, .SLDPRT, Default, Description, Plate, Plate, Text, True,\n\n---\n\n# EXPORT MODE\n\nDESCRIPTION\n\nReads properties from files and writes them to CSV.\n\nProperties include:\n\n- File custom properties\n- Configuration properties\n- Evaluated values\n- Property types\n\n---\n\nEXAMPLE\n\ndocmanprops -directory \"C:\\Vault\\Parts\" -csv \"C:\\temp\\props.csv\" -recursive\n\nOUTPUT\n![export mode](/images/exportmode.png)\n---\n\n# update MODE\n\nDESCRIPTION\n\nReads CSV file and writes properties back into files.\n\nFeatures:\n\n- Opens each file once\n- Updates all properties\n- Saves file\n- Updates CSV Success and Exception columns\n- Parallel processing\n\nImplementation reference: :contentReference[oaicite:1]{index=1}\n\n---\n\nEXAMPLE\n\ndocmanprops -csv \"C:\\temp\\props.csv\" -update\n\nOUTPUT\n![updatemode](/images/refreshmode.png)\n\nTemporary files start with ~ are ignored.\n---\n\n# SUCCESS AND ERROR TRACKING\n\nThe CSV is updated during update:\n\nSuccess column:\n\nTrue — Property updated successfully \nFalse — Property update failed \n\nException column:\n\nContains error message\n\nExample:\n\nProperty,Success,Exception\nDescription,True,\nPartNumber,False,Configuration Default not found\n\n---\n\n# PERFORMANCE\n\nTypical performance:\n\n| Files | Time |\n|---|---|\n| 1,000 | seconds |\n| 10,000 | under 1 minute |\n| 100,000 | few minutes |\n\n---",
203+
"content": "DESCRIPTION\n\nThe `docmanprops` command is used to **export and update SOLIDWORKS file custom properties** without opening SOLIDWORKS.\n\nThis command supports two primary modes:\n\n- **Export Mode (Default)** — Reads properties from SOLIDWORKS files and writes them to a CSV file\n- **Update Mode** — Reads a CSV file and writes the properties back into the SOLIDWORKS files (Same CSV from Export mode)\n- **Refresh Mode** — Reads a CSV file and refreshes the content of the csv.\n\nThis 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).\n\n---\n\n# SYNTAX\n\ndocmanprops -directory <path> -csv <csvPath> [-recursive] [-configNames] [-update] [-refresh][extensions]\n\n---\n\n# PARAMETERS\n\ndirectory\n\nSpecifies the folder containing SOLIDWORKS files.\n\nExample:\n```bash \n`-directory \"C:\\Vault\\Projects\"`\n\n---\n\ncsv\n\nSpecifies the CSV file path.\n\nUsed for:\n\n- Export destination\n- update source\n\nExample: `-csv \"C:\\temp\\props.csv\"`\n\n---\n\nupdate\n\nWhen specified, the command runs in **Update Mode**.\n\nReads the CSV file and writes the properties back into the SOLIDWORKS files.\n\n---\nrefresh\n\nWhen specified, the command runs in **Refresh Mode**.\n\nReads the CSV file and refreshes the content of the properties in the csv file.\n\n---\nrecursive\n\nWhen specified, searches subfolders.\n---\n\nconfigNames\n\nSpecifies which configurations to include.\n\nDefault: All configurations\n\nExample: `-configNames \"Default,Config1\"` Use space for custom property.\n\n---\n\nextensions\n\nSpecifies which file extensions to include when exporting or updateing properties.\n\nDefault: `*` (all files)\n\nSupports wildcards and multiple values separated by commas.\n\nSpecial value for all solidworks file extensions is: `solidworks`\n\nExamples:\n\n#all solidworks files\n-extensions \"solidworks\"\n\n-extensions \"*.sld*\"\n\n-extensions \"*.sldprt,*.sldasm\"\n\n-extensions \"*.sld*,*.pdf\"\n\n-extensions \"*\"\n\nIf an extension filter contains spaces, wrap it in quotes.\n\nExample:\n\n-extensions \"*.sld*,*.step,*.pdf\"\n\nUse `*.*` to include all files regardless of extension.\n--\n\n# CSV FORMAT\n\nThe CSV contains the following columns:\n\nFolder \nFullPath \nFileName \nExtension \nConfiguration \nProperty \nValue \nEvaluatedValue \nType \nSuccess \nException \n\nExample:\n\nC:\\Vault\\Part, C:\\Vault\\Part\\Part1.SLDPRT, Part1, .SLDPRT, Default, Description, Plate, Plate, Text, True,\n\n---\n\n# EXPORT MODE\n\nDESCRIPTION\n\nReads properties from files and writes them to CSV.\n\nProperties include:\n\n- File custom properties\n- Configuration properties\n- Evaluated values\n- Property types\n\n---\n\nEXAMPLE\n\ndocmanprops -directory \"C:\\Vault\\Parts\" -csv \"C:\\temp\\props.csv\" -recursive\n\nOUTPUT\n![export mode](/images/exportmode.png)\n---\n\n# UPDATE MODE\n\nDESCRIPTION\n\nReads CSV file and writes properties back into files.\n\nFeatures:\n\n- Opens each file once\n- Updates all properties\n- Saves file\n- Updates CSV Success and Exception columns\n- Parallel processing\n\n---\n\nEXAMPLE\n\ndocmanprops -csv \"C:\\temp\\props.csv\" -update\n\nOUTPUT\n![updatemode](/images/refreshmode.png)\n\nTemporary files start with ~ are ignored.\n\n---\n\n# SUCCESS AND ERROR TRACKING\n\nThe CSV is updated during update:\n\nSuccess column:\n\nTrue — Property updated successfully \nFalse — Property update failed \n\nException column:\n\nContains error message\n\nExample:\n\nProperty,Success,Exception\nDescription,True,\nPartNumber,False,Configuration Default not found\n\n---",
204204
"keywords": [
205205
"docmanprops"
206206
],

0 commit comments

Comments
 (0)