IBM Agent Builder Interim Fix 01 6.3.5-TIV-ITM_ABLDR-IF0001

Copyright International Business Machines Corporation 2019.
All rights reserved.

Component: IBM® Agent Builder, Version 6.3.5
           
Component ID: 5724C04BR

Interim Fix: 0001, 6.3.5-TIV-ITM_ABLDR-IF0001

Date: May 22, 2019

Contents:

1.0 General description
2.0 Problems fixed
3.0 Architecture and prerequisites
4.0 Image directory contents
5.0 Installation instructions
6.0 Additional installation information
7.0 Known problems and workarounds
8.0 Additional product information
9.0 Copyright and trademark information
10.0 Notices

1.0 General description
===============
This fix resolves the APARs and defects listed in the "Problems Fixed"
section below.

2.0 Problems fixed
============
The following problems are addressed by this fix.
 

  2.1 APARs
  -------------    
  APAR: IJ14927
  Abstract: AGENT BUILDER WINDOWS AGENTS DO NOT INSTALL CORRECTLY
        INTO APM ON WINDOWS 10 OR WINDOWS 2016 SERVER                          
  Additional information: Agent Builder agents do not install
        correctly into an Application Performance Management (APM)
        installation on Windows 10 or Windows 2016 server. The  
        installation appears successful but the agent fails to start.
        A "txtsub.exe - System Error" occurs: "The program can't start
        because MSVCR71.dll is missing from your computer. ..."
        The end of the Kxxinstall.log ends with lines similar to
        "Starting Monitoring Agent for <agent> ...
        KCICF9051E: Monitoring Agent for <agent> failed to start.
        See the C:\IBM\APM\InstallITM\APM-KinConfg_2019mmdd_hhmmss.log
        file for more details."

        This occurs if the msvcr71.dll file is not in the path.
        For Windows 10 or Windows 2016 server, it is not in the path
        by default.     

        Note:  If an IBM Tivoli Monitoring (ITM) agent installation
        is on the machine, then a copy of msvcr71.dll is in the path       
        because the installation updated the system PATH environment    
        variable.  APM agent installation does not alter the system
        PATH environment variable.
                                                                
        The agent ENV, KxxENV.expanded, ini files in
        %CANDLE_HOME%\tmaitm6[_x64] and the %CANDLE_HOME%\CNP\cnp.bat
        and %CANDLE_HOME%\CNB\applet.html created during the
        installation process by installIraAgent.bat and
        installIraAgentTEPS.bat are not complete or correct.

  APAR: IJ14926                        
  Abstract: AGENT BUILDER JAVA SIGNING CERTIFICATES EXPIRE NOVEMBER 1, 2018
  Additional information: IBM Tivoli Enterprise Portal Java™ Web
          Start client or browser client do not start due to expired
          Java certificates.  The Java certificates used by Agent
          Builder to sign the kxx_resources.jar files expired on
          November 1, 2018.
        
          The new certificates expire on June 5, 2021. Both of these
          certificates are fully SHA-2.    

  APAR: IJ05930
  Abstract: WIDGETS FOR CUSTOM AGENTS OVERLAPPING IN APM 8.1.4 UI
  Additional information: Depending on the order used to add
        attribute groups and on type of attribute group (multi-rows
        vs. single row output), the APM dashboard automatically
        created by the Agent Builder can result in overlapping widgets
        in APM 8.1.4 UI.                 
                                                               
        This occurs when a multi-row attribute group widget is put
        next to a single-row attribute group. It does not occur when
        there are two single row widgets on the same line. The widgets
        are rendered in the same order the attribute groups were added
        when creating the custom agent.

  APAR: IJ05369
  Abstract: JAPANESE APPLICATION SUPPORT FILE IS INCORRECT AND FAILS TO   
        INSTALL                                                   
  Additional information: Generating an agent with the Agent Builder
        Japanese Language Pack installed results in a k<pc>_resources.jar,
        where <pc> is the product code of the agent, with no class files.             
                                                                        
        Application support installation may complete without a visible
        error.  However, after installing the TEMS and TEPS support for
        the agent results in one of the following symptoms:             
        1. The Tivoli Enterprise Portal displays the internal keys of   
        the attribute group names.                                      
        2. The Java Web Start portal fails to start up.                 
        3. Attribute Group and Attribute items of the agent do not      
        match in Situation Editor.                                      
                                                                       
        Reviewing the TraceKQZ.log in the Agent Builder workspace       
        .metadata\tivoli\KQZ\logs directory, you can see that an error  
        occurred when compiling the application support because a       
        unicode character is split/truncated, when the line is continued
        to the next line.                                               
                                                                        
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -   
        ...                                                             
                                                                        
        2018-03-22T16:19:26.968-04:00] - MID - 9 - ModalContext -       
        com.ibm.tivoli.monitoring.util.ProcUtil.runProcess - Entry,     
        parm 1 = C:\Program Files                                       
        (x86)\IBM\AgentBuilder_635\jre\bin\javac                        
        [2018-03-22T16:19:27.665-04:00] - MIN - 9 - Thread-17 -         
        com.ibm.tivoli.monitoring.util.ProcUtil$StreamHandler.logLines  
        - C:\Program Files (x86)\IBM\AgentBuilder_635\jre\bin\javac     
        stderr                                                          
                                                                        
        ??: [options] ???????????????? -source 1.4 ?????????????        
        ??: [options] ???? 1.4 ????????????????????                     
        ??: [options] ?????? 1.4 ????????????????????                   
        ??: [options] ?????????????????????????-Xlint:-options ???????  
                                                                        
        C:\PMRS\k19\ira\agent\common\odi2rb\package\candle\k19\resources
        \K19Bundle.java:53: ???: Unicode ???????????????    
        { K191008,                                                      
        "\u300c\u30d1\u30d5\u30a9\u30fc\u30de\u30f3\u30b9\u30fb\u30aa\u3
        0d6\u30b8\u30a7\u30af\u30c8\u72b6\u6cc1\u300d\u5c5e\u6027\u30b0\
        u30eb\u30fc\u30d7\u306b\u306f\u4ed6\u306e\u5c5e\u6027\u30b0\u30e
        b\u30fc\u30d7\u306e\u72b6\u6cc1\u3092\u53cd\u6620\u3059\u308b\u6
        0c5\u5831\u304c\u542b\u307e\u308c\u3066\u3044\u308b\u305f\u3081\
        u3001\u3053\u306e\u30a2\u30d7\u30ea\u30b1\u30fc\u30b7\u30e7\u30f
        3\u3092\u69cb\u6210\u3059\u308b\u3059\u3079\u3066\u306e\u30d1\u3
        0d5\u30a9\u30fc\u30de\u30f3\u30b9\u30fb\u30aa\u30d6\u30b8\u30a7\
        u30af\u30c8\u306e\u72b6\u6cc1\u3092\u307e\u3068\u3081\u3066\u4e0
        0\u62ec\u8868\u793a\u3059\u308b\u3053\u3068\u304c\u3067\u304d\u3
        07e\u3059\u3002\u3053\u308c\u3089\u306e\u4ed6\u306e\u30d1\u30d5\
        u30a9\u30fc\u3" +                                               
                    ^^ (Half a unicode character preceding quote)       
        C:\PMRS\k19\ira\agent\common\odi2rb\package\candle\k19\resources\
        K19Bundle.java:55: ???: Unicode ???????????????    
        "\u5c5e\u6027\u30b0\u30eb\u30fc\u30d7\u306e\u72b6\u6cc1\u306b\u3
        06f\u3001\u305d\u306e\u5c5e\u6027\u30b0\u30eb\u30fc\u30d7\u306b\
        u3064\u3044\u3066\u306e\u6700\u5f8c\u306e\u30c7\u30fc\u30bf\u53c
        e\u96c6\u306e\u8a66\u884c\u7d50\u679c\u304c\u53cd\u6620\u3055\u3
        08c\u308b\u305f\u3081\u3001\u30a8\u30fc\u30b8\u30a7\u30f3\u30c8\
        u304c\u30c7\u30fc\u30bf\u53ce\u96c6\u3092\u6b63\u3057\u304f\u5b9
        f\u884c\u3057\u3066\u3044\u308b\u304b\u3069\u3046\u304b\u3092\u7
        8ba\u8a8d\u3067\u304d\u307e\u3059\u3002\u4ed6\u306e\u5c5e\u6027\
        u30b0\u30eb\u30fc\u30d7\u3068\u306f\u7570\u306a\u308a\u3001\u300
        c\u30d1\u30d5\u30a9\u30fc\u30de\u30f3\u30b9\u30fb\u30aa\u30d6\u3
        0b8\u30a7\u30af\u30c8\u72b6\u6cc1\u300d\u5c5e\u6027\u30b0\u30eb\
        u30fc\u30d7\u3"                                                 
                    ^^                                                  
        [2018-03-22T16:17:23.556-04:00] -  MIN  - 9 - Thread-11 -       
        com.ibm.tivoli.monitoring.util.ProcUtil$StreamHandler.logLines -
         C:\Program Files (x86)\IBM\AgentBuilder_635\jre\bin\javac      
        stderr                                                          
        ??? 2 ?                                                         
        ?? 4 ?                                                          
                                                                        
        [2018-03-22T16:17:23.559-04:00] -  MID  - 9 - ModalContext -    
        com.ibm.tivoli.monitoring.util.ProcUtil.runProcess - Exit,      
        return value = 1                                                
        ....                                                            
                                                                        
        [2018-03-22T16:19:33.737-04:00] - MIN - 9 - Thread-18 -         
        com.ibm.tivoli.monitoring.util.ProcUtil$StreamHandler.logLines  
        - C:\Program Files                                              
        (x86)\IBM\AgentBuilder_635\jre\bin\jarsigner.exe stdout         
        jarsigner: jar????????: java.io.IOException: DER input not a    
        UTF8 string                                                     
        ...                                                             
        - - - - - - - - - - - - - - - - - - - - - - - - - - - -- - -    
        In the K<pc>Bundle.java generated by Agent Builder, which
        is located in the agent package in                                 
        ...\ira\agent\common\odi2rb\package\candle\k<pc>\resources,     
        you can see where the "Performance Object Status" strings are   
        broken into pieces and split in the middle of a UNICODE         
        character (see above ^^).                                        

        This APAR is fixed in Language Pack Fix 0001
        (6.3.5-TIV-ITM_ABLDR-LP0001), and Agent Builder to prevent
        the problem from occurring again in the future.  

  APAR: IJ05103
  Abstract: LOG MONITORING PRINTS RAS1 LOG CONTENTS TO RESTART FILE       
  Additional information: Using a log monitor data source and the
        restart feature to process records not previously processed
        by the agent, the restart (.rst) file has random data written
        to it.  The random data is usually agent RAS1 log content.
        This may cause performance issues, the agent to crash or
        output rows duplicated multiple times.       

        With a minimum of the following trace enabled: "KBB_RAS1=ERROR",
        the agent RAS1 log                                            
        <hostname>_<pc>_[instance]_k<pc>agent_<timestamp>-<nn>.log
        contains trace points similar to the following:                                                           
        "....Error: parsed location <NULL> file ...." and  "Note:        
        Required fields missing from restart file " .
                                                
        This issue exists in Agent Builder V6.3.5 and has been seen
        on UNIX® platforms.   

  APAR: IJ04744
  Abstract: AGENT BUILDER SOAP BROWSER-EDITOR INCORRECTLY HANDLES           
        NAMESPACE QUALIFIED TAGS FOR ROW SELECTION OR ATTRIBUTE XPATHS
  Additional information:The SOAP browser and editor does not correctly
        handle namespace qualified tags for row selection or attribute
        XPaths.  Using a SOAP data source agent, the SOAP Browser
        successfully connects and returns data; however the Test
        function fails to "Collect Data" and returns "0 data rows
        returned at ...".  This occurs when tags are returned which
        contain a namespace, for example "namespace:name" because               
        Agent Builder is discarding the namespace in the XPath. 

            

  2.2 Defects
  --------------
  None.
 
  2.3 Superseded fixes
  -------------------------
  None.                                                                      
 
  2.4 APARs and defects included from superseded fixes
  ---------------------------------------------------------------
  None.
             

3.0 Architecture and prerequisites
======================
This fix is supported on all operating systems listed in the
IBM Agent Builder version 6.3.5 User's Guide.
 

  3.1 Prerequisites for this fix
  --------------------------------
  The prerequisite level for this fix is as follows:

   IBM Agent Builder V6.3.5, which is available from Passport
   Advantage under the following eAssembly:

   * IBM Agent Builder V6.3.5 Multilingual (CNL8RML)
   * IBM Agent Builder V6.3.5,Language Pack Multilingual (CNL8QML)

 
4.0 Image directory contents
===================
This fix image contains the following files:
 

- 6.3.5-TIV-ITM_ABLDR-IF0001.README - This README file
- 6.3.5-TIV-ITM_ABLDR-IF0001.tar - Fix archive .tar format
- 6.3.5-TIV-ITM_ABLDR-IF0001.zip - Fix archive .zip format.
 

Note:

1. The .tar and .zip files are identical in content. Use the .tar
file if you are working in a UNIX environment; use the .zip file
if you are working in a Windows® environment.
 

The fix archive file contains the following files:
  - com.ibm.tivoli.monitoring_6.3.5.v201903281419.jar
  - com.ibm.tivoli.monitoring.AgentGenerator_6.3.5.v201903281419.jar
  - com.ibm.tivoli.monitoring.AgentGenerator.runtime_6.3.5.v201903281419.jar
  - com.ibm.tivoli.monitoring.agentkit_6.3.5.v201903281419.jar
  - com.ibm.tivoli.monitoring.remotedeploy_6.3.5.v201903281419.jar
  - com.ibm.tivoli.monitoring.agentkit.provider.http_6.3.5.v201903281419.jar
  - com.ibm.tivoli.monitoring.agentkit.provider.log_6.3.5.v201903281419.jar
 
2. The plugins contained in this fix are not removed when Agent Builder
  is uninstalled. They must be manually removed.
 
5.0 Installation instructions
==================
This fix applies to an Agent Builder, version 6.3.5 installation.
Use the following steps to install this fix.
 

  5.1 Before installing the fix
  -------------------------------
  - The prerequisites listed under section 3.1 entitled 'Prerequisites
    for this fix' must be installed before this fix can be installed.
    
  - Stop Agent builder, if it is currently running.
     
  5.2 Agent Builder update
  --------------------------
  1. Transfer the appropriate archive file 6.3.5-TIV-ITM_ABLDR-IF0001.tar
     or .zip to the repository directory of the Agent Builder
     installation to be updated. The default installation location on
     Windows systems is "C:\Program Files\IBM\ITM\AgentBuilder" and
     on Linux® systems, it is "/opt/IBM/ITM/AgentBuilder".
 

  2. Expand the archive file into the Agent Builder repository
     directory using the tar command on UNIX systems or an extract
     utility on Windows systems, such that it expands directly to the
     repository directory.
            
  3. Start or restart Agent Builder.

  4. In Agent Builder:

     A. From the Help menu, select "Check for Updates" .

        Note: If you receive the informational message "No updates
        were found in available software sites". Click "available
        software sites" and use the Add button to add the path of the
        Agent Builder repository directory.  This can also be set by
        selecting Window > Preferences to open the Preferences window.
        In the navigation pane, expand Install/Update. Click Available
        Software sites.
      
     B. On the "Available updates" page, click the "Select All"
        button to select "Agent Builder Interim Fix 0001". Click Next.

        Note: Depending on the available software sites enabled, the
        list of available updates may vary. If necessary, deselect any
        other updates you do not want to install. You might see a
        message "Insufficient access privileges to apply this update.",
        which can be ignored.  

     C. On the "Update details" page, click Next.

     D. On the "Review Licenses" page, click "I Accept ..." and
        Finish. It now says "Updating Software".             

        Note: You might receive a Security Warning "Warning: You are
        installing software that contains unsigned content. ...".
        Click ok to continue.

     E. Select Yes to restart Agent Builder when asked.
 
  5.3 Agent support update
  ------------------------------
  There are Agent Builder changes which affect agent support files
  for the Tivoli Enterprise Monitoring Server, Tivoli Enterprise Portal
  Server, or Tivoli Enterprise Portal Desktop included in this fix.

  1. In Agent Builder, update the Version of the affected agents and
     Save.

  2. Use the Generate Agent Wizard to regenerate your agents and then
     re-install the affected agents and application support files.
    
 
6.0 Additional installation information
========================
 

  6.1 Verifying the update
  ----------------------------
  1. From the Agent builder menu bar, select Help, then Installation
     Details.

     A. Select the Features tab. There is a row
        Feature Name: IBM Agent Builder
        Version: 201903281419
        Feature Id: com.ibm.agentbuilder

     B. Select the Plug-ins tab. Click on the Provider column header
        to sort and find "IBM Corporation". The plugins listed in
        section 4.0 have the Version: 6.3.5.v201903281419.

  2. To verify Agent Builder was updated correctly, after regeneration
     of the agent package, the header of most newly generated scripts
     contain comment line listing the refreshed plugins with a version
     of "v6.3.5.1 201903281419".

     For example
     . . .
     <!--    IBM Tivoli Monitoring Agent Generator v6.3.5.1 201903281419-->
     <!--    IBM Tivoli Monitoring Agent Generator Runtime v6.3.5.1 201903281419-->
     . . .
 
  3. To verify the agent you are running contains the updates from the
     fix, see the following lines in the agent log                    
     <hostname>_<productCode>_[<instance>]_k<productCode>agent_<timestamp>.log:
     located in $CANDLEHOME/logs on UNIX systems and
     %CANDLE_HOME%\tmaitm6[_x64]\logs on Windows systems.

    <timestamp>       Component: ira
    <timestamp>          Driver: agentfac:201903281419/4923649.3
    <Timestamp>       Timestamp: Mar 28 2019 14:28:48

     
7.0 Known problems and workarounds
=========================
None.

8.0 Additional product information
======================
None.
 

9.0 Copyright and trademark information
==================================  
A current list of IBM trademarks is available on the Web at "Copyright
and trademark information" at www.ibm.com/legal/copytrade.shtml.

10.0 Notices
=======

INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION
"AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

Some states do not allow disclaimer of express or implied warranties in
certain transactions, therefore, this statement may not apply to you.

Microsoft, Windows, and Windows Server are trademarks of Microsoft
of Microsoft Corporation in the United States, other countries, or
both.

UNIX is a registered trademark of The Open Group in the United States
and other countries.

Java and all Java-based trademarks and logos are trademarks or
registered trademarks of Oracle and/or its affiliates.

Linux is a registered trademark of Linus Torvalds in the United States,
other countries, or both.

Other company, product, or service names may be trademarks or service
marks of others.

Third-Party License Terms and Conditions, Notices and Information
-----------------------------------------------------------------
The license agreement for this product refers you to this file for
details concerning terms and conditions applicable to third party
software code included in this product, and for certain notices and
other information IBM must provide to you under its license to
certain software code. The relevant terms and conditions, notices and
other information are provided or referenced below. Please note that
any non-English version of the licenses below is unofficial and is
provided to you for your convenience only. The English version of the
licenses below, provided as part of the English version of this file,
is the official version.

Notwithstanding the terms and conditions of any other agreement you
may have with IBM or any of its related or affiliated entities
(collectively "IBM"), the third party software code identified below
are "Excluded Components" and are subject to the following terms and
conditions:

- the Excluded Components are provided on an "AS IS" basis
- IBM DISCLAIMS ANY AND ALL EXPRESS AND IMPLIED WARRANTIES AND
  CONDITIONS WITH RESPECT TO THE EXCLUDED COMPONENTS, INCLUDING, BUT
  NOT LIMITED TO, THE WARRANTY OF NON-INFRINGEMENT OR INTERFERENCE
  AND THE IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND
  FITNESS FOR A PARTICULAR PURPOSE
- IBM will not be liable to you or indemnify you for any claims
  related to the Excluded Components
- IBM will not be liable for any direct, indirect, incidental,
  special, exemplary, punitive or consequential damages with respect
  to the Excluded Components.