HTM Requests
An 'HTM Request' is the DSL’s representation of a single HTM task definition. It provides the ability to define all the aspects of an HTM task request so that it can then be invoked from within any payment flow.
The HTM Request will automatically create two responses that need to be handled. These are:
-
<RequestName> Response - this is the main response from the HTM Server and details the outcome of the task.
-
<RequestName> Technical Response - this is the technical ack that comes back from the HTM Server and defines whether the task registration was successful.
The HTM request holds a number of properties that can be used to setup the definition of the task:
-
Name - this will become the 'task type' within the HTM definition.
-
Description - used for informational purposes only and not sent to HTM itself.
-
Priority - this integer value is sent to HTM as the priority value of the task.
-
Required Approvals - this integer value is sent to HTM to specify how many approvals are required for the task.
-
Ignore Tech Response - when an HTM task is created within HTM, an acceptance response is returned containing the task id. By default, this is returned to the flow as a "Technical Response" to the request. If ignore tech response is enabled, the technical response will be logged only and not sent to the flow for processing.
-
Response Codes - these define the different options that the user will be able to select in HTM for an outcome of the task.
-
Business Data - this specifies the business data that is made available to the HTM service. If a single business data element is defined, then it is sent as the primary element in HTM. If multiple elements are defined then it is necessary to configure a mapping to the HTM input data type.
-
Meta Data - this specifies static meta tags that are applicable to all the requests of this type. It is typically used to define known groups, for example that a request is related to "Sanctions".
Each HTM request is stored within an 'HTM Request Library'. The library in this case is simply a grouping container for logically displaying HTM Requests and has in itself no functional impact.