Remedy - DevStudio - How to enable API logging for Developer Studio - includes video

Version 4
    Share This:

    This document contains official content from the BMC Software Knowledge Base. It is automatically updated when the knowledge article is modified.


    PRODUCT:

    Remedy AR System Server


    COMPONENT:

    AR System


    APPLIES TO:

    BMC Remedy AR System Developer Studio



    QUESTION:

     
       How do I enable client side logging to debug the actions being performing in Developer Studio? 


    ANSWER:

     

       
     
      Developer Studio uses Java API when connecting to AR Server and hence the traditional option which involves setting an environment variable named ARAPILOGGING does not help.

    To enable client-side API logging, please use the following steps:

    1- Close Developer Studio.

    2- Find "arsys_sample.xml"  in "..\DeveloperStudio\plugins\com.bmc.arsys.studio.api_<versionstring>".
                    - In v8.1, v8.1.01 and 8.1.02:...\DeveloperStudio\plugins\com.bmc.arsys.studio.api_8.1.0.build001
                    - In v9.0: ...\DeveloperStudio\plugins\com.bmc.arsys.studio.api_9.0.0.build001
                    - In v9.1: ...\DeveloperStudio\plugins\com.bmc.arsys.studio.api_9.1.0.build001
                    In v9.1.02:...\DeveloperStudio\plugins\com.bmc.arsys.studio.api_9.1.2.build001
                    In v9.1.03:...\DeveloperStudio\plugins\com.bmc.arsys.studio.api_9.1.3.build002
                   In v9.1.04: ...\DeveloperStudio\plugins\com.bmc.arsys.studio.api_9.1.4.build003
                    In v9.1.05 (18.05): ...\DeveloperStudio\plugins\com.bmc.arsys.studio.api_9.1.5.build004
                    In v9.1.06 (18.08): ...\DeveloperStudio\plugins\com.bmc.arsys.studio.api_9.1.6.build005
     
     
      3- Copy "arsys_sample.xml" as "arsys_api.xml" and leave it in the same directory.

    4- In this new "arsys_api.xml" file, look for the section "<javaapi_config> </javaapi_config>" ,ensure that this section is uncommented

    5- Enable API logging by adding/ modifying the following line in this section:
      
      .......
    ...etc...
        <timeLagBetweenRetriesMillSec>100</timeLagBetweenRetriesMillSec>
        <toStringStyle>com.bmc.arsys.api.NoPrefixToStringStyle.NO_PREFIX_STYLE</toStringStyle>
        <stringizeFieldAssignments>false</stringizeFieldAssignments>
        <stringizeSetIfQualification>false</stringizeSetIfQualification>

        <apiRecording>0</apiRecording>
        <jniLoadMode>1</jniLoadMode>
    ...etc...
    .......
      
      to  be:
        <apiRecording>31</apiRecording>
      
      and save the file.
      
     
      6- Restart Developer Studio and reproduce the problem - please provide the time you reproduce the error so this can be found in the logs.

    7- Forward the log files:
      
      - API log file named "<username><ARServer name>*_arapires.log" from the "..\DeveloperStudio" folder



    Additional Information
    Remedy - DevStudio - How to enable java debug logging for Developer Studio

     


    Article Number:

    000113061


    Article Type:

    FAQ/Procedural



      Looking for additional information?    Search BMC Support  or  Browse Knowledge Articles