XOG Client Installation

Download and install the XOG client, test connectivity, and verify the XOG client version. You can also configure FIPS 140-2 mode.
ccppmop142
Download and install the XOG client, test connectivity, and verify the XOG client version. You can also configure FIPS 140-2 mode.
2
 
Download and Install the XOG Client
Windows Installation
If your computer is running a Windows OS, use these instructions to download and install the XOG client.
Follow these steps:
  1. Open Administration, and from General Settings, click Client Downloads.
  2. Click the Download link for the Windows Installer.
  3. Save the XOG.exe file to a directory on your local computer.
  4. Run the XOG.exe file and follow the on-screen instructions.
Installation on Other Operating Systems
On other supported operating systems, use these instructions to download and install the XOG client.
Follow these steps:
  1. Open Administration, and from General Settings, click Client Downloads.
  2. Click the Download link for the Cross-platform ZIP.
  3. Save the xogclient.zip file to your local computer.
  4. Create a local folder that is named 
    xogclient 
    and extract the xogclient.zip files to that folder.
  5. (UNIX only) Run the
    chmod +x run.sh
    command from the 
    bin
     directory.
XOG Client Directories
These directories are copied to your computer when you run the XOG client installer:
  • bin
    . Batch files to run the XOG client. The test.properties file can also be used to run the XOG client.
  • lib
    . Libraries that are required to run the XOG client.
  • wsdl
    . XOGService.wsdl file.
  • xml
    . Sample XML read and write files for the XOG-supported objects.
  • xsd
    . XML schemas for the XOG-supported objects.
Verify the XOG Client Version and the Connectivity
After you successfully download and install the XOG client, download the Java Runtime Environment (JRE) and set the JAVA_HOME variable. Complete this step before you verify the XOG client version and the connectivity.
Over time, a mismatch between 
Clarity Project and Portfolio Management (PPM)
 and the XOG client can occur. This mismatch results if the product is upgraded but the XOG client is not. Verify that the XOG client version that you are using matches your version of 
Clarity Project and Portfolio Management (PPM)
.
Best Practice:
 Test the connectivity between the XOG client and the 
Clarity Project and Portfolio Management (PPM)
 server after you install the XOG client.
Follow these steps:
  1. Open a command prompt.
    • Windows: From the Start menu, select All Programs, CA, Clarity, 
      Clarity Project and Portfolio Management (PPM)
       XML Open Gateway.
    • UNIX: Navigate to the XOG client home directory.
  2. Issue the following commands to see the version number:
    • HTTP enabled - 
      xog
    • HTTPS enabled - 
      xog -sslenabled true
    If the version numbers do not match, download and reinstall the XOG client. To see your 
    Clarity Project and Portfolio Management (PPM)
     version number, click About in the upper-right corner of the page.
  3. Issue the following command to verify the connection:
    login <username>/<mypassword>@<myserver>:<port>
    For example, if you are connecting to
    https://cppm1234-dev.ca.com/niku
    with the username and password of admin1/password2, issue the following command:
    login admin1/[email protected]:443
(Optional) Set Up FIPS 140-2 Mode
The FIPS 140-2 standard defines U.S. federal government requirements for encrypting sensitive data. If this standard is required for your business, you can set
Clarity Project and Portfolio Management (PPM)
 to run in FIPS 140-2 mode. 
Enabling the XOG client in FIPS 140-2 mode (
-fipsenabled=true
) with the IBM Java Virtual Machine requires more steps. Add the FIPS approved IBM JCEFIPS and IBMJSSEFIPSProvider2 providers to the provider list in the JVM java.security file.
Clarity Project and Portfolio Management (PPM)
 14.2 and 14.3 supported IBM AIX and WebSphere. The following steps only apply to those releases.
These steps explain how to add provider entries to the providers list.
Follow these steps:
  1. Open the java.security file in the 
    <JAVA_HOME>/jre/lib/security/java.security
     directory:
    The provider entries in the JVM java.security file are similar to these entries:
    security.provider.1=com.ibm.crypto.fips.provider.IBMJCEFIPS security.provider.2=com.ibm.crypto.provider.IBMJCE #security.provider.3=com.ibm.jsse.IBMJSSEProvider security.provider.3=com.ibm.jsse2.IBMJSSEProvider2 security.provider.4=com.ibm.security.jgss.IBMJGSSProvider security.provider.5=com.ibm.security.cert.IBMCertPath security.provider.6=com.ibm.crypto.pkcs11.provider.IBMPKCS11 security.provider.7=com.ibm.security.cmskeystore.CMSProvider security.provider.8=com.ibm.security.jgss.mech.spnego.IBMSPNEGO
  2. Add the IBMJCEFIPS entry to the beginning of the list:
    security.provider.1=com.ibm.crypto.fips.provider.IBMJCEFIPS
  3. Comment out the IBMJSSE entry if listed. For example:
    #security.provider.3=com.ibm.jsse.IBMJSSEProvider
  4. Add the IBMJSSEProvider2 entry below the IBMJCEFIPS entry if it is not already listed:
    security.provider.<n>=com.ibm.jsse2.IBMJSSEProvider2
  5. Replace <n> in the IBMJSSE entry with a sequence number for the provider in searches from the list.
  6. Renumber the remaining listed entries so that they appear in order without any gaps.