Document Management
Overview
Documents are managed, rendered, and associated in several areas within Socotra:
Configuration: See the Document Resources Configuration Guide for an overview, along with the DocumentConfigRef configuration entity.
Policy Data: As managed by the policy system and using the Document Selection and Document Data Snapshot plugin configuration guides.
Invoice Documents: See the Invoicing Feature Guide.
Direct Attachment and Modification: Described below.
Document Retrieval
Documents can be retrieved by locator with the Fetch Document endpoint. To retrieve all the documents for a given entity, you can use any of these endpoints:
Direct Document Attachment and Modification
Most document creation and updates are configured and then managed automatically, as described in the Overview, above. You can extend this functionality with direct actions as described here.
This can be useful for managing “trailing documents,” which require information that isn’t known at the time of policy or transaction bound time or issue time.
Attaching New Documents
The Attach Document endpoint can be used to inject a new document directly into Socotra and associate it with any of the following types of entities:
Quotes
Policies
Policy Transactions
Policy Terms
Policy Segments
Documents added this way will have their external property set to true to indicate that they weren’t created through normal system behavior.
Documents added this way must be fully rendered before upload, such as a full PDF file. Socotra document templates are not used for producing these documents.
Updating Documents
Documents that already exist in the system can be updated with the Replace Document endpoint. You can change the following:
The
metadatafor the documentThe document
categoryThe document itself
See Also
Document Selection Plugin
Document Data Snapshot Plugin