Host Server Web Server tab

Outside applications can access some internal functions, such as SMAT message resend or error message resend.

These internal functions are exposed as web services, so that the outside applications can access them through Simple Object Access Protocol (SOAP).

Additional options are:

  • Launch web server on Host Server startup

    When this is selected, the web server starts along with the host server. If this cleared, then Enable web services is also cleared. The default is selected.

  • Enable Cloverleaf API

    The Cloverleaf API uses a RESTful web service architecture and (JavaScript Object Notation (JSON) as the data interchange format. Through this, you can create, edit, and delete Cloverleaf objects that were traditionally only available in the Cloverleaf GUI.

  • Enable Cloverleaf API Documentation

    Enable Cloverleaf API must be selected to enable this check box.

    By default, Enable Cloverleaf API Documentation is cleared.

    The CLAPI web page includes the CLAPI SDK document and examples. By default, it is disabled. To enable the CLAPI web page, the host server must be running in security mode.

    When the Cloverleaf host server is started with Enable Cloverleaf API Documentation enabled, all Cloverleaf APIs are listed in HTML through https://hostservername:15047/clapi/. This provides details about request parameters and responses for each API.

    You can also enter API parameters and click Try it out in the API window.

    The Resources Available page lists available APIs and their location.

    For information on CLAPI, see Cloverleaf API.

  • Port

    Port 15040 is the default for the Site Document.

    By default, the HTML files that are generated by the Site Document are put under $HCIROOT/server/tomcat/webapps/sitedoc.

  • Any changes enable Save. After you click Save, you must restart the host server before the change takes place.
  • The HTTP port defaults to 15040, HTTPS defaults to 15043, and the Tomcat server shutdown port defaults to 15045. To change these ports, go to $HCIROOT/server/tomcat/conf/server.xml.

Web services respect the host server's security configuration. If the host server is configured as no security, then no security is used for web services. If the host server is configured as basic or advanced security, then Transport Security (SSL) is used for web services. SSL provides a point-to-point security.