Options

Restriction: This topic applies to Windows environments only.

The SP tool comes configured to test your stored procedures using a set of default options. You can change the default options to customize the behavior of the SP Test tool. For example, you can set startup, execution and testing options, control the generation of COBOL code and certain files, specify a particular editor, specify directories, and set Wizard options.

You can set the following options to control the behavior of the SP Test tool. Default settings appear in a regular typeface. Non-default settings, directories and filenames appear bold. Read-only options are grayed-out.
Generate COBOL Code Generates a COBOL program that invokes:
  • The stored procedure
  • Result sets generated by the stored procedure
  • Host variables required to invoke the appropriate functions

Default: True

COBOL Specifies the directory where the SP Test tool stores the COBOL it generates, if any.

Default: %LOCALAPPDATA%

Input Saved Parameters Specifies the directory where the SP Test tool retrieves the XML file containing input parameters.

Default: %LOCALAPPDATA%

Output Saved Parameters Specifies the directory where the SP Test tool stores the XML file it generates containing output parameters.

Default: %LOCALAPPDATA%

Stored Procedures Specifies the debug directory for stored procedures. You must set this option before attempting to debug a stored procedure to prevent it from hanging during execution.

Default: %LOCALAPPDATA%.

Use Project Settings Specifies whether or not to apply the settings defined for the current project to the SP Test tool as well.

Default: False

Editor for Side Files Optionally provide the full path and executable filename of a non-Micro Focus editor you want to use to edit side files.

Default: Blank

Allow Output Side Files Enable the SP Test tool to save output results in a side file rather than viewing them on-screen. This is useful when large amounts of data are returned for a parameter.

Default: False

Alternate Entry Map Name Optionally specify the path to a directory that contains entry point map files.

Default: Blank

Timeout

The amount of time in milliseconds to process requests, such as REFRESH, before being prompted to continue waiting. To turn this option off, set the value to 0.

Default: 5000 (equivalent to 5 seconds)

Automatically Save Input File Save input files in XML format, automatically generating input filenames based on the value of the Format Input Filename field. This option is automatically set to False if you have set the Format Input Filename to No Default Format, and is automatically set to True when Format Input Filename is set to either Stored Procedure name + “_IN_” + current date or Stored Procedure name + “_IN_” + number.

Default: True

Encoding of Side Files Specify the type of encoding to use for side files. Available types are:
  • ASCII
  • EBCDIC
  • UNICODE
Note:

If you specify EBCDIC, the tool translates the value to ASCII using the Micro Focus codeset defined for your machine.

Default: ASCII

Format Input File Name Set a default filename format for generated XML input files, or specify no default filename format. The XDB Stored Procedure Test tool uses the specified format for input files when Automatically Save Input File is set to True. The options are:
  • Stored procedure name + “_IN_” + number
  • Stored procedure name + “_IN_” + current date
  • No default format

Default: Stored procedure name + “ _IN_” + number

Format Output File Name Set a default filename format for generated XML output files, or specify no default filename format. The options are:
  • Stored procedure name + number
  • Stored procedure name + current date
  • No default format

Default: Stored procedure name + number

Generate Output File Name Save output files in XML format, automatically generating ouput filenames based on the value of the Format Output Filename field. This option is automatically set to False if you have set the Format Output Filename to No Default Format, and is automatically set to True when Format Output Filename is set to either Stored Procedure name + current date or Stored Procedure name + number.

Default: True

Refresh List on Startup Build a new list of stored procedures and functions each time you invoke the XDB Stored Procedures Test tool, saved to a local XML file. For this option to work properly, you must have the XDB Server started before you invoke the tool.
Note: We recommend disabling this option in cases where the time required to rebuild the list is prohibitive, for example, when connecting to a mainframe DB2 server using XDB LINK. When disabled, the tool presents the list from your previous session. You can then refresh the list manually by clicking Refresh list of stored procedures.

Default: True

Test Coverage Config File Specify the configuration file to use when executing the stored procedure in test coverage mode. This is only applicable if you have set the Use Test Coverage option to True.

Default: Blank

Use Test Coverage Specify whether or not the tool executes stored procedures in test coverage mode.

Default: False

Test Script Generation Set the tool either to write the commands used to test a stored procedure to an ASCII command file, or to not save the commands. The options are:
  • Automatically save commands
  • Prompt before saving
  • Don't save commands

See the section Test Scripts for more information.

Default: Automatically save commands

Abend Options Specifies the behavior of the routine when it encounters a failure. The options are as follows:
  • Use Default Setting
  • STOP AFTER SYSTEM DEFAULT FAILURES
  • STOP AFTER nn FAILURES
  • CONTINUE AFTER FAILURE
Note: If you select STOP AFTER nn FAILURES, you must specify the number of failures (represnted by "nn") in the Abend field on the Wizard's Specify Options page.

Default: Use Default Setting1

ASU Time Specifies the total amount of processor time, in CPU service units, that a single invocation of the routine can run. Default: 0
Commit on Return Specifies whether or not DB2 commits the transaction immediately upon return from the routine. The options are:
  • Use Default Setting
  • YES
  • NO

Default: Use Default Setting1

DBINFO Parameter Specifies whether or not additional status information is passed when the routine is invoked.
Note:

This parameter is used only when the Parameter Style option is set to SQL.

Default: False

DETERMINISTIC Specifies whether or not the routine returns the same results each time it is called with the same IN and INOUT arguments. Default: False
Dynamic Result Sets Specifies the maximum number of result sets that the routine can return. Default: 0
Execute on FINISH Specifies whether or not the Wizard executes the generated routine when you click Finish. Default: False
Fenced Specifies whether or not the routine runs in an external address space to prevent user programs from corrupting DB2 storage. Default: False
Parameter CCSID Specifies the encoding scheme for string parameters. The options are:
  • ASCII
  • EBCDIC
  • UNICODE

Default: EBCDIC

Parameter Style Specifies the linkage convention used to pass parameters to and return values from the routine. The options are:
  • GENERAL
  • GENERAL WITH NULLS
  • SQL

Default: GENERAL

Language Specifies the language used to interface with the routine. The options are:
  • COBOL
  • C
  • PLI
  • ASSEMBLER
  • REXX

Default: COBOL

Run-time options Specifies the Language Environment run-time options for the routine. Default: none (blank)
Security Specifies how the routine interacts with an external security product to control access to non-SQL resources. The options are:
  • Use Default Setting
  • DB2
  • USER
  • DEFINER

Default: Use Default Setting1

SQL Statement Defaults Specifies which SQL statements, if any, can be executed in this routine or any routine that is called from this routine. The options are:
  • Modifies SQL Data
  • Reads SQL Data
  • Contains SQL
  • No SQL

Default: Modifies SQL Data

Stay Resident Specifies whether or not the routine's load module remains resident in memory when the routine ends.

Default: False

Use Default Special Register Specifies whether or not special registers are initialized to the default values.

Default: False

WLM Environment Specifies the name of the WLM (workload manager) environment in which the routine is to run when the DB2 stored procedure address space is WLM-established.

Default: Blank

1The default setting for this option depends on the type of code the Wizard is generating - stored procedure, external table function, or external scalar function. The default setting for each type of code is that which appears in the field corresponding to this option when you first invoke the Wizard's Specify Options page.

Note: You can override Wizard options on the Specify Options page of each wizard.