Configure a Save to Local Drive/Share activity
-
Add an activity to the map.
By default, the Configuration tab is open in the properties panel of the activity.
- Change the default Name of the activity to something meaningful.
- On the Type list, select Capture > Save to Local Drive/Share.
-
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.
-
-
Save the process map.
- At runtime, when the Save to Local Drive/Share activity executes, documents are bundled with their OCR data into a zip file named by Job ID (for example, 3f2504e0-4f89-11d3-9a0c-0305e82c3301.zip) and written to the configured destination path.
- In a tenant environment, the activity runs on Integration Server, which is the only valid execution target as the cloud server cannot access on-premise paths.
- In a standard on-premise environment, the activity runs on the on-premise server under the Core Worker Service credentials.
- If the destination path does not exist, the service account lacks write permission, or a disk-full condition occurs, the job is suspended with a descriptive error message identifying the cause.
- Within skins, the destination path can be overridden using static values to support different deployment environments. See Create a skin.