Topics on this page

Components reference

The example components below are taken from different clients to document as many components as possible.

header

Displays the document header, which includes company logo, address, and minimal policy information.

include_template('@@components/header', defaults=defaults)

  • Receives defaults values as an argument.
  • Conditionally rendered based on `page_title` value.

Functions used

  • get_policy
  • get_revision
  • get_print_date

Settings that affect it

  • reports: dec-embolden-policy-number

mailing-info

Displays document mailing information, which includes insured and agency information.

include_template('@@components/mailing-info', defaults=defaults)

  • Receives defaults value as an argument.

Functions used

  • get_named_insureds:
  • format_address:
  • get_primary_property:
  • get_agency:
  • retrieve_primary_address:

Settings that affect it

  • reports: show-insured-address
  • reports: show-property-address-as-insured-address
  • reports: show-insured-phone
  • reports: show-insured-date-business-started

policy-term-information

Displays policy term information, including effective date, expiration date, and submission payment.

include_template('@@components/policy-term-information, defaults=defaults, two_cols=False)

  • Receive defaults as an argument, and two_cols.
  • If you need only two columns, use two_cols=True; use False for three columns.

Functions used

  • get_policy_term
  • get_submission_amount_text
  • get_revision

Instead of submission payment, some templates might need to display another piece of information such as policy cancellation date, endorsement effective date, etc. You can control which one to display with conditionals based on the page_title of the deliverable, or you can send an extra argument when including the template.

policy-coverages

Displays policy coverages in a table, separated in sections, showing the names, limit, and premiums for each coverage. It also displays totals at the bottom.

include_template('@@components/policy-coverages, defaults=defaults, rev_items=rev_items, properties=properties, show_coverage_premium=True, show_role_on_bill_to=False, show_bill_to=False)

  • Receives defaults as an argument.
  • Receives revision items.
  • Receives properties.
  • Receive variables used for conditionals: show_coverage_premium, show_roll_on_bill_to, show_bill_to.

Functions used

  • get_revision_items
  • get_properties
  • get_revision

Settings that affect it

  • reports: dec-omit-zero-dollar-fee-total
  • reports: show-premium-delta-amended-dec
  • reports: display-coverage-zero-limit

rating-information

Displays line items’ rating information, such as categories, deductibles, questions, and user inputs.

include_template('@@components/policy-coverages, defaults=defaults, rev_items=rev_items, properties=properties)

  • Receives defaults as an argument
  • Receives revision items
  • Receives properties

Functions used

  • get_revision_items
  • get_properties
  • get_revision
  • money
  • format_address

forms

Displays form data (description and edition) that apply to a policy.

include_template('@@components/forms')

Functions used

  • get_all_forms

Settings that affect it

  • reports: show-form-desc
  • reports: show-forms-as-list
  • reports: sort-forms-in-dec

mortgagees

Displays mortgagees information.

include_template('@@components/mortgagees', properties=properties)

  • Receives properties as an argument

Functions used

  • get_properties

credit-score-permission

Displays score permission questions and answers.

Functions used

  • get_permission_questions

loss-history

Displays loss history for each property.

include_template('@@components/loss-history', properties=properties)

  • Receives properties as an argument.

Functions used

  • get_properties
  • money

underwriting-questions

Displays underwriting questions and answers.

include_template(‘@@components/underwriting-questions’)

Functions used

  • get_underwriting_questions

underwriting

Displays specific underwriting questions and their answers. Specific to Cameron.

include_template('@@components/underwriting', defaults=defaults, rev_items=rev_items)}

  • Receives defaults as an argument.
  • Receives rev_items as an argument.

Functions used

  • get_revision_items
  • get_named_insureds

signature

Displays signature placeholder or company official signature and date of signing.

include_template('@@components/signature', signer='Applicant Signature') include_template('@@components/signature', signer='CHIEF EXECUTIVE OFFICER', provide_signature_img=True)

  • Receives signer as an argument.
  • Receives provide_signature_img as an argument. If set to True, it will retrieve signature url.

Functions used

  • get_print_date
  • get_signature_url

schedule-of-coverages

Displays schedule of coverages.

include_template('@@components/schedule-of-coverages', properties=properties)

  • Receives properties as an argument.

Functions used

  • get_properties

billing-summary

Displays billing summary table with details for each payment bill.

include_template('@@components/billing-summary')

Functions used

  • get_debit_deltas_to_date
  • get_bill_when
  • money
  • get_account_balance

billing-schedule

Displays selected billing schedule table with payment amount and dates.

include_template('@@components/billing-schedule', defaults=defaults)

  • Receives defaults as an argument.

Functions used

  • get_billing_schedule_options
  • money
  • get_revision

stub

Displays payment details in a tear-off format, including a payment scanline.

include_template('@@components/stub', defaults=defaults, show_bill_to=false, show_due_date=false)

  • Receives defaults, show_bill_to, and show_due_date as arguments.

Functions used

  • get_policy
  • get_payoff_amount
  • get_account_balance
  • get_last_invoice
  • get_ocr_scan_line
  • get_check_digit
  • get_bill_whom
  • get_named_insureds
  • get_deliverable_date