IV16972: TYPOGRAPHICAL ERROR IN PERL API DOCUMENTATION.

IBM Tivoli Network Manager IP 3.9.0 Fix Pack 3, 3.9.0-TIV-ITNMIP-FP0003
IBM Tivoli Network Manager IP 3.9.0 Fix Pack 4, 3.9.0-TIV-ITNMIP-FP0004
IBM Tivoli Network Manager IP Edition 3.9.0 Fix Pack 5, 3.9.0-TIV-ITNMIP-FP0005

APAR status

• Closed as documentation error.

Error description

• Note from Al Wojtas on Thursday, 15-March-2012: I have updated
  the Perl API documentation as follows:
  
  Appendix A. RIV Modules Reference, under the section RIV module
  synopsis:
  
  Changed the following:
  # Call the DecryptPassword and EncryptPassword virtual methods.
  Note
  # that $rivSession stores the application object returned in a
  previous
  # call to the RIV::Agent or RIV::App constructor.
  $txtPwd = $rivSession->DecryptPassword($encPwd);
  $encPwd = $rivSession->EncryptPassword($txtPwd);
  
  To:
  # Call the DecryptPassword and EncryptPassword virtual methods.
  $txtPwd = RIV::DecryptPassword($encPwd);
  $encPwd = RIV::EncryptPassword($txtPwd);
  
  Appendix A. RIV Modules Reference, under the DecryptPassword
  reference page:
  
  Changed the following:
  $txtPwd = $rivSession->DecryptPassword($encPwd);
  
  To:
  $txtPwd = RIV::DecryptPassword($encPwd);
  
  Appendix A. RIV Modules Reference, under the EncryptPassword
  reference page:
  
  Changed the following:
  $encPwd = $rivSession->EncryptPassword($txtPwd);
  
  To:
  $encPwd = RIV::EncryptPassword($txtPwd);
  ----------------------------------------------------------------
  ----------------------------------------------------------------
  ------
  Product: Tivoli Network Manager IP edition.
  Version: All
  Component: Documenation for Perl API.
  
  Problem description:
  The examples in the documentation regarding the use of the
  EncryptPassword and DecryptPassword RIV Modules are incorrect.
  The examples given are:
  
   $txtPwd = $rivSession->DecryptPassword($encPwd);
   $encPwd = $rivSession->EncryptPassword($txtPwd);
  
  These ought to read:
  
   $txtPwd = RIV::DecryptPassword($encPwd);
   $encPwd = RIV::EncryptPassword($txtPwd);
  

Local fix

• Use the example text as per this APAR.
  

Problem summary

• ****************************************************************
  * USERS AFFECTED:                                              *
  * ITNM 3.9 Users who work with the ITNM Perl API.              *
  ****************************************************************
  * PROBLEM DESCRIPTION:                                         *
  * Update the examples for DecryptPassword and EncryptPassword  *
  * interfaces.                                                  *
  ****************************************************************
  * RECOMMENDATION:                                              *
  * | fix pack | 3.9.0-ITNMIP-FP0002                             *
  ****************************************************************
  

Problem conclusion

• See the Error Description field in the APAR Information tab. The
  changes to the documentation were specified there.
  

Temporary fix

Comments

APAR Information

• APAR is sysrouted FROM one or more of the following:

• APAR is sysrouted TO one or more of the following:

Fix information

Applicable component levels