Skip to content

Add Document

The Add Document node is a utility task that downloads a specified file from a known document path and makes it available for downstream tasks by adding it to the automation’s internal data dictionary. This is useful when you want to bring external files into the workflow for later use, such as in parsing, uploading, or transformation tasks.


🧩 Node Type

  • Task
  • TaskType: Add Document

🔧 Inputs

LabelTypeDescription
Document to addTextThe full server-side file path to download and add to the automation data.

⚠️ The file must be accessible via the server's configured download route and use a compatible path format.


📤 Outputs

This task dynamically creates a new output in the automation’s data dictionary with the key being the file name (without extension) and the value being the local path to the downloaded file. This can be used in subsequent nodes by referencing {YourFileName}.

Example: If Document to add is /files/test.docx, a new data variable named test will be available.


🧠 Behavior

  • Validates that the input Document to add is provided.

  • Extracts the file name and downloads it to the automation’s working directory.

  • Adds the downloaded file’s path to the automation’s internal dictionary using the file name (without extension) as the key.

  • On success:

    • taskSuccess = true
    • statusReturn = Completed
  • On failure (e.g., if the file cannot be downloaded):

    • taskSuccess = false
    • statusReturn = Fail
    • An error message is returned in taskMessage.

💡 Common Use Cases

  • Load a static template document into the workflow.
  • Prepare input files for processing by other nodes (e.g., parsing, conversion).
  • Collect audit or reference files at runtime.

❗ Notes

  • The file must reside on a location accessible to the server (e.g., network share, internal document repository).
  • This task does not modify or transform the file in any way; it simply retrieves and registers it.

Tentech 2024