Skip to main content
Version: v0.16.0

NuixRunScript

Alias:NuixRunScript

Output:StringStream

Run an arbitrary ruby script in nuix. It should return a string.

ParameterTypeRequiredPositionDefault ValueRequirementsSummary
FunctionNamestring✔1Version 8.2What to call this function. This will have spaces replaced with underscores and the first character will be made lowercase
ScriptTextstring✔2The text of the script to run
Parametersentity✔3Parameters to send to the script. You can access these by name (with spaces replaced by underscores and the first character lowercase).
EntityStreamParameterarray<entity>4Do not stream entitiesEntities to stream to the script. The parameter name is 'entityStream'