Declare Index rulesCompleting the Create, Save As, or Specialization form

You are here: Reference > Rule types > Declare Indexes > Declare Index rules - Completing the New or Save As form

Declare Index rules Completing the Create, Save As, or Specialization form
About New Indexes Pages & Indexes History More...

Records can be created in various ways. You can add a new record to your application or copy an existing one. You can specialize existing rules by creating a copy in a specific ruleset, against a different class or (in some cases) with a set of circumstance definitions. You may copy data instances but they do not support specialization as they are not versioned.

Based on your use case, the Create, Save As, or Specialization form is used to create the record. The number of fields and available options vary by record type. Start by familiarizing yourself with the generic layout of these forms and their common fields using the following Developer Help topics:

Completing the Create form Designer Studio – Completing the Create form
Completing the Save As form Completing the Save As form
Completing the Specialization form Completing the Specialization form

This help topic help topic identifies the key parts and options that are applicable to the record type you are creating.

Create a Declare Index rule by selecting Declare Index from the SysAdmin category.

Key parts:

A Declare Index rule has two key parts:

Field

Description

Apply to

Select a concrete or abstract class that defines the scope of the indexes. At runtime, a clipboard page of this class must be a top-level page. Concrete objects in classes derived from this class are candidates for indexing under this rule.

Note these restrictions:

Choose an internal class. You can't index an external class.
You cannot use @baseclass or the Rule- base class, nor any class derived from the Rule- base class here. You cannot use a class derived from the Code- or Embed- class here.
You can choose a class derived from the Data- base class, but limitations apply. See More about Declare Index rules.

Identifier

Enter a name for this Declare Index rule. Begin the name with a letter and use only letters, numbers, and a hyphen.

No other rules explicitly reference this Identifier value. However, based on class inheritance, a Declare Index rule named ByChild at one level in the class structure may override and therefore prevent execution of a Declare Index rule named ByChild at a higher level in the class structure.

Rule resolution

When searching for rules of this type, the system:

Filters candidate rules based on a requestor's ruleset list of rulesets and versions
Searches through ancestor classes in the class hierarchy for candidates when no matching rule is found in the starting class

Time-qualified and circumstance-qualified rule resolution features are not available for this rule type.

Related information

Open topic with navigation