XOG Client Installation

Download and install the XML Open Gateway (XOG) client, test connectivity, and verify the XOG client version. You can also configure FIPS 140-2 mode.
Download and install the XML Open Gateway (XOG) client, test connectivity, and verify the XOG client version. You can also configure FIPS 140-2 mode.
Download and Install the XOG Client
Follow these steps:
  1. Click
    General Settings
    Client Downloads
  2. For the Windows operating system:
    1. Click the
      Windows Installer
    2. Save the XOG.exe file to a directory on your local computer.
    3. Run the XOG.exe file and follow the on-screen instructions.
  3. For other supported operating systems:
    1. Click the
      Cross-platform ZIP
    2. Save the xogclient.zip file to your local computer.
    3. Create a local folder that is named 
      and extract the xogclient.zip files to that folder.
  4. (UNIX only) Run the
    chmod +x run.sh
    command from the 
XOG Client Directories
The following directories are copied to your computer when you run the XOG client installer:
  • bin
    (batch files to run the XOG client; you can also run the XOG client using the test.properties file)
  • lib
     (libraries that are required to run the XOG client)
  • wsdl
     (the 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 Connectivity
After you install the XOG client, test its connectivity to the 
Clarity PPM
 server. Over time, a mismatch between 
Clarity PPM
 and the XOG client can occur 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 PPM
After you 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.
Follow these steps:
  1. In
    Clarity PPM
    , determine your release version number by clicking 
     in the upper-right corner of any page.
  2. Open a command prompt.
    • Windows
      : From the
      menu, select
      All Programs
      Clarity PPM
       XML Open Gateway
    • UNIX
      : Navigate to the
      client home directory.
  3. Issue the following commands to see the XOG client version number:
    • HTTP enabled 
      - xog
    • HTTPS enabled
      - xog -sslenabled true
  4. If the version numbers do not match, download and reinstall the XOG client. 
  5. Issue the following command to verify the connection: 
    login <username>/<mypassword>@<myserver>:<port>
    For example, if you are connecting to
    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, set up FIPS 140-2 mode. 
: In
Clarity PPM
15.3 (released in September 2017), a new Bouncy Castle Cryptography Package for FIPS replaced the RSA B-SAFE FIPS provider from previous releases.