You are here: Record management > Rule creation > Creating a rule or data instance > Guidelines for entering a Java identifier

Guidelines for entering a Java identifier

Use the following guidelines when you type a Java identifier into a rule form, user form, or other form:

Start the value with a letter.
Use only letters and numbers.
In Class rule names, use a hyphen (-) to define pattern inheritance.

Pega Platform uses Java identifiers in generated Java code. Java identifiers in Pega Platform are similar to traditional Java language identifiers, except that Java identifiers that are key parts of an object are limited to 128 characters, or less.

Even though in some cases other formats might be accepted, follow these guidelines to avoid problems. Pega Platform converts any characters other than letters and numbers to an underscore character, which might cause unintended duplicates.

The following features require Java identifiers:

A key part of rules for many rule types must be a valid Java identifier. This requirement applies to all rule types for which View Java is visible from the Actions menu, including:

Activities (Rule-Obj-Activity)

Collections (Rule-Declare-Collection)

Connect rules (Rule-Connect-*)

Data transform rules (Rule-Obj-Model)

Edit input rules (Rule-Edit-Input)

Edit validate rules (Rule-Edit-Validate)

Rule types derived from Rule-Stream, including HTML, HTML fragment, XML, Harness, Section, Property, Paragraph and Flow Action

Function rules (Rule-Utility-Function)

Libraries (Rule-Utility-Library)

Map values (Rule-Obj-MapValue)

Sections (Rule-HTML-Section)

Service rules (Rule-Service-*)

For Value Group and Page Group properties, each subscript value must be a valid Java identifier. The following values are acceptable:
StateCapital("VT")
ZipCode(Customer)
Domaine(EntreDeuxMers2005)
The quotation marks are optional.
You cannot use a value that starts with a number as a Value Group or Page Group subscript. The following values are not correct:
StateCapital(8)
ZipCode(02138)
Domaine(4X4)
In activities, the names of parameters and local variables must be valid Java identifiers.
In flows, list value rules, summary value rules, and sections, the names of parameters must be valid Java identifiers.

Property values

To restrict a Single Value property to hold only Java identifier values:

Set the Property Type to Identifier (on the General tab).
Set Validate field to JavaIdentifier (on the Advanced tab).

Standard function

In an expression, call the standard function rule ValidateJavaIdentifier( ) to test whether a property contains a valid Java identifier.

Open topic with navigation