Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

Index Data Reader "WebService"

The purpose of the "WebService" index data reader is to read the artificial file attachment batch.json generated by the "WebServiceInput" and "WebServiceOutputClient" input systems. Generally, the file attachment can also be processed with the generic JSON reader. However, because of the fixed structure of the JSON data, the configuration of the specialized index data reader is simpler than otherwise.

The batch.json file includes a complete batch as it was transferred to the web service. Thus, the batch might contain multiple documents. However, since processing in the index data reader is performed by document, the reader will automatically select the appropriate document from the batch. As .InputName, specify the field name in the same manner as the one transferred to the web service. It is not necessary to formulate the entire JSON path.

The ProcessReadIndex[].Field[] list of fields to be read in can be left completely empty. In this case, the names of all fields from the field catalog will be used instead to identify the input fields. This can simplify the configuration in cases such as when data is passed via web service from one xSuite Interface instance (output system "WebserviceOutput" or "WebServiceInputClient") to another xSuite Interface instance (input system "WebServiceOutputClient" or "WebServiceInput") and both instances use identical field catalogs.

Generally, the program adopts typed values from the JSON of the input data are as such. The exception, however, is date values, because they are not directly supported by JSON, but are transferred as string values. If the target field is declared as a date field, the string value will be converted automatically. With common syntaxes (e.g., with the ISO format), the conversion also works without defining the date format. Otherwise, the format must be explicitly configured in .InputFormat.