Identifying which record format to add in a file with multiple formats
If your application uses a file name instead of a record format name for records to be added to the database, and if the file used is a logical file with more than one record format, write a format selector program to determine where a record should be placed in the database. A format selector can be a control language (CL) program or a high-level language program. It must be used if all of the following conditions are true:
- The logical file is not a join and not a view logical file.
- The logical file is based on multiple physical files.
- The program uses a file name instead of a record format name on the add operation.
A format selector program cannot be used to select a member if a file has multiple members; it can only select a record format.
When an application program wants to add a record to the database file, the system calls the format selector program. The format selector program examines the record and specifies the record format to be used. The system then adds the record to the database file using the specified record format name.
The following example shows the programming statements for a format selector program written in the RPG/400® language:
CL0N01N02N03Factor1+++OpcdeFactor2+++ResultLenDHHiLoEqComments+++... +++* C *ENTRY PLIST C PARM RECORD 80 C* The length of field RECORD must equal the length of C* the longest record expected. C PARM FORMAT 10 C MOVELRECORD BYTE 1 C BYTE IFEQ 'A' C MOVEL'HDR' FORMAT C ELSE C MOVEL'DTL' FORMAT C END
The format selector receives the record in the first parameter; therefore, this field must be declared to be the length of the longest record expected by the format selector. The format selector can access any portion of the record to determine the record format name. In this example, the format selector checks the first character in the record for the character A. If the first character is A, the format selector moves the record format name HDR into the second parameter (FORMAT). If the character is not A, the format selector moves the record format name DTL into the second parameter.
The format selector uses the second parameter, which is a 10-character field, to pass the record format name to the system. When the system knows the name of the record format, it adds the record to the database. You do not need a format selector if:
- You are doing update operations only. For update operations, your program already retrieved the record, and the system knows which physical file the record came from.
- Your application program specifies the record format name instead of a file name for an add or delete operation.
- All the records used by your application program are contained in one physical file.
To create the format selector, you use the create program command for the language in which you wrote the program. You cannot specify USRPRF(*OWNER) on the create command. The format selector must run under the user's user profile not the owner's user profile.
In addition, for security and integrity and because performance would be severely affected, not have any calls or input/output operations within the format selector.
The name of the format selector is specified on the FMTSLR parameter of the Create Logical File (CRTLF), Change Logical File (CHGLF), or Override with Database File (OVRDBF) command. The format selector program does not have to exist when the file is created, but it must exist when the application program is run.
Parent topic:
Adding database records
Related concepts
Controlling how records are added to a logical file with multiple formats
Related tasks
Creating a logical file