Docs.bmc.com brief outage

This site, docs.bmc.com, will undergo a brief outage of less than ten minutes starting at 5 PM CDT June 12/3:30 AM IST June 13.

Default language.

Client-side ARAPILOGGING

For Windows clients and applications that use the C API, such as the BMC Remedy Email Engine, and so on, you can enable the ARAPILOGGING environment variable to capture all client API calls along with detailed server responses. This log contains different information than the client-side logs that you configure in the user preferences.

ARAPILOGGING can help in troubleshooting situations where you need to determine what client action is generating an error or a delayed response. BMC Software technical support might request a copy of this log when working on an issue. ARAPILOGGING works for all windows clients, the ODBC driver, and API programs that use the arapinn.dll.

When this is enabled, the client logs each API call along with the server response to the file clientInstallDir\arapires.log. If bit 16 is not set, client calls are recorded separately in clientInstallDir\arapicmd.log.

A new log is created each time you restart the client. Previous logs are saved with a sequential number appended to the name, for example, arapires_1.log, arapires_2.log, and so on. (For more information, see the Maximum Backups definition at Setting-log-files-options.)

Warning

To avoid consuming disk space unnecessarily, do not leave ARAPILOGGING turned on indefinitely. If you do, the client will continue to log every action while saving old copies of the log files. One way to avoid this is to use the command prompt method to set the variable and start the client as described in this section.

Setting the ARAPILOGGING environment variable

You can set the value of the ARAPILOGGING environment variable to control how the information is logged. This option uses a bit mask to control the log output. You can combine the values to get combined results in the log. The following table describes the effect of each bit mask value.

ARAPILOGGING bit mask values

Best practice
We recommend that you set ARAPILOGGING to 24. Setting ARAPILOGGING=24 (8 +16) adds start, finish, and elapsed time to the log (8) and combines the commands and results in the arapires.log (16). In addition, setting the value to 24 adds the user name, server name, and port number to the output described in this section. This is helpful when you need to use ARAPILOGGING in a multi-user or multi-server environment.

To enable ARAPILOGGING using the Windows System Properties dialog box

  1. Open the Windows System Properties dialog box as appropriate for your operating system. For example, right-click My Computer, and then select Properties.
  2. Click the Advanced tab, and then click Environment Variables.
  3. In the System Variables area, click New, and then enter the following values:
    • Variable name: ARAPILOGGING
    • Variable value: value
  4. Click OK to save the variable and exit Windows System properties.

In the browser, perform the actions that you want to capture in the log.
When you have completed capturing information to the log, turn off ARAPILOGGING by repeating steps 1 through 4 and setting the value of ARAPILOGGING to 0.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*