settings_scripts
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
settings_scripts [2023/03/28 10:24] angelos [Parameters & command line arguments] |
settings_scripts [2023/11/22 17:58] (current) chris |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ===== External script ===== | ===== External script ===== | ||
| - | External scripts is the functionality provided by PMA.core to configure and execute command line programs via PMA.core itself. | + | External scripts are a method provided by PMA.core to configure and execute command line programs via PMA.core itself. |
| {{ ::external_scripts.jpg?600 |}} | {{ ::external_scripts.jpg?600 |}} | ||
| Line 7: | Line 7: | ||
| To configure a new script you need to provide the following information describing the application you want to execute and the parameters passed to it | To configure a new script you need to provide the following information describing the application you want to execute and the parameters passed to it | ||
| ^ Setting ^ Description ^ | ^ Setting ^ Description ^ | ||
| - | |Name| A unique name for the script used to fetch it and distinguish from others| | + | |Name| A unique name for the script, used to fetch and distinguish from other scripts| |
| - | |Command| The command line to execute, a batch file, cmd file or exe| | + | |Command| The command line to execute, a batch file, cmd or .exe file| |
| |Arguments| The arguments passed to the script | | |Arguments| The arguments passed to the script | | ||
| |Parameters| A dynamic list of parameters passed to the script by PMA.core| | |Parameters| A dynamic list of parameters passed to the script by PMA.core| | ||
| Line 20: | Line 20: | ||
| ==== Parameters & command line arguments ==== | ==== Parameters & command line arguments ==== | ||
| - | The parameters define which query string parameters should PMA.core attempt to parse from the URL, when a script is invoked. Then, the values of these parameters can be passed as command line arguments to the script, provided that they also appear in the arguments list enveloped with braces. | + | The parameters define which query string parameters PMA.core should attempt to parse from the URL when a script is invoked. Then, the values of these parameters can be passed as command line arguments to the script, provided that they also appear in the arguments list contained within the braces. |
| Here's an example: | Here's an example: | ||
| Line 37: | Line 37: | ||
| - | Then PMA.core would extract and validate the values "images/collection1/slide1.svs" and "10" and pass them on to the command, by replacing {slide_path} and {some_number} respectively. This would end up looking like this: | + | Then PMA.core would extract and validate the values "images/collection1/slide1.svs" and "10" and pass them on to the command, by replacing {slide_path} and {some_number} respectively. The resulting script looks like this: |
settings_scripts.txt · Last modified: 2023/11/22 17:58 by chris
