Comment Templates Overview

Comment templates can be created to define the content of various comments that can then be applied to activities, policies, segments, or suspense records in OIPA. Having a template makes it easy for a CSR to add general statements that apply to multiple types of records.

Template Configuration

There are three configuration pieces that are required to support comment templates:

  • AsCode must have AsCodeCommentType populated with available types of comments.
  • CommentScreen and CommentSearchScreen business rules must be configured.
  • Security privileges must be granted to the user working with templates.

Business Rules

The CommentScreen business rule contains a <UseTemplates> element that controls whether comment templates are available in OIPA. This element can be repeated under each of the comment sections to indicate if comment templates are available for that specific type of comment.

There are five types of comments referenced in the CommentScreen business rule.

  • <DefaultComments>: configuration in this section will apply to all types of comments, unless specific configuration is present in a comment section below it.
  • <PolicyComments>: configuration in this section will apply to policy comments only.
  • <ActivityComments>: configuration in this section will apply to activity comments only.
  • <SuspenseComments>: configuration in this section will apply to suspense comments only.
  • <SegmentComments>: configuration in this section will apply to segment comments only.

Comment templates can be defined at several different levels. Creating an override of the CommentScreen business rule allows you to fine tune comment templates and control the templates that are available to users in OIPA. The following override levels are available.

  • Plan level: available for any Policy, Segment or Activity comment under the identified plan.
  • Product level: available for any Policy, Segment or Activity comments for all plans under the identified Products.
  • Subsidiary Company level: available for any Policy, Segment or Activity comments for all plans under the identified subsidiary company.
  • Primary Company level: available for any Policy, Segment, Activity, Suspense or Client record under the identified company.
  • Global level: available for all comment types regardless of company.

Security

A Rules Palette user must have the Administration - All Non-Security Administration - CheckIn/CheckOut privilege to work with templates.

Comment Templates Via AsFile

Comment templates can also be defined via AsFile, where AsFile allows inserts into the AsCommentsTemplates. An example of this configuration is provided below.

<AsCommentsTemplate>
<CommentsTemplateGUID>3D8AC8C1-C4F1-4DBF-8068-758A4EA52743</CommentsTemplateGUID>
<TemplateName>TestTemplate</TemplateName>
<CompanyGUID>3D8AC8C1-C4F1-4DBF-8068-758A4EA52743</CompanyGUID>
<PlanGUID>(null)</PlanGUID>
<TemplateText>This is a test template</TemplateText>
</AsCommentsTemplate>