The PDF provider allows the generation of various types of PDF documents within the Harmoney application. A single implementation is provided, which is an internal service provided as part of the platform.
⚙️ Configuration
Provider fields
Below is an overview of how the PDF Provider utilizes the standard provider fields.
| Mandatory | ||
|---|---|---|
| Identifier | ✅ | Unique identifier for the PDF provider |
| Resource URI | ✅ | The base URL for the PDF service. Example: http://pdf |
Settings
The PDF provider supports the following specific settings:
| Key | Mandatory | |
|---|---|---|
PDF_SEND_EXTERNAL_URI | ❌ | When set to true, external URLs are provided to the PDF service. Otherwise, in-cluster URLs are used. Default: false |
RETURN_DEFINITION | ❌ | When set to true, the PDF service returns JSON definitions instead of the actual PDF binary data. This is primarily used for debugging purposes. A placeholder PDF is generated for further processing. Note: Must be used with LOG_RESPONSE set to true. |
LOG_RESPONSE | ❌ | When set to true, PDF service responses are logged. Required when RETURN_DEFINITION is enabled. Default: false |
PDF Types
The PDF provider supports generating various types of documents:
- Submission PDF: PDF representation of submitted data in investor flows
- Identity PDF: Identity verification documents
- Due Diligence Reports: Various due diligence report formats:
- World Check reports
- SAS AML due diligence reports (APPC)
- LexisNexis reports
- Dow Jones reports
- Dossier Summary: Summary of dossier information
Error Handling
The PDF provider implements comprehensive error handling for various scenarios:
| Error Type | Description | Error Code |
|---|---|---|
| Attachment timeouts | Timeout occurred when retrieving attachments | PDF_SERVICE_TIMEOUT |
| Invalid attachments | Issues with attachments (encrypted, unreadable, unsupported format) | PDF_SERVICE_INVALID_ATTACHMENT or PDF_SERVICE_INVALID_ATTACHMENT_TOO_MANY_PAGES |
| PDF processing timeout | Timeout during PDF generation process | INVALID_PDF |
| Unreadable PDF | PDF is in an unreadable format | INVALID_PDF |
| Encrypted PDF | PDF is encrypted and cannot be processed | ENCRYPTED_PDF |