OWPolicyCommon Standard Container
In This Topic...
The OWPolicyCommon container includes prebuilt screens for managing information related to billing, distributors, and insurers.
This container has Policy as the Functional Area, and is automatically shared to any custom containers with the Functional Area set to Policy or Claims.
Note: The components from this standard container can be used in custom configurations, including adding behavior override rules or similar settings, but the original settings in the standard container can not be changed.
Caution: Any workflow components that are not specifically addressed in this section represent features that are under development. This applies even if they are visible within the system. These components should not be used as they are not yet fully supported.
This container includes the following components. Please see the individual configurations for details.
Workflow
-
Name: OwPolicyCommon
Code: OwPolicyCommon
Notes: This workflow is a placeholder, and is not intended for use within a product.
Screens
-
Name: OwBillingInfoScreen
Code: OwBillingInfoScreen
Label: Billing Information Screen
Notes: This screen includes all of the components to manage billing information, including bill to party details, settings, installment information, and additional parties. See the Panels and Fields section below for details.
-
Name: OwPolicyDistributorScreen
Code: OwPolicyDistributorScreen
Label: OwPolicyDistributorScreen
Notes: This screen includes all of the components to manage distributor information, including details on the primary distributor, additional distributors, and commission information. See the Panels and Fields section below for details.
-
Name: OwPolicyInsurerScreen
Code: OwPolicyInsurerScreen
Label: OwPolicyInsurerScreen
Notes: This screen includes all of the components to manage insurer information, including details on the primary insurer, additional insurers, and premium information. See the Panels and Fields section below for details.
-
Name: OwPolicyCoverages
Code: OwPolicyCoverages
Label: OwPolicyCoverages
Notes: This screen includes all of the components to manage Policy Coverage information, including details on the Policy contract term, Policy charges, coverage limits, coverage deductibles, and insuring conditions. See the Panels and Fields section below for details.
Panels, Grids, and Fields - OwBillingInfoScreen
-
Panel Name: Billing Information
Code: BillingInformation
Label: Billing Information
Notes: This panel includes policy term payment information.
Fields:
-
Name: Total Payment Amount
Code: BillingTotalTransactionPaymentAmount
Label: Total Payment Amount
Notes:
This field is updated by the system, and displays the total payment amount collected through Receipt Detail Allocation amounts and On Account Balance receipts associated to the policy transaction. Only receipts in Posted status are included.
This field is automatically indexed.
Note: If a receipt applies to an invoice that is associated to more than one policy transaction, the full balance of the invoice must be paid before the receipt amount is included in the calculation for this field.
-
Name: Policy Term Overdue Amount
Code: BillingPolicyTermOverdueAmount
Label: Policy Term Overdue Amount
Notes: This field is updated by the system, and displays the total overdue amount for the policy term for all outstanding invoices where the invoice due date is a minimum of one day before the current date.
-
Name: Policy Term Collected Amount
Code: BillingPolicyTermCollectedAmount
Label: Policy Term Collected Amount
Notes: This field is updated by the system, and displays the total amount collected through Receipt and Receipt Detail Allocations associated to the policy term. Only amounts for receipts in Posted status are included.
This field is automatically indexed.
-
Name: Policy Term Earliest Overdue Invoice Due Date
Code: BillingPolicyTermEarliestOverdueInvoiceDueDate
Label: Policy Term Earliest Overdue Invoice Due Date
Notes: This field is updated by the system, and displays the earliest overdue invoice due date associated to the policy term where the invoice outstanding amount is greater than zero and the invoice due date is a minimum of one day before the current date.
This field is automatically indexed.
-
Name: Policy Term Outstanding Amount
Code: BillingPolicyTermOutstandingAmount
Label: Policy Term Outstanding Amount
Notes: This field is updated by the system, and displays the total outstanding amount for invoices associated to the policy term.
This field is automatically indexed.
-
Name: Last Online Payment Status
Code: BillingTransactionLastOnlinePaymentStatus
Label: Last Online Payment Status
Notes: This field is updated by the system, and displays the status of the most recent online payment transaction.
If no payment is found, this field will be blank.
-
Name: Last Online Payment Date
Code: BillingTransactionLastOnlinePaymentDate
Label: Last Online Payment Date
Notes: This field is updated by the system, and displays the date of the most recent online payment transaction.
If no payment is found, this field will be blank.
-
Name: Payment Method Available for Use
Code: BillingTransactionPaymentMethodAvailableForUse
Label: Payment Method Available for Use
Notes: This field is updated by the system, and displays "Yes" if a payment method has been saved for the Bill to Party, and "No" if a payment method has not been saved for the Bill to Party.
-
-
Panel Name: Billing Primary Bill to Party
Code: BillingPrimaryBillToParty
Label: Billing Primary Bill to Party
Notes: This panel includes details for the primary bill to party for the policy.
Fields:
-
Name: Primary Bill to Party Code
Code: BillingPrimaryBillToPartyCode
Label: Primary Bill to Party Code
Notes:
-
Name: Primary Bill to Party Name
Code: BillingPrimaryBillToPartyName
Label: Primary Bill to Party
Notes:
-
Name: Primary Bill to Party Id
Code: BillingPrimaryBillToPartyID
Label:
Notes: This field is read only.
This field is hidden.
-
Name: Primary Bill to Party Guid
Code: BillingPrimaryBillToPartyGuid
Label: Primary Bill to Party Guid
Notes: This field is read only.
This field is hidden.
-
-
Grid Name: Bill to Parties Billing Settings
Code: BillToPartyBillingSetting
Label: Bill to Parties Billing Settings
Notes: This grid lists additional bill to parties and their billing percentages.
Fields:
-
Name: [Parties Billing Settings] Additional Bill to Party Code
Code: BillToPartyBillingSetting.BillToPartyCode
Label: Bill to Party Code
Notes:
-
Name: [Parties Billing Settings] Additional Bill to Party Name
Code: BillToPartyBillingSetting.BillToPartyName
Label: Bill to Party
Notes:
-
Name: [Parties Billing Settings] Percentage Billed
Code: BillToPartyBillingSetting.PremiumPercentage
Label: Percentage Billed
Notes:
-
Name: [Parties Billing Settings] Premium Type Code
Code: BillToPartyBillingSetting.PremiumTypeCode
Label: Premium Type Code
Notes:
-
Some columns have been hidden.
-
Grid Name: Billing Installments
Code: BillingInstallment
Label: Billing Installments
Notes: The Billing Installments grid lists the scheduled installments for each bill to party.
Fields:
-
Name: [Billing Installments] Installment Amount Due
Code: BillingInstallment.AmountDue
Label: Amount Due
Notes:
-
Name: [Billing Installments] Installment Bill to Party Code
Code: BillingInstallment.BillToPartyCode
Label: Bill to Party Code
Notes:
-
Name: [Billing Installments] Installment Bill to Party Name
Code: BillingInstallment.BillToPartyName
Label: Bill to Party
Notes:
-
Name: [Billing Installments] Installment Commission Amount
Code: BillingInstallment.CommissionAmount
Label: Commission Amount
Notes:
-
Name: [Billing Installments] Currency Code
Code: BillingInstallment.Currency
Label: Currency Code
Notes:
-
Name: [Billing Installments] Installment Gross Amount
Code: BillingInstallment.GrossAmount
Label: Gross Amount
Notes:
-
Name: [Billing Installments] Installment Number
Code: BillingInstallment.Number
Label: Number
Notes:
-
Name: [Billing Installments] Installment Tax Amount
Code: BillingInstallment.TaxAmount
Label: Tax Amount
Notes:
-
Name: [Billing Installments] Installment Total Amount Due
Code: BillingInstallment.TotalAmountDue
Label: Total Amount Due
Notes:
-
Name: [Billing Installments] Installment Total Amount
Code: BillingInstallment.TotalInstallmentAmount
Label: Total Amount
Notes:
-
Name: [Billing Installments] Installment Date
Code: BillingInstallment.Date
Label: Date
Notes:
-
Some columns have been hidden.
-
Grid Name: Additional Parties
Code: AdditionalParty
Label: Additional Companies
Notes: This grid lists additional parties attached to the policy, including contact and address details. This information is read only. Selecting a party in this grid displays the Bill to Parties Billing Settings child grid.
Fields:
-
Name: [Additional Parties] Additional Company Code
Code: AdditionalParty.Code
Label: Code
Notes: This field is read only.
-
Name: [Additional Parties] Additional Company Address
Code: AdditionalParty.Address
Label: Address
Notes: This field is read only.
-
Name: [Additional Parties] Additional Company City
Code: AdditionalParty.City
Label: City
Notes: This field is read only.
-
Name: [Additional Parties] Additional Company Contact Email
Code: AdditionalParty.ContactEmail
Label: E-mail
Notes: This field is read only.
-
Name: [Additional Parties] Additional Company Contact Employee Number
Code: AdditionalParty.ContactEmployeeNumber
Label: Employee Number
Notes: This field is read only.
-
Name: [Additional Parties] Additional Company Contact First Name
Code: AdditionalParty.ContactFirstName
Label: First Name
Notes: This field is read only.
-
Name: [Additional Parties] Additional Company Contact Last Name
Code: AdditionalParty.ContactLastName
Label: Last Name
Notes: This field is read only.
-
Name: [Additional Parties] Additional Company Contact Phone
Code: AdditionalParty.ContactPhone
Label: Phone
Notes: This field is read only.
-
Name: [Additional Parties] Additional Company Country
Code: AdditionalParty.Country
Label: Country
Notes: This field is read only.
-
Name: [Additional Parties] Additional Company Fax
Code: AdditionalParty.Fax
Label: Fax
Notes: This field is read only.
-
Name: [Additional Parties] Additional Company Name
Code: AdditionalParty.Name
Label: Name
Notes: This field is read only.
-
Name: [Additional Parties] Additional Company Phone
Code: AdditionalParty.Phone
Label: Phone
Notes: This field is read only.
-
Name: [Additional Parties] Additional Company Web Site
Code: AdditionalParty.Website
Label: Web site
Notes: This field is read only.
-
Name: [Additional Parties] Additional Company Zip / Postal Code
Code: AdditionalParty.ZipPostalCode
Label: Zip/Postal Code
Notes: This field is read only.
-
Name: [Additional Parties] Additional Company GUID
Code: AdditionalParty.Guid
Label:
Notes: This field is read only.
This field is hidden.
This field is not displayed in the grid.
-
Name: [Additional Parties] Additional Company Resource ID
Code: AdditionalParty.Id
Label:
Notes: This field is read only.
This field is hidden.
This field is not displayed in the grid.
-
Name: [Additional Parties] Additional Company State / Province
Code: AdditionalParty.StateProvince
Label: State/Province
Notes: This field is read only.
-
-
Grid Name: Bill to Parties Billing Settings
Code: BillToPartyBillingSetting
Label: Bill to Parties Billing Settings
Notes: This is a child to the Additional Parties grid, and lists additional bill to parties and their billing percentages.
Fields:
-
Name: [Parties Billing Settings] Additional Bill to Party Code
Code: BillToPartyBillingSetting.BillToPartyCode
Label: Bill to Party Code
Notes:
-
Name: [Parties Billing Settings] Additional Bill to Party Name
Code: BillToPartyBillingSetting.BillToPartyName
Label: Bill to Party
Notes:
-
Name: [Parties Billing Settings] Percentage Billed
Code: BillToPartyBillingSetting.PremiumPercentage
Label: Percentage Billed
Notes:
-
Name: [Parties Billing Settings] Premium Type Code
Code: BillToPartyBillingSetting.PremiumTypeCode
Label: Premium Type Code
Notes:
-
Panels, Grids, and Fields - OwPolicyDistributorScreen
-
Panel Name: Distributor
Code: Distributor
Label: Distributor
Notes: This panel provides details on the current primary distributor for the policy. This information is read only.
Fields:
-
Name: Distributor Name
Code: DistributorName
Label: Name
Notes: This field is required.
This field is read only.
-
Name: Distributor Contact Email
Code: DistributorContactEmail
Label: Contact E-mail
Notes: This field is read only.
-
Name: Distributor Contact Phone
Code: DistributorContactPhone
Label: Contact Phone
Notes: This field is read only.
-
Name: Distributor Fax
Code: DistributorFax
Label: Fax
Notes: This field is read only.
-
Name: Distributor Address
Code: DistributorAddress
Label: Address
Notes: This field is read only.
-
Name: Distributor City
Code: DistributorCity
Label: City
Notes: This field is read only.
-
Name: Distributor Client Code
Code: DistributorClientCode
Label: Code
Notes: This field is read only.
-
Name: Distributor Code
Code: DistributorCode
Label: Distributor Code
Notes: This field is read only.
-
Name: Distributor Contact Employee Number
Code: DistributorContactEmployeeNumber
Label: Contact Employee Number
Notes: This field is read only.
-
Name: Distributor Contact First Name
Code: DistributorContactFirstName
Label: Contact First Name
Notes: This field is read only.
-
Name: Distributor Contact Last Name
Code: DistributorContactLastName
Label: Contact Last Name
Notes: This field is read only.
-
Name: Distributor Country
Code: DistributorCountry
Label: Country
Notes: This field is read only.
-
Name: Distributor Phone
Code: DistributorPhone
Label: Phone
Notes: This field is read only.
-
Name: Distributor Reference Code
Code: DistributorReferenceCode
Label: Distributor Reference Code
Notes: This field is read only.
-
Name: Distributor State / Province
Code: DistributorStateProvince
Label: State/Province
Notes: This field is read only.
-
Name: Distributor Website
Code: DistributorWebsite
Label: Website
Notes: This field is read only.
-
Name: Distributor Zip / Postal Code
Code: DistributorZipPostalCode
Label: Zip/Postal Code
Notes: This field is read only.
-
Name: Distributor Resource ID
Code: DistributorId
Label:
Notes: This field is hidden.
-
Name: Distributor GUID
Code: DistributorGuid
Label:
Notes: This field is hidden.
-
Name: Distributor Total Commission Amount
Code: DistributorCommission
Label: Commission Amount
Notes: This is a calculated field that retrieves the commission amount for the main distributor from the [Policy Distributors] Commission Amount field in the Policy Distributors grid.
This field is read only.
This field is hidden.
-
-
Grid Name: Policy Distributors
Code: PolicyDistributor
Label: Policy Distributors
Notes: This grid lists the distributors attached to the policy, including contact and address details.
The detail window includes a lookup to select a distributor, which populates the remaining fields.
The detail fields are read only on Cancellation and Reinstatement transaction types, as well as any transaction type in Bound, Declined, or Lost status.
Selecting a distributor in this grid may display the Distributor Commission By PremiumType child grid. This child grid only appears on Cancellation transaction types in Incomplete, Bound, or Rescinded status.
The SaveToGrid function can be used to enter a commission percentage or amount overrides for other transaction types.
The Main Distributor will not appear in this grid, however, it will show in any documents and e-mails generated using this grid.
Fields:
-
Name: [Policy Distributors] Distributor Lookup
Code: PolicyDistributor.Lookup
Label: Distributor Lookup
Notes: This is a combo box field used to search for distributor information.
This field uses the Distributor Lookup Data Source data source.
This field is not displayed in the grid.
-
Name: [Policy Distributors] Distributor Resource ID
Code: PolicyDistributor.Id
Label:
Notes: This field is populated by the results of the [Policy Distributors] Distributor Lookup field.
This field is hidden.
This field is not displayed in the grid.
-
Name: [Policy Distributors] Distributor GUID
Code: PolicyDistributor.Guid
Label:
Notes: This field is populated by the results of the [Policy Distributors] Distributor Lookup field.
This field is hidden.
This field is not displayed in the grid.
-
Name: [Policy Distributors] Main Distributor
Code: PolicyDistributor.IsMain
Label: Main distributor
Notes: This field is hidden.
This field is not displayed in the grid.
-
Name: [Policy Distributors] Distributor Name
Code: PolicyDistributor.Name
Label: Name
Notes: This field is populated by the results of the [Policy Distributors] Distributor Lookup field.
This field is required.
This field is read only.
-
Name: [Policy Distributors] Distributor Client Code
Code: PolicyDistributor.ClientCode
Label: Code
Notes: This field is populated by the results of the [Policy Distributors] Distributor Lookup field.
This field is required.
This field is read only.
-
Name: [Policy Distributors] Distributor Code
Code: PolicyDistributor.Code
Label: Distributor Code
Notes: This field is populated by the results of the [Policy Distributors] Distributor Lookup field.
This field is read only.
This field is not displayed in the grid.
-
Name: [Policy Distributors] Distributor Reference Code
Code: PolicyDistributor.ReferenceCode
Label: Distributor Reference Code
Notes: This field is populated by the results of the [Policy Distributors] Distributor Lookup field.
This field is read only.
This field is not displayed in the grid.
-
Name: [Policy Distributors] Distributor Phone
Code: PolicyDistributor.Phone
Label: Phone
Notes: This field is populated by the results of the [Policy Distributors] Distributor Lookup field.
This field is read only.
-
Name: [Policy Distributors] Distributor Fax
Code: PolicyDistributor.Fax
Label: Fax
Notes: This field is populated by the results of the [Policy Distributors] Distributor Lookup field.
This field is read only.
This field is not displayed in the grid.
-
Name: [Policy Distributors] Distributor Website
Code: PolicyDistributor.Website
Label: Website
Notes: This field is populated by the results of the [Policy Distributors] Distributor Lookup field.
This field is read only.
This field is not displayed in the grid.
-
Name: [Policy Distributors] Distributor Address
Code: PolicyDistributor.Address
Label: Address
Notes: This field is populated by the results of the [Policy Distributors] Distributor Lookup field.
This field is read only.
This field is not displayed in the grid.
-
Name: [Policy Distributors] Distributor City
Code: PolicyDistributor.City
Label: City
Notes: This field is populated by the results of the [Policy Distributors] Distributor Lookup field.
This field is read only.
-
Name: [Policy Distributors] Distributor Country
Code: PolicyDistributor.Country
Label: Country
Notes: This field is populated by the results of the [Policy Distributors] Distributor Lookup field.
This field is read only.
-
Name: [Policy Distributors] Distributor State / Province
Code: PolicyDistributor.StateProvince
Label: State/Province
Notes: This field is populated by the results of the [Policy Distributors] Distributor Lookup field.
This field is read only.
-
Name: [Policy Distributors] Distributor Zip / Postal code
Code: PolicyDistributor.ZipPostalCode
Label: Zip/Postal Code
Notes: This field is populated by the results of the [Policy Distributors] Distributor Lookup field.
This field is read only.
-
Name: [Policy Distributors] Distributor Contact First Name
Code: PolicyDistributor.ContactFirstName
Label: Contact First Name
Notes: This field is populated by the results of the [Policy Distributors] Distributor Lookup field.
This field is read only.
This field is not displayed in the grid.
-
Name: [Policy Distributors] Distributor Contact Last Name
Code: PolicyDistributor.ContactLastName
Label: Contact Last Name
Notes: This field is populated by the results of the [Policy Distributors] Distributor Lookup field.
This field is read only.
This field is not displayed in the grid.
-
Name: [Policy Distributors] Distributor Contact Phone
Code: PolicyDistributor.ContactPhone
Label: Contact Phone
Notes: This field is populated by the results of the [Policy Distributors] Distributor Lookup field.
This field is read only.
This field is not displayed in the grid.
-
Name: [Policy Distributors] Distributor Contact Email
Code: PolicyDistributor.ContactEmail
Label: Contact E-mail
Notes: This field is populated by the results of the [Policy Distributors] Distributor Lookup field.
This field is read only.
This field is not displayed in the grid.
-
Name: [Policy Distributors] Distributor Contact Employee Number
Code: PolicyDistributor.ContactEmployeeNumber
Label: Contact Employee Number
Notes: This field is populated by the results of the [Policy Distributors] Distributor Lookup field.
This field is read only.
This field is not displayed in the grid.
-
Name: [Policy Distributors] Commission Amount
Code: PolicyDistributor.CommissionAmount
Label: Commission Amount
Notes: This is a calculated field that retrieves the total commission amount for the distributor, across all premium types, from the [Commission by Premium Type] Distributor Commission Amount field in the Distributor Commission By PremiumType grid.
This field is read only.
This field is hidden.
This field is not displayed in the grid.
-
-
Grid Name: Distributor Commission By PremiumType
Code: DistributorCommissionByPremiumType
Label: Distributor Commission By PremiumType
Notes: This grid is a child to the Policy Distributors grid, and lists the commission percentages and totals for each distributor.
This grid is hidden on New Business, Endorsement, Adjustment, Declaration, Renewal, and Reinstatement transaction types, as well as Cancellation transactions in Incomplete, Bound, or Rescinded status. This information is read only, except for a commission override field.
Fields:
-
Name: [Commission by Premium Type] Distributor Premium Type Name
Code: DistributorCommissionByPremiumType.PremiumTypeName
Label: Premium Type Name
Notes: This field is read only.
When calculating commissions, this field is populated with the Name for each premium type.
-
Name: [Commission by Premium Type] Distributor Premium Type Code
Code: DistributorCommissionByPremiumType.PremiumTypeCode
Label: Premium Type Code
Notes: This field is read only.
When calculating commissions, this field is populated with the Code for each premium type.
-
Name: [Commission by Premium Type] Distributor Premium Amount
Code: DistributorCommissionByPremiumType.PremiumAmount
Label: Premium Amount
Notes: This field is read only.
When calculating commissions, this field is populated with the total calculated premium for each premium type.
-
Name: [Commission by Premium Type] Distributor Code
Code: DistributorCommissionByPremiumType.DistributorCode
Label: Distributor Code
Notes: This field is read only.
This field is hidden.
This field is not displayed in the grid.
When calculating commissions, this field is populated with the Code for the selected distributor.
-
Name: [Commission by Premium Type] Default Commission Percentage
Code: DistributorCommissionByPremiumType.DefaultCommissionPercentage
Label: Default Commission (%)
Notes: This field is read only.
This field is hidden.
This field is not displayed in the grid.
When calculating commissions, this field is populated with the Default Commission (%) for the selected distributor and the current master cover.
-
Name: [Commission by Premium Type] Master Cover Commission Field Code
Code: DistributorCommissionByPremiumType.MasterCoverCommissionFieldCode
Label: Master Cover Commission Field Code
Notes: This field is read only.
This field is hidden.
This field is not displayed in the grid.
When calculating commissions, this field is populated with the Code for the field selected in the Commission Percentage Field field in the Master Cover - General Information page.
-
Name: [Commission by Premium Type] Master Cover Field Commission Percentage
Code: DistributorCommissionByPremiumType.MasterCoverFieldCommissionPercentage
Label: Master Cover Commission Field (%)
Notes: This field is read only.
This field is hidden.
This field is not displayed in the grid.
When calculating commissions, this value is copied from the field selected in the Commission Percentage Field field in the Master Cover - General Information page.
-
Name: [Commission by Premium Type] Commission Override Trigger Value
Code: DistributorCommissionByPremiumType.AssociationCommissionOverrideTriggerValue
Label: Association Commission Override Trigger Value
Notes: This field is read only.
This field is hidden.
This field is not displayed in the grid.
When calculating commissions, this field is populated with the true or false value of the trigger selected in the Field Override Trigger field for the selected distributor and the current master cover.
-
Name: [Commission by Premium Type] Commission Override Field Code
Code: DistributorCommissionByPremiumType.AssociationCommissionOverrideFieldCode
Label: Association Commission Override Field Code
Notes: This field is read only.
This field is hidden.
This field is not displayed in the grid.
When calculating commissions, this field is populated with the Code for the field selected in the Default Commission Field Override field for the selected distributor and the current master cover.
-
Name: [Commission by Premium Type] Association Field Commission Percentage
Code: DistributorCommissionByPremiumType.AssociationFieldCommissionPercentage
Label: Association Commission Override Field (%)
Notes: This field is read only.
This field is hidden.
This field is not displayed in the grid.
When calculating commissions, this field is populated with the value of the field selected in the Default Commission Field Override field for the selected distributor and the current master cover.
-
Name: [Commission by Premium Type] Premium Type Commission Percentage
Code: DistributorCommissionByPremiumType.PremiumTypeCommissionPercentage
Label: Premium Type Commission (%)
Notes: This field is read only.
This field is hidden.
This field is not displayed in the grid.
When calculating commissions, this field is populated with the Commission (%) values copied from the Premium Type - Commission (%) Overrides panel in the Master Cover Associations for the distributor.
-
Name: [Commission by Premium Type] Commission Override (%)
Code: DistributorCommissionByPremiumType.CommissionOverridePercentage
Label: Commission Override (%)
Notes: This field is hidden.
This field is not displayed in the grid.
A custom override for the commission percentage can be saved to this field by an integration or function.
-
Name: [Commission by Premium Type] Commission Override Amount
Code: DistributorCommissionByPremiumType.CommissionOverrideAmount
Label: Commission Override Amount
Notes:
-
Name: [Commission by Premium Type] Distributor Commission Rate
Code: DistributorCommissionByPremiumType.CommissionRate
Label: Commission (%)
Notes: This field is hidden.
This field is not displayed in the grid.
This is a calculated field that determines the commission rate for the current distributor and premium type. The formula checks for values in this order, using the first valid option.
- If the [Commission by Premium Type] Commission Override Amount field has a numeric value, it will be used.
- If the [Commission by Premium Type] Commission Override (%) field has a numeric value, it will be used.
- If the [Commission by Premium Type] Premium Type Commission Percentage field has a numeric value, it will be used.
- If the master cover association configuration for the distributor has a Default Commission Field Override, and either has no trigger or the trigger evaluates to true, the commission from the override field will be used. If the field does not contain a numeric value, 0 will be used.
- If the master cover association configuration for the distributor has a numeric Default Commission, it will be used.
- If the distributor has a numeric Default Commission (%) value, it will be used.
-
Name: [Commission by Premium Type] Distributor Commission Amount
Code: DistributorCommissionByPremiumType.CommissionAmount
Label: Commission Amount
Notes: This field is read only.
This is a calculated field that calculates the commission amount for the premium type, using the [Commission by Premium Type] Distributor Premium Amount and [Commission by Premium Type] Distributor Commission Rate fields.
-
Panels, Grids, and Fields - OwPolicyInsurerScreen
-
Panel Name: Insurer
Code: Insurer
Label: Insurer
Notes: This panel provides details on the current primary insurer for the policy. This information is read only.
Fields:
-
Name: Insurer Name
Code: InsurerName
Label: Name
Notes: This field is read only.
-
Name: Insurer Code
Code: InsurerCode
Label: Code
Notes: This field is read only.
-
Name: Insurer Client Code
Code: InsurerClientCode
Label: Insurer Code
Notes: This field is read only.
-
Name: Insurer Reference Code
Code: InsurerReferenceCode
Label: Insurer Reference Code
Notes: This field is read only.
-
Name: Insurer Address
Code: InsurerAddress
Label: Address
Notes: This field is read only.
-
Name: Insurer City
Code: InsurerCity
Label: City
Notes: This field is read only.
-
Name: Insurer Country
Code: InsurerCountry
Label: Country
Notes: This field is read only.
-
Name: Insurer State/Province
Code: InsurerStateProvince
Label: State/Province
Notes: This field is read only.
-
Name: Insurer Zip / Postal Code
Code: InsurerZipPostalCode
Label: Zip/Postal Code
Notes: This field is read only.
-
Name: Insurer Website
Code: InsurerWebsite
Label: Website
Notes: This field is read only.
-
Name: Insurer Phone
Code: InsurerPhone
Label: Phone
Notes: This field is read only.
-
Name: Insurer Fax
Code: InsurerFax
Label: Fax
Notes: This field is read only.
-
Name: Insurer Contact First Name
Code: InsurerContactFirstName
Label: Contact First Name
Notes: This field is read only.
-
Name: Insurer Contact Last Name
Code: InsurerContactLastName
Label: Contact Last Name
Notes: This field is read only.
-
Name: Insurer Contact Phone
Code: InsurerContactPhone
Label: Contact Phone
Notes: This field is read only.
-
Name: Insurer Contact Email
Code: InsurerContactEmail
Label: Contact E-mail
Notes: This field is read only.
-
Name: Insurer Contact Employee Number
Code: InsurerContactEmployeeNumber
Label: Contact Employee Number
Notes: This field is read only.
-
Name: Insurer Risk Percentage
Code: InsurerRiskPercentage
Label: Risk Percentage
Notes: This field is read only.
-
Name: Insurer Resource ID
Code: InsurerId
Label:
Notes: This field is read only.
This field is hidden.
-
Name: Insurer GUID
Code: InsurerGuid
Label:
Notes: This field is read only.
This field is hidden.
-
Some columns have been hidden.
-
Grid Name: Policy Insurers
Code: PolicyInsurer
Label: Policy Insurers
Notes: This grid lists the insurers attached to the policy, including contact and address details.
Selecting an insurer in this grid displays the Policy Insurer by Premium Type child grid.
If the Allow Multiple Insurers setting is checked in the Master Cover, the Insurer Code, Insurer Risk Percentage, and Lead Insurer fields must be populated using functions, integrations, or similar methods. On calculating a quote, the system validates the provided insurers, and populates the remaining fields in the grid with the current information for those insurers.
Fields:
-
Name: [Policy Insurer] Insurer Resource ID
Code: PolicyInsurer.Id
Label:
Notes: This field is read only.
This field is hidden.
This field is not displayed in the grid.
This information is populated by the system during quote calculation.
-
Name: [Policy Insurer] Insurer GUID
Code: PolicyInsurer.Guid
Label:
Notes: This field is read only.
This field is hidden.
This field is not displayed in the grid.
This information is populated by the system during quote calculation.
-
Name: [Policy Insurer] Insurer Name
Code: PolicyInsurer.Name
Label: Name
Notes: This field is read only.
This information is populated by the system during quote calculation.
-
Name: [Policy Insurer] Insurer Code
Code: PolicyInsurer.Code
Label: Code
Notes: This field is read only.
This field is required when the Allow Multiple Insurers setting is checked in the master cover.
This field must contain the Code of each insurer to be attached to the transaction, populated using functions, integration points, or similar methods.
-
Name: [Policy Insurer] Insurer Client Code
Code: PolicyInsurer.ClientCode
Label: Insurer Client Code
Notes: This field is read only.
This information is populated by the system during quote calculation.
-
Name: [Policy Insurer] Lead Insurer
Code: PolicyInsurer.IsLead
Label: Lead Insurer
Notes: This field is read only.
This field is required when the Allow Multiple Insurers setting is checked in the master cover.
This field must contain "True" or "False" to identify if the insurer is to be the lead insurer on the transaction, and should be populated using functions, integration points, or similar methods.
Note that there must only be a single lead insurer specified.
-
Name: [Policy Insurer] Insurer Reference Code
Code: PolicyInsurer.ReferenceCode
Label: Insurer Reference Code
Notes: This field is read only.
This information is populated by the system during quote calculation.
-
Name: [Policy Insurer] Insurer Address
Code: PolicyInsurer.Address
Label: Address
Notes: This field is read only.
This information is populated by the system during quote calculation.
-
Name: [Policy Insurer] Insurer City
Code: PolicyInsurer.City
Label: City
Notes: This field is read only.
This information is populated by the system during quote calculation.
-
Name: [Policy Insurer] Insurer Country
Code: PolicyInsurer.Country
Label: Country
Notes: This field is read only.
This information is populated by the system during quote calculation.
-
Name: [Policy Insurer] Insurer State/Province
Code: PolicyInsurer.StateProvince
Label: State/Province
Notes: This field is read only.
This information is populated by the system during quote calculation.
-
Name: [Policy Insurer] Insurer Zip/Postal Code
Code: PolicyInsurer.ZipPostalCode
Label: Zip/Postal Code
Notes: This field is read only.
This information is populated by the system during quote calculation.
-
Name: [Policy Insurer] Insurer Website
Code: PolicyInsurer.Website
Label: Website
Notes: This field is read only.
This information is populated by the system during quote calculation.
-
Name: [Policy Insurer] Insurer Phone
Code: PolicyInsurer.Phone
Label: Phone
Notes: This field is read only.
This information is populated by the system during quote calculation.
-
Name: [Policy Insurer] Insurer Fax
Code: PolicyInsurer.Fax
Label: Fax
Notes: This field is read only.
This information is populated by the system during quote calculation.
-
Name: [Policy Insurer] Insurer Contact First Name
Code: PolicyInsurer.ContactFirstName
Label: Contact First Name
Notes: This field is read only.
This information is populated by the system during quote calculation.
-
Name: [Policy Insurer] Insurer Contact Last Name
Code: PolicyInsurer.ContactLastName
Label: Contact Last Name
Notes: This field is read only.
This information is populated by the system during quote calculation.
-
Name: [Policy Insurer] Insurer Contact Phone
Code: PolicyInsurer.ContactPhone
Label: Contact Phone
Notes: This field is read only.
This information is populated by the system during quote calculation.
-
Name: [Policy Insurer] Insurer Contact Email
Code: PolicyInsurer.ContactEmail
Label: Contact E-mail
Notes: This field is read only.
This information is populated by the system during quote calculation.
-
Name: [Policy Insurer] Insurer Contact Employee Number
Code: PolicyInsurer.ContactEmployeeNumber
Label: Contact Employee Number
Notes: This field is read only.
This information is populated by the system during quote calculation.
-
Name: [Policy Insurer] Insurer Risk Percentage
Code: PolicyInsurer.RiskPercentage
Label: Risk Percentage
Notes: This field is required when the Allow Multiple Insurers setting is checked in the master cover.
This field requires data to be populated using manual entry, functions, integration points, or similar methods.
This is a decimal field, where a value of 50 equals 50 %.
-
Name: [Policy Insurer] Insurer Insurance Cost
Code: PolicyInsurer.InsuranceCost
Label: Insurer Insurance Cost
Notes: This is a calculated field that provides a sum of the [Policy Insurer by Premium Type] Insurer Insurance Cost values for the insurer.
This field is read only.
-
-
Grid Name: Policy Insurer by Premium Type
Code: PolicyInsurerByPremiumType
Label: Policy Insurer By Premium Type
Notes: This grid is a child to the Policy Insurers grid, and lists the risk amounts and premium distribution for each insurer attached to the transaction.
This information is populated by the system during quote calculation, based on the insurers defined in the Policy Insurers parent grid. The risk percentage override values can be entered manually, if necessary.
Fields:
-
Name: [Policy Insurer by Premium Type] Insurer Premium Type Name
Code: PolicyInsurerByPremiumType.PremiumTypeName
Label: Premium Type Name
Notes: This field is read only.
This information is populated by the system during quote calculation.
-
Name: [Policy Insurer by Premium Type] Insurer Premium Type Code
Code: PolicyInsurerByPremiumType.PremiumTypeCode
Label: Premium Type Code
Notes: This field is read only.
This information is populated by the system during quote calculation. If any value already exists in this field, it will not be overwritten.
-
Name: [Policy Insurer by Premium Type] Insurer Name
Code: PolicyInsurerByPremiumType.InsurerName
Label: Insurer Name
Notes: This is a calculated field that displays the [Policy Insurer] Insurer Name value from the parent grid.
This field is read only.
-
Name: [Policy Insurer by Premium Type] Insurer Code
Code: PolicyInsurerByPremiumType.InsurerCode
Label: Insurer Code
Notes: This is a calculated field that displays the [Policy Insurer] Insurer Code value from the parent grid.
This field is read only.
-
Name: [Policy Insurer by Premium Type] Insurer Premium Amount
Code: PolicyInsurerByPremiumType.PremiumAmount
Label: Premium Amount
Notes: This is a calculated field that determines the premium for the current insurer and premium type by multiplying the current premium amount by the [Policy Insurer by Premium Type] Insurer Effective Risk Percentage field.
This field is read only.
-
Name: [Policy Insurer by Premium Type] Insurer Insurance Cost
Code: PolicyInsurerByPremiumType.InsuranceCostAmount
Label: Insurance Cost Amount
Notes: This is a calculated field that determines the insurance cost for the current insurer and premium type by multiplying the commission amount by the [Policy Insurer by Premium Type] Insurer Effective Risk Percentage field, and deducting the result from the [Policy Insurer by Premium Type] Insurer Premium Amount field.
This field is read only.
-
Name: [Policy Insurer by Premium Type] Insurer Risk Percentage Override
Code: PolicyInsurerByPremiumType.RiskPercentageOverride
Label: Risk Percentage Override
Notes: If a value is provided for this field, it overrides the Risk Percentage defined in the Policy Insurer parent grid.
-
Name: [Policy Insurer by Premium Type] Insurer Effective Risk Percentage
Code: PolicyInsurerByPremiumType.EffectiveRiskPercentage
Label: Effective Risk Percentage
Notes: This is a calculated field that determines the effective risk percentage to be used. If there is a numerical value in the [Policy Insurer by Premium Type] Insurer Risk Percentage Override field, then that value will be used. Otherwise, the value from the [Policy Insurer] Insurer Risk Percentage field in the parent grid will be used.
This field is read only.
-
Panels, Grids, and Fields - Other
-
Grid Name: Policy Document
Code: PolicyDocument
Label: Policy Document
Notes: This grid tracks internal information related to documents, and is used for certain integrations. This grid should not be used in a workflow.
Fields:
-
Name: PolicyDocument.Extension
Code: PolicyDocument.Extension
Label:
Notes:
-
Name: PolicyDocument.Filename
Code: PolicyDocument.Filename
Label:
Notes:
-
Name: PolicyDocument.Guid
Code: PolicyDocument.Guid
Label:
Notes:
-
Name: PolicyDocument.ModifiedDate
Code: PolicyDocument.ModifiedDate
Label:
Notes:
-
Name: PolicyDocument.ParentGuid
Code: PolicyDocument.ParentGuid
Label:
Notes: This field is not displayed in the grid.
-
Name: PolicyDocument.ParentType
Code: PolicyDocument.ParentType
Label:
Notes: This field is not displayed in the grid.
-
Name: PolicyDocument.Type
Code: PolicyDocument.Type
Label:
Notes:
-
-
Grid Name: Premium
Code: Premium
Label: Premium
Notes: This grid is currently not is use within the system.
Fields:
-
Name: Policy Transaction Premium Amount (aggregated)
Code: Premium.Amount
Label: Policy Transaction Premium Amount (aggregated)
Notes: This field is read only.
-
Name: Policy Transaction Premium Type Code
Code: Premium.PremiumTypeCode
Label: Policy Transaction Premium Type Code
Notes: This field is read only.
-
Name: Policy Transaction Premium Type Id
Code: Premium.PremiumTypeId
Label: Policy Transaction Premium Type Id
Notes: This field is read only.
This field is hidden.
-
Name: Policy Transaction Premium Type Name
Code: Premium.PremiumTypeName
Label: Policy Transaction Premium Type Name
Notes: This field is read only.
-
Name: Policy Transaction Premium Currency
Code: Premium.Currency
Label: Policy Transaction Premium Currency
Notes: This field is read only.
-
Name: Policy Transaction Commission Amount
Code: Premium.CommissionAmount
Label: Policy Transaction Commission Amount
Notes: This field is read only.
-
Name: Policy Transaction Net Amount
Code: Premium.NetAmount
Label: Policy Transaction Net Amount
Notes: This field is read only.
-
Name: Policy Transaction Tax Amount
Code: Premium.TaxAmount
Label: Policy Transaction Tax Amount
Notes: This field is read only.
-
Standalone Fields
The following system fields are not configured within a panel or screen by default, but can be configured within a workflow to display live system data.
Some of these fields have equivalent placeholders that retrieve the same information. For use as placeholders, see the equivalent placeholder entry in
-
Name: [Policy] Policy Number
Code: PolicyNumber
Label: Policy Number
Notes: This field contains the Policy Number.
This field is read only.
Equivalent Placeholder: [[SubPolPolicyNo]]
-
Name: [Policy] Policy Term Number
Code: PolicyTermNumber
Label: Policy Term Number
Notes: This field contains the policy Term ID, formatted to 10 digits.
This field is read only.
Equivalent Placeholder: [[SubPolPolicyTermID]]
-
Name: [Policy] Policy Effective Date
Code: PolicyEffectiveDate
Label: Policy Effective Date
Notes: This field contains the policy Effective Date.
This field is read only.
Equivalent Placeholder: [[PolicyEffectiveDate]]
-
Name: [Policy] Policy Valid Until Date
Code: PolicyValidUntilDate
Label: Policy Valid Until Date
Notes: This field contains the policy Valid Until date.
This field is read only.
Equivalent Placeholder: [[PolicyValidUntilDate]]
-
Name: [Policy] Transaction Status
Code: TransactionStatus
Label: Transaction Status
Notes: This field contains the transaction status.
This field is required and read only.
-
Name: [Policy] Transaction Type
Code: TransactionType
Label: Transaction Type
Notes: This field contains the transaction type.
This field is required and read only.
-
Name: [Policy] Product Name
Code: ProductName
Label: Product Name
Notes: This field contains the name of the Master Cover.
This field is read only.
Equivalent Placeholder: [[SubPolProduct]]
-
Name: [Policy] Policy Term Effective Date
Code: PolicyTermEffectiveDate
Label: Policy Term Effective Date
Notes: This field contains the policy term Effective Date.
This field is read only.
Equivalent Placeholder: [[CurrentTerm/EffectiveDate]]
-
Name: [Policy] Policy Term Valid Until Date
Code: PolicyTermValidUntilDate
Label: Policy Term Valid Until Date
Notes: This field contains the policy term Valid Until date.
This field is read only.
Equivalent Placeholder: [[CurrentTerm/ExpiryDate]]
-
Name: [Policy] Product Code
Code: ProductCode
Label: Product Code
Notes: This field contains the code of the Master Cover.
This field is read only.
Data Sources
-
Name: Distributor Lookup Data Source
Code: DistributorLookupDS
Notes: This data source is used for the [Policy Distributors] Distributor Lookup field, and uses the Distributor Lookup web service to search for and select distributor information.
Selecting a distributor populates the fields in the Policy Distributors detail window.
Option Lists
-
Name: Cancellation Reasons
Code: CancellationReasons
Notes: This list contains default reasons available for selection during a policy cancellation.