Viewing or downloading an HTDS description file

For any ruleset, you can view or download the description file of a hosted transparent decision service to Web Service Description Language (WSDL) format or to Web Application Description Language (WADL) format.

About this task

You can generate HTDS WSDL code for rulesets that use either an XML XOM or a Java™ XOM with JAXB annotations. The URL is based on the Rule Execution Server console host, even if the jrules-res-htds-<appserver>.ear archive is not deployed on that host.

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

Restriction:

WSDL or WADL generation are not available for rulesets that are built with the decision engine.

WSDL

To create 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 decision service into any product or application that supports WSDL code, such as Rule Designer or IBM® Integration Designer with XSD files.
  • Modify the WSDL so that the service uses a compatibility mode.
  • Host the WSDL on another computer.
WADL

When you want to execute a ruleset through the REST API, you generate its description file in WADL format from the Rule Execution Server console. You can then download the result to a .wadl file that REST clients can read.

When you download a WSDL or WADL file, you can select the ruleset path, add a decision trace request, and download the XSD files separately.

Moreover, in a WSDL file, you can also generate the code for compatibility with 7.0, 7.1, or 7.1.1.3 clients.

Procedure

  1. Start your application server (or the sample server), open the Rule Execution Server console, and sign in to it.
  2. Click the Explorer tab, expand the RuleApp you want, and select a ruleset to open the Ruleset View.
  3. At the bottom of the Ruleset View, click Show HTDS Options.
  4. Optional: If applicable, edit the decision service location, endpoint, and target name space as explained in Configuring a web service endpoint and Changing target namespaces.
  5. Click Retrieve HTDS Description File. The ruleset path is displayed above the options. For example: /execution/1.0/PreTradeChecks/1.0For 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.
  6. Optional: For either format, select the appropriate options.
    Latest ruleset version
    Select this check box if you want to generate the WSDL or WADL code 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 or WADL code from the latest ruleset in the latest version of the RuleApp.
    Decision trace information
    Select this check box if you want the WSDL or WADL code to include decision trace filters.
    • In the WSDL code, decision trace filters are documented in <xsd:documentation> elements.
    • In the WADL code, decision trace filters are documented in <trac:>...</trac:> elements.
    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.
    Compatibility mode
    Note: The Compatibility mode is available only for the WSDL format in this release.
    By default, the generated WSDL file is compatible with 7.5 and 8.0.x clients. Select this check box if you want to generate a WSDL file that is compatible with 7.0, 7.1, or 7.1.1.3 clients. If you do not select any compatibility mode, the WSDL code includes decision identifiers and dynamic namespaces that start with http://www.ibm.com/.
    • If you select 7.1.1.3, the namespace is dynamically set to include the ruleset name, you can change the namespace, and decision identifiers are generated.
    • If you select 7.1, the namespace is set to http://www.ilog.com/rules/DecisionService but decision identifiers are available in the resulting WSDL code.
    • If you select 7.0, the namespace is also hardcoded as http://www.ilog.com/rules/DecisionService and you cannot set it to another path, and no decision identifiers are shown.
  7. Click View or Download.

Results

The WSDL or WADL code 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.