About the Perforce ALM SDK

The SOAP-based Perforce ALM Software Development Kit (SDK) provides a way to remotely make method calls on classes and objects hosted on a remote server. It provides an interface into ALM that allows external applications and users to send, retrieve, save, and update items, such as issues, requirements, test cases, and users.

You can use the SDK to interface with third-party applications or configure SOAP triggers that run an automated process when specific conditions are met.

On this page:

How it works

When a SOAP message is sent from a client computer, it is accepted and processed by the web server hosting the ALM SOAP CGI before it is passed to the Perforce ALM Server. The response is returned to the client using the same path. An automated SOAP trigger works the same way. If the message is configured to send a response, the ALM SOAP CGI sends the appropriate encoded responses back to the SOAP client.

Terminology

The ALM SDK uses the following names for item types: defects, requirements, requirement documents, test cases, and test runs. Keep in mind that your organization may have renamed these items in ALM. The default terminology for ‘defect’ changed to ‘issue’ and 'test run' changed to 'manual test run'. To preserve backward compatibility, the SDK uses ‘defect’ and 'test run'.
To preserve backward compatibility with earlier versions, the SDK uses 'TestTrack Pro' for issue management, 'TestTrack RM' for requirements management, and 'TestTrack TCM' for test case management.