Labels for Short Name (*PD)

Short names are easily readable codes that are used as internal identifiers in PolicyCenter, for example when generating PCFs. Create short names that follow best-practice naming conventions agreed upon by the organization or team.

The APD App product screens have Short Name fields. These fields must be filled in before generating the product. For drop-down lists, you specify the short name in the Typelist field.

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 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 names cannot contain spaces.

Avoid using similar names within the same clause term. If any of the characters $, /, or % are used in the short name for a drop-down or package option, they are replaced by an empty string "" when the corresponding code identifiers are generated. This replacement may result in a duplicated name. For example, "100%" and "100$" are both mapped to "100" during the code generation process.

Short Name fields have character limits that are enforced in the user interface. If you import a mind map or APD template where short names exceed the character limits, the short names are truncated.
Note: The combined length of the Clause and Clause Term names must not exceed 47 characters. The maximum length is 50 if you include the prefix. For example, if a coverage name is 30 characters long, the coverage term name must not exceed 17 characters. APD App does not provide a warning for this limitation, but a warning is raised in the startup logging for PolicyCenter.
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
  • 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.

Avoid using the short name of a PolicyCenter interface.

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
  • Class
  • DisplayName
  • EffectiveDate
  • ExpirationDate
  • New
  • TYPE
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.

Defaulting Short Name

When you create or update a visualized product from a mind map, you can choose to create default short names. Choose Default additional fields on the Load Product popup. Design Mode must be set to Developer.

Short names are easily readable codes that are used as internal identifiers in PolicyCenter, for example when generating PCFs. Create short names that follow best-practice naming conventions agreed upon by the organization or team.

The APD App product screens have Short Name fields. These fields must be filled in before generating the product. For drop-down lists, you specify the short name in the Typelist field.