Step Library Reference

The parameter names in the tables below are the identifiers used in the workflow JSON document. In the Configure panel, the same parameters appear with friendly labels — for example, os_kind appears as Os Kind, requiredGB appears as Required GB, and execution_strategy appears as Execution Strategy. Every panel also offers the Save node result check box, which stores the step output so that a later Switch step can evaluate it; keep it selected — clearing it has no special use in version 1.0.

BigFix: Action Script (Action)

Runs any BigFix ActionScript code inside the workflow as-is. If the execution of the provided ActionScript fails, the workflow ends with the exit code provided within the ActionScript.

Output: this step does not return any value.

BigFix: Relevance (Check)

Evaluates Relevance and either returns its value (with the return execution strategy) or breaks the workflow when the expression evaluates to false. To use the exit execution strategy, the Relevance must evaluate to a boolean value; if it evaluates to a non-boolean value, the workflow returns the value. For example, product info string of operating system requires return (not boolean), while exists service "acmesrv" works with both return and exit.

Output: boolean — the value of the evaluated Relevance.

BigFix: Script (Action)

Runs a provided Bash, PowerShell, or Batch script.

Output: boolean — true if the execution was successful, false otherwise.

File System: File Copy (Action)

Copies the given file to the destination, with the option to overwrite. If the operation fails, the workflow is interrupted.

Output: boolean — true when the copy was successful, false otherwise.

File System: Directory (Action)

Creates or removes a directory.

Output: boolean — true when the directory is in the desired state, false otherwise.

File System: Dir Exists (Check)

Checks whether the given directory exists or does not exist.

Output: boolean — true when the directory matches the expected state, false otherwise.

File System: Disk Space (Check)

Checks the free disk space on the system drive and reports whether it meets a required threshold.

Output: boolean — true when the free disk space is at least requiredGB, false otherwise.

File System: File Exists (Check)

Checks whether the given path points to the file and the state matches the exists parameter.

Output: boolean — true when the file matches the desired state, false otherwise.

File System: Path Exists (Check)

Checks whether the given path exists and returns whether it points to a directory or a file.

Output: enum — NOTEXISTS (the path does not exist), DIR (the path points to a directory), or FILE (the path points to a file).

Flow Control: Stop (Flow)

Ends the workflow in a Switch branch immediately, keeping the workflow short and clean. You can also provide an explanatory message about the reason.

Output: ends the workflow execution with the provided exit code.

Flow Control: Switch (Flow)

Splits the execution into two or more flows depending on result values from previous steps. There is always a default flow. The order of the branches is the order of evaluation, so the flow enters the first matched branch; in each subsequent branch, the conditions of the branches above were not met. A Switch node cannot be the first step of a workflow. Use a check step with execution_strategy set to exit when no alternate flow is expected, or the dedicated Stop step to exit the workflow at any time. For the branch configuration procedure, see Branching with the Switch step.

Maintenance: Disk Cleanup (Action)

Performs modern disk cleanup on Windows using PowerShell: handles the Recycle Bin, system and user Temp folders, Storage Sense, and DISM Component Store cleanup. When no option is selected, the step still executes and only ensures that the Temp folder exists.

Output: boolean — true when the selected operations were successful, false otherwise.

Operating System: OS (Check)

Evaluates whether the current operating system matches the provided criteria and returns a boolean result. The step always checks os_kind, and optionally refines the match with min_version, arch, and os_edition. When all provided conditions match, the output is true; otherwise it is false. With execution_strategy set to exit, the workflow stops immediately when the condition is false. Example: os_kind = Windows, min_version = 10.0, execution_strategy = return checks for Windows 10 or later and continues with the boolean result.

Output: boolean — true if the device OS matches the criteria, false otherwise.

Operating System: Service (Action)

Manages the service state and startup type: start (start the service; if disabled, first set its startup type to manual), stop (stop without changing the startup type), restart (restart; if disabled, first set the startup type to manual), disable (stop the service and set the startup type to disabled), auto (set the startup type to automatic and start), auto_delayed (automatic delayed start, then start), and manual (set the startup type to manual without changing the running state). The step returns false instead of exiting when validation fails, the service does not exist, the requested state is unsupported, or a service command fails.

Output: boolean — true when all commands for the requested action complete successfully; false when validation or command execution fails.

Operating System: Service State (Check)

Determines whether the monitored service is operating correctly. This check step intentionally does not provide the execution_strategy capability.

Output: enum — the current service status: RUNNING, STOPPED, NOTFOUND, DISABLED, STOPPING, UNKNOWN, STARTING, PAUSED, PAUSING, CONTINUING.

Package: Package Exists (Check)

Checks for installed packages by name and optional version. If Winget is available, the step reads winget list and compares the supplied name and version with each result using case-insensitive exact, wildcard, or regular-expression matching. If Winget is unavailable, the step uses Get-Package, passing the name to -Name and a supplied version to -RequiredVersion. An empty version or * disables version filtering. The output is true when the number of matches is between 1 and expected_instances, inclusive; false when there are no matches or the count exceeds expected_instances. A Winget query failure, an unavailable PackageManagement module on the fallback path, or an unexpected PowerShell exit code fails the step instead of returning false. Examples: name: PuTTY release 0.85 (64-bit); with version: 0.85.0.0; fallback wildcard PuTTY*; Winget regular expression ^(Notepad\+\+.*|7-Zip.*)$.

Output: boolean — true when 1 through expected_instances packages match; false when no packages match or the count exceeds expected_instances.

Package: Package Install (Action)

Uses the BigFix Platform to fetch the installation media from the provided URL, push it to the device, and run the supplied installation command. You must manually supply the size and checksums; the package is validated against the checksum every time the URL is used, and a wrong SHA checksum fails the workflow on the BigFix Platform side. A cached version based on the checksum is used when already cached. Supported media are MSI and executable: for an MSI the step executes msiexec.exe /i <filename> <parameters>; for an executable it runs <filename> <parameters>. There is no single standard for EXE wrappers — refer to the product documentation for silent-install switches, prefer MSI (/quiet /norestart), and always test the installation procedure in a lab first.

Output: boolean — true when the installation was successful, false otherwise.

Package: Package Uninstall (Action)

Finds and uninstalls matching Windows packages. If Winget is available, the step reads winget list, matches by name and optional version (case-insensitive exact, wildcard, or regular expression), and uninstalls each match by its exact Winget package ID with silent and non-interactive options. If Winget is unavailable, the step uses Get-Package and passes each result to Uninstall-Package -Force. An empty version or * disables version filtering. The step stops before uninstalling when there are no matches or the match count exceeds expected_instances. After all uninstall commands report success, the step re-checks the list up to 10 times, waiting two seconds between attempts, and reports success only when no matches remain.

Output: boolean — true only when all uninstall commands report success and the verification query finds no remaining matches; otherwise false.