Enabling Java API recording
Java API recording turns on the client-side API logging to capture all client API calls along with detailed server responses.
Java API recording produces a command file (<username><servername><port>_arapicmd.log) and a result output file (<username><servername><port>_arapires.log).
To enable Java API recording
The values of the API configuration parameters in the sample file are the default values. Follow the steps given below to override the default values:
- Copy and rename the arsys_sample.xml file to arsys_api.xml and save the file in one of the following locations:
- For : <Mid-tier Installation>\WEB-INF\classes\
- For : <Dev Studio Installation>\plugins\com.bmc.arsys.studio.api_<version>\
Change the configuration parameter values you want to override. This value uses a bit mask to control the output. You can combine the values to get combined results. The following table describes the effect of each bit mask value.
Java API recording bit mask valuesValue
Output
0
Do not log data
1
Log data
2
Record in the append mode in the file
4
Record start and finish time
8
Record elapse time is milliseconds (ms)
16
Combine the command file and result file into a single output file
32
Do not record result data output
64
Buffer the file output
For example, setting Java API recording=42 (2+8 +32) adds the data to the results file in append mode (2) and adds only the elapsed time to the log (8) and does not record the result data output (32).
- Locate the <apiRecordingLogDir> tag in the arsys_api.xml file and specify the location for command file and results output file.
For example, <apiRecordingLogDir>specify the location</apiRecordingLogDir>