Override with Display File (OVRDSPF)

The Override with Display File (OVRDSPF) command is used to: (1) override (replace) the file named in the program, (2) override certain parameters of a file that are used by the program, or (3) override the file named in the program and override certain parameters of the file processed. Parameters overridden by this command are specified in the file description, in the program, or in other called file override commands.

If a file named in the program is overridden, the name of that file is specified in the FILE parameter and the name of the overriding file (the file being processed) is specified in the TOFILE parameter. The OVRDSPF command also specifies parameters to override values contained in the file description of the overriding file. If the file named in the program is not replaced but certain parameters of the file are overridden, the name of the file is specified in the FILE parameter and *FILE is specified in the TOFILE parameter. The parameters overridden are then specified by the other parameters of the OVRDSPF command. Parameters that are not specified do not affect parameters specified in the file description, in the program, or in other called file override commands.

More information on override files is in the Application Display Programming book, SC41-5715.

Note: Using this command does not cause a file to be overridden immediately. Information provided on this command is stored until the file is used, at which time the file is overridden.

Parameters

Keyword	Description	Choices	Notes
FILE	File being overridden	Name	Required, Positional 1
TOFILE	Overriding to display file	Single values: FILE Other values: Qualified object name*	Optional, Positional 2
	Qualifier 1: Overriding to display file	Name
	Qualifier 2: Library	Name, LIBL, CURLIB
DEV	Device	Values (up to 50 repetitions): Name, *REQUESTER	Optional, Positional 3
CHRID	Character identifier	Single values: DEVD, SYSVAL, JOBCCSID, CHRIDCTL Other values: Element list	Optional
	Element 1: Graphic character set	Integer
	Element 2: Code page	Integer
DECFMT	Decimal format	FILE, JOB	Optional
SFLENDTXT	SFLEND text	MSG, FILE	Optional
IGCDTA	User specified DBCS data	NO, YES	Optional
IGCEXNCHR	DBCS extension characters	YES, NO	Optional
WAITFILE	Maximum file wait time	Integer, IMMED, CLS	Optional
WAITRCD	Maximum record wait time	1-32767, NOMAX, IMMED	Optional
LVLCHK	Record format level check	*NO	Optional
SECURE	Secure from other overrides	NO, YES	Optional
OVRSCOPE	Override scope	ACTGRPDFN, CALLLVL, *JOB	Optional
DTAQ	Data queue	Single values: NONE Other values: Qualified object name*	Optional
	Qualifier 1: Data queue	Name
	Qualifier 2: Library	Name, LIBL, CURLIB
SHARE	Share open data path	YES, NO	Optional
OPNSCOPE	Open scope	ACTGRPDFN, JOB	Optional

Top

Overriding to display file (TOFILE)

Specifies the display file that is used instead of the file specified in the File being overridden (FILE) parameter, or, if *FILE is specified, specifies that certain attributes are overridden by parameters specified in this command. The parameters specified on this command override the same parameters specified in the display device file, in the program, or in other called (OVRDSPF) commands.

Single values

*FILE: The display device file named in the FILE parameter has some of its parameters overridden by values specified in this command.

Qualifier 1: Overriding to display file

name: Specify the name of the display device file that is used instead of the overridden file.

Qualifier 2: Library

*LIBL: All libraries in the library list for the current thread are searched until the first match is found.

*CURLIB: The current library for the job is used to locate the device file. If no current library entry exists in the library list, QGPL is used.
name: Specify the library where the device file is located.

Device (DEV)

Specifies the names of one or more display devices that are used with the display device file. This parameter overrides the device names specified in the device file, in the program, or in other called Override with Display File (OVRDSPF) commands. The device name specified in the IBM-supplied display device file is *REQUESTER.

This parameter overrides the device names specified in the device file, in the program, or in other called OVRDSPF commands.

*REQUESTER: The display device from which the program is called is the device assigned to the file when the file is opened.

name: Specify the names of one or more display devices that are used with this device file to pass data records between the users of the devices and the system. Each device name must already be known on the system (in a device description) before this device file is created. *REQUESTER can be specified as one of the names.
A maximum of 50 device names (including *REQUESTER, if it is specified) can be specified in this command, but the total number cannot exceed the number specified on the Maximum devices (MAXDEV) parameter when the file is opened.

Character identifier (CHRID)

Specifies the character identifier (graphic character set and code page) for the file. When a display file that was created with the CHRID DDS keyword is used with a work station device, the system translates data sent to and received from the device (as necessary) to ensure that the correct characters are displayed, and the correct hexadecimal byte values are returned to the application program. More information about display file CHRID processing and the translation tables that are used to convert data sent to and received from the display are in the Application Display Programming book, SC41-5715.

Single values

*DEVD: The CHRID value specified in the device description of the work station on which the application is running is used. The *DEVD value means no translation is necessary because the file has the same character identifier as the work station. For a list of valid values, see the CHRID parameter of the Create Device Description Display (CRTDEVDSP) command.
*SYSVAL: The CHRID value specified for the system on which the application is running is used. Translation may be necessary depending on the character identifier of the work station.
*JOBCCSID: The character data is changed from the device CHRID to the CCSID (coded character set identifier) of the job on display file input, and from the CCSID of the job to the device CHRID on display file output. The character data is converted, if necessary, from the device CCSID (coded character set identifier) of the job during input, and from the CCSID of the job to the device CHRID on output.
Note: This value is not allowed if the file was created on a system at an earlier release level than V2R3M0.
*CHRIDCTL: The system checks the CHRIDCTL job definition attribute to determine whether to use *JOBCCSID or *DEVD on the CHRID command parameter for this file.

Element 1: Graphic character set

integer: Specify the graphic character set value that matches the attributes of the display device. Valid values range from 1 through 32,767.

Element 2: Code page

integer: Specify the code page value that matches the attributes of the display device. Valid values range from 1 through 32,767.

Decimal format (DECFMT)

Specifies which decimal format value is used when editing numeric fields with the EDTCDE DDS keyword. The decimal format value determines the use of commas and periods for the decimal position and three digit positional separators on edited fields.

*FILE: Use the decimal format value stored with the file when the file was created.
*JOB: Use the decimal format value from the DECFMT job attribute when the file is opened.

SFLEND text (SFLENDTXT)

Specifies where the 'More...' and 'Bottom' text is retrieved from when displaying a subfile. The 'More...' and 'Bottom' text is displayed in a subfile when the SFLEND(*MORE) DDS keyword is specified on the subfile control record.

*MSG: Use the 'More...' and 'Bottom' text retrieved from messages CPX6AB1 and CPX6AB2 which exist in the current active language of the system when the file is opened.
*FILE: Use the 'More...' and 'Bottom' text that is stored in the file during file creation. This text was retrieved from messages CPX6AB1 and CPX6AB2 which exist in the active language of the system when the file was created.

User specified DBCS data (IGCDTA)

Specifies, for program-described files, whether the file processes double-byte character set (DBCS) data. Specifies, for externally described files, the DBCS attributes of the file.

For program-described files:

*NO: The file does not process double-byte character set (DBCS) data.

*YES: The file processes double-byte character set (DBCS) data.

For DDS files:

*NO: The only DBCS attributes of the file are those defined in the DDS.
*YES: DBCS attributes in addition to those defined in the DDS, include (1) putting the DDS keyword for alternative data type (IGCALTTYP) into effect, and (2) identifying DBCS attributes of fields or messages not identified in the DDS.

Maximum file wait time (WAITFILE)

Specifies the number of seconds that the program waits for the file resources to be allocated when the file is opened, or the device or session resources to be allocated when an acquire operation is performed to the file. If the file resources cannot be allocated in the specified wait time, an error message is sent to the program.

More information on this parameter is in the CL concepts and reference topic in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter, Appendix A.

Note: An immediate allocation of the device by the device resource is required when an acquire operation is performed to the file.

This parameter overrides the wait time specified in the device file, in the program, or in other called OVRDSPF commands.

*IMMED: The program does not wait. Immediate allocation of file resources is required.

*CLS: The default wait time specified in the class description is used as the wait time for the allocation of the file resources.
integer: Specify the number of seconds that the program waits for the allocation of the file resources. Valid values range from 1 through 32767 seconds.

Maximum record wait time (WAITRCD)

Specifies the number of seconds the program waits for the completion of a read-from-invited-program-devices operation to a multiple device file in an HLL program. More information on how to determine when a file is considered a multiple device file is in the appropriate HLL reference manual. The program performing the read operation waits for input from all invited devices currently acquired by the file. If a record is not returned from an invited device within the specified amount of time, a notify message is sent to the program. This parameter has no effect on an input operation directed to one device.

This parameter is also used to specify the number of seconds that a CL program waits to complete a WAIT command. If a record is not returned from any of the devices that should return a record, the CL program is sent an escape message.

This parameter overrides the wait record value specified in the device file, in the program, or in other called OVRDSPF commands.

*NOMAX: There is no limit on the amount of time the program waits for completion of a read-from-invited-program-device operation for the file.

*IMMED: The program does not wait. If a record is not available when the read-from-invited-devices operation is done, a notify message is sent to the program.

1-32767: Specify the number of seconds that the program waits for the completion of the read-from-invited-program-device operations.

Record format level check (LVLCHK)

Specifies whether the level identifiers of the record formats in this device file are checked when the file is opened by a program. For this check, which is done when the file is opened, the system compares the record format identifiers of each record format used by the program with the corresponding identifiers in the device file. Because the same record format name can exist in more than one file, each record format is given a unique internal system identifier when the format is created.

Level checking cannot be done unless the program contains the record format identifiers. This command cannot override level checking from *NO to *YES.

*NO: The level identifiers are not checked when the file is opened.

Override scope (OVRSCOPE)

Specifies the extent of influence (scope) of the override.

*ACTGRPDFN: The scope of the override is determined by the activation group of the program that calls this command. When the activation group is the default activation group, the scope equals the call level of the calling program. When the activation group is not the default activation group, the scope equals the activation group of the calling program.
*CALLLVL: The scope of the override is determined by the current call level. All open operations done at a call level that is the same as or higher than the current call level are influenced by this override.
*JOB: The scope of the override is the job in which the override occurs.

Data queue (DTAQ)

Specifies the data queue that receives an entry from the system when a data-available event is signaled from an invited display device. The data queue need not exist when the display file is created since the name specified on this parameter is not evaluated until the file is used. More information on the data queue function is in the CL information in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter.

Single values

*NONE: No data queue is specified.

Qualifier 1: Data queue

name: Specify the name of the data queue on which entries are placed.

Qualifier 2: Library

*LIBL: All libraries in the library list for the current thread are searched until the first match is found.

*CURLIB: The current library is used to locate the data queue. If no library is specified as the current library, QGPL is used.
name: Specify the library where the data queue is located.

Share open data path (SHARE)

Specifies whether the open data path (ODP) is shared with other programs in the same routing step. When an ODP is shared, the programs accessing the file share facilities such as the file status and the buffer.

More information on shared database files is in the Database information in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter.

This parameter overrides the value specified in the device file, in the program, or in other called OVRDSPF commands.

*NO: The ODP is not shared with other programs in the routing step. A new ODP for the file is created and used every time a program opens the file.

*YES: The same ODP is shared with each program in the job that also specifies *YES when it opens the file.

Open scope (OPNSCOPE)

Specifies the extent of influence (scope) of the open operation.

*ACTGRPDFN: The scope of the open operation is determined by the activation group of the program that called the OVRDSPF command processing program. If the activation group is the default activation group, the scope is the call level of the caller. If the activation group is a non-default activation group, the scope is the activation group of the caller.
*JOB: The scope of the open operation is the job in which the open operation occurs.

Examples

OVRDSPF   FILE(DISPLAY75)  WAITFILE(30)

This command overrides the file wait time value specified in the DISPLAY75 device file description, in the program, or in other called OVRDSPF commands. The program in which this command occurs waits up to 30 seconds (if necessary) to allocate the required file resources to the file named DISPLAY75.