This section contains the following topics:
Web Services Descriptive Language (WSDL)
Welcome to the CA Clarity Integration Guide. This document contains technical information needed to work with the XML Open Gateway (XOG).
Intended Audience
The audience for this guide includes integrators or system administrators who have the need to read data from or write data to CA Clarity using XML and web services. This guide assumes the reader is already familiar with XML code and the CA Clarity application.
Document Contents
This guide contains task oriented, conceptual, and reference material. The appendixes contain reference material on the following:
The XML Open Gateway (XOG) is a CA Clarity web service interface that you can use to:
CA Clarity web services are available on the same HTTP or HTTPS port as the HTML web browser interface. You can access a web service using one of the following:
You can download the XOG client to your computer and use it to run the XOG.
You can access and run the XOG directly using SOAP without using the XOG client. CA Clarity web services use XML messages that follow the SOAP standard.
The XOG client is a Java program that you can install on your computer and use to import and export data using the XOG. The XOG client communicates with the CA Clarity server on the standard HTTP port using the SOAP protocol. Using the client, you can:
The following web services are available from the XOG API:
This API includes all read and write services for objects whose data can be imported or exported using the XOG.
This API provides for administrative actions that fall outside the categories of data import and export. It contains two root elements:
This API lets you execute NSQL-based queries from the XOG. You can use this API to select and export the exact information you need from CA Clarity.
The Web Services Description Language (WSDL) describes the available XOG services and indicates how to communicate with the services. WSDL is used with SOAP and the XML schema to provide web services over the internet. You can connect to a web service and read the appropriate WSDL file to learn what functions are available on the server.
Access Rights to Run the XOG from the Client
Before using the XOG client, you must have a valid CA Clarity login name and password.
You must also have one of the following access rights:
XOG Access Rights for Individual Objects
Before a resource can use the XOG to import or export data for a particular object, you must assign the resource the XOG access right for that object (for example, Asset - XOG Access, Project - XOG Access, Resource - XOG Access, and so on).
For example, you can grant the Asset - XOG Access right to a resource to support a custom CA Clarity PPM desktop application that needs asset information. While the resource can import and export instance data that is associated with the asset object, the resource is not able to import or export data on any other objects.
XOG access rights for objects are listed in the access rights list in the Administration Tool with other access rights. XOG access rights are global rights.
To assign XOG access right to a resource
The list page appears.
The properties page appears.
The access rights list page appears.
The access rights selection page appears.
A list of XOG access rights for individual objects appears.
The XOG access right appears in the list of access rights for the resource.
For more information, see the Administration Guide.
|
Copyright © 2013 CA.
All rights reserved.
|
|