Files

File Object

Expression Language and Variable Picker Support

Using the Variable Picker

1. Open the variable picker and expand the files section.
2. Select the file variable you want to use. In the example below, the variable is named WorkingDirectory.

3. Choose the property required by the action: File Identifier, File Path, or File Size. For the example variable, these appear as WorkingDirectory|identifier, WorkingDirectory|path, and WorkingDirectory|size.

Using Expressions

{{get_file("WorkingDirectory").identifier}}
{{get_file("WorkingDirectory").path}}
{{get_file("WorkingDirectory").size}}

{{get_file("WorkingDirectory")}}

Files Uploaded Through Input Parameters and Web Forms

Optional File Fields

A file variable named 'report' was not created during this execution

• If the workflow requires the file: Mark the file field as Required.
• If the file is optional: Add a condition so that steps referencing the file run only when a file was provided. This includes any step that retrieves the file’s path before passing it to another step.

Using a File in Python Code

1. Output the file path in a preceding step. For example, add a Run Bash Script step with the following code:
   printf '%s' "{{get_file("report").path}}"
   
   This outputs the resolved file path without a trailing newline. Replace report with the file field’s Parameter Name.
2. Read the file in the Python step. If the preceding Bash step is S1, use:
   file_path = context.steps.S1.output
   
   with open(file_path, "rb") as file:
       data = file.read()
   
   Replace S1 with the identifier of the step that outputs the file path. This example opens the file in binary mode and stores its contents in data.

When Is a Working Directory Needed?

• You want to access an existing file variable: Files uploaded through input parameters or web forms, and files created by Download File From URL, are already available as file variables. Access their paths using {{get_file("name").path}}, replacing name with the file variable’s name. You do not need a working directory or Set File Variable to access these files.
• Your script creates a file that a later step needs: Add a Create Working Directory action, select that directory in the script step, and save the file there. Then use Set File Variable with the same Working Directory to make the file available as a file variable for subsequent steps.
• Your script processes an existing file and you need to preserve the result: Select a working directory in the script step and save the new or updated file there. Then use Set File Variable with the same working directory to make the result available to subsequent steps.

Limitations

Example Use Cases

• Download a file and send it via Slack.
• Create a file using Bash or Python and upload it to a remote server.
• Generate a Steampipe report and send it as an email attachment.