Clarity XOG Plugin version 3.22
XOG is the XML based webservice offered by CA Clarity which provides you functionality to send XML to retrieve or update data in Clarity. XOG is the XML based webservice offered by CA Clarity which provides you functionality to send XML to retrieve or update data in Clarity.You will get the result as another XML. xog.png

XMLSpear is my full featured XML editor that is on the market now for more than 5 years.

I thougt it would be more convenient to edit and xog files in XMLSpear all together.

That's why I built the Clarity XOG plugin.

The XOG plugin for XMLSpear offers you an integrated environment where you can develop, validate and test your XOG files and manage your XOG connections to different environments.


The tool can also can transform your Excel or csv files to XOG input files. You can use either a simple merge xml template or a real XSLT template and will be guided by a wizard.
You can download the manual for instructions

You will need java 1.5+ to run XMLSpear with XOG plugin. So you can pick up your favorite platform : Linux, Mac OS X or Windows.

Configure your XOG connections

To use this plugin you first have to install it. This is described in the install.txt file in the download package. One of the steps described there, is to create a configuration file for each target environment. Several example configuartions are incuded in the package.
For people familiar to the clarity command-line xog client: these files are the equivalent to the propertyfile, but the fomat is XML. It maybe convenient to load a file tree (File --> Add File Tree) with the configurations directory as the root of the tree: now you can easily view and edit the files by clicking them in the tree. You can check your changes by validating the xml against the schema. Press the green "check icon" in the toolbar to turn on real-time validation. Load the changes in the tool by reloading the configuration (Clarity --> Reload config).

Important note: If you are using the default port then leave the port element empty.

Create or edit XOG file

Again it maybe convenient to load a file tree with your xml and xsd directories. If you have installed the CA Clarity XOG client, then you may use that install directory as a file root. Now open a XOG input file. You can edit the file in the XML handler.
To see which attributes or elements can be inserted, right-click the xsd schema file in the file tree and choose "show schema in tree" from the popup menu (choose NikuDatabus in the subsequent popup which prompt you for the root element).
To create a XOG file from scratch, the you can also right-click the xsd schema file in the file tree and choose "generate XML" from the popup menu (choose NikuDatabus in the subsequent popup which prompt you for the root element).

Example of Object xml:

<NikuDataBus>
	<Header version="12.0.0.5028" action="read" objectType="user" externalSource="NIKU"/>
	<Query>
		<Filter name="userName" criteria="EQUALS">XXXXX</Filter>
	</Query>
</NikuDataBus>

Example of query xml (Do not code a NikuDatabus element):
<Query xmlns="http://www.niku.com/xog/Query">
	<Code>P027_NSQL</Code>
</Query>

Example of InvokeAction xml (Do not code a NikuDatabus element):
<FlushAllCaches xmlns="http://www.niku.com/xog/InvokeAction">
</FlushAllCaches>

Check your file

To check the XOG file for errors, click the green validation button on the toolbar. This will turn on real-time validation. If there are errors, they will be displayed in the "Problems" window. You can click on the errors to jump to the location of the error in the source.

note:
The XOG xsd schemas all have a syntax error which will be displayed the first time you turn on validation: [5:43]: cos-nonambig: column and column (or elements from their substitution group) violate "Unique Particle Attribution". During validation against this schema, ambiguity would be created for those two particles.
This error can be ignored.

Execute the XOG

To make the actual xog request, choose Clarity -->doXOG from the menu. You have several input and output options and you can choose the target environment from a list. You can configure a proxy server for XOG webservices that are behind a proxy.

notes :
The first time you XOG to a new SSL Server, you may be kept asking to accept the certificate. You have to restart XMLSpear to get the certificate properly loaded. You can also edit the plugin.properties file in the configuration directory. It contains a property to trust all certificates.
There is also another property to keep characters entities (unicode notations) in the XOG response.

Check result

Check the result. Sometimes, if the result contains html messages in the content, it is most convenient to view the results in the XML table view. The console tab will show the logging of the process, which may be important in case of unexpected errors.

Initially the XOG plugin was created to xog instance data of an Object. In version 2.3 support was added for the Query and InvokeAction api. The plugin is not dependant of a specific clarity version. Only a few xog operations are tested. Please report bug or issues.
Any sugestions are welcome!

XMLSpear 3.32 with Clarity XOG plugin 3.22 installed as ZIP archive (release date 2016-01-28).

XMLSpear 3.32 with Clarity XOG plugin 3.22 installed as Self Extracting archive (release date 2016-01-28).

Documentation CsvExcel plugin how to transform the CSV or Excel files to XML (or as you like XOG files) (release date 2016-12-21)

Documentation CSV to XOG how to use the CSV to XOG plugin (release date 2014-04-13), based on version 3.00.

Extra Documentation CSV to XOG with examples how to create a structured recursive XML from a flat csv file, like needed in the OBS xog (release date 2014-03-25), based on version 3.00

Version 3.22 jan, 28 2016
  • Upgraded the XMLSpear to version 3.32 which includes a fix for java 1.8.0_66+. This solves the problems with the tree and element view in the XMLHandler wich could not be displayed.
Version 3.22 march,19 2015
  • The last minute change in 3.21 of using the dialogs instead of frames caused some GUI glitches. So this change is reverted.
    If you open a file for viewing using the magnifier glass button in the XOG Multiple Files progress Dialog or in the List XOG Results Dialog, the file will be visible at the background and you have to move the dialog away to get a full view. I will change this in a next release, but it needs some more coding and testing.
Version 3.21 march,18 2015
  • Upgraded the bundled XMLSPear to version 3.31, which contains several bugfixes and enhancements. See About screen in the application for all the details.
  • Fixed some typos in menu and dialogs
  • Added minimize/maximize buttons to the multiple XOG dialog and the List Result XOG dialog. In fact they are not dialogs anymore but independent frames.
Version 3.20 feb,04 2015
  • Changed interface for xogging multipe files to provide more feedback.
  • The result only showed the technical result of overall XOG operation. Now the actual response is interpreted and the highest severity will be displayed.
  • Added multi-threading to boost performance. Now you can xog multiple files in parallel. Warning: This is an experimental feature, only tested with read XOG actions.
    boost_xog.png
  • Added a menu function to list xog results of a directory that contains XOG output files
  • Version 3.10 may,19 2014
    • The CSV to XOG function is moved to its own plugIn and is made available as "CSV to XML using a template" in the Conversion menu.
    • The new plugin can also perform Excel to XML conversions.
    • Default to last choosen input directory while selecting input XOG file. This was not the case in selecting multiple input files.
    Version 3.00 sept,12 2013
    • Upgraded the bundled XMLSPear to version 3.20, which contains several bugfixes and enhancements
    • CSV to XOG: Transformation with a xslt stylesheet will be done against a xml row element constructed from the record in the csv file
    • Records in the csv file can be grouped into one xog request
    Version 2.31 jul,13 2012
    • There was a bug in accepting certificates which affected users that did not accept all certificates (see plugin.properties in the configuration folder
    Version 2.30 sep,19 2011
    • This release is a further enhancement of fix 2.22. But now support is added for Query and InvokeAction requests. For these requests you do not code a NikuDatabus element
    Version 2.22 sep,16 2011
    • Some xog results do not contain a XOGOutput element. An example is the contentpack read xog. The program will no longer throw an exception in this cases. Thanks to Steve for reporting this issue.
    Version 2.21 july,14 2011
    • added function to convert CSV to XOG
    • Feature to XOG multiple input files
    • XOG timeout setting changed to unlimited
    Version 2.10 april, 4 2011
    • Proxy support enabled
    • Added a schema file for the configuration XML so you can validate your configuration while editing them in XMLSpear
    • Use the given userid and password for subsequent XOG calls
    • a property can be configured to show non ascii characters as unicode numbers in the XOG response message ==> showUnicodeCharacters=true
    • a property can be configured to trust all certificates ==> trustAllCertificates=true
    • Improved handling of new certificates
    Your feedback is important. The plugin is only tested to my local Clarity environment. Let me know if you find bugs, have suggestions or just let me know that you are using it and find it useful.

    (your e-mail program will be started)