The WebServiceModelConfig.txt file controls which inputs the web service will expect to receive for your model and which results it will return. It is generated by the export process from the STEM Editor and Results Program. The content and format of this file may change in future versions of STEM – please do not rely on modifying or parsing it.
Each line of the file consists of a tag defining the meaning of the line, an equals sign and then a value. Each of these must be separated by one or more space characters. The essential tags and corresponding values are as follows:
| Tag |
Corresponding value |
| model |
The name of the file defining the model
(a .dtl file; this must be in the same folder as WebServiceModelConfig.txt).
|
| config |
The name of the config file defining any calculated or customised results
(a .cnf file; this must be in the same folder as WebServiceModelConfig.txt).
|
| run_scenarios |
A comma-separated list of scenarios that must be run to generate the results listed in the file. The numbers rather than names of scenarios are used to keep this list concise. If you are also running sensitivities, the relevant scenario and sensitivity combinations are defined with comma-separated lists of scenarios and sensitivities separated by ‘+’. The combinations will be separated by semicolons. |
| input |
An expected input. This value must consist of the element name, then a single tab character and then the field name. |
| result |
A result that will be returned to callers of the web service. This value must consist of a scenario name (blank to use the working model), an element name and a result name, separated by single tab characters. This is optionally followed by a consolidation mode. If you are accessing sensitivity results, the value will also contain sensitivity name, parameter name, and step. |
| Value_lookup |
A value from the model that will be returned to callers of the web service alongside the results. These are used in the generated web interface to update chart axis-labels with appropriate text (for example, a currency unit). |
Figure 1: The essential elements of a WebServiceModelConfig.txt file
A few optional tags which control activity logging and the generation of downloadable reports are described in 8.4.4 Controlling activity logging and debug output and 8.6 Creating Excel-based reports to download in XLSX or PDF format.
Figure 2: Example WebServiceModelConfig.txt file