NiFi Ingest 26.1
NiFi Ingest

# PutDigitalSafe

Indexes documents into Digital Safe through the Digital Safe REST API.

## Properties

Name | Default Value | Description
--- | --- | ---
IDOL License Service |  | An IdolLicenseServiceImpl that provides a way to communicate with a Knowledge Discovery License Server.
Proxy Configuration Service |  | A ProxyConfigurationServiceImpl that specifies the proxy server to use.
SSL Config Service |  | An optional IdolSSLConfigServiceImpl that specifies the settings to use to index documents over SSL/TLS.
Document Registry Service |  | A DocumentRegistryServiceImpl that manages and updates a document registry database. This ensures that documents are indexed in the correct order. For more information about the document registry service, see Index Documents in the Correct Sequence.
OAuth Database Service |  | A DatabaseServiceImpl to use to store OAuth tokens in an external database. This is necessary if you want to use the PutDigitalSafe processor on a NiFi cluster. For information about creating the database service, see Create a Database Service.
DigitalSafe base URL | http://localhost/ | The base URL of the Digital Safe. The following URL must be valid, where `DigitalSafeURL/` is replaced by the value of this parameter:
    DigitalSafeURL/rest-api/documents/v1/
Client ID |  | The OAuth application key (client ID) to use to authenticate with Digital Safe.
Client secret |  | The OAuth application secret (client secret) to use to authenticate with Digital Safe.
Refresh token |  | The OAuth refresh token to use to authenticate with Digital Safe.
Sender | admin@testdomain1.digitalsafe.net | The e-mail address that the e-mail message appears to have been sent from. This parameter sets the value of the "envelope sender" when requests are made to the Digital Safe API.
Recipient | admin@testdomain1.digitalsafe.net | The e-mail address that the e-mail message appears to have been sent to. This parameter sets the value of the "envelope recipient" when requests are made to the Digital Safe API.
Username |  | The user name to use to authenticate with Digital Safe. This user name is associated with the OAuth settings that you provide.
File container format | MultipleAsZip | Specifies how to send documents to Digital Safe: MultipleAsZip - If a document has content or one associated file (but not both), the content or file is sent to Digital Safe without being added to a container. Otherwise, the document content and associated file(s) are added to a zip file and sent to Digital Safe. The document metadata are sent separately. ZIP - Any files associated with a document, and the document content, are added to a zip file and sent to Digital Safe. The document metadata are sent separately. EML - Information is sent to Digital Safe in EML format. The document content becomes the body of the message, document metadata fields are flattened and become EML headers, and files are added as attachments.
EML metadata header regex |  | A regular expression that matches document fields that you want to add as EML headers without an "X-" prefix. All other document metadata fields are added as EML headers with an "X-" prefix. Therefore, the regular expression should usually match field names that correspond to standard EML headers such as "To", "From", or "Subject". The connector only sends documents in EML format when you set File container format to "EML". In other cases this property is ignored.
Disable metadata encoding regex |  | To prevent the processor from encoding some metadata fields using RFC1522, use this parameter to identify the fields. This parameter accepts a regular expression. If the name of a field matches the regular expression, the field value is not encoded with RFC1522.

## Relationships

Name | Description
--- | ---
success | FlowFiles that were indexed successfully.
failure | FlowFiles that were not indexed successfully.

Copyright 2018-2025 Open Text
Version 26.1 | Last updated January 2026

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery NiFi Ingest 26.1

Topic Title: PutDigitalSafe