Metadata

You must add metadata for all elements in the product model tree in fields labeled (*PD). These fields are not required to visualize the product, but are required for product generation.

The metadata includes business descriptions and codes, such as:
  • General product details
  • Line details and risk objects
    • Fields
    • Coverages, conditions, and exclusions
    • Drop-down lists associated with fields, coverages, conditions, and exclusions

The product model is not valid until all metadata has been entered.

How to specify metadata

You can specify metadata for the product model by:
  • Entering (*PD) values in the visualized product screens directly.
  • Defining short names in the mind map.

Adding Short Name (*PD)

If Product Design Mode is Developer, the Product Definition screens have Short Name (*PD) fields. These fields must be filled in before generating the product. For drop-down lists, you specify the short name in the Typelist (*PD) field.

When designing a product, create short names that follow best-practice naming conventions agreed upon by the organization or team.

Mind map label for short name

For all topics with markers (except Product and Product Line ) in the XMind mind map, you can specify the short name in a label. The label becomes the Short Name (*PD) in the visualized product.

Short name requirements

Short names must:
  • Start with an uppercase letter
  • Include only letters, digits, $ or _
  • Clauses and clause categories – Be unique within the product line
  • Clause terms – Be unique within the parent clause
  • Drop-down list entries – Can start with a lowercase letter or digit

Short Name (*PD) fields have character limits that are enforced in the user interface. If you import a mind map or template where short names exceed the character limits, the short names are truncated. Short Name (*PD) is visible if Product Design Mode is Developer.

The character limits for short names are:
Fields Limit Description
Clauses 45
Clause categories 45
Clause terms 30
Risk objects 22
Exposures 22
Attributes or fields 30
Drop-down list values 45
Product line 22 On the Product Definition screen, PolicyLine Subtype, excluding prefix (*PD)

Words to avoid

The short name cannot be one of the following keywords. The check is case-insensitive.
  • Java keywords
  • Gosu keywords – See Gosu Reference Guide
  • The following SQL keywords:
    • use
    • type

The name can include these words. For example, abstract is a Java and Gosu keyword, so the short name cannot be ABSTRACT, but can be abstractPhrase.

Words to avoid for exposures and coverables

For exposures and coverables, field short names cannot match certain property names on PolicyCenter entities. Coverables are risk object that have coverages, including product lines. Using one of these words results in a warning, but does not block you from completing code generation. Guidewire recommends that you change the name so that no warning is issued.

On exposures and coverables, including the product line, do not use these words as field short names:
  • Changed
  • ExpirationDate
  • Class
  • New
  • DisplayName
  • TYPE
  • EffectiveDate
    • On coverables, including the product line, do not use this word as field short names:
    • State
    On the product line, do not use these words as field short names:
    • AdditionalInsureds
    • BaseState
    • Branch
    Note: These are the words to avoid that you are most likely to use. This is not a complete list.

    Add metadata

    Before you begin

    • Set Product Design Mode to Developer.

    About this task

    Note:

    Do not add prefixes to codes that identify the line or risk object. The build process will do this for you. These codes end with excluding prefix (*PD).

    Procedure

    1. Select a product at the top of the APD Managed tab.
      The selected product appears in the Details tab.
    2. Click Edit Product.
      PolicyCenter displays the Product Definition screen.
    3. Starting with the Details tab, enter values for all fields appended with (*PD).
  • Fields
    1. On the Fields tab, enter Menu Label for Generated UI (*PD).
    2. On the Fields tab, click Definition for a drop-down list.
      The Drop-Down Definition popup appears.
    3. Enter Description (*PD).
  • Coverages, Exclusions, and Conditions
    1. On the Coverages, Exclusions, or Conditions tab, enter Description (*PD) for each row in the table.
    2. For each row in the table, click Terms to update Description (*PD) and Short Name (*PD) for each term.
    3. If terms have drop-down lists, update Description (*PD) and Short Name (*PD) for each list entry.
    4. At the top of the Coverages, Exclusions, or Conditions tab, click Manage Clause Categories to update Description (*PD).
  • Risk objects
    1. Click the Children tab to set metadata on risk objects.
      A table contains a link to each risk object.
    2. For each risk object, click the link to display the Risk Object Definition popup.
    3. On the Details tab, enter metadata.
      OptionDescription
      Description (*PD) Describe the risk in business terms
      Menu Label for Generated UI (*PD)  
    4. Click the Fields tab to enter metadata for fields on the risk object. Use the guidance provided above for completing the Fields metadata.
    5. Continue this process for all tabs and all parts of the product model.