API XL Processor
The API XL Processor evaluates and executes API XL documents.
Select the Processor Configuration tab and click on Add Processor.
Select the API XL Processor from the drop-down.
On the Basic tab you can specify:
Input File: input file, if the transaction contents do not contain the document to evaluate.
Validate XML: if the received or loaded XML document should be validated against its schema.
Cache Schema: if the schema for validation should be cached, so it won’t be re-loaded on every execution.
On the Conditional Execution tab, you can set additional Processor execution conditions. The transaction data dependent condition may be specified here as enhanced expression. If this expression returns anything other than TRUE (ignore case) – this processor will be skipped. No additional configuration for this Processor is required.
On the Advanced tab you can specify:
Timeout: the amount of the time of wait before timing out the HTTP connection. If the value is set with enhanced properties, the units are seconds.
Handle Bad Response: if selected, responses with failure status codes (ie, 404 or 500) will still be returned via the Response section in the XML – rather than failing with an exception. Please note that this means response status values should be checked prior to trying to handle their contents.
Normalize Response Stream: if selected, API XL will automatically normalize the HTTP response body streams to remove bytes with invalid character encodings to avoid errors that can cause. This can add additional processing time, so should only be used if necessary.
JSON Transformer Version: which version of the PilotFish JSON transformer should be used transforming JSON to XML. Highly recommended to use version 2.0 unless 1.0 is needed for backward compatibility for older API XL documents.
Cache type: set the type of cache used internally for storing data when the XML structure is executed.
On the Proxy tab you can specify:
If you use proxy – check the Use Proxy on the Proxy tab and specify Proxy Host, Proxy Port, Proxy User, and Proxy Password.
On the Debug tab you can specify:
Evaluation Logging: if selected, extra information about the evaluation process will be logged to help with debugging its execution. Keep in mind that, in some cases, sensitive information may be logged with this option, so it should be kept off by default.
NOTE: This is separate from the Log elements in the XML structure.