cprflevel (display or change the PRF trace collection level)

Format

cprflevel [-PRFID prf-identifier] [-h]
         [-PrfChangeLevel prf-trace-collection-level[,[prf-trace
         collection-level]...]]
         [-PrfLevelIndex index-number] [-PrfLevelAll]

Function

This command displays or changes the PRF trace collection level.

When the -PrfChangeLevel option is omitted, the PRF trace collection level set for the specified PRF identifier is displayed. When the -PrfChangeLevel option is specified, the PRF trace collection level set for the specified PRF identifier is changed to the value specified here.

When the -PrfLevelIndex option is specified, a list of PRF trace collection levels for the specified index is displayed. When the -PrfLevelAll option is specified, the PRF trace collection levels for all indexes are displayed.

Arguments

-PRFID prf-identifier
Specifies a PRF daemon identifier, as 1 to 31 alphanumeric characters and the underscore (_). Do not specify a character string that begins with TSC or tsc or with CTM or ctm. If this argument is omitted, the character string PRF_ID is assumed.
-h
Displays the command's usage.
-PrfChangeLevel prf-trace-collection-level[,[prf-trace-collection-level]...]
Specifies PRF trace collection levels, each as a 4-byte hexadecimal number (8-digit value). Here, you can add 0x at the beginning of the 4 byte hexadecimal number; however, 0x is ignored. You can specify multiple trace collection level values, corresponding to the index numbers (left to right), delimited by a comma (,). If the level value for an index is not to be changed, do not specify any value. To omit specification of level values for all index numbers beginning after a specific index number, omit all the subsequent comma delimiters. To set the PRF trace collection level for index No. 1 to (1) and the PRF trace collection level for index No. 2 to (2), specify the arguments as (1),(2),....
The table below shows examples of PRF trace collection level specifications.

Table 4-3 PRF trace collection level specification examples (cprflevel command)

PRF trace collection level specification exampleOption specification
Specify a PRF trace collection level for index No. 1-PrfChangeLevel 0x44445555​
Specify PRF trace collection levels for index Nos. 1 and 2-PrfChangeLevel 0x44445555​,0x55554444​
Specify a PRF trace collection level for index No. 2-PrfChangeLevel,0x55554444​
Assignment of PRF trace collection levels at each functionality layer is explained here.
A PRF trace collection level is specified as an eight-digit hexadecimal number for each index. Each digit is allocated two functionality layers. When a hexadecimal number is expressed as a decimal number, the functionality layer allocated to the upper 2 bits is called the upper layer, and the functionality layer allocated to the lower 2 bits is called the lower layer.
The table below shows the functionality layers that are allocated to the upper and lower layers for each digit.

Table 4-4 Specification values for collecting detail-level trace information (cprflevel command)

IndexDigitsUpper layerLower layer
Index 1Digit 1RedirectorWeb container
Digit 2EJB containerJNDI
Digit 3JTAJCA container
Digit 4DB ConnectorRMI
Digit 5SOAP Communication Infrastructure'uCosminexus TP1 Connector,
TP1/Client/J
Digit 6TP1/Message Queue - AccessCosminexus RM
Digit 7OTSCTM
Digit 8CTMCTM
Index 2Digit 1HCSC serverStandard output, standard error output, and user log
Digit 2DIuCosminexus Service Coordinator Interactive Workflow
Digit 3HCSC server (Object Access Adapter)HCSC server (File Adapter)
Digit 4HCSC server (Message Queue Adapter)Cosminexus JPA
Digit 5JAX-WS engineJPA container
Digit 6Cosminexus JMS Provider functionalityTP1 inbound adapter
Digit 7HCSC server (FTP Adapter)JavaMail
Digit 8Java VMJSF and JSTL
Index 3Digit 1Batch Application Execution Base(None)
Index 4Digit 1CDI(None)
Index 9Digit 1Elastic Application Data store(None)
To specify a PRF trace collection level, decide whether to specify Standard, Detail, or Maintenance for the PRF trace collection level of the upper and lower layers for each digit, and specify it as a hexadecimal number. The table below shows the correspondence between combinations of PRF trace collection levels for the upper and lower layers with specification values.
Note that because the Maintenance level is used for collecting maintenance information when an error occurs, it should not be specified during normal operation.

Table 4-5 Specification values for collecting detail-level or maintenance-level trace information (cprflevel command)

Upper layerLower layerSpecification value
StandardStandard0
StandardDetail1
StandardMaintenance2
DetailStandard4
DetailDetail5
DetailMaintenance6
MaintenanceStandard8
MaintenanceDetail9
MaintenanceMaintenancea
Specification examples are shown below.

Table 4-6 PRF trace collection level specification examples (cprflevel command)

IndexSpecification exampleExplanation
Index 100000000​Acquires Standard-level trace information from each functionality layer of index 1.
00000004​Acquires Detail-level trace information only from CTM, and acquires Standard-level trace information from other functionality layers.
55555544​Acquires Detail-level trace information from each functionality layer of index 1.
a5565544​Acquires maintenance information from the redirector, Web container, and RMI, and acquires Detail-level trace information from other functionality layers.
Index 200000000​Acquires Standard-level trace information from each functionality layer of index 2.
40000000​Acquires Detail-level trace information only from HCSC server.
You can specify the control-level for RMI.
Specify the following values as the specification value (fourth digit of index one) of trace collection level to specify the control-level for RMI.

Table 4-7 Specification value of the RMI control-level

Upper layer
(DB Connector)
Lower layer
(RMI)
Specification value
StandardControl3
DetailControl7
MaintenanceControlb
-PrfLevelIndex index-number
Specifies the index number of the PRF trace collection level to be changed or referenced, as an integer in the range 1 to 16. The default value is 1. When this argument is specified together with -PrfChangeLevel, the PRF trace collection level for the specified index number is changed to the value specified in -PrfChangeLevel.
When this argument is specified but -PrfChangeLevel is not specified, the PRF trace collection level for the specified index number is displayed. When you specify this argument together with -PrfChangeLevel, be sure to specify only a single value in -PrfChangeLevel.
Example: Change the value for the second index number to 0x55554444

cprflevel -PrfChangeLevel 0x55554444 -PrfLevelIndex 2

If multiple values are specified in -PrfChangeLevel, an option error occurs.
Example: Specify multiple values in -PrfChangeLevel

cprflevel -PrfChangeLevel,0x55554444,0x55554444 -PrfLevelIndex 2

This is because multiple values are specified in -PrfChangeLevel even though 2 is specified in -PrfLevelIndex. If the specification of -PrfLevelIndex is omitted, 1 is assumed.
-PrfLevelAll
Displays all level values. This option cannot be specified together with -PrfChangeLevel or -PrfLevelIndex. The table below shows the combinations of this option and -PrfLevelIndex.

Table 4-8 -PrfLevelAll and -PrfLevelIndex combinations

cprflevel current level value display method-PrfLevelIndex
SpecifiedNot specified
-PrfLevelAllSpecifiedOption errorDisplays all level values
Not specifiedDisplays the level value of only the specified indexDisplays the level value of index 1 only

The table below shows the command option combinations that can be specified.

Table 4-9 Argument (command option) combination list (cprflevel command)

Command
option
-h-PRFID-PrfChange
Level
-PrfLevel
Index
-PrfLevel
All
-h--[Figure]-h[Figure]-h[Figure]-h[Figure]-h
-PRFID[Figure]-h--YYY
-PrfChangeLevel[Figure]-hY--YN
-PrfLevelIndex[Figure]-hYY--N
-PrfLevelAll[Figure]-hYNN--
Legend:
Y: Can be simultaneously specified
[Figure]: Valid with the option whose name follows the [Figure]
N: Cannot be simultaneously specified
--: Not applicable

Return values

0:
The command terminated normally.
1:
The PRF daemon is not active. Either the PRFSPOOL environment variable is different from the one assumed for the PRF daemon or the value of -PRFID is invalid.
2:
The PRFSPOOL environment variable has not been set up.
Other than the above:
An error occurred during command processing. Take the corrective action indicated in the output message, and then re-execute the command. The error message is output to the standard error output and a log file. For acquiring data, see 2.4.3 Correspondence between the collection and checking methods in the uCosminexus Application Server Maintenance and Migration Guide.

Input/output examples

Notes