Cobra Web Service
The Cobra Web Service allows you to create applications that can programmatically execute Cobra functions over the network.
To know the supported processes, operations, and data for creation, deletion, and retrieval, see Supported Processes, Operations, and Data.
The Cobra Web Service consists of two parts: the Cobra Web Service host and the Cobra Web Service ClientAPI.
Cobra Web Service Host
The Cobra Web Service host is a Simple Object Access Protocol (SOAP) based Windows Communication Foundation (WCF) service which exposes Cobra functions over the network.
Cobra Web Service ClientAPI
The Cobra Web Service ClientAPI is a .NET dynamic link library which consumes the WCF service. Deltek recommends that application developers use this library in their applications.
Use the link below to display the Web Service ClientAPI Help. Alternatively, you can navigate to the
subfolder of the Cobra installation folder.Utilizing the Cobra Web Service
This table summarizes the steps you need to perform to utilize the Cobra Web Service.
Step | Procedure | Notes |
---|---|---|
1 | Deploy the Cobra Web Service host. | This step is required. |
2 | Configure the Cobra Web Service when using Windows authentication . | This step is required only if you are using Windows authentication. You do not need to perform this step if you are using SQL Server Authentication (username/password) in your datasource. |
3 | Deploy the Cobra Web Service ClientAPI. | This step is required only if you are going to utilize the Cobra Web Service ClientAPI in your application. |
4 | Create a Visual Studio project and add the ClientAPI files as reference. | |
Attention: To better understand how to use the Cobra Web Service ClientAPI in your application, Cobra provides a sample ClientAPI file which contains examples on how to authenticate and call Cobra processes through Cobra Web Service ClientAPI. Refer to
Cobra Web Service ClientAPI Example for step-by-step explanation.
|
Cobra Web Service Management Tool
Cobra is shipped with the Cobra Web Service Management Tool that you can use to configure instances and gateway endpoints through an intuitive user interface. For more information about the tool and how to use the it, see Cobra Web Service Management Tool.
- Related Topics:
- Supported Processes, Operations, and Data
The Cobra Web Service supports a number of processes, operations, and data for creation, deletion, and retrieval. - Deploying the Cobra Web Service
To start using the Cobra Web Service, you must deploy the Cobra Web Service host. - Using the Cobra Web Service ClientAPI in Your Application
To use the Cobra Web Service ClientAPI in your application, you must set up your .NET project by adding the ClientAPI file as reference in Visual Studio Projects. - Cobra Web Service ClientAPI Example
This section demonstrates how to use the Cobra Web Service ClientAPI by using the ClientAPI sample file that comes with the Cobra installation. - Cobra Web Service Log
You can use the Cobra Web Service Debug log or the WCF Trace log to troubleshoot Cobra Web Service issues. - Other Distribution Files
There are additional distribution files related to the Cobra Web Service aside from the ClientAPI files. - Deltek Products That Utilize the Cobra Web Service
There are Deltek products that use the Cobra Web Service in order to automate and execute Cobra processes. - Troubleshooting Cobra Web Service Issues
This section provides errors that you may encounter when using Cobra Web Service as well as possible solutions.