Viewing or downloading an HTDS description file

You can view or download the description file of a hosted transparent decision service to Web Service Description Language (WSDL), Web Application Description Language (WADL), or OpenAPI format. Decision services that support being described with OpenAPI (topic covers restrictions) can also be viewed and interacted with through a hosted Swagger UI tool.

Before you begin

Restriction:
  • Generation of OpenAPI description files is supported for only Java™ XOMs, while WSDL and WADL file generation are supported for XML XOMs and Java XOMs with JAXB annotations.
  • You cannot use the Retrieve HTDS Description File feature for rulesets that are built with an incompatible engine version. In case of incompatibility, the ruleset view provides more information.

About this task

When you present a ruleset as a SOAP hosted transparent decision service, the description file is generated in WSDL. When you create a transparent decision service to execute a ruleset through the REST API, the description file is generated in WADL or OpenAPI.

WSDL

To invoke a hosted transparent decision service, you can generate a WSDL file from a ruleset from the Rule Execution Server console. You can download the generated WSDL for the following purposes:

  • Import the transparent decision service into any product or application that supports WSDL code, such as Rule Designer or IBM® Integration Designer with XSD files.
  • Host the WSDL on another computer.
WADL

When you want to execute a ruleset by using the REST API, you can generate a description file in .wadl format for the ruleset from the Rule Execution Server console.

OpenAPI

Another way to execute a ruleset by using the REST API is to generate an OpenAPI definition file in .yaml or .json format for the ruleset from the Rule Execution Server console, and execute it through an OpenAPI tool or framework.

Swagger UI
Swagger UI is an industry standard utility that allows one to visualize the details of a REST service and interact with it. From the Rule Execution Server console, you may also directly navigate from a ruleset to a Swagger UI page, which is based on the OpenAPI descriptor for that ruleset. It provides a visual representation of the (JSON) REST execution API specific to that ruleset, and allows to edit and send requests.

When you download an OpenAPI file, you can select the ruleset path and add a decision trace request.

Procedure

  1. In the Rule Execution Server console, click the Explorer tab, expand the RuleApp you want, and select a ruleset to open the ruleset view.
  2. Expand the Hosted Transparent Decision Services (HTDS) Options section.
  3. Optional: If applicable, edit the transparent decision service target name space as explained in Changing target namespaces.
  4. Click Retrieve HTDS Description File.
    The ruleset path is displayed above the options.
    For example: /execution/1.0/PreTradeChecks/1.0
    • To generate a WSDL file, keep the SOAP option selected. If you select no options for WSDL generation, the WSDL code is generated as a single .wsdl file from the ruleset that you selected in the RuleApp view, with dynamic namespaces and decision identifiers, and with no decision trace filters.
    • To generate a WADL file, select the REST option, and then choose WADL from the Format pull-down menu.
    • To generate an OpenAPI file, select the REST option, , and then choose YAML or JSON from the Format pull-down menu.
  5. Optional: For either format, select the appropriate options.
    Latest ruleset version
    Select this check box if you want to generate the WSDL, WADL, or OpenAPI file from the latest ruleset of the RuleApp displayed above the options.
    Latest RuleApp version
    Select this check box if you want to generate the WSDL, WADL, or OpenAPI file from the latest ruleset in the latest version of the RuleApp.
    Decision trace information
    Select this check box if you want the WSDL, WADL, or OpenAPI file to include decision trace filter definitions and trace.

    In the WSDL and WADL code, descriptions of the decision trace filters are documented in <xsd:documentation> elements.

    For information about the decision trace filters, see HTDS decision trace filters

    Important:

    The order between filters is meaningful: when a filter conflicts with another filter, the filter in the higher position is taken into account.

    Inline types in separate XSD files
    Select this check box if you want to download the WSDL or WADL code as a .zip archive in which the .xsd files are saved separately from the .wsdl or .wadl file. This option is useful if you import more than one decision from Decision Server into an IBM Integration Designer project, or if you turn a rule flow into a process. The separation of the object types from the WSDL avoids the duplication of these objects in IBM Integration Designer.
  6. Click View, Download or Swagger UI.

Results

The WSDL file, WADL file, OpenAPI file, or Swagger UI interface is displayed in a separate browser tab or window and saved to the disk to your default download directory. If you select Inline types as separate XSDs, the View button is not available and you can only download the generated files.