Connect SOAP API Developer’s Guide

Welcome to the Xactly Connect SOAP API Developer’s Guide. This guide describes how to access Xactly Incent (including eDocs and Approvals), Modeling, and Territories capabilities using the Xactly Connect SOAP Application Programming Interface (API).

Using the Xactly Connect SOAP API, you can create, view, modify, and delete objects within the Xactly data model, enabling you to create and manage compensation information for your organization. Xactly Connect administrators can also start and monitor key processes such as validation, calculation, and result releases.

The Xactly Connect SOAP API is part of Xactly Connect, a web-services technology that enables you to control the full lifecycle for data integration with Xactly Incent. In addition to the SOAP API described in this document, Xactly Connect further includes a comprehensive REST API and two separate but integrated languages: xCL (Connect’s Xactly Command Language) and xSQL.

xCL enables you to manage Connect objects such as tables, schedules, steps, pipelines, emails, and more. In contrast, xSQL is a dialect of SQL that allows you to query and manipulate data.

Using This Document

This guide is divided into the following chapters:

Introducing Xactly Connect describes key Xactly Connect concepts and introduces the objects and operations available using the Xactly Web Services Application Programming Interface.

Using the Xactly Connect Toolkit provides information about how to use Xactly Connect to create applications, including details about Xactly objects and operations, the processing model, and suggested best practices.

Getting Started provides an overview of the Xactly Connect application development process including how to download the Xactly Connect WSDL files, how to enable user access, and how to generate the Application Programming Interface objects.

Xactly Connect Reference provides detailed information about Xactly Connect objects and operations including the Xactly Web Services Application Programming Interface and Java API.

• Exploring Primitive Data Types
• Exploring Complex Types
• Understanding Xactly Objects
• Xactly Connect Object Operations
• Exploring Operations
• Exploring the Xactly Connect Java API

Common Xactly Connect Tasks shows and describes sample code for a series of common Xactly Connect tasks for the Java and Microsoft .NET environments.

Supported Development Environments

Xactly Connect enables you to develop applications using any programming language that support SOAP protocols, including Java and C#. You can also access the Xactly Connect SOAP API using middleware technologies and tools that similarly support SOAP protocols. Table 1 lists the supported development environments for Xactly Connect.

Table 1: Supported Development Environments

System Requirements

The system requirements for Xactly Connect are based on the requirements for the supported development environments, as outlined in Table 1.

Accessing Technical Support

Xactly Incent Support is available through multiple channels including telephone, email, and Web-based access. Table 2 outlines the available channels to report service request tickets for timely resolution.

Table 2: Xactly Incent Support