Add a Save to Local Drive/Share activity

Use the Save to Local Drive/Share activity to automatically save documents and their extracted OCR data to a local drive or network share. This activity exports processed documents to a specified file system location without requiring export connectors.

For tenant deployments:

  • Configure this activity to run on the Integration Server.
  • Ensure the Core Worker Service account has write access to the target path.

Procedure
  1. On the Workflow tab, select below the Start node.

    The Add activity dialog box is displayed.

  2. On the Type list, select Capture > Save to Local Drive/Share.
  3. By default, "Save to Local Drive/Share" appears as the Title. You can change the title as needed.
  4. Configure the following properties.
    Property Description
    Input source

    Select the type of input to save. Available options are:

    • Folder: Select a folder variable containing documents to save.

    • Document: Select a document variable to save a single document.

    Destination path

    Specify the file system path where documents should be saved. You can provide a static path (for example, C:\Export\ProcessedDocs or \\NetworkShare\Documents) or select a variable containing the path. Secure server variables are supported.

    The path must be accessible by the Core Worker Service account. No credentials are stored in the activity.

    If the destination path does not exist or the service account lacks write permission, the job is suspended with an error message.
    Output format

    Select the format for the extracted OCR data. Available options are:

    • CSV: Exports data as a CSV file with a header row. The first column is Document ID, followed by extracted field names and their values.

    • JSON: Exports data as JSON files containing extracted fields and raw OCR results in the selected Output Type.

    Output type

    This property appears only when Output format is set to JSON. Available options are:

    • Merged: Creates a single JSON file named by Job GUID containing extracted fields and raw OCR results for all documents.

    • Separate: Creates one JSON file per document named by Document ID, each containing that document's extracted fields and raw OCR results. If a per-document file name already exists, it is renamed with an incrementing suffix ( {docId}_1, {docId}_2, and so on).

    Unzip on save

    Select whether to extract the zip file contents at the destination. Available options are:

    • Yes: The ZIP is extracted at the destination, and the ZIP is then deleted, leaving only the loose files.

    • No (default): The ZIP is saved as-is without extraction.

    On filename collision

    Specify the behavior when a file with the same name already exists at the destination. Available options are:

    • Overwrite: Replaces the existing file with the new file.

    • Rename: Creates a new file with an incrementing number appended ( {guid}_1.zip, {guid}_2.zip, and so on) until a free name is found.

    • Suspend: Suspends the job with an appropriate error message indicating the file collision.

  5. Specify a State to apply when the task becomes available or is pending.
  6. Select Add.

    The Save to Local Drive/Share activity is added to the workflow, and the configured properties are displayed in the properties panel.