|
229 | 229 | "title": "Notes About Running PDMShell Scripts from Dispatch | SOLIDWORKS PDM | Powershell like features for SOLIDWORKS PDM Professional", |
230 | 230 | "summary": "Notes About Running PDMShell Scripts from Dispatch When you want to run PDMShell scripts from Dispatch, you can use the Shell Command action. Shell Command Settings Verb: Leave this field empty. Filename: Specify the path to the PDMShell executable, which is pdmcli.exe. Note Do not wrap the path in quotes (\"\"), even if it contains spaces. Parameters: Use the following format: runscript \"pathToScript\" [additional parameters] The pathToScript must be wrapped in quotes (\"\") if it contains spaces. Additional parameters can be passed to the script as needed. Example: Dispatch Shell Execute Configuration Verb: #leave this empty Filename: C:\\Program Files (x86)\\BLUE BYTE SYSTEMS INC\\PDMShell\\PDMCLI.exe Parameters: runscript \"C:\\Scripts\\frogleap.pdmshell\" \"%PathToSelectedFile%\" \"%OldVersion%\" Example Script: In the PDMShell script (frogleap.pdmshell), you can reference the parameters as follows: # check selected file out checkout -filePath \"$parameter1$\" # frogleap version to specified version frogleap -filePath \"$parameter1$\" -oldVersion \"$parameter2$\" # save changes checkin -filePath \"$parameter1$\" -comment \"prompted version $parameter2$\" # you must call this quit Tutorial Tips for Running PDMShell Scripts from Dispatch Test Your Scripts: Always test your PDMShell scripts independently before integrating them with Dispatch. Use Quotes for Paths: Wrap paths and parameters in quotes (\"\") if they contain spaces to avoid errors." |
231 | 231 | }, |
| 232 | + "src/escapingquotes.html": { |
| 233 | + "href": "src/escapingquotes.html", |
| 234 | + "title": "Quote Escaping Rules for PDMShell | SOLIDWORKS PDM | Powershell like features for SOLIDWORKS PDM Professional", |
| 235 | + "summary": "When calling from command line (cmd.exe or Dispatch): Example 1: Using \\\" in cmd.exe will actually produce \" in the PDMShell session: pdmcli.exe /single help -command \\\"checkout\\\" # This runs the command: help -command \"checkout\" (See above) Example 2: Using \\\\\\\"\" in cmd.exe will actually produce \\\" in the PDMShell session command box which in turn gets evaluated as \" once executed: pdmcli.exe /single setvar -filePath membrane.sldprt -variableName Description -value \\\" 1 \\\\\\\"\" 3\\\" will produce: # >setvar -filePath membrane.sldprt -variableName Description -value \"1 \\\" 3\" # >@: Set Description to 1 \" 3 # \\\" in PDMShell session evaluates to \" When calling from PDMShell regular session: To escape \", use this \\\": setvar -filePath membrane.sldprt -VariableName Description -value \"3/1\" # @: Set Description to 3/1 setvar -filePath membrane.sldprt -VariableName Description -value \"3/\\\"1\" # @: Set Description to 3/\"1 # \\\" escape \" in a regular session" |
| 236 | + }, |
232 | 237 | "src/eula.html": { |
233 | 238 | "href": "src/eula.html", |
234 | 239 | "title": "EULA | PDMShell | SOLIDWORKS PDM | Powershell like features for SOLIDWORKS PDM Professional", |
|
254 | 259 | "title": "PDMShell | Powershell like features for SOLIDWORKS PDM Professional", |
255 | 260 | "summary": "body { background-color: #121212; color: #e0e0e0; font-family: Arial, sans-serif; }git h2 { color: #bb86fc; } p { color: #e0e0e0; } a { color: #bb86fc; text-decoration: none; } a:hover { text-decoration: underline; } .container { display: flex; flex-wrap: wrap; justify-content: center; margin: 20px 0; } .card { background-color: #1f1f1f; border: 1px solid #333; border-radius: 8px; margin: 10px; padding: 20px; width: 300px; text-align: center; } .card img { max-width: 100%; height: auto; border-radius: 8px; } .video-container { background-color: black; width: 100%; padding: 10px; margin: auto; text-align: center; } .video-container video { width: 100%; max-width: 800px; height: auto; border-radius: 8px; } .download-button { display: inline-block; background-color: #bb86fc; color: #ffffff; font-weight: bold; text-transform: uppercase; padding: 10px 20px; border-radius: 8px; margin: 20px 0; text-align: center; } .download-button:hover { background-color: #9b6fcf; } body { background-color: #1a1a1a; margin: 0; font-family: 'Open Sans', sans-serif; } .header-container { display: flex; padding: 10px; margin: auto; align-items: center; gap: 20px; flex-wrap: wrap; } .header-text { color: white; text-shadow: 1px 1px 4px rgba(0, 0, 0, 0.3); font-weight: 600; font-size: 32px; margin: auto; text-transform: uppercase; letter-spacing: 1px; line-height: 1.4; max-width: 600px; } @media (max-width: 768px) { .header-container { flex-direction: column; align-items: flex-start; } } PowerShell-Like Features For SOLIDWORKS PDM Professional This video autoplays silently so you can watch without sound. Unmute if you'd like to hear it. PDMShell, a command-line interpreter designed to streamline and automate tasks within SOLIDWORKS PDM Professional. We also provide helpful articles on PDM best practices and tooling. Before submitting a support ticket, we highly recommend reviewing the documentation and troubleshooting guides available on this site. Click on PDM Commands to get started. DOWNLOAD PDMSHELL DIRECTLY PDMShell is free. PDMShell is free to use and allows you to test all commands with some limits without committing to a license. To buy a license, please visit the Blue Byte Systems online shop. Read details below. Find Any File Archive Path Learn how to manage archive paths effectively in PDMShell. Edit Datacards like a Boss Change datacard values for one of many files using the SetVar command. Change Directory Understand how to use the CD command to navigate directories in PDMShell. Checkout, 1, 10 or 1000 Files In One Line Discover how to use the CHECKOUT command to check out files from the vault. List Directory Content Explore the DIR command to list files and folders in the current directory. Concurrent PDM Sessions Learn how to use the LOGIN command to authenticate with the vault. Options Understand the various options available in PDMShell to customize your experience. Power Search Capabilitiy Learn how to use the Search command to find files and folders efficiently. Need more power? Choose Premium. Upgrade to the Premium Version of PDMShell to unlock advanced features that take your productivity to the next level. With the Premium Version, you can: Call PDMShell directly from other applications, enabling seamless integration into your workflows. Run PDMShell as a workflow transition action, automating complex tasks and saving time. Process unlimited number of files. Free version caps at items per search. Take advantage of these powerful features to streamline your PDM operations and enhance your team's efficiency. Buy the Premium Version Now Need more information or want to discuss how PDMShell can fit into your workflow? Schedule a call with us today: Schedule a Call Contact Us For more information or to get in touch with our support team, please refer to the Contact Us page." |
256 | 261 | }, |
| 262 | + "src/instances.html": { |
| 263 | + "href": "src/instances.html", |
| 264 | + "title": "Notes About Running PDMShell in Single Instance Mode | SOLIDWORKS PDM | Powershell like features for SOLIDWORKS PDM Professional", |
| 265 | + "summary": "Notes About Running PDMShell in Single Instance Mode PDMShell can run in two modes: Multi Instance Mode (default) Single Instance Mode (one controller instance, all commands routed to it) Single instance mode is useful when you want: faster execution for multiple commands automation pipelines that require sequential execution Single Instance Mode Overview To enable Single Instance Mode, start PDMShell using: pdmcli.exe /single or pdmcli.exe -single When PDMShell is running in Single Instance Mode, you’ll see a single-instance indicator in the top-right corner of the window. It shows a “1” icon, confirming that all commands will be routed to this instance from other single instances. If PDMShell is not running in single instance mode, the indicator will display an infinity symbol (∞), meaning multiple PDMShell instances are allowed and each command launches independently in its own PDMShell process. With single instance, you can: ✅ launch PDMShell as a single instance controller ✅ allow subsequent commands to reuse the same PDMShell instance ✅ improve performance if triggered from cmd.exe or Dispatch ✅ prevent multiple conflicting PDMShell instances UAC, Permissions, and Single Instance Mode PDMShell’s Single Instance Mode relies on Windows’ global mutex system. Because of this, User Account Control (UAC) and process elevation matter. To attach to the single instance, you must ensure that: If the first instance is started as Admin, all following calls must also run as Admin If the first instance is started without elevation, all following calls must also run without elevation Warning Avoid running PDMShell as a Windows Administrator if you have custom add-ins installed. Check-in and check-out commands can create instances of your add-in inside the host application's memory. If the add-in was registered under a different user or UAC level, PDM will throw a “Class not registered” error. Executing Commands in Single Instance Mode Once PDMShell is running with /single, all subsequent calls to pdmcli.exe must also include /single, or PDMShell will launch a new instance instead of attaching. Example: pdmcli.exe \"/single help command checkout\" This will: connect to the already running instance execute help command checkout return output immediately Tips for Single Instance Mode Always include /single in every call Use proper quote escaping when calling from Dispatch Use Single Instance mode for sequences of operations Use Multi Instance mode for isolated one-shot commands" |
| 266 | + }, |
257 | 267 | "src/introduction.html": { |
258 | 268 | "href": "src/introduction.html", |
259 | 269 | "title": "Getting Started | PDMShell | SOLIDWORKS PDM | Powershell like features for SOLIDWORKS PDM Professional", |
260 | | - "summary": "Introduction to PDMShell Welcome to PDMShell, the command-line interpreter designed specifically for SOLIDWORKS PDM Professional. PDMShell empowers engineers and IT professionals with a powerful, flexible, and efficient tool for automating and streamlining tasks within the SOLIDWORKS PDM environment. Using the Help System PDMShell provides a comprehensive help system and detailed command documentation to guide you through its features. Here's how to get started: To view a list of all available commands, type: help To get detailed information about a specific command, type: help -command <command> For example: help -command cd Understanding the Command Documentation Structure Each command page in PDMShell documentation is organized into the following sections: DESCRIPTION: A brief explanation of what the command does. SYNTAX: The syntax for using the command, including required and optional parameters. PARAMETERS: A detailed explanation of each parameter, including whether it is required or optional. EXAMPLES: Practical examples of how to use the command. REMARKS: Additional notes, tips, or special considerations for using the command. TUTORIAL: A short video tutorial demonstrating the command in action (if available). Example Command Documentation Here’s an example of how a command is documented: CD Command Documentation DESCRIPTION: Changes the current PDM directory. SYNTAX: cd [-directory|-id] PARAMETERS: directory: The directory to switch to. The directory parameter can be a relative or absolute path in PDM. id: ID of the folder to navigate to. EXAMPLES: cd -directory 'C:\\Vault\\NewFolder' # Navigates to NewFolder cd -id 755 # Navigates to the folder with ID 755 REMARKS: Use cd.. to navigate to the parent folder or cd\\ to navigate to the root of the vault. If you just created a new folder and want to cd to it using autocomplete, use the dir command with the -refresh parameter to reload the session. directory is the default parameter, so you don’t need to specify it if it’s the only parameter in your command. TUTORIAL: By following this structure, you can quickly learn how to use any command in PDMShell and integrate it into your workflows. \uD83D\uDCDE Getting Support If you need assistance or have any questions, we're here to help! Contact Us: Click the button below to reach out to our support team: Get Support Thank you for choosing PDMShell! We’re excited to help you streamline your PDM workflows and unlock new levels of productivity." |
| 270 | + "summary": "Introduction to PDMShell Welcome to PDMShell, the command-line interpreter designed specifically for SOLIDWORKS PDM Professional. PDMShell empowers engineers and IT professionals with a powerful, flexible, and efficient tool for automating and streamlining tasks within the SOLIDWORKS PDM environment. Using the Help System PDMShell provides a comprehensive help system and detailed command documentation to guide you through its features. Here's how to get started: To view a list of all available commands, type: help To get detailed information about a specific command, type: help -command <command> For example: help -command cd Understanding the Command Documentation Structure Each command page in PDMShell documentation is organized into the following sections: DESCRIPTION: A brief explanation of what the command does. SYNTAX: The syntax for using the command, including required and optional parameters. PARAMETERS: A detailed explanation of each parameter, including whether it is required or optional. EXAMPLES: Practical examples of how to use the command. REMARKS: Additional notes, tips, or special considerations for using the command. TUTORIAL: A short video tutorial demonstrating the command in action (if available). Example Command Documentation Here’s an example of how a command is documented: CD Command Documentation DESCRIPTION: Changes the current PDM directory. SYNTAX: cd [-directory|-id] PARAMETERS: directory: The directory to switch to. The directory parameter can be a relative or absolute path in PDM. id: ID of the folder to navigate to. EXAMPLES: cd -directory 'C:\\Vault\\NewFolder' # Navigates to NewFolder cd -id 755 # Navigates to the folder with ID 755 REMARKS: Use cd.. to navigate to the parent folder or cd\\ to navigate to the root of the vault. If you just created a new folder and want to cd to it using autocomplete, use the dir command with the -refresh parameter to reload the session. directory is the default parameter, so you don’t need to specify it if it’s the only parameter in your command. Case Sensitivity As of PDMShell 3.0.1, all command names, parameter names, and values are case-sensitive. Escaping Quotes Escaping quotes when passing arguments to PDMShell depends on where the command originates. Please read this dedicated article. TUTORIAL: By following this structure, you can quickly learn how to use any command in PDMShell and integrate it into your workflows. \uD83D\uDCDE Getting Support If you need assistance or have any questions, we're here to help! Contact Us: Click the button below to reach out to our support team: Get Support Thank you for choosing PDMShell! We’re excited to help you streamline your PDM workflows and unlock new levels of productivity." |
261 | 271 | }, |
262 | 272 | "src/parameter_short_format.html": { |
263 | 273 | "href": "src/parameter_short_format.html", |
|
0 commit comments