Skip to content

Available Steps ​

Use this reference when authoring a package workflow. For setup, see Packages.

Execution ​

Follow Scripts for parameter, output, and secret-handling guidance.

Run package command ​

Runs a package command or installer invocation. Configure the command, interpreter, whether Ordyn should download the primary package file, and reboot-success exit codes. Install commands download the file by default; uninstall commands leave this option disabled by default.

Linux package commands support Bash and POSIX sh; Windows package commands support PowerShell and CMD.

For a Windows package, the package execution context can use a reusable Windows Account or a templated user. A templated user selects a plain username variable and a secret password variable. During a job, both variables resolve from the package task context, including applicable endpoint, product, package, job, and submitted run values.

Command stdout and stderr use the endpoint agent's bounded process capture. See Agent Runtime Limits.

Package commands start in {{ job.workspace }}. Within a package workflow, {{ package.directory }} resolves to the same shared directory. When Download package file is enabled, {{ package.path }} provides the absolute path to the verified primary package file, so commands can invoke it while using relative paths for configuration and extracted content.

Package commands can write logs or other diagnostics to {{ package.artifact_directory }}. {{ package.log_file }} points at the default package log in the managed diagnostics directory.

Run script ​

Runs a saved endpoint script. Select a saved script and provide any parameters or output bindings it expects.

Run inline script ​

Runs inline script content inside the workflow. Set the interpreter, script content, output mode, optional output schema, output bindings, and reboot-success exit codes.

Linux inline scripts support Bash and POSIX sh; Windows inline scripts support PowerShell and CMD.

Inline script stdout, stderr, and cancellation follow the agent process limits.

Inline scripts can use {{ job.workspace }} or {{ package.directory }} for files shared with later workflow steps. Use {{ package.artifact_directory }} and {{ package.log_file }} for files that a later collect-artifact step should upload.

To use {{ package.path }} in an inline script, add Stage package file for the primary file before the script. Every branch that can reach the script must stage the primary file. A staging step inside a loop does not provide the path after that loop.

Matching credential-backed Windows package commands, scripts, and GUI replay steps in one job target share a Windows logon session. This allows user-session state such as mapped drives to remain available across those steps. See Session reuse within a job.

Control flow ​

End job ​

Ends the current endpoint target after any remaining Always workflow steps finish. Choose whether the target should finish as aborted or succeeded, and optionally add a message.

If branch ​

Run the then or else branch based on endpoint values, variables, or earlier results. Use expressions to write the condition; store a reused result in job.vars when several later steps need it.

Loops ​

For each ​

Evaluates an items expression and runs the body once per item. Set the items expression, item variable, optional index variable, and maximum iteration count, then add body steps. Replay GUI automation steps are not supported inside loop bodies. Keep GUI replay at top level or inside branches outside the loop.

While loop ​

Re-evaluates a condition and repeats the body until it becomes false or the maximum iterations is reached. Set the condition, optional maximum iteration count, and the body steps. Replay GUI automation steps are not supported inside loop bodies. Keep GUI replay at top level or inside branches outside the loop. The condition editor supports the same string operators and variable override checks as If branch.

Variables & data ​

Set job variable ​

Stores a runtime value under job.vars for later workflow branches and steps. Set the variable name and the expression that should populate job.vars.

Read key/value file value ​

Reads a key from a dotenv or INI file. Set the file path, file format, and key to read.

Write key/value file value ​

Sets, updates, clears, or deletes a key in a dotenv or INI file. Set the file path, file format, key, write operation, and value when you choose Set or Update existing. Update existing succeeds without writing when the file, section, or key is missing, and never creates them.

Messaging ​

Log message ​

Record a templated message in job history to explain the values used by this workflow. Use Log message for shared behavior and output limits.

Process & service management ​

Inspect process ​

Checks whether matching processes are running by name or PID and reports the matches. Choose whether to search by name or PID, then set the match mode when you use the name search.

Terminate process ​

Terminates one or more matching processes before or after package execution. Set the process name, match mode, force behavior, and whether child processes should be included. Use the scope setting to target the whole device, all sessions for a Windows account, or a specific Windows session ID. In self-service workflows, {{ trigger.self_service.source_session_id }} targets the session that launched the portal request.

User messages ​

Choice prompt ​

Shows a prompt on the endpoint and waits for the user to select one of the configured choices. The selected value can be stored for later package workflow branches and steps.

Choose the display target:

  • All active sessions: show the prompt to every active signed-in Windows session.
  • Specific Windows session ID: show the prompt only in the selected Windows session.

On Windows endpoints with multiple active sessions, choose a specific Windows session ID for choice prompts. In self-service workflows, use {{ trigger.self_service.source_session_id }} to target the session that launched the portal request.

Notification ​

Shows a non-blocking message on the endpoint. Notifications can auto-close after the configured duration.

Choose the display target:

  • All active sessions: show the notification to every active signed-in Windows session.
  • Specific Windows session ID: show the notification only in the selected Windows session.

In self-service workflows, use {{ trigger.self_service.source_session_id }} to show the notification in the session that launched the portal request.

Services ​

Inspect service ​

Checks whether the selected service exists and reports its current state. Select the service name.

Start service ​

Starts the selected service. Select the service name.

Stop service ​

Stops the selected service. Select the service name.

Restart service ​

Restarts the selected service. Select the service name.

Artifacts ​

Stage package file ​

Stages package content in {{ job.workspace }} for later workflow steps.

Select Primary file to stage the package installer and expose its verified absolute path as {{ package.path }}. Select Staged install archive to place an attached ZIP in the workspace without extracting it.

Later steps can use the file only after its download succeeds.

Collect artifact ​

Collects files or logs as workflow artifacts. Set the artifact paths to collect.

Use {{ package.artifact_directory }} to collect files written by earlier package workflow steps, for example {{ package.artifact_directory }}\*.log.

Artifact paths support runtime environment references such as {{ env.TEMP }}\installer.log, {{ env["ProgramFiles(x86)"] }}\Vendor\*.log, or {{ env.TMPDIR }}/package/*.log. Ordyn resolves each reference once before matching. Windows names are case-insensitive; Linux names are case-sensitive. A missing variable fails the collection step with the variable name in the error.

Package artifact collection inherits the package workflow's Windows execution context, so user-specific paths and environment values match the package steps. Prefer {{ package.artifact_directory }} and {{ package.log_file }} for files that do not need a user-specific location.

Directories are collected recursively, duplicate source files are collected once, and symbolic links are skipped. A matched file that cannot be read or staged fails the collection step.

Extract staged install archive ​

Stages and extracts an attached staged install ZIP directly into {{ job.workspace }}. The ZIP's internal paths are preserved exactly; Ordyn does not add or remove a containing folder. A separate Stage package file step is not required for the selected archive.

Select the staged install archive to unpack. If an archive file conflicts with an existing workspace path, the step fails without overwriting the existing file.

Large archives must fit the limits in Agent Runtime Limits for the entry, expanded-size, depth, ratio, and disk-headroom limits.

Filesystem ​

Inspect file ​

Checks whether a file exists and reports its metadata. Set the file path.

Read file ​

Reads a text file from the endpoint filesystem. Set the file path, and choose the encoding and read limit if needed.

Write file ​

Writes inline content to a file on the endpoint filesystem. Set the file path, content, encoding, overwrite behavior, and whether Ordyn should create the parent folder. Use Place file when the source is a stored Ordyn file.

Place file ​

Places a stored Ordyn file onto the endpoint filesystem. Set the target path, uploaded file, optional file name, overwrite behavior, and parent-folder handling. Template rendering accepts valid UTF-8 text files of up to 10 MiB. Leave it disabled to copy the file bytes unchanged.

Delete file ​

Deletes a file from the endpoint filesystem. Set the file path.

Retrieve file ​

Retrieves one or more files from the endpoint into Ordyn storage. Set one or more source paths and an optional archive name.

Inspect directory ​

Checks whether a directory exists and reports its metadata. Set the directory path.

List directory ​

Lists files and folders from the endpoint filesystem. Set the directory path and, if needed, recursive listing, maximum depth, and entry limits.

Create directory ​

Creates a directory on the endpoint filesystem. Set the directory path and whether recursive handling is allowed.

Delete directory ​

Deletes a directory from the endpoint filesystem. Set the directory path and whether recursive handling is allowed.

Retrieve directory ​

Retrieves a directory as a ZIP from the endpoint into Ordyn storage. Set the directory path and an optional archive name.

Registry ​

Inspect registry key ​

Checks whether a Windows registry key exists and reports its metadata. Set the registry hive and path.

List registry key ​

Lists subkeys and values under a Windows registry key. Set the registry hive and path.

Create registry key ​

Creates a Windows registry key if it does not exist. Set the registry hive and path.

Delete registry key ​

Deletes a Windows registry key, optionally recursively. Set the registry hive and path, and choose whether recursive deletion is allowed.

Inspect registry value ​

Checks whether a Windows registry value exists and reports its metadata. Set the registry hive, key path, and value name.

Read registry value ​

Reads a Windows registry value from the endpoint. Set the registry hive, key path, and value name.

Write registry value ​

Creates or updates a Windows registry value on the endpoint. Set the registry hive, key path, value name, value type, and value data.

Delete registry value ​

Deletes a Windows registry value from the endpoint. Set the registry hive, key path, and value name.

Retrieve registry key ​

Exports a Windows registry key into Ordyn as a .reg file. Set the registry hive, key path, and an optional file name for the export.

Automation ​

Wait for Windows desktop readiness ​

Waits until Windows setup/OOBE handoff is complete, Windows Update servicing is idle, no shutdown or restart is in progress, and either a usable desktop or a normal logon screen remains stable. A pending-reboot report is informational and does not trigger a restart or block an otherwise idle endpoint. A reboot during managed preparation can delay the workflow until the Agent reconnects and is ready.

Inspect desktop session ​

Inspects the active Windows console session.

Desktop logon ​

Logs on to the active Windows desktop using the package Windows execution context. Choose the desktop logon user mode and, when needed, either a Windows Account or Templated user. A templated user requires a plain username variable and a secret password variable. A step-level selection overrides the package execution context for that desktop logon. When the step creates a managed login, Ordyn preserves the Windows sign-in identity selected before the step. When you author it manually, add a matching Desktop logoff cleanup step unless the workflow intentionally leaves the user session active.

Lock desktop input ​

Locks local keyboard and mouse input until an unlock step or emergency PIN releases it. When you author it manually, add a matching Unlock desktop input cleanup step that runs even when replay fails.

Unlock desktop input ​

Releases the current Ordyn keyboard and mouse input lock.

Desktop logoff ​

Logs off the active Windows console session.

Replay GUI automation ​

Replay an uploaded recording using the package's launch settings and Windows execution context. Enable package-file download if replay needs the uploaded installer.

Keep Manage desktop preparation enabled to prepare and clean up the desktop. An existing unlocked console session can be reused; otherwise Ordyn creates a managed login. Disable managed preparation only when the workflow provides its own desktop-control steps and cleanup.

GUI replay cannot run inside loop bodies. See GUI automation and Windows execution contexts for session requirements.

Other ​

Prompt user ​

Prompts the logged-in user and stores the selected button value under job.vars. Set the prompt title, message, buttons, default button value, target variable, and display target. For self-service workflows, use {{ trigger.self_service.source_session_id }} as the Windows session ID when the prompt should appear in the session that launched the portal request.