Aurora_Gaimon

CA PPM: XMLSpear - SOAP client tool (Part 4)

Blog Post created by Aurora_Gaimon Employee on Apr 18, 2017

In previous blog posts, I showed different ways and tools to XOG in/out. There are more tools in the market which can be used, but bear in mind, they are not support by CA. Therefore, any technical issue you may encounter when xogging, CA support will request to reproduce it with XOG client. If issue does not occur, you will get not support for it. Customer is assuming the risk when using unsupported tools.

 

Today I will demo XMLSpear.

 

 

What is it?

XMLSpear is a free XML editor with real-time validation.
It is easy to use, built in Java and available for all platforms.

** Source: XMLSpear 3.40  

 

 

Where do we download it from?

See official website: Clarity XOG Plugin 3.22 

It's important to download the version with "Clarity XOG" plugging.

 

 

How do we configure it?

- Go to your XMLSpear home directory(ie: “C:\...\XMLSpear\configurations”)

- Edit your clarity-www2.xml file with an advanced editor (strongly recommend to use notepad++).

 

<?xml version="1.0" encoding="UTF-8"?>
<!-- created with XMLSpear -->
<configuration environment="clarity-on-www" color="orange" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="configuration.xsd">
     <XOGSettings>
          <!-- *  Soap XOG server credentials and end point 10.66.58.33 -->
          <!-- http://10.66.58.34/niku/xog -->
          <userid>admin</userid>
          <password/>
          <host>www.mycompany.com</host>
          <!-- if using a default port then leave the port element empty -->
          <port>9082</port>
          <ssl>false</ssl>
          <!-- ask for confirm before actual XOG -->
          <confirm>false</confirm>
          <!-- if the proxy settings are not configured-->
          <!-- the proxy hostname and port are taken from the XMLSpear network settings-->
          <useProxy>true</useProxy>
     </XOGSettings>
</configuration>

- Save it with a different file name which represents the environment you want to XOG, for example: "Lab_Machine.xml" .

 

Tips:

enviroment=<your_enviroment_name>

color=<your_enviroment_color>

 

You can also assign different colors to your environment here. In example below I'm using "BLACK" 

 

But other colors can be used such "RED" "YELLOW" "BLUE"... etc.. they work too.  It will be later on shown in the XMLSpear when xogging:

 

 

It will allow to create many XML (one for each environment) and easily recognize in the lookup when chose for your target application server.

 

How do we use it?

- Launch XMLSpear exe file. Let's go to perform a simple XOG. For that demo, I will read an user from CA PPM.

- Open the XML file as input file. 

 

 

- In the top menu, go to Claity / Run XOG action

 

 

- Select your environment and enter password (if not configured in the XML properties file).

   Default values will be "Use current tab"  for the Input file and "Open in a new tab" for Output file. 

 

 

   For Input, it can be changed from one or multiple files:

 

   For Output, it can be changed to be saved into a file:

 

   Different options will be shown according depending on the selection. User will have to complete required details.

 

- Click "OK" and wait for the results in a new tab called "xogresults".

 

**Note: Advance functionalities are not covered in that post.

 

 

And if it's SSL ... ?

Same process, just ensure correct details are entered in the XML configuration file.

 

 

Advantages

  • Easy to use and friendly Graphical User Interface (GUI).
  • It's open source, for simple software version, no license is needed.
  • It should work with any Web Services, not just CA PPM.
  • It provides clear documentation on functionality and possibilities of the tool.
  • Allows conversion from CSV to XML files.

        Documentation CSV to XOG

        Extra Documentation CSV to XOG

  • Monitor xogging process
  • Provides dashboard with XML files results (success / failure) and details of results/errors.

  

Disadvantages

  • It's not supported or certified by CA. Only a few XOG operations have been tested.
  • Long time since last release.
  • Even XMLSpear indicates is not dependent of a specific CA PPM version, versions will not be aligned with CA PPM versions and possible changes amongst them.
  • Customer assumes risks when using unsupported tools, any issues will not be supported if they are not reproducible when using XOG client tool.

 

 

Related links:

 

 

 

 

If you need help with XOG, engage CA Services or ask questions in CA Communities.

 

That’s all. Thanks for reading until here. Did you like it? Please, don’t be shy and share it.

 

Outcomes