You are here: LANSA for i User Guide > 2. Fields > 2 9 Code Table File Lookup Rule

2.9 Code / Table File Lookup Rule

This display results when:

 

 DC@P700105              Code /Table File Lookup                       

                                                                       

  File         : XXXXXXXXXX XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX    

  Field        : XXXXXXXXXX XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX    

                                                                       

 Order to process / source . . . 999 / DATA DICTIONARY                 

 User description of rule  . . . ______________________________        

 Use rule when performing  . . . ADD    CHG     DLT                    

 Lookup code table / file  :  __________                               

    using key field(s)     :  XXXXXXXXXX                               

                              ____________________                     

                              ____________________                     

                              ____________________                     

                              ____________________ +                   

                                                                       

 If            a "key match" is found in code file            : NEXT   

 Else          a "key match" is NOT found in code file        : ERROR  

 Specify error message number, file and library : _____  ____  _____ 

 Or text : ___________________________________________________________ 

                                                                       

                                                                       

 Fnn=Help  Fnn=Exit  Fnn=Cancel  Fnn=Messages                          

 

 

Note:  File name only displayed when working at file level. Change & Delete function keys only enabled when displaying an existing check.

If an existing rule is being reviewed then the CHANGE key can be used to place the screen in change mode and the required changes made.

If an existing rule is being reviewed then the DELETE key can be used to delete the rule. Note that the delete is immediate. No confirmation is required.

If a new rule is being added then the screen will be presented initially with default values. Change as required and press Enter to complete specification of the rule.

Input Options

These input options apply to a code/table file lookup rule:

Order to Process:

Mandatory, but always prefilled to <highest order number + 10>. Validation rules are performed (and displayed) in the sequence of these order numbers (within the validation level). Order numbers must be unique within the validation level.

For instance, in the following example, they would be performed in this sequence: RULE04, RULE01,

Rule

Level

Order To Process

RULE01

Dictionary

100

RULE02

Dictionary

200

RULE03

File

20

RULE04

Dictionary

50

RULE05

File

10

 

Source

Output field. Indicates the source or level at which the rule applies.

User Description of Rule

Mandatory. Enter a brief description of the rule to aid other users in understanding its purpose.

Use Rule When Performing

At least one entry required. Prefilled to ADD and CHG. Specifies "when" the rule is to be performed. Allowable values are:

ADD

When information is added (inserted) to the database.

ADDUSE

When information is added, and the field is actually specified/used in the INSERT command being executed.

CHG

When information is changed (updated) in the database.

CHGUSE

When information is changed, and the field is actually specified/used in the UPDATE command being executed.

DLT

When information is deleted (removed) from the database.

Most commonly used entries are ADD, CHG and CHGUSE. Use of DLT by itself is a common and a very powerful check mechanism. If ADDUSE is specified, ensure that the default value of the field is a valid database value. Use caution when specifying CHGUSE with a rule that involves multiple fields, because the check will only be done when the field linked to the rule is specified on an UPDATE command, and not done when it is omitted, regardless of whether or not any of the other fields referenced in the rule are specified.

Lookup Code/Table File

Mandatory. Specifies the physical or logical file that is to be used for checking. The full or partial name of the file can be entered. If a partial name is supplied a list of all files that have a generically identical name is displayed. The required file can be chosen from this list.

Using Key Field(s)

At least 1 key field is required. Specifies the key that is to be compared with the keyed index of the file looking for a "match" (i.e. to find a record with an identical key in the file). Initially, the field is pre-filled to name of the field that is being checked. It can be changed to any other value.

Key values specified can be:

Key values are checked for type and length compatibility. The entire key list supplied is checked for compatibility with the actual key(s) of the file. The key list specified can be a full or partial key to the file. A warning is issued if a partial key list is specified.

If a "Key Match" Is Found in Code File

Mandatory. Prefilled to NEXT. Specifies what is to happen if one or more records in the file have a key identical to the key(s) supplied. Allowable values are:

NEXT

Field is "okay". Proceed to next rule for this field.

ERROR

Field is in error. Issue error message described below.

ACCEPT

Field is okay. Bypass all other rules for this field.

 

Else a "Key" Match Is NOT Found in Code File

Mandatory. Prefilled to ERROR. Specifies what is to happen if NO records in the file have a key identical to the key(s) supplied. Allowable values are:

NEXT

Field is "okay". Proceed to next rule for this field.

ERROR

Field is in error. Issue error message described below.

ACCEPT

Field is okay. Bypass all other rules for this field.

 

Error Message Number, File and Library

Optional. Specify either error message number, file and library or error message text (described below), but not both. Error message files and error message numbers are a native part of the IBM i operating system. Refer to the IBM supplied Control Language Reference Manual for details. CL commands involving message files include CRTMSGF and ADDMSGD.

If you are working on an IBM i, you can directly edit the message details from this screen panel. Enter as much of the message details as is known and use the function key labeled "Work Msgd" (Work Message Description). This will cause a WRKMSGD command to be executed, using as much of the supplied message details as is possible. This operating system facility will allow you to create or edit the message details. Upon completion of the WRKMSGD command, this screen panel will be redisplayed, unchanged, to allow you to proceed.

Do not store user defined messages in, or modify "shipped" messages in, the LANSA message file DC@M01 via this or any other message file editing facility. It is regularly replaced by new version or PC (program change) installations.

Text

Optional. If you do not wish to use an error message file (described above) to store the message text, then you may enter the text of the error message to be displayed directly. If this facility is used then the message will have no second level text associated with it. Refer to the section on Messages and the Help Key.

If neither an error message number, file and library nor error message text is specified LANSA will insert a default error message number, file and library as the error message. These default messages are "general purpose" and do not provide much detail about the specific cause of the error.