PCo Web Server Settings Tab

Context

On this tab, you define the server endpoint under which the Web server can be called.

Procedure

Choose the Add Endpoint pushbutton.

PCo displays the Add Server Endpoint Description dialog box.
In the Endpoint URL field, define the URL under which the Web server can be called by the clients.
PCo proposes an example URL. When you create a new entry or change an entry, you need to enter a valid URL here. A simple validity check is performed.
Note
A valid URL starts with one of the following character strings:
- http://
  
  With this URI scheme, you can only choose the options None or Basic in the Authentication field. Authentication using a certificate is not possible.
- https://
  
  The advantage of this URI scheme is that communication can be secured using a TLS certificate.
  
  With this URI scheme, you can choose between all three options in the Authentication field.
Then comes the URL of the server, where, ideally, you use a fully qualified domain name. This is followed – separated by colons – by a port number and, optionally, path details.

Example: https://localhost:<Port>/PCoWebServer
PCo checks if the port number is still being used on other active servers of the PCo instance and allows you, if necessary, to choose a port number that has not yet been used.

Make the following settings:

Settings for the Endpoint
Field	Description
Service Mode	The service mode allows the user to select a protocol or an architecture style for the Web service. You can choose between the following settings: SOAP-based Web service This Web service is closely linked to the server; in other words there is a fixed contract between the client and the server. The client updates the service definition as soon as there are changes on the server. REST-based Web service The architecture of this Web service is designed in such a way that a client knows the URL of the entry point and processes the stateless resources using a standard interface. This processing is performed by the use of http methods such as GET, POST, UPDATE, and DELETE operations.
OData	If you set the indicator, the OData protocol is activated.
Target Namespace	You need to create a target namespace if you are using parameters with the same name. You can only distinguish between parameters with the same name if you use namespaces. The target namespace is only input enabled in conjunction with the SOAP-based setting. The namespace http://tempuri.org is proposed by default. You can overwrite this proposal. Once you have saved, the namespace that you entered is created.
Content Type	The content type defines how the resources are displayed. You can choose one of the following options, depending on the service mode you defined previously: XML JSON
Authentication	The Web client can perform the calls of the Web service operations with or without access control. Certificate If you choose the Certificate option, you need to select a server certificate. In addition, you need to make settings for the certificate folder. (See also: Certificate Folders.) Note The Certificate option is only possible in conjunction with the https URI scheme. No authorization check takes place during runtime. Only the certificate is checked. If you choose the Basic option, the Windows user needs to provide valid logon data. This option is possible for the http and for the https URI scheme. After authentication, PCo performs a role-based authorization check. Note The Windows user who authenticates herself or himself to the Web server needs to belong to the Windows user group PCoWebServer. The Web server cannot be called for Windows users who, even though they can authenticate themselves, do not belong to the user group. If you choose the option None, the client can consume the Web service without logon data needing to be provided. No authorization check takes place either.
TLS / Server Certificate	You always need to choose a TLS certificate here if you are using https as the URI scheme for the endpoint. TLS is a technology concept that enables secure communication between client and server using the https protocol. The TLS server certificate is also required in conjunction with the Certificate option in the Authentication field. Note The certificate must match the domain server name (host name) that is used in the endpoint. This means that, in the settings for the certificate, the Subject Name needs to match with the host name of the server endpoint, otherwise no connection can be established between PCo and the client.
Certificate Folders	You make the settings for the certificate folders here. These settings are used during runtime for validation of the certificate sent by the client. (See also: Certificate Folders.) Note The fields are only ready for input if you have chosen the certificate option in the authentication field.

Results

The endpoint for the Web server has been created. In the next step, you need to create the method definition. (See: Web Server Method Definitions Tab (Web Server).)