Hello
Using deadlinecommand, how can I query key/value of a plugin?
I want to get list of all exe/names/labels/tags of my plugin from my app let user specify some details based on what its supported in deadline.
TIA
The information about what options are available in a plugin are typically defined in three places - the .options file, the .param file, and the Python integration script itself.
So while you could use deadlinecommand to figure out where those files are stored for a particular plugin, it would not tell you what is inside those files. You would have to run your own code to scan through their content and figure out what is available.
The results will be different depending on whether you are connected directly to the Repository, or via a Remote Connection Server (in which case copies of the files get cached on a local path to access):
C:\>deadlinecommand -GetRepositoryPath plugins\vray
C:\DeadlineRepository10\plugins\vray
C:\>deadlinecommand -GetRepositoryPath plugins\vray
C:\Users\username\AppData\Local\Thinkbox\Deadline10\cache\QC6Q1XV3ZclisdmBNCBAEbj6oc\plugins\vray
The .options file usually contains the parameters that the plugin supports, and it is used to expose them to the Job Properties’ plugin-specific section as a UI to customize them after submission.
For example, part of the VRay.options file looks like this:
[InputFilename]
Type=filename
Label=Input Filename
Category=Input Options
CategoryOrder=0
Index=0
Description=The input filename to render.
Required=True
DisableIfBlank=false
Default=
[Width]
Type=integer
Minimum=0
Label=Image Width
Category=Output Resolution
CategoryOrder=1
Index=1
Description=The output image width in pixels.
Required=false
DisableIfBlank=true
[Height]
Type=integer
Minimum=0
Label=Image Height
Category=Output Resolution
CategoryOrder=1
Index=2
Description=The output image height in pixels.
Required=false
DisableIfBlank=true
[OutputFilename]
Type=filenamesave
Label=Output Filename
Category=Output Options
CategoryOrder=2
Index=0
Description=The output filename to render to.
Required=True
DisableIfBlank=false
Default=
...
The .param file contains the executable paths defaults and options related to the Task behavior like whether to remap paths. Its content is used to build the Tools > Configure Plugins dialog of the plugin. For example
...
[VRay_RenderExecutable]
Label=V-Ray Executable
Category=Render Executables
CategoryOrder=0
Type=multilinemultifilename
Default=C:\Program Files\Chaos Group\V-Ray\Standalone for x64\bin\x64\vc14\vray.exe;C:\Program Files\Chaos Group\V-Ray\Standalone for x64\bin\x64\vc101\vray.exe;C:\Program Files\Chaos Group\V-Ray\Standalone for x64\bin\x64\vc11\vray.exe;/usr/ChaosGroup/V-Ray/Standalone_for_linux_x64/bin/linux_x64/gcc-4.6/vray;/Applications/ChaosGroup/V-Ray/Standalone_for_mavericks_x64/bin/mavericks_x64/gcc-4.2/vray;/usr/autodesk/mayaIO2017/vray/bin/vray
Description=The path to the V-Ray executable file used for rendering. Enter alternative paths on separate lines.
[EnableVrscenePathMapping]
Type=boolean
Category=Path Mapping For vrscene Files (For Mixed Farms)
CategoryOrder=2
CategoryIndex=0
Label=Enable Path Mapping For vrscene Files
Default=true
Description=If enabled, a temporary vrscene file will be created locally on the Worker for rendering and Deadline will do path mapping directly in the vrscene file.
...
In both files, the INI file [Category] names define the names of the parameters supported, and the INI keys contain information about the format, default values, etc.
So once you get the path to these files, you can read them as INI files and get the Categories from them, and parse as needed…