- "content": "Overview\n\n<div style=\"position: relative; padding-bottom: 42.1875%; height: 0;\"><iframe src=\"https://www.loom.com/embed/8dd02ac8f0fa43a48541b04bc3ef114f\" frameborder=\"0\" webkitallowfullscreen mozallowfullscreen allowfullscreen style=\"position: absolute; top: 0; left: 0; width: 100%; height: 100%;\"></iframe></div>\n\n---\n\n**TaskScript** is a custom PDM task add-in developed by **Blue Byte Systems Inc.** that allows you to execute **PDMShell scripts** the same way you would use the built-in **Convert** task.\n\nTaskScript is found in your Blue Byte Systems Inc [account](https://bluebyte.biz/account) for users with the premium version (active license). You can download also TaskScript using [PDMDeploy](https://docs.bluebyte.biz/src/cdpdm.html).\n\nWith TaskScript, administrators can create configurable tasks that run custom `.pdmshell` scripts using the `pdmcli` engine on selected files within the vault.\n\nKey Features\n\n- Execute PDMShell commands in response to PDM task triggers\n- Dynamic script editing and variable binding\n- Reuses existing scripts stored locally or downloaded\n- Supports file filtering based on extensions\n- Evaluates placeholders like `$fileName`, `$localPath`, and more\n- Handles script failure with detailed logging\n\n---\n\nPDMShell Scrit page\n\n\n### 1. **Available Scripts (BLUE BYTE SYSTEMS)**\n\n- A dropdown list showing available `.pdmshell` scripts.\n- These can be downloaded.\n- Selecting a script from the list loads it into the editor.\n\n### 2. **Buttons**\n\n- **DOWNLOAD SELECTED** \n Downloads the currently selected script file.\n\n- **REQUEST A SCRIPT** \n Opens a preformatted email to `amen@bluebyte.biz` with the subject **\"Script Request\"**.\n\n- **REFRESH** \n Reloads the available script list.\n\n### 3. Script Editor\n\n- A multi-line editable area for entering or modifying `.pdmshell` scripts.\n- Lines starting with `#` are treated as **comments**.\n- Syntax highlighting shows comments in *italic green* for better readability.\n\n### 4. Extensions and test button\n - Specify the extensions to process.\n - **TEST WITH FILE** allows to test your script before running it.\n---\n\nExample Script\n\ncd/\nprint -id $id\n\nYou can request a script by emailing us via the Request Script button.\n\nRemarks\n\n- You can include the extensions: `sldprt;sldasm;slddrw` are the default value.\n- TaskScript will run PDMShell sessions on all affected documents by the task.\n- Do not forget to set the Command Menu tab.\n\nPlaceholder Variables\n\nTaskScript supports dynamic variables that are replaced at runtime for each selected file. Below is a list of available placeholders:\n\n| Placeholder | Description |\n|-----------------------------|------------------------------------------------------------------|\n| `$localPath` | Full local path to the selected file |\n| `$fileName` | File name (including extension) |\n| `$fileNameWithoutExtension` | File name without the extension |\n| `$name` | Alias for file name |\n| `$extension` | File extension |\n| `$id` | Internal PDM file ID |\n| `$GUID` | Unique Identifier |\n| `$taskName` | Name of the running task |\n| `$folderPath` | Full local path to the file's parent folder |\n| `$folderID` | Internal PDM folder ID |\n| `$vaultName` | Name of the vault the file belongs to |\n| `$vaultRootFolder` | Local root path of the vault |\n| `$(Variable.Configuration)` | Value of a custom PDM variable for a given configuration |\n| `$machineName` | Name of the current machine |\n| `$computerName` | Alias for machine name |\n| `$userName` | Logged-in PDM user name |\n| `$windowsUser` | Windows user name |\n| `$userDomain` | Windows domain name |\n| `$domain` | Alias for domain name |\n| `$yyyy` | Current year (4 digits) |\n| `$yy` | Current year (2 digits) |\n| `$MM` | Month (2 digits) |\n| `$M` | Month (no leading zero) |\n| `$dd` | Day (2 digits) |\n| `$d` | Day (no leading zero) |\n| `$month` | Full month name (e.g., January) |\n| `$mon` | Short month name (e.g., Jan) |\n| `$day` | Full day name (e.g., Monday) |\n| `$dayShort` | Short day name (e.g., Mon) |\n| `$HH` | Hour (24-hour format) |\n| `$hh` | Hour (12-hour format) |\n| `$mm` | Minutes |\n| `$ss` | Seconds |\n| `$tt` | AM/PM designator |\n| `$timestamp` | Combined date and time (yyyyMMdd_HHmmss) |\n| `$date` | Current date (yyyy-MM-dd) |\n| `$time` | Current time (HH-mm-ss) |\n\n$(Variable.Configuration)\n- Use `@` for the `@` tab. Example: `$(Description.@)`\n- Use empty string for files with no configurations. Example: `$(Description. )`",
0 commit comments