Lookup directive

Show all

Use the Lookup directive to retrieve and display a property value of an instance that is stored in the database, but that is not open on the clipboard. (If the instance is already on the clipboard, use the Reference directive.)

JSP equivalent

The lookup JavaServer Page tag provides a functionally identical capability. See JSP Tags — lookup.

Basics

To use the Lookup directive, specify the following:

The name of the property for which you seek the value
The class that contains the instance that contains the property
The property or properties that identify the key parts for the class
The value of the property or properties that identify the keys for the specific instance

Here is an example, explained in detail below.

{LOOKUP pxCreateOperator Rule-Obj-HTML
pyClassName=Work-
pyStreamName=New
}

Complete syntax

In the syntax presentations below:

Square bracket characters [ and ] define optional parts of the directive. Do not type the brackets.
Curly brace characters { and } mark the start and end of the directive.
Replace any text in italics with your choice of value of that type.

{LOOKUP propertyclass-name keyName=keyValue}

If you find it easier to read, include the keyword IN:

{LOOKUP property IN = class-name keyName=keyValue}

Follow the property and class name with one or more property-name/value pairs in any order:

{LOOKUP propertyclass-name key(1)=keyValue(1)key(2) =keyValue(2)}

The Lookup directive can be used within other directives to supply values used as HTML attribute values and in XML tags.

Example

To display the Add Operator field for an HTML rule instance named Work-.Newbook without opening the instance to the clipboard:

1. Determine the property that corresponds to the Add Operator field.

The property that holds the Add Operator field is pxCreateOperator. To discover this, review any HTML rule, and then click the Rule Data toolbar button on the toolbar. Scan the XML display to locate the property.

2. Determine the rule type of the HTML rule.

The rule type is Rule-Obj-HTML.

3. Determine the properties that hold the key parts for any HTML rule.

The key parts are pyClassName and pyStreamName. You can determine the key parts of any class by reviewing the Rule-Obj-Class instance that defines that class.

4. Determine the values for the key parts for this specific instance.

The value of the first key part is Work-; the value for the second key part is Newbook.

{LOOKUP pxCreateOperator Rule-Obj-HTML pyClassName=Work- pyStreamName=Newbook}

Directives