The PowerBSORT operating environment is controlled by several environment variables. These variables can be set using any of the techniques provided by Windows. Consult your Windows documentation for more information for setting environment variables.
The environment variable settings establish default values which may be overridden during execution of PowerBSORT.
Environment variable | Meaning |
|---|---|
Checking level | |
COBOL file system option | |
Application log output | |
FIFO (first-in, first-out) option | |
Work area size | |
Message output file name | |
Message output level | |
Data, error message output destination definition | |
Output form of message | |
Whether or not +0 and -0 are treated as the same value | |
Whether or not record summation continues after an overflow occurs | |
Temporary file folder name | |
Defining the beginning year for data form of "two digit years" | |
Unicode UCS-2 format byte order | |
Unicode UTF-32 format byte order | |
Whether or not BOM is skipped |
BSORT_CHKLEVEL={0 | 1}
The check option within PowerBSORT is specified.
Level | Meaning |
|---|---|
0 | Nothing checked (Default value) |
1 | Interface check with BSORT function is performed. |
BSORT_COBFSYS_MODE={NORMAL | BSAM}
Specify COBOL file system option. When order file is processed by COBOL file system, this option is effective. The default value is NORMAL.
Specified value | Meaning |
|---|---|
NORMAL | A previous version COBOL file system is used. (Default value) |
BSAM | BSAM (high-speed processing) is used. |
Note
Record locking is not implemented when BSAM is specified.
The size of the maximum file which can be used is up to an upper bound value of COBOL file system. Please refer to the NetCOBOL manual for the upper bound value of the size of the file.
This specification applies to all data files, input and output.
BSORT_EVENTLOG={N | E | W | I | YES | NO}
Specifies the level of messages output to the application log by PowerBSORT.
Specified value | Meaning |
|---|---|
N | Nothing is output. (Default value) |
E | Error messages are output. |
W | Error messages and warning messages are output. |
I | Error messages, warning messages and information messages are output. |
The YES and NO values used by previous versions can also be specified.
When YES is specified, only the important error information that PowerBSORT detected can be output to the application log. Messages are output when there is insufficient memory for PowerBSORT to run, and when the file system detects an I/O error. For more information, refer to the Application Log Output Messages.
Specified value | Meaning |
|---|---|
YES | Error information is output to the application log. |
NO | Error information is not output to the application log. (Default value) |
BSORT_FIFO={ON | OFF}
The FIFO (first-in, first-out) option is specified.
Specified value | Meaning |
|---|---|
ON | When the value of the specified key field is the same, those records are output in input order. This is effective for the sort function. The specification of the fifo (first-in, first-out) option is disregarded when combined with the merge function, the copy function, the record summation option, and the suppression option. |
OFF | The order of records with the same key may be different in the output file compared to the input file. (Default value) |
BSORT_MEMSIZE=n
The size of the work area that PowerBSORT uses is specified in kilobytes.
The work area is specified within the range from 32 to 2097151 kilobytes. When 0 is specified, or specifying BSORT_MEMSIZE is omitted, the work area is automatically set. When the value of 2097152 or more is specified, 2097151 are assumed.
To run PowerBSORT efficiently, specify the memory size of 1/50 or more of the amount of input data. However, when the calculation value (1/50 of the amounts of input data) falls below 8192 kilobytes, 8192 kilobytes is recommended.
BSORT_MSGFILE=Message output file name
This specifies the file path name in which the message output by PowerBSORT is stored.
When a file name contains a blank, the file name need not be enclosed with double quotation (").
BSORT_MSGLEVEL={N | E | W | I | 0 | 1 | 2}
This specifies the level of messages output by PowerBSORT.
Level | Meaning |
|---|---|
N | Nothing output. |
E | Error messages are output. |
W | Error messages and warning messages are output. (Default value) |
I | Error messages, warning messages and information messages are output. |
The following types (level) can be specified for use with previous versions.
Level | Meaning |
|---|---|
0 | Nothing is output. |
1 | Error messages and warning messages are output. (Default value) |
2 | Error messages, warning messages and information messages are output. |
BSORT_MSGOUT={STDOUT | STDERR}
An output destination of an information message, warning message, and an error message are specified.
Specified value | Meaning |
|---|---|
STDOUT | Information messages are not output to standard outputs, although error messages and warning messages are output to standard outputs. When a message file is specified, the error messages and warning messages are output to a standard output, and the error messages, warning messages, and the information messages are output to the message file as well. |
STDERR | Information messages, warning messages, and error messages are output to standard error outputs. When a message file is specified, the error messages and warning messages are output to the standard error output, and the information messages, warning messages, and the error messages are output to the message file as well. (Default value) |
Example
Example 1) the error messages and output destinations of information messages and the processing results when STDOUT is specified for environment variable BSORT_MSGOUT are as follows:
PowerBSORT Behavior | Warning message and Error message | Information message | Processing result |
|---|---|---|---|
Normal termination | None | None | Redirected file |
Fail | Redirected file | None | None |
Example 2) the error messages and output destinations of information messages and the processing results when STDERR is specified for environment variable BSORT_MSGOUT are as follows.
PowerBSORT Behavior | Warning message and Error message | Information message | Processing result |
|---|---|---|---|
Normal termination | None | Display (Standard error output) | Redirected file |
Fail | Display (Standard error output) | Display (Standard error output) | None |
BSORT_MSGSTYLE={1 | 2}
The output form of the message is specified.
Specified value | Meaning |
|---|---|
1 | Output only the the message text. This is the form output by the version before V5. |
2 | Output the header, the message type, the date, the message number, and the message text. (Default value) |
BSORT_SIGNEDZERO={EFFECT | IGNORE}
For data that can be expressed as "+0" and "-0", specify whether "+0" and "-0" are to be treated as equivalent.
Specified value | Meaning |
|---|---|
EFFECT | "+0" and "-0" are treated as different. |
IGNORE | "+0" and "-0" are treated as equivalent. (Default value) |
Information
The following data forms can be expressed as "+0" and "-0":
Packed decimal number
External decimal number
Leading separate signed number
Trailing separate signed number
Leading overpunch signed number
Trailing overpunch signed number
When n(BSOPT_NUMERIC) is specified for an operation of the key field and the selection field at the text file.
When N(BSOPT_CHARNUM) is specified for an operation of the key field at the text file.
When EFFECT is specified, "+0" and "-0" becomes "+0">"-0".
The version before V5 operate as if EFFECT was selected.
BSORT_SUMOVERCONT={ON | OFF}
Specify whether or not record summation continues after an overflow occurs.
Specified value | Meaning |
|---|---|
ON | The record summated immediately before the overflow occurred is output and subsequent records with the same key field are summated as separate records. This is repeated whenever an overflow occurs. |
OFF | The record summated immediately before the overflow occurred is output. Subsequent records with the same key field are not summated. (Default value) |
BSORT_TMPDIR=Temporary file folder name[;Temporary file folder name...]
A folder name specifying where PowerBSORT temporary files are created. When you process to sort the file of the amount that cannot be processed within the memory alone, a temporary file is created in a folder specified by environment variable BSORT_TMPDIR.
You can also specify two or more folder names by delimiting the folders by semicolon (;). Specifying two or more folder names in different drives could prevent the error due to free space shortage. Do not put an unnecessary character string such as a blank before and behind the semicolon (;) when you specify two or more folder names. PowerBSORT decides the order of creating temporary files according to the following priority levels. When the specified folder name does not exist, it is an error.
Folder specified by environment variable BSORT_TMPDIR
Folder specified by environment variable TEMP
Folder specified by environment variable TMP
Windows system folder
BSORT_TOPYY=yy
Define the beginning year for data form of "two digit years".
For instance, if BSORT_TOPYY=50 is specified, the effective range is from 1950 to 2049. The default value for yy is 60. BSORT_TOPYY is used when a data form of "two digit years" field is specified.
BSORT_UCS2TYPE={BIG_ENDIAN | LITTLE_ENDIAN}
Specify the Unicode UCS-2 format byte order.
Valid when the data format is set to UCS-2 using the PowerBSORT command line interface.
Specified value | Meaning |
|---|---|
BIG_ENDIAN | Sets Big Endian. |
LITTLE_ENDIAN | Sets Little Endian. (Default value) |
BSORT_UTF32TYPE={BIG_ENDIAN | LITTLE_ENDIAN}
Specify the Unicode UTF-32 format byte order.
Valid when the data format is set to UTF-32 using the PowerBSORT command line interface.
Specified value | Meaning |
|---|---|
BIG_ENDIAN | Sets Big Endian. |
LITTLE_ENDIAN | Sets Little Endian. (Default value) |
BSORT_UNICODEBOM={ON | OFF}
Specify whether or not the Unicode byte order marker, BOM, is skipped.
Valid when the input file is a text file and the code set of that file is Unicode (UCS-2, UTF-32, or UTF-8).
If a BOM exists in the input file and is skipped, a BOM is still inserted in the output file. If multiple input files are specified, a BOM exists in the first input file specified, and the BOM was skipped, a BOM is inserted in the output file.
Specified value | Meaning |
|---|---|
ON | Skips the BOM. Note that, if the head of the file is anything other than a BOM, it is not skipped. (Default value) |
OFF | Does not skip the BOM. |
