Help System

Using the Help Search
Using the Help Search
  • Phrase:Returns all topics that contain the exact phrase in the search criteria. Use quotation marks around the phrase.
    Ex."system administration"
  • And:Returns all topics that contain all the words in the search criteria, in any combination. Insert a plus sign between all words in the search criteria.
    Ex.system + administration
  • Or:Returns all topics with any combination of words in the search criteria. This is the default.
    Ex.system administration
For more information:Searching Online Help

Cobra Web Service Instance Settings

The right pane displays the Cobra Web Service Instance Settings if an instance or New Instance is selected in the Instances tree.

If an instance is selected, the tool loads the configuration file settings into the right pane. If <New Instance> is selected, all fields in the right pane are blank.

The Cobra Web Service Gateway Settings interface is described in the following tables.

Field Description
Name

This field displays the unique name of the instance in Windows Services.

  • This field is required.
  • This field is editable if <New Instance> is selected in the Instances tree.
  • This field is read-only if an instance is selected in the Instances tree.
Description

This field displays the description of the instance in Windows Services.

  • This field is optional.
  • This field is editable if <New Instance> is selected in the Instances tree.
  • This field is read-only if an instance is selected in the Instances tree.
Config File

This field displays the configuration file assigned to the instance. This file must reside in the same folder as the Cobra.WebService.Host.exe file.

  • This field is required.
  • This field is editable if <New Instance> is selected in the Instances tree.
  • This field is read-only if an instance is selected in the Instances tree.

Endpoint Group Box

Field Description
Host

This field displays the host name of the endpoint of the instance.

  • This field is required.
  • This field is editable if <New Instance> or an instance with Stopped status is selected in the Instances tree.
  • This field is read-only if an instance with Paused or Running status is selected in the Instances tree.
Note: When configuring this instance to use SSL, supply the Subject from Windows Server Certificate intended for Server Authentication. For more information, see Configuring Cobra Web Service to Use Secure Socket Layers.
Protocol

This field displays the protocol of the endpoint of an instance, which can be HTTP or HTTPS.

  • This field is required.
  • This field is editable if <New Instance> or an instance with Stopped status is selected in the Instances tree.
  • This field is read-only if an instance with Paused or Running status is selected in the Instances tree.
Port

This field displays the port number of the endpoint of an instance.

  • This field is required.
  • This field is editable if <New Instance> or an instance with Stopped status is selected in the Instances tree.
  • This field is read-only if an instance with Paused or Running status is selected in the Instances tree.
Note: You must ensure that the port number does not conflict with the port number from other endpoints in instances or other systems. The Cobra Web Service Management Tool will not validate it.
Note: When configuring the instance to use SSL, supply the port that was binded with the Windows Server Certificate intended for Server Authentication. For more information, see Configuring Cobra Web Service to Use Secure Socket Layers.
Address

This field displays the address of the endpoint of the instance, which is generated using the Host, Protocol, and Port settings. This setting is always read-only.

Open endpoint for Deltek Costpoint Integration

This checkbox determines whether an endpoint will be open for the Costpoint-Cobra Integration.

  • This checkbox is editable if <New Instance> or an instance with Stopped status is selected in the Instances tree.
  • This checkbox is read-only if an instance with Paused or Running status is selected in the Instances tree.
Port

This field displays the port number of the endpoint for the Costpoint-Cobra Integration.

  • This field is disabled if the Open endpoint for Deltek CostPoint Integration checkbox is cleared.
  • This field is required unless it is disabled.
  • This field is editable if <New Instance> or an instance with Stopped status is selected in the Instances tree.
  • This field is read-only if an instance with Paused or Running status is selected in the Instances tree.
Note: You must ensure that the port number does not conflict with the port number from other endpoints in instances or other systems. The Cobra Web Service Management Tool will not validate it.
Address

This field displays the address of the endpoint for the Costpoint-Cobra Integration, which is generated using the Host, Protocol, and Port settings. This setting is always read-only.

Logging Group Box

Field Description
Enable WCF Trace Log

Select this checkbox to allow the instance to write WCF Trace logs.

  • This checkbox is editable if <New Instance> or an instance with Stopped status is selected in the Instances tree.
  • This checkbox is read-only if an instance with Paused or Running status is selected in the Instances tree.
Attention: For more information, see Enable the WCF Trace Log.
Log File

This field is required if the Enable WCF Trace Log checkbox is selected.

  • This field is required unless it is disabled.
  • This field is disabled if the Enable WCF Trace Log checkbox is cleared.
  • This field is read-only if an instance with Paused or Running status is selected in the Instances tree.
  • This field is editable if <New Instance> or an instance with Stopped status is selected in the Instances tree.
  • This field displays the path and file to which the instance will write the WCF Trace logs. The path of the file must exist while file may or may not exist.

Save

Use this button to save the settings in the configuration file.

This button is disabled if an instance with Paused or Running status is selected in the Instances tree.

If <New Instance> or an instance with Stopped status is selected in the Instances tree:

  • This button initially disabled.
  • If you make changes to any of the fields, this button becomes enabled.
  • If you click this button, the changes are saved, and this button becomes disabled again.

Cancel

Use this button to revert the changes you made and reload the previous settings from the configuration file. This button is disabled if an instance with Running or Paused status is selected in the Instances tree. If <New Instance> is selected in the Instances tree, this button initially disabled.

Generate ClientAPI Configuration File

This button is enabled if the instance is selected in the Instances tree. Click this button to generate the configuration file for the ClientAPI. Upon clicking, the tool displays a prompt with the location where the Cobra.WebService.ClientAPI.dll.config file will be generated. If the file already exists, it will be overwritten.