Skip to content

Commit f67b3ca

Browse files
gns-xgns-x
committed
docs: sync pdmshell-docs from upstream
1 parent 5619557 commit f67b3ca

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

‎server/utils/pdmshell-docs.ts‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -146,13 +146,14 @@ export const pdmshellDocs: DocChunk[] = [
146146
{
147147
"id": "deletefromsource",
148148
"title": "DELETEFROMSOURCE Command",
149-
"content": "DESCRIPTION:\n\nThe `deletefromsource` command deletes files listed in a CSV file. It can also optionally destroy the files and export the operation results to a CSV file for auditing and reporting purposes.\n\nSYNTAX:\n\n deletefromsource -filePath -destroy -csv -batch\n\nPARAMETERS:\n\n| Parameter | Type | Required | Description |\n|---|---|---|---|\n| `filePath` | string | Yes | Path to the source CSV file containing File IDs and Folder IDs. This can be outside the vault. |\n| `destroy` | flag | No | If specified, files will be permanently destroyed after deletion. |\n| `csv` | string | No | Path to export the results CSV file. |\n| `batch` | int | No | Destory batch size for large folders. |\nSOURCE CSV FORMAT:\n\nThe source CSV file must contain a header row with the following columns:\n\nFileID,FolderID\n12345,678\n12346,678\n\n| Column | Description |\n|---|---|\n| FileID | The document ID of the file |\n| FolderID | The folder ID containing the file |\n\nRESULTS CSV FORMAT:\n\nIf `-csv` is specified, PDMShell will generate a results file containing:\n\nFileID,FolderID,Deleted,Destroyed,DeleteError,DestroyError\n12345,678,True,True,,\n12346,678,False,False,File is checked out,\n\nRESULTS CSV COLUMNS:\n\n| Column | Description |\n|---|---|\n| FileID | File ID |\n| FolderID | Folder ID |\n| Deleted | Whether delete succeeded |\n| Destroyed | Whether destroy succeeded |\n| DeleteError | Delete error message if failed |\n| DestroyError | Destroy error message if failed |\n\nREMARKS:\n\n- The source file **must be a CSV file with a header row**.\n\nEXAMPLES:\n\nDelete files from CSV:\ndeletefromsource -filePath \"files to delete.csv\"\n\n##Delete and destroy files:\ndeletefromsource -filePath \"files to delete.csv\" -destroy\n\nDelete, destroy, and export results:\ndeletefromsource -filePath \"files to delete.csv\" -destroy -csv \"results.csv\"\n\nDelete, destroy (50 files at a time in each folder), and export results:\ndeletefromsource -filePath \"files to delete.csv\" -destroy -csv \"results.csv\" -batch 50",
149+
"content": "DESCRIPTION:\n\nThe `deletefromsource` command deletes files listed in a CSV file. It can also optionally destroy the files and export the operation results to a CSV file for auditing and reporting purposes.\n\nSYNTAX:\n\n deletefromsource -filePath -destroy -csv -batch\n\nPARAMETERS:\n\n| Parameter | Type | Required | Description |\n|---|---|---|---|\n| `filePath` | string | Yes | Path to the source CSV file containing File IDs and Folder IDs. This can be outside the vault. |\n| `destroy` | flag | No | If specified, files will be permanently destroyed after deletion. |\n| `csv` | string | No | Path to export the results CSV file. |\n| `batch` | int | No | Destory batch size for large folders. |\n\nIMPORTANT NOTES ABOUT `-destroy`:\nThe `deletefromsource` command first attempts to delete and destroy (if `-destroy` used) files normally using the provided input (IDs from the CSV).\n\nAfter that initial pass, it performs a second step using the Name column. This is specifically for files that were already deleted but not destroyed.\nSince these files no longer exist in the vault in a normal state, they cannot be deleted again and their IDs do not exist anymore. Instead, PDMShell uses the file name to locate these previously deleted items and destroy them directly.\n\nThis approach allows you to:\n- Handle active files (delete → destroy)\n- Handle already deleted files (destroy only) if there a value in the name column. See structure of the CSV file.\n\nFor previously deleted files, you only need to provide the file name in the Name column.\n\nSOURCE CSV FORMAT:\n\nThe source CSV file must contain a header row with the following columns:\n\nFileID,FolderID,Name\n12345,678,1.sldprt\n12346,678,2.sldprt\n\nThe `Name` column is optional. PDMShell uses this value to destroy items. You can enter the names of files that were previously deleted; PDMShell will attempt to delete them (which will fail) and then proceed to destroy them. \n\n| Column | Description |\n|---|---|\n| FileID | The document ID of the file |\n| FolderID | The folder ID containing the file |\n\nRESULTS CSV FORMAT:\n\nIf `-csv` is specified, PDMShell will generate a results file containing:\n\nFileID,FolderID,Error\n12345,678,\"DELETE error: File Not Found\"\n\nRESULTS CSV COLUMNS:\n\n| Column | Description |\n|---|---|\n| FileID | File ID |\n| FolderID | Folder ID |\n| Error | Error message |\n\nREMARKS:\n\n- The source file **must be a CSV file with a header row**.\n\nEXAMPLES:\n\nDelete files from CSV:\ndeletefromsource -filePath \"files to delete.csv\"\n\n##Delete and destroy files:\ndeletefromsource -filePath \"files to delete.csv\" -destroy\n\nDelete, destroy, and export results:\ndeletefromsource -filePath \"files to delete.csv\" -destroy -csv \"results.csv\"\n\nDelete, destroy (50 files at a time in each folder), and export results:\ndeletefromsource -filePath \"files to delete.csv\" -destroy -csv \"results.csv\" -batch 50",
150150
"keywords": [
151151
"deletefromsource",
152152
"filepath",
153153
"destroy",
154154
"csv",
155-
"batch"
155+
"batch",
156+
"name"
156157
],
157158
"category": "file-management"
158159
},
@@ -607,8 +608,8 @@ export const pdmshellDocs: DocChunk[] = [
607608
},
608609
{
609610
"id": "releasenotes",
610-
"title": "3.0.53 (2026-03-18)",
611-
"content": "To update PDMShell properly, **download** the latest version, **uninstall** PDMShell and \nthen **install** the latest version. **Do not update installed version.**\n\n- `deletefromsource`: Fixed some bugs \n\n# 3.0.52 (2026-03-17)\n- internal build\n\n# 3.0.51 (2026-03-17)\n- internal build\n\n# 3.0.50 (2026-03-16)\n- `updatesreferences`: added `csv` to save output.\n# 3.0.49 (2026-03-16)\n- Adding verbose logging to to `addtovault`\n- `setvarfromsource`: Added error message to error code. \n\n# 3.0.48 (2026-03-15)\n- Minor change to `addtovault`: existing files found during add will be added to results file from parameter `csv`.\n- Added TaskScript add-in to run tasks with PDMShell (Similar to convert task). \n\n# 3.0.47 (2026-03-07)\n- Added `edit` token to search. This will force a check out and check-in when using a PDM `-search` during any command. \n- Added `version` to specify the version of SOLIDWORKS to use in `export` and `runswmacro` commands. \n \n\n# 3.0.46 (2026-03-06)\n- Expanded `source` to take folder in [move](MOVE.md): This allow folders to be moved.\n\n# 3.0.45 (2026-03-06)\n- Add `label` parameter to [addtovault](ADDTOVAULT.md)\n\n# 3.0.44 (2026-03-03)\n- Add `count`, `clear`, `skip` parameters to [addtovault](ADDTOVAULT.md)\n\n# 3.0.42 (2026-03-02)\n- Small bugs fixes with the `csv` parameter in [addtovault](ADDTOVAULT.md)\n- If you specify the word \"DELETE\" in the value of the custom property in the `propertymap`, PDMShell will delete the property prior to adding the file.\n\n# 3.0.41 (2026-03-01)\n- Added `propertymap` parameter to allow to set custom property prior to adding files to vault from a csv file.\n- Changed `list` parameter in [addtovault](ADDTOVAULT.md) to `map`\n\n# 3.0.40\n# 3.0.39\nGhost builds\n\n# 3.0.38 (2026-02-26)\n- Added `update` parameter and changed the logic `refresh` parameter [DocManProps](DOCMANPROPS.md): `Update` now updates the files and `refresh` refresh the csv.\n\n# 3.0.37 (2026-02-25)\n- Added `list` parameter to [addtovault](ADDTOVAULT.md): CSV mapping file list\n- Added `batch` parameter to [addtovault](ADDTOVAULT.md).\n- Improved performance with large data sets [addtovault](ADDTOVAULT.md). \n\n# 3.0.36 (2026-02-24)\n- Ignored temporary files in [DocManProps](DOCMANPROPS.md).\n- Added support for listing non-solidworks in output of [DocManProps](DOCMANPROPS.md).\n# 3.0.35 (2026-02-23)\n# 3.0.34 (2026-02-23)\n- Fixed bug when enumerating large data volume [DocManProps](DOCMANPROPS.md).\n- pdmcli.exe now signed with a verified publisher.\n\n# 3.0.33 (2026-02-21)\n- Fixed escape and unescape bug in default mode in [DocManProps](DOCMANPROPS.md) command.\n- Add `extensions` parameter to [DocManProps](DOCMANPROPS.md) command.\n\n# 3.0.32 (2026-02-20)\n- Added documentation for the `transition` [Transition](TRANSITION.md) command.\n\n# 3.0.31 (2026-02-20)\n- Added `docmanprops` to edit properties using the document manager [DocManProps](DOCMANPROPS.md) command.\n\n# 3.0.30 (2026-02-17)\n- Added `batch` parameter for destroying files in the [DeleteFromSource](DELETEFROMSOURCE.md) command.\n\n# 3.0.29 (2026-02-16)\n- Minor changes and updates to the docs.\n\n# 3.0.28 (2026-02-11)\n- Added `DuplicatedBy` token to advanced search and `DuplicateStrategy` parameter to the search command.\n- Added [Move](MOVE.md) and [MoveFromSource](MOVEFROMSOURCE.md) commands.\n# 3.0.27 (2026-02-09)\n- Added [Pack And Go](PACKANDGO.md)\n- Updated [Where Used](WHEREUSED.md) \n\n# 3.0.26 (2026-01-05)\n- Happy New Year 2026 🎊!\n- [get command](GET.md): `Directory` parameter is now **optional**. If not specified, the file is cached in its folder. If specified with an empty value, the file is cached at the root of the vault.\n- Update tooltip for the `source` parameter in the [clear cache command](CLEARACACHE.md)\n\n# 3.0.25 (2025-12-23)\n- No added commands or bug fixes. \n- Updated parameters tooltip in `addtovault`, `rename`, `cd` and others.\n\n# 3.0.24 (2025-12-22)\n- parameter tooltips (little box that shows up next to the parameter when you type in the command box) are now uniaue for each command. Over the next releases, we will update all tooltips for all parameters to make them more clear. The same parameter can be used in multiple commands having different function in each.\n\n# 3.0.23 (2025-12-20)\n- Added [update references command](UPDATEREFERENCES.md)\n\n# 3.0.22 (2025-12-19)\n- Added [copy command](COPY.md)\n\n# 3.0.21 (2025-12-18)\n- Fixed single instance bug. All commands are now executed sequentially. Output is not during commands execution anymore. This was in 3.0.19 and 20\n- Added `getoptions` in [Get](GET.md)\n- Added `checkoutoptions` in [Checkout](CHECKOUT.md)\n\n# 3.0.20 (2025-12-12)\n- Fixed timeout issue with [Export](EXPORT.md) and [RunSwMacro](RUNSWMACRO.md).\n- Added `name`, `filePath` and `value` parameters to [INBOX](INBOX.md). \n- `source` parameter default to current directory in [addtovaultcommmand](ADDTOVAULT.md). \n\n# 3.0.19 (2025-12-11)\n- Added `winlog` parameter for pdmcli.exe. See remarks section of [dump command](DUMP.md).\n- Fixed single instance bug. All commands are now executed sequentially. Output is blocked during commands execution.\n\n# 3.0.18 (2025-12-08)\n- Rebuild. Previous faulty build.\n\n# 3.0.17 (2025-12-08)\n- Fixed single instance issue related to Windows enviornment variables\n- Added note for `solidworks` and `pdm`parameters in the [Version](VERSION.md) command: **RESERVED FOR FUTURE. NOT IMPLEMENTED** \n\n# 3.0.16 (2025-12-07)\n- [Export: Added timeout parameter launching SOLIDWORKS](EXPORT.md).\n- [RunSwMacro: timeout parameter is also enabled for launching SOLIDWORKS](RUNSWMACRO.md).\n- Enforced `.pdmshell` extension across all commands as the scripting file extension.\n# 3.0.15\n- skipped\n\n# 3.0.14 (2025-12-05)\n- [Login: Fix bug with parameter casing](LOGIN.md).\n- [Login: Added implementation with the transition command](TRANSITION.md).\n- Updated documentation\n\n# 3.0.13 (2025-12-04)\n- [VERSIONUPGRADE: Added a new command](VERSIONUPGRADE.md).\n- [VERSIONUPGRADEFROMSOURCE: Added a new command (Reserved but not implemented)](VERSIONUPGRADEFROMSOURCE.md).\n\n# 3.0.12 (2025-12-03)\n- [SetRevisionFromSource: Added a new command](SETREVISIONFROMSOURCE.md).\n\n# 3.0.11 (2025-12-02)\n- [SetRevision: Added a new command](SETREVISION.md).\n - Fixed evaluation bug: Bracketed variable `[Variable]` fail to evaluate in `name` and `value` parameters\n\n# 3.0.10 (2025-12-01)\n- Rebuild\n\n# 3.0.9 (2025-12-01)\n - [INFOVAR: Fixed bug with related to single flag variables](INFOVAR.md) \n - [SETVAR: Added support for handling folder cards](SETVAR.md) \n\n# 3.0.8 (2025-11-30)\n - Fixed unhandled exception when license is limited that causes a crash in all commands\n - Fixed evaluation bug (order)\n - Fixed some minor bugs in BOM command\n\n# 3.0.7 (2025-11-29)\n - [BOM: Added a new command](BOM.md). Please see notes [here](howtoinstall.md#common-update-issues) about new commands in the **Common Update Issues** section.\n - [Added `$configuration` placeholder](EVAL.md)\n - Added release notes page\n - Fixed some minor typos for the delete and destroy commands\n - Change toolbar icons and tooltips for better UX",
611+
"title": "3.0.55 (2026-03-20)",
612+
"content": "To update PDMShell properly, **download** the latest version, **uninstall** PDMShell and \nthen **install** the latest version. **Do not update installed version.**\n\n- Added a quick access button to PDMShell AI assistant\n# 3.0.54 (2026-03-20)\n- `deletefromsource`: API workaround for IEdmBatchDelete3 \n# 3.0.53 (2026-03-18)\n- `deletefromsource`: Fixed some bugs \n\n# 3.0.52 (2026-03-17)\n- internal build\n\n# 3.0.51 (2026-03-17)\n- internal build\n\n# 3.0.50 (2026-03-16)\n- `updatesreferences`: added `csv` to save output.\n# 3.0.49 (2026-03-16)\n- Adding verbose logging to to `addtovault`\n- `setvarfromsource`: Added error message to error code. \n\n# 3.0.48 (2026-03-15)\n- Minor change to `addtovault`: existing files found during add will be added to results file from parameter `csv`.\n- Added TaskScript add-in to run tasks with PDMShell (Similar to convert task). \n\n# 3.0.47 (2026-03-07)\n- Added `edit` token to search. This will force a check out and check-in when using a PDM `-search` during any command. \n- Added `version` to specify the version of SOLIDWORKS to use in `export` and `runswmacro` commands. \n \n\n# 3.0.46 (2026-03-06)\n- Expanded `source` to take folder in [move](MOVE.md): This allow folders to be moved.\n\n# 3.0.45 (2026-03-06)\n- Add `label` parameter to [addtovault](ADDTOVAULT.md)\n\n# 3.0.44 (2026-03-03)\n- Add `count`, `clear`, `skip` parameters to [addtovault](ADDTOVAULT.md)\n\n# 3.0.42 (2026-03-02)\n- Small bugs fixes with the `csv` parameter in [addtovault](ADDTOVAULT.md)\n- If you specify the word \"DELETE\" in the value of the custom property in the `propertymap`, PDMShell will delete the property prior to adding the file.\n\n# 3.0.41 (2026-03-01)\n- Added `propertymap` parameter to allow to set custom property prior to adding files to vault from a csv file.\n- Changed `list` parameter in [addtovault](ADDTOVAULT.md) to `map`\n\n# 3.0.40\n# 3.0.39\nGhost builds\n\n# 3.0.38 (2026-02-26)\n- Added `update` parameter and changed the logic `refresh` parameter [DocManProps](DOCMANPROPS.md): `Update` now updates the files and `refresh` refresh the csv.\n\n# 3.0.37 (2026-02-25)\n- Added `list` parameter to [addtovault](ADDTOVAULT.md): CSV mapping file list\n- Added `batch` parameter to [addtovault](ADDTOVAULT.md).\n- Improved performance with large data sets [addtovault](ADDTOVAULT.md). \n\n# 3.0.36 (2026-02-24)\n- Ignored temporary files in [DocManProps](DOCMANPROPS.md).\n- Added support for listing non-solidworks in output of [DocManProps](DOCMANPROPS.md).\n# 3.0.35 (2026-02-23)\n# 3.0.34 (2026-02-23)\n- Fixed bug when enumerating large data volume [DocManProps](DOCMANPROPS.md).\n- pdmcli.exe now signed with a verified publisher.\n\n# 3.0.33 (2026-02-21)\n- Fixed escape and unescape bug in default mode in [DocManProps](DOCMANPROPS.md) command.\n- Add `extensions` parameter to [DocManProps](DOCMANPROPS.md) command.\n\n# 3.0.32 (2026-02-20)\n- Added documentation for the `transition` [Transition](TRANSITION.md) command.\n\n# 3.0.31 (2026-02-20)\n- Added `docmanprops` to edit properties using the document manager [DocManProps](DOCMANPROPS.md) command.\n\n# 3.0.30 (2026-02-17)\n- Added `batch` parameter for destroying files in the [DeleteFromSource](DELETEFROMSOURCE.md) command.\n\n# 3.0.29 (2026-02-16)\n- Minor changes and updates to the docs.\n\n# 3.0.28 (2026-02-11)\n- Added `DuplicatedBy` token to advanced search and `DuplicateStrategy` parameter to the search command.\n- Added [Move](MOVE.md) and [MoveFromSource](MOVEFROMSOURCE.md) commands.\n# 3.0.27 (2026-02-09)\n- Added [Pack And Go](PACKANDGO.md)\n- Updated [Where Used](WHEREUSED.md) \n\n# 3.0.26 (2026-01-05)\n- Happy New Year 2026 🎊!\n- [get command](GET.md): `Directory` parameter is now **optional**. If not specified, the file is cached in its folder. If specified with an empty value, the file is cached at the root of the vault.\n- Update tooltip for the `source` parameter in the [clear cache command](CLEARACACHE.md)\n\n# 3.0.25 (2025-12-23)\n- No added commands or bug fixes. \n- Updated parameters tooltip in `addtovault`, `rename`, `cd` and others.\n\n# 3.0.24 (2025-12-22)\n- parameter tooltips (little box that shows up next to the parameter when you type in the command box) are now uniaue for each command. Over the next releases, we will update all tooltips for all parameters to make them more clear. The same parameter can be used in multiple commands having different function in each.\n\n# 3.0.23 (2025-12-20)\n- Added [update references command](UPDATEREFERENCES.md)\n\n# 3.0.22 (2025-12-19)\n- Added [copy command](COPY.md)\n\n# 3.0.21 (2025-12-18)\n- Fixed single instance bug. All commands are now executed sequentially. Output is not during commands execution anymore. This was in 3.0.19 and 20\n- Added `getoptions` in [Get](GET.md)\n- Added `checkoutoptions` in [Checkout](CHECKOUT.md)\n\n# 3.0.20 (2025-12-12)\n- Fixed timeout issue with [Export](EXPORT.md) and [RunSwMacro](RUNSWMACRO.md).\n- Added `name`, `filePath` and `value` parameters to [INBOX](INBOX.md). \n- `source` parameter default to current directory in [addtovaultcommmand](ADDTOVAULT.md). \n\n# 3.0.19 (2025-12-11)\n- Added `winlog` parameter for pdmcli.exe. See remarks section of [dump command](DUMP.md).\n- Fixed single instance bug. All commands are now executed sequentially. Output is blocked during commands execution.\n\n# 3.0.18 (2025-12-08)\n- Rebuild. Previous faulty build.\n\n# 3.0.17 (2025-12-08)\n- Fixed single instance issue related to Windows enviornment variables\n- Added note for `solidworks` and `pdm`parameters in the [Version](VERSION.md) command: **RESERVED FOR FUTURE. NOT IMPLEMENTED** \n\n# 3.0.16 (2025-12-07)\n- [Export: Added timeout parameter launching SOLIDWORKS](EXPORT.md).\n- [RunSwMacro: timeout parameter is also enabled for launching SOLIDWORKS](RUNSWMACRO.md).\n- Enforced `.pdmshell` extension across all commands as the scripting file extension.\n# 3.0.15\n- skipped\n\n# 3.0.14 (2025-12-05)\n- [Login: Fix bug with parameter casing](LOGIN.md).\n- [Login: Added implementation with the transition command](TRANSITION.md).\n- Updated documentation\n\n# 3.0.13 (2025-12-04)\n- [VERSIONUPGRADE: Added a new command](VERSIONUPGRADE.md).\n- [VERSIONUPGRADEFROMSOURCE: Added a new command (Reserved but not implemented)](VERSIONUPGRADEFROMSOURCE.md).\n\n# 3.0.12 (2025-12-03)\n- [SetRevisionFromSource: Added a new command](SETREVISIONFROMSOURCE.md).\n\n# 3.0.11 (2025-12-02)\n- [SetRevision: Added a new command](SETREVISION.md).\n - Fixed evaluation bug: Bracketed variable `[Variable]` fail to evaluate in `name` and `value` parameters\n\n# 3.0.10 (2025-12-01)\n- Rebuild\n\n# 3.0.9 (2025-12-01)\n - [INFOVAR: Fixed bug with related to single flag variables](INFOVAR.md) \n - [SETVAR: Added support for handling folder cards](SETVAR.md) \n\n# 3.0.8 (2025-11-30)\n - Fixed unhandled exception when license is limited that causes a crash in all commands\n - Fixed evaluation bug (order)\n - Fixed some minor bugs in BOM command\n\n# 3.0.7 (2025-11-29)\n - [BOM: Added a new command](BOM.md). Please see notes [here](howtoinstall.md#common-update-issues) about new commands in the **Common Update Issues** section.\n - [Added `$configuration` placeholder](EVAL.md)\n - Added release notes page\n - Fixed some minor typos for the delete and destroy commands\n - Change toolbar icons and tooltips for better UX",
612613
"keywords": [
613614
"releasenotes"
614615
],

0 commit comments

Comments
 (0)