Text Catalog Keys for Documents

ePerformance designates these keys for storing and retrieving its entries for performance and development documents:

Field or Control	Description
Section Type	From the list of section types that you defined on the Section Definition page, select the section type to which the text pertains.
Author Type	From the list of role types that you defined on the Role Types page, select the evaluator role of the evaluation on which the text appears.
User Role	From the list of predefined system roles, select the system role to which the text pertains. This key is used to select text depending on the user's system privileges; for example, update or approve.
Document Status	Select the status to which the text pertains: Acknowledged, Shared with Employee, Canceled, Completed, Define Criteria, Evaluation in Progress, Not Started, Approval, Pending Acknowledgement or Track Progress.
Track Progress Sub Status	Select the number of the checkpoint (from 1 to 11) or F (for the Finalize Criteria step) to which the text pertains.

When the system retrieves text from the catalog:

• Section type key takes precedence over author type.

• Author type takes precedence over user role.

• User role takes precedence over document status.

• Document status takes precedence over track progress sub status.

Note:

An empty key functions as a wildcard. Entries with wildcard keys pertain to all possible values for the key.

Example of Text Retrieval for Documents in ePerformance

For example, if you define two different instructional messages for completing the Goals section of a document, one message for employees and an alternate version for managers, you would define the four keys as shown in this table:

Text ID	Section Type (Key 1)	Author Type (Key 2)	User Role (Key 3)	Document Status (Key 4)	Track Progress Sub Status (Key 5)
Any ID	Goal	Blank	Employee	Blank	Blank
Any ID	Goal	Blank	Manager	Blank	Blank

First, the system looks for entries with an exact match on Key 1 (section type). If it finds entries that match the key value (including the wildcard entry), it searches only those entries for the other values and picks up the best match. In this case, the section type for both entries is Goal, so the system looks at Key 2 (author type). It applies the same logic. Both values in this case are wild cards, so both entries remain possibilities. Now, the system looks for a match on Key 3 (user role) and finds an exact match on Manager. The system only considers entries where Key 4 is blank if it cannot find any match on key 3. Similarly; the system looks at entries where Key 5 is blank if it cannot find any match using the other four keys.