RUNS A CUSTOM APPLICATION TO WORK WITH PROVIDED FILES¶
Launches a user-defined executable against a working directory of simulation or data files, optionally writing a commands file and injecting environment variables before execution. Use this worker to integrate any external tool or script into a d3VIEW workflow when no purpose-built worker exists.
When to use¶
Tagged: commands_file, custom_application, env_vars, executable, files, generic, local_execution, shell.
Inputs¶
| Label | ID | Type | Default | Required | Description |
|---|---|---|---|---|---|
| Executable | application_exe | textarea | — | Absolute or relative path to the binary or script to execute (e.g. /usr/local/bin/myapp); required for local execution but ignored when an SSH Profile is selected, in which case the profile’s whitelisted command is used. | |
| Application Commands | application_commands | textarea | — | Body of a commands file written to disk before execution; use DATA_SOURCE and OUTPUT_DIR as placeholder variables for the input and output directory paths — leave blank if the executable does not consume a commands file. | |
| Application Args | application_args | textarea | c=commands.cfile | ✓ | Command-line arguments passed directly to the executable (e.g. ‘c=commands.cfile’); defaults to ‘c=commands.cfile’ to point the application at the generated commands file. |
| Environment Variables | application_env | textarea | — | Additional environment variables injected at runtime, one per line in NAME=VALUE format (e.g. OMP_NUM_THREADS=4); leave blank to inherit the process environment unchanged. | |
| Application Commands Type | application_commands_content_type | select | — | MIME / content type of the commands file (currently only ‘Text’ is supported); controls how the commands content is serialized before being written to disk. | |
| File Name | application_commands_write_filename | text | commands.cfile | Filename under which the commands content is saved in the working directory before the executable is launched; defaults to ‘commands.cfile’. | |
| Needs Graphics | needs_graphics | select | yes | Set to ‘Yes’ (default) if the application requires a display or GPU context; set to ‘No’ for headless/CLI-only tools to avoid allocating an unnecessary graphics resource. | |
| Files | files | file | — | Up to 100 input files (must be accessible on all d3VIEW servers and compute nodes) that are staged into the working directory before the executable runs. | |
| Input Files Dataset | input_files_ds | dataset | — | Dataset whose ‘path’ and ‘name’ columns enumerate additional input files to copy into the working directory before execution; takes precedence over or supplements the ‘files’ input. | |
| Save Files | save_files | select | no | Set to ‘Yes’ to capture output files from the working directory as workflow attachments; defaults to ‘No’ to skip attachment saving and reduce storage overhead. | |
| SSH Profile | ssh_profile | remote_lookup | — | Select an admin-configured SSH profile for remote execution. Leave empty for local execution. | |
| SSH Command | ssh_command | text | — | Name of the whitelisted command from the SSH profile to execute (e.g. Peacock). Must match a command configured in the selected profile. | |
| Execution Timeout (seconds) | execution_timeout | number | 600 | Maximum seconds to wait for the remote command to finish (SSH path only). Increase for long-running solvers or large model parses. | |
| Inject Active User Credentials | inject_active_user_credentials | select | no | When Yes, the worker exports SOLVERAI_USER and SOLVERAI_API_KEY from the active d3VIEW user into the remote shell (SSH path only). Overrides values from the SSH profile’s env_setup script; still overridable by the Environment Variables input. Use for workers like Peacock that authenticate back to the platform. |
Outputs¶
| Label | ID | Type | Description |
|---|---|---|---|
| Files | files | dataset | Dataset listing all files present in the output directory after the application finishes, with path and name columns for downstream workers to consume. |
| Attachments | attachments | dataset | Dataset of output files saved as platform attachments (only populated when ‘Save Files’ is set to ‘Yes’). |
| STDOUT | stdout | textarea | Full standard-output text captured from the application process; useful for logging, result parsing, or pass/fail checks in downstream workers. |
| STDERR | stderr | textarea | Full standard-error text captured from the application process; inspect this output first when diagnosing execution failures or warnings. |
Disciplines¶
- data.io.file
- platform.job_submission
- platform.workflow
Auto-generated from platform schema. Worker id: custom_application. Schema hash: 3a88c5a30e33. Hand-curated docs in workerexamples/ override this page when present.