Action Approaches

Document generation is triggered through risk actions. Two approaches exist — Approach B (two actions) is recommended for new implementations.

Approach A — Three actions (legacy)

Uses three actions per action group:

1. structured_quote — prices the risk
2. forms_and_subjectivities — clause selection
3. generate_documentation — document generation

This approach separates quoting, clause selection, and generation into distinct steps. It is still supported but creates a more fragmented user experience and more configuration to maintain.

Approach B — Two actions (recommended)

Uses two actions per action group:

1. structured_quote — prices the risk
2. document_creation — clause selection, preview, and generation embedded in one action

Clause selection and preview are embedded within the same document_creation action, delivering a more streamlined user experience with fewer clicks.

Minimum required actions

At minimum, four actions are required for full quote and broker response support:

Action group	Actions
rate	structured_quote, document_creation
broker_response	structured_broker_response, br_document_creation

The rate group handles the quote-side document (e.g. the quote slip). The broker_response group handles the document sent to the broker.

Key additionalProperties for document_creation

The document_creation action requires specific additionalProperties to enable v2 document generation:

Property	Value	Description
embedDocumentGeneration	true	Embeds clause selection and generation in the same action (Approach B)
docGenType	multi-to-multi	Allows multiple documents to be generated at once
hidePrefixFileName	true	Hides the auto-generated filename prefix from the UI
version	3	Specifies document generation v2 at the business class level
allowDocGenPreview	true	Allows users to preview rendered documents before generating the final PDF
canCompleteConfig.requiredGeneratedDocType	DT12 (or relevant code)	Document type that must be generated before the action can be completed

Example action config (Approach B)

{
  "code": "document_creation",
  "label": "Document Creation",
  "actionGroupCode": "rate",
  "actionPrerequisites": ["structured_quote"],
  "embedDocumentGeneration": true,
  "additionalProperties": {
    "docGenType": "multi-to-multi",
    "hidePrefixFileName": true,
    "version": "3",
    "allowDocGenPreview": true,
    "canCompleteConfig": {
      "requiredGeneratedDocType": "DT12"
    }
  }
}

Important

The action group codes (rate, broker_response) must be defined in business-constants/action_group.json before they can be referenced here. See Action Groups.

When to use Approach A

Approach A may still be appropriate if:

• You are migrating from an existing v1 implementation that uses the three-action pattern and want to minimise change
• The business requires clause selection to be a separately tracked, auditable step with its own completion status

In all other cases, Approach B is preferred.