Roadmap for Creating REST Outbound Services in Siebel CRM

This roadmap covers the essential tasks that you must perform to import a JSON into Web Tools, and to create an outbound REST service and repository artefacts.

When these steps are completed, the newly created business service can be used like any other Siebel business service to call external endpoints.

1. Create a 64-bit Java subsystem if it doesn’t exist already.

   For more information about Java subsystems, see "Requirements for Implementing a Java Business Service" in Transports and Interfaces: Siebel Enterprise Application Integration.

2. (Optional) If you need to increase logs for debugging or diagnostic purposes, update your REST outbound log level value.

   For more information, see Setting the Log Level for REST Outbound Services.

3. Create a new outbound REST Service based on an OpenAPI compliant JSON file.

   For more information, see Creating an Outbound REST Service Based on an OpenAPI Compliant JSON File.

4. In a Siebel Application, open the new REST outbound service in the Outbound REST Services view and verify that you have correctly imported artefacts such as service methods to the Outbound REST Services. You must also verify the endpoint URL in the Address column of the Service Params Applet.

   For more information, see Creating an Outbound REST Service Based on an OpenAPI Compliant JSON File.

   In OpenAPI 3.0 specification, it is possible to provide different and multiple Host Servers under Server Node, or in Path under Server Node or at operations Node (such as get, put, post, delete, patch) under Server. Only one Host Server which would be most appropriate to that endpoint URL would be persisted in the Address column for use. If a request needs to be sent to a different Host Server, then the Address column can be updated accordingly, or the Filter service can be used to inject and modify the payload for updating the host at runtime.

5. If necessary, set up the proxy for external endpoint access and import the certificates of the external endpoint into the applicationcontainer_internal tomcat that was configured in the 64-bit Java subsystem.

   For more information, see Integration Platform Technologies: Siebel Enterprise Application Integration.

6. If you need to use a security type other than basic authentication, then setup the Request and Response Filter services as required, to inject the security parameters into the payload.

   For more information, see Overview of the REST Outbound Filter Service.

When these steps are completed, the newly created business service can be used like any other Siebel business service to call external endpoints.