Portlet Factory, Version 6.1.2

 

Domino Keyword Lookup builder

Use the Domino Keyword Lookup builder to display or handle Domino data that is structured as value and label pairs.

The Domino Keyword Lookup builder integrates Domino data with the IBM® WebSphere Portlet Factory Lookup Table builder. You can use a Domino View, Profile Document, or Formula to generate a set of data and feed that data into the Lookup Table builder at runtime to support value and label mappings and the creation of HTML select controls on a page.

The Domino Keyword Lookup builder either works stand alone or with a supporting Domino Data Access builder or Domino View & Form builder. The Keyword Lookup builder uses the Domino artifacts created by itself or the other builder to communicate with the backend Domino server and extract data for use by the Lookup Table builder.

Most of the integration of Domino with the Lookup Builder is accomplished at model regeneration time. At regeneration time, the Domino Keyword Lookup builder adds a Lookup Table builder to the model and connects it to the Domino artifacts responsible for providing the actual data to drive the Lookup Table builder functionality at runtime.

This data is then used by any of several builders that consume Lookup Table builder calls. A Select builder or a Radio Button Group builder, for example, each have an input that refers to a Lookup Table builder call in the same model. Because the Domino Keyword Lookup builder includes a Lookup Table builder, any builder that can consume a Lookup Table builder can consume the one created by the Domino Keyword Lookup builder. As a result, HTML user interface (UI) elements such as select lists and radio buttons can have lists with name and value pairs where the name and value pairs are stored in views in Domino databases. Other builders that can make use of a Lookup Table builder created by a Domino Keyword Lookup builder include but are not limited to Text, and Data Field Modifier.

Control flow in this builder depends on how the builder is configured. For example:

Domino View

When the builder is configured to obtain data from a Domino view, and a client calls one of the Lookup Table methods, the Keyword Lookup builder performs the following high-level actions at runtime:

  • The builder uses the Domino artifacts created by itself or another other Domino builder to obtain an XML representation of the Domino view contents.

  • The XML data flows directly into the Lookup Table methods due to the connections created at regeneration time by the builder.

Profile Document

When the builder is configured to obtain its data from a Domino profile document, the Keyword Lookup builder performs the following high-level actions at runtime:

  • Obtains the name of the Domino profile document that contains the data to be fed into the Lookup Table builder. This name is contained in the Domino Profile Document builder input.

  • Obtains the name of the Domino Profile document field that contains the data. This field name is contained in the Field Name builder input.

  • Extracts the value of the field and converts it into an XML representation suitable for consumption by the Lookup Table builder.

The XML data flows into the Lookup Table builder methods due to the connections created at regeneration time by the builder.

Formula

When the builder is configured to obtain its data from a Domino formula, the Keyword Lookup builder performs the following high-level actions at runtime:

  • Obtains the unique ID for the Domino document, if any, associated with the formula. The ID is contained in the Document UNID builder input.

  • Obtains the formula to be evaluated.

  • Uses the Domino artifacts created by itself or another Domino builder to evaluate the formula. The result of the formula is converted it into an XML representation suitable for consumption by the Lookup Table builder.

The XML data flows into the Lookup Table methods due to the connections created at regeneration time by the builder.

 

Strings and separator characters

The builder assumes that the result of evaluating a formula is a Vector of strings where each string is a value and label pair containing a separator character. If a string from the Vector does not contain the separator character, the builder treats the whole string as both the value and label. If a string from the Vector contains more than one separator character, the builder treats the substring before the first separator as the value and the rest of the strings as the label.

 

Value and label order

The data obtained from a Domino profile document or formula must be formatted so that the value appears before the label in a value and label pair.

Parent topic: Builder help

Library | Support |