Connecting to the SOAP server

A connection to the SOAP server is required before requests can be sent to it. You must create a SOAP server object with methods that correspond to the available Helix ALM methods.

After the server object is created, you can start making SOAP calls using the methods supported by the Helix ALM SDK.

The following example code is in C#.

1. Add a web reference that points to the ttsoapcgi.wsdl file installed on the computer that hosts the Helix ALM SOAP CGI.

For example, if the WSDL file is installed on your local computer, the path is http://localhost/ttsoapcgi.wsdl.

To use the SOAP CGI with Visual Studio, you must run the wsdl.exe command line utility and generate a source code file that contains SDK stub code. See SDK DateTime Object Does Not Work With .NET 2.0 for information.

2. Create a ttsoapcgi object, which is used to make calls into SOAP.

ttsdk = new ttsoapcgi()

3. Specify the SOAP CGI server address.

For example, if the SOAP CGI is installed on the local computer, the address is http://127.0.0.1:80/scripts/ttsoapcgi.exe.

ttsdk.Url = "http://localhost:80/scripts/ttsoapcgi.exe";

4. Log in to the SOAP server to start making calls.

A cookie is received from the SOAP server when you log in. This cookie defines the current authenticated session and is required for all other SOAP calls.

  • If you know the name of the Helix ALM project you want to connect to, use the following call:
    long ICookie = ttsdk.ProjectLogon(MyProject, "administrator", "password");
  • If you do not know the project name or want to view a list of available projects, use the following call to find the project and then use the projectLogon operation to log in:
    CProject[]adb = ttsdk.getProjectList();.

5. Log out when you are finished.

ttsdk.DatabaseLogoff(ICookie);

The connection remains active if you do not log out. Other users cannot use the SOAP license until the session times out.