Table of Contents
This article covers how to apply specific report versions to a WebMIS account and why it is important to do so if you rely on specific format for report ingestion.
SOAP Report Versioning
Occasionally NMI will deploy new functionality to our reporting platform for our customers to use and integrate with, however, if your integration uses a specific format for report ingestion this can cause issues wherein an extra column added half way through the report could either shift data across into the next column once ingested, or cause the ingestion process to completely break down.
To aid in resolving these occurrences we provide a configurable report version selector in the WebMIS user preferences section. This can either be set to an absolute version, such as the latest available at time of integration, or set to the latest available at all times (which is the default selection).
How to Set a Fixed Report Version
Before you start, please ensure you confirm the correct reporting version for your needs with your integrator. Once you have confirmed which version you require, enter the preferences for the WebMIS account that generates the reports:
Select the Fix report format to version dropdown box and select the required version for your integration and save:
Please note: As of version 1.1.5 reports will include the Distributor column. If your report ingestion process fails as a result of this please use version 1.1.4.