XML Open Gateway (XOG) Development
The XML Open Gateway (XOG) is a
Clarity PPMweb service interface that integrators and system administrators can use to import data, export data, and move configuration data from one system to another. The XOG uses XML and web services to perform these actions. Before you begin using the XOG, verify that you are familiar with XML code, web services, and
Clarity PPMweb 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 these methods:
- XOG client. Download the XOG client to your computer and use it to run the XOG.
- Simple Object Access Protocol (SOAP). Access and run the XOG directly using SOAP without using the XOG client.Clarity PPMweb services use XML messages that comply with the SOAP standard.
This content is only available in English.
Video: What is XML Open Gateway (XOG)?
The following third-party video is provided by Rego Consulting. This video is provided by CA Technologies “AS IS” and without warranty.
To play this video in full screen, click the YouTube logo to the right of Settings at the bottom of the video.
The XOG client is a Java program that you can install on your computer and can use to import and export data using the XOG. The XOG client communicates with the
Clarity PPMserver on the standard HTTP port using the SOAP protocol. Using the client, you can perform these steps:
- Log in to start an authenticated session.
- Execute requests to read or writeClarity PPMdata.
- Log out to end the session.
XOG Web Services
The following web services are available from the XOG API:
- Object API. Includes all read and write services for objects for which the data can be imported or exported using the XOG.
- InvokeAction API. Supports administrative actions that are beyond the categories of data import and export. This API includes theProcessroot element.
- Query API. Supports the execution of NSQL-based queries from the XOG. You can use this API to select and export the information that you need fromClarity PPM.
Web Services Descriptive Language (WSDL)
The Web Services Description Language (WSDL) describes the available XOG services and indicates how to communicate with them. WSDL is used with SOAP and the XML schema to provide web services over the Internet. You can connect to a web service and can read the appropriate WSDL file to learn what functions are available on the server.
Assign XOG Access Rights
Before you use the XOG client, you must have a valid
Clarity PPMlogin name and password. You must also be assigned one of these access rights:
- Administration - Access
- Administration - XOG
Before a resource can use the XOG to import or export data for a particular object, assign them the XOG access right for that object. For example, you can assign the resource the
Asset - XOG Access,
Project - XOGAccess, and
Resource - XOG Accessaccess right. You can grant the
Asset - XOG Accessright to a resource to support a custom
Clarity PPMdesktop application that needs asset information. The resource can import and export instance data that is associated with the asset object. However, the resource cannot import or export data on any other objects.
You can find XOG access rights (global rights) for objects in the access rights list in the Administration Tool, in addition to the other supported access rights.
Follow these steps:
- Open Administration, and from Organization and Access, click Resources.
- Click the resource last name.
- Open the Resource's Access Rights menu and click Global.
- Click Add.
- Enter*XOG Accessin the Access Right field and click Filter.
- Select the appropriate XOG access rights and click Add.
The XOG access right is assigned to the resource.