File Read activity

  • Release version: Yokohama
  • Updated January 30, 2025
  • 1 minute to read

    • The File Read activity reads a file on a Linux or UNIX computer.

    This activity replaces an SSH activity by the same name available in releases prior to Geneva. If you have a workflow created in a previous version that uses the deprecated activity, your workflow will continue to work normally after upgrading to Geneva. However, all new workflows must use the custom version of this activity. This activity was built with the SSH activity designer template, which gives workflow administrators the ability to store input and output variables in the databus.

    To access this activity in the Workflow Editor, select the Custom tab, and then navigate to Custom Activities > Global > Orchestration - SSH.

    Input variables

    Table 1. File read input variables
    Input variable Description
    Hostname Hostname or IP address of the destination server for SSH activity.
    Directory Name of the working directory.
    File The name of the file to read.

    Output variables

    Table 2. File read output variables
    Output variable Description
    contents Content of the file to read.
    result Either success or failure.
    errorMessage The executionResult.errorMessages from the Activity designer parsing sources.

    Conditions

    Table 3. File Read conditions
    Condition Description
    Success Activity successfully read the contents of the specified file.
    Failure Activity could not read the contents of the specified file.