6.5.8 Component-ID configuration file

Organization of this subsection

(1) Format
(2) Function
(3) File storage location
(4) Specifiable parameters
(5) Example of coding

(1) Format

[HCSC-component-ID={ON|OFF}]
 ...
[HCSC-component-ID={ON|OFF}]

To Page Top

(2) Function

Specifies whether to output HCSC component information for the user message trace based on HCSC component IDs (reception IDs or service IDs). Specify one HCSC component in one file in the J2SE property file format.

Reference note

To specify whether to output the user message traces based on HCSC component types, set up the component-type configuration file.

You can set up both the component-ID configuration file and the component-type configuration file. If you specify the same HCSC component in both of these files, the setting of the component-ID configuration file will be applied.

To Page Top

(3) File storage location

There is no template file for a component-ID configuration file.

You can store the created component-ID configuration file with any name and in any location.

To enable the created component-ID configuration file, specify the path in the telegramtrace-component-id-filepath property of the HCSC server runtime definition file.

To Page Top

(4) Specifiable parameters

HCSC-component-ID={ON|OFF}

Specifies whether to output HCSC component information for the user message trace.

HCSC-component-ID

Specify the service ID or reception ID.

{ON|OFF}

Specifies whether to output the specified HCSC component information for the user message trace.

ON: Information is output for the user message trace.
OFF: Information is not output for the user message trace.

The setting (ON or OFF) is determined based on exact match. If you specify any other value or empty characters, the operation is the same as when no component ID is specified.

Note that you can also use the component-type configuration file (containing the HCSC component types) to specify whether to output HCSC component information for the user message trace. If you specify the same HCSC component in the component-ID configuration file and the component-type configuration file, the setting of the component-ID configuration file will be applied.

To Page Top

(5) Example of coding

The following shows an example when the following information is output for the user message trace:
- Information for HCSC component ID RCP1 is output.
- Information for HCSC component ID ADP1 is not output.
In this case, specify as follows in the component-ID configuration file.
```
RCP1=ON
ADP1=OFF
```
To output information for all FTP receptions and FTP adapters except for HCSC component IDs FTP_RCP1, FTP_ADP1, and FTP_ADP3 for the user message trace, specify as follows in the component-type configuration file and the component-ID configuration file.
- Contents of the component-type configuration file (output of FTP receptions and FTP adapters) are as follows:
```
reception.urecp.ftp
adapter.ftp
```
- Contents of the component-ID configuration file (excluding HCSC component IDs FTP_RCP1, FTP_ADP1, and FTP_ADP3 from the output target) are as follows:
```
FTP_RCP1=OFF
FTP_ADP1=OFF
FTP_ADP3=OFF
```

To Page Top