The Web Service Consumer object is used to request and process information or activity from a provider through the use of request messages. How this request message should be structured should be made available to you by the actual provider of that service.
CIC currently supports the REST protocol. The consumer object using REST references a single Service.
When creating a Web Consumer (REST) object, you define different options and settings. This includes the URL location of the service, as well as the HTTP methods to be used. Once saved the Web Service Consumer object can be called as a Business Process task.
Web Service Consumers and the API Consumer Endpoint (in Cockpit)
How to create a Web Service Consumer (REST)
Create a Web Service Consumer to create and configure the objects that are used to request and process information or activity from a provider through the use of request messages.
- Select File | New | Web Service Consumer from the main menu.
- Select a Web Service Consumer type - currently, the only choice is REST. Click Next to proceed.
- Select Source folder, Package, and Name.
Note: Since the name you select here will also be the name of the service to be provided, it is good practice to include descriptive naming (while following recommended Naming Conventions).
Click Finish. An editor appears.
How to define a Web Service Consumer (REST)
Defining this object identifies the active service made available by a provider using the REST protocol, and allows you to configure settings on how the service is to be consumed.
- Under the Settings section, enter the URL. This indicates the actual location of the service.
If you are connecting to a secure (HTTPS) URL you may need to import the certificate for the URL you are connecting to the CIC Studio Keystore prior to connecting.
Note: You can also type a Substitution Variable - a place holder for all or part of the url path. The actual url will be supplied at runtime by a Business Process. An example of partial replacement may be just replacing...
...gets substituted with an actual product id at runtime.
- Select the HTTP Method. This indicates the type of REST operation (GET, POST, PUT, DELETE) to perform when accessing a URL.
- Use the Timeout field to determine exactly when a connection attempt to an external Web Service provider will be terminated if a response is not received.
- Use the Retry Count field to determine the number of times the Web Service consumer will attempt to reconnect.
- Use the Retry Delay field to determine the amount of time between each retry attempt.
- Determine payload behavior by using the Transfer Type field. Two options are available.
- Chunked: The payload will be divided into smaller units and sent one at a time.
- Content-Length: The entire payload will be sent.
- Enter the name of the Alias into the Vault Entry Alias field to have this object to use a vault entry. See Secure Authorization of Web Service Requests using the Server Vault for more details.
- Under the Default Request HTTP Headers section, click the Add button to provide and define any HTTP Headers you plan to use with the REST consumer. This optional table allows you to send additional headers to the remote server when the REST consumer is executed. The values specified in the HTTP headers are the default values sent out, however, these values can be modified when the REST Consumer is used by the Business Process at runtime.
Note: These new REST interfaces are also available in the Web Service Consumer editor so you can change these values after the Web Service Consumer is created.