IBM Support

How to Encrypt Password in Planning Analytics WLP Server.xml File

Troubleshooting


Problem

Depending on your configuration, you may have a need to connect to a password secured resource configured by the server.xml file in a Websphere Liberty Application server.  In this example, the Planning Analytics Web Tier / TM1Web is being secured to use KERBEROS security - which requires an LDAP password be provided.

Resolving The Problem

How to Encrypt Passwords in WLP Server.xml File
  1. Open Command Prompt (as an Administrator)
  2. Set a JAVA_HOME environment variable to match the JRE that comes with Planning Analytics
    EXAMPLE: set JAVA_HOME=C:\Program Files\ibm\cognos\tm1_64\jre
  3. In Command Prompt navigate to: <install_dir>\tm1_64\wlp\bin\
  4. Execute the following command: securityUtility encode --encoding=xor PASupport@
    *In the above example, PASupport!@ is the password that is being encoded using XOR encoding
    **The securityUtility allows use of other encoding types, and is a decision you need to make yourself.  
    ***
    CAUTION:

    Different operating systems and command line environments treat some characters differently. In many environments, you can redefine which characters are special and how they behave.

    By default, in the Windows environment, if you have an exclamation point (!) in your input string, it must be escaped by the caret character (^). The following example has a value of a! encoded.
    C:\Program Files\ibm\cognos\tm1_64\wlp\bin>securityUtility encode --encoding=xor "Admin1234^!"
    {xor}HjsyNjFubWxrfg==

    the escape character is not honoured unless the 'password_in_clear_text' is enclosed in quotes.
    For some operating systems, you might need to use single quotation marks around arguments that are passed to the tool.
  5. Copy the text including  {xor} tags. 
    *EXAMPLE:  password="{xor}Dx4MKi8vMC0rHw=="
  6. Update the bindPassword (or any other password you are changing) to reflect the encoded password
    NOTE: The default encoding type is XOR.  Other encoding types require specifying the --encoding parameter
  7. Restart your Planning Analytics Web Tier

Document Location

Worldwide

[{"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSD29G","label":"IBM Planning Analytics"},"ARM Category":[{"code":"a8m0z000000GoUlAAK","label":"Troubleshooting-\u003ETM1Web"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Version(s)","Line of Business":{"code":"LOB10","label":"Data and AI"}}]

Document Information

Modified date:
27 September 2023

UID

ibm16233994