Cobra Web Service Gateway Settings

The right pane displays the Cobra Web Service Gateway Settings if the gateway is selected in the left pane of the tool.

Use the fields in this pane to define the Cobra Web Service endpoints that you will use for the concurrency feature so that the Cobra Web Service Gateway can identify their URLs and make the connection.

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

Gateway Endpoint Group Box

This group box displays the address of the gateway's listening endpoint.

Field Description
Host

This field displays the host name of the gateway's listening endpoint, which is usually the machine name.

  • This field is required.
  • This field is read-only if the gateway is installed, and the status is Running or Paused.
  • This field is editable if the gateway is not installed, or the status is Stopped.
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 gateway’s listening endpoint, which can be HTTP or HTTPS.

  • This field is required.
  • This field is read-only if the gateway is installed, and the status is Running or Paused.
  • This field is editable if the gateway is not installed, or the status is Stopped.
Port

This field displays the port number of the gateway's listening endpoint.

  • This field is required.
  • This field is read-only if the gateway is installed, and the status is Running or Paused.
  • This field is editable if the gateway is not installed, or the status is Stopped.
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 gateway, which is generated using the Host, Protocol, and Port settings. This setting is always read-only.

Note: When using the Concurrency feature, this is the address of the gateway’s listening endpoint to which the PM Compass Process Server must connect.

Cobra Web Service Endpoints Grid

This grid displays the different Cobra Web Service endpoints to which the gateway will connect. This grid is read-only if the gateway is installed, and the status is Running or Paused. This grid is editable if the gateway is not installed, or the status is Stopped.

Note: You must define at least one endpoint to install the gateway to Windows Services.

Each endpoint in the grid has the following fields.

Field Description
Name

This field displays the unique name of the endpoint.

Address

This field displays the addresses of the endpoint.

UPN

If the Cobra Web Service is located on a remote machine that runs on the Windows Domain Account that does not have access to the Service Principal Name (SPN), use this field to specify the User Principal Name (UPN) of the running Windows domain account. This will be the Identity of each remote Cobra Web Service. This field is optional.

Logging Group Box

Use this group box to set up the WCF Trace logging of the gateway.

Field Description
Enable WCF Trace Log

Select this checkbox to allow the gateway to write WCF Trace logs. This checkbox is read-only if the gateway is installed, and the status is Running or Paused.

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 read-only if the gateway is installed, and the status is Running or Paused.
  • This field is editable if the gateway is not installed, or the status is Stopped.
  • 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 the gateway is installed, and the status is Running or Paused.

If the gateway is not installed or the status is Stopped:

  • 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 the gateway is installed, and the status is Running or Paused.

If the gateway is not installed or the status is Stopped:

  • 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.

Generate ClientAPI Configuration File

This button is enabled if the gateway is installed. 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.