HTDS context parameters

This section describes various context parameters that are available for HTDS application, their default values, possible values and their meanings.

These parameters are located in the web.xml file for that application. When modifying the file that contains these parameters, the HTDS application must be repackaged with the modified file to take effect.

Table 1. HTDS parameters
Parameter Default value Description
InfoRulesFiredPropertiesFilter false Specifies whether the filter is applied to the properties of the ruleInformation for the rules that are fired as the result of the ruleset execution.
  • true: Properties are filtered
  • false: Properties are not filtered.
ExecutionProvider Depending on application server Possible values:
  • J2SE: Tomcat and Liberty
  • POJO: Other supported platforms
Note: Do not modify this value. By default, it is set specifically to your server.
Compatibility Latest Specify the WSDL format. for backward compatibility.

Possible values:

  • Latest: Generate WSDL and run with the latest HTDS feature.
  • 7.0: Generate the WSDL and run the ruleset with the 7.0 format.
  • 7.1: Generate the WSDL and run the ruleset with the 7.1 format.
  • 7.1.1.3: Generate the WSDL and run the ruleset with the 7.1.1.3 format
Deprecated feature:

Deprecation icon The SOAP compatibility modes 7.0, 7.1 and 7.1.1.3 are deprecated as of V9.6.0.0. See Deprecated and removed features for details.
DecisionServicePrefix HTDS Specify the root name that is used to register the Decision MBean. Use this parameter to deploy multiple instances of HTDS into the same server.
InterceptorEnabled false Specify whether the interceptor feature is enabled for HTDS executions.

Possible values:

  • true: interceptor is enabled
  • false: interceptor is disabled
AsynchronousRulesetParsing false Specify whether asynchronous ruleset parsing applies to all HTDS executions.

Possible values:

  • true: asynchronous ruleset parsing enabled
  • false: force execution of the most up-to-date version of the ruleset
org.jboss.jbossfaces.WAR_BUNDLES_JSF_IMPL true Forces JBoss® to use the JSF implementation that is included in HTDS.
Note: Do not modify this value. It applies to only JBoss application servers.
QualifyElementsInParametersNamespaceForWSDL false Controls the “elementFormDefault “ attribute presence on the WSDL schema part for parameters with the value ”qualified.”

Possible values:

  • true : attribute is added to WSDL.
  • false: attribute is not present in WSDL
Example: <xsd:schema elementFormDefault=“qualified” targetNamespace=“http://www.ibm.com/rules/decisionservice/myRuleapp/myRuleset/param”/>
DefaultTimeZoneForJsonDeserialization default Specify the timezone in which dates are expressed in case they do not contain timezone information for the REST JSON execution endpoint.

Possible values:

  • default: does not override timezone used by the JSON parser (GMT)
  • server: overrides timezone used by the JSON parser and uses the JVM's default timezone
  • a timezone identifier: overrides timezone used by the JSON parser and use the specified timezone, if it is a valid timezone identifier
CheckEmptyJsonRequests true Specify whether to check for empty JSON requests and reject them.

Possible values:

  • true: requests are checked and rejected when empty. May induce a performance hit with large documents.
  • false: requests are not checked.
forceSerializationOfNullFieldsDecoratedWithJAXBAnnotations false Specify whether to force the inclusion of null values in JSON responses ({ "fieldName": null}) when corresponding fields are decorated with JAXB annotations like @XmlElement.

Possible values:

  • true: null fields are included.
  • false: null fields are not included.
ResetJsonMapperElapsedHoursThreshold 24 Specify the duration in hours after which the JSON serializer is reset.
EmitErrorEventOnRulesetNotExecuted false Allows HTDS to emit an event to Kafka whenever the execution request for a ruleset is not carried out, in the case of incorrect parameter deserialization. However, rulesets must have properties set to emit events, and as well, the event emitter plug-in must be configured. See Emitting runtime events.

Possible values:

  • true: Emit an event in case of deserialization issue.
  • false: No event is generated in such case.
OpenAPITagNameForExecutionMethod No value Controls and defines the name of the tag associated with the REST execution method in the generated OpenAPI descriptor files. If left empty (default value), no tag will be used, and as a consequence the method will appear under a tag named "default" in Swagger UI. If set, a tag will be created with the value set for this parameter and the REST execution method will be associated with that tag, and as a consequence, the method will appear under that tag name in Swagger UI.