Purpose
When executing Mistika Workflows via the command line (CLI mode), this node permits to change property values passed as command line arguments. It is able to change any property of any node of any workflow.
The node consoleArgsToProperties just needs to appear in the workflow as an island, but it needs to be prioritized via the rank connector (yellow triangles) to make sure that it is executed before the node being changed.
Each argument can be passed as follows:
--WorkflowName.NodeName.PropertyID="New property value"
The full command line syntax is this (it is just one line, even if your reader may split it ... ):
PathToWorkflowsBinary/workflows -r YourWorkflowsFile.mwf --WorkflowName.NodeName.PropertyID="New property value" (multiple arguments are possible)
To find the PropertyID to be used in those commands, just put the pointer over the property that you want and leave it there for a second. The property id will be shown, until you move the pointer again.
The NodeName is not the original node name but its current name (the Object Name property, which the user can rename as necessary).
The double quotes ("") are only necessary for strings with spaces, otherwise they are optional.
Boolean values can be set by using 0 / 1 syntax
If you want to load the .mwf and execute it in interactive mode (with GUI) then you can use -A rather than -r, which also support this node. The -A mode will execute all workflows while showing the GUI (normal user interaction is possible), so it can also be useful for monitoring and visual debugging, even if you plan to use -r for the final command line.
Note that the affected nodes should be already pre-configured to work without missing properties, by putting any valid values in the properties that you plan to change later (also they will serve as default values if you do not change them)
Example:
Let's suppose you save Example.mwf containing a workflow tab named WF1, with these nodes:
Now we will save it as Example.mwf and we will execute this command:
/home/mistika/SGO Apps/Mistika Worfkflows/bin/workflows -r /mnt/MyWorkflows/Example.mwf --WF1.File.url="/mnt/MySourceMedia/MyInputClip.mp4" --WF1.ProRes.enableFrameRange=1 --WF1.ProRes.rangeDuration=100 --WF1.ProRes.rangeFirstFrame=300
That command will change the file to be transcoded to MyInputClip.mp4 , and it will configure the ProRes encoder to render 100 frames starting at frame 300. Then it will execute the worklfow (without showing any GUI) and it will exit.
Note for windows users: We recommend to write the paths using forward slashes ( / ) rather than backward slashes ( \ ), as that will avoid dangerous path conversions. For example we could add another argument for the output path:
--WF1.ProRes.url="D:/MyRenderedMedia/Example1/MyInputClip.mov"
Or just the destination folder, ending it with "/":
--WF1.ProRes.url="D:/MyRenderedMedia/Example1/"
Finally, note that this is a Python node and the source code is provided in the Code property, so that advanced users can customize parameter parsing programatically to better suite their needs.
Standard properties
Object Name
Color
Bypass
Lock
Code
Developer reference (Python - ConsoleArgsToProperties.[Property ID], API Rest - node/ConsoleArgsToProperties/property/[Property ID])
Property Label |
Property ID |
Data |
data |