The web service is designed to log all activity, you simply have to enable the functionality as follows and decide how much detail you want to see.
For each individual model, you can define a logging attribute within its associated WebServiceModelConfig.txt file with possible values as shown in Figure 1 below.
| Attribute and value |
Effect |
| logging = none |
No log files are created (the default). |
| logging = transaction |
One line is appended to the log file for each external request handled by the web service, listing the time and date, the user and the type of transaction. |
| logging = input |
In addition to the transaction detail, one further line is appended to the log file for each input value sent for each run, save or export command, listing the time and date, the user, the relevant input reference and the value set for that input. |
| logging = debug |
In addition to the transaction and input details, further detail is appended to the per-transaction output including the length of time taken to process the request, the value of each result returned to the user (where appropriate), and any additional information which may be required to profile or diagnose any problems with the service from time to time.
|
Figure 1: Individual model logging options for the eSTEM web service
For the server as a whole, two attributes in WebServicemasterConfig.txt control where the logs are stored and to what database (if any) the log information will be replicated as shown in Figure 2 below.
| Attribute and value |
Interpretation |
| logpath = logs |
Path of a folder in which log files will be stored (relative to /offline/). |
| logdb = data-source |
Data-source name of the intended database which must be separately defined in the web.config file for the site as a whole. The web service will attempt to connect and log information to this data source if this attribute is present and the value is not blank. |
Figure 2: Global logging options for the eSTEM web service
It is beyond the scope of this user guide to explain in general how to configure the additional data source required by the web site in order to connect with your chosen database. Please contact Implied Logic Support if you need help with this.
Note: logging to database is not implemented in STEM 7.4 but is documented here as an intended future feature.