BriteDocs core concepts

BriteDocs is responsible for create, read, update, and delete (CRUD) operations on deliverable templates, which define the content and presentation of a document. BriteDocs serves as a deliverable rendering engine for the BriteCore ecosystem and can create/manage the following deliverable types:

  • HTML/Jinja templates
  • Static PDF forms
  • Image assets (.png/.jpeg)

Core concepts

  • Asset: Assets are CSS and image files that a user can import into a deliverable for customization.
  • Association for Cooperative Operations Research and Development (ACORD): ACORD is the global standards-setting body for the insurance and related financial services industries (non-profit, industry-owned organization).
  • Data point: A data point is information generated by other systems that a user can use on a deliverable, such as a recipient, policy number, etc.
  • Deliverable: A deliverable is any document produced by BriteCore.
  • Draft version: All deliverables created in BriteDocs have draft versions. They’re intended to give the person building it the ability to preview the deliverable without changing the one in place in production.
  • Effective date: When someone sets an effective date into a draft version BriteDocs freezes its contents—no changes can be made to it. From that date forward, this specific version will be used to render deliverables.

Note: Deliverables’ effective dates in BriteDocs are independent from other products.

  • Effective version: The effective version is the version your clients will receive, print, etc. Effective versions can’t be changed and are defined by effective dates, enabling the ability to generate different deliverables at different points in time.
  • Form: Forms are PDF files attached to some deliverables (mainly declarations) that outline which is an insured, the insuring conditions, what type of loss(es) are covered, and what type of loss(es) are excluded. In BriteDocs, users can fill PDF forms with data points as well and they’re also versioned.
  • Imported documents: Users can import dynamic PDF forms (such as ACORD) into BriteCore and integrate them into their workflow.
  • Rendering: The rendering engine accepts the document template along with any form data, generates the rendered output, and returns the location of the rendered file.
  • Rendering Location: Rendered documents are stored in an S3 bucket. S3 buckets are organized using a logical hierarchy to ensure that content is discoverable by any service that interacts directly with S3.
  • Template: A Jinja template.