The Use Log
The following is specific to our WorkZone Service OData provider.
The OData provider used for WorkZone OData is built on top of the standard WorkZone installation. Logging to the use log is handled by WorkZone with the following parameters specific to the OData service:
| Field | Format | Description |
|---|---|---|
| ApplicationName | OData.svc – [{Header:UseLog-Application}] |
Identifies the application that issued the request. The OData server always writes ‘OData.svc – ‘ in the first part. Clients should always send the UseLog-Application HTTP header on all requests with a string that identifies their application. |
| WindowName | {Feed}[/{NavigationProperty}] – [{Header:UseLog-Window}][ – {Driver}] |
Identifies where in the system the request originated from/is destined to. The OData server always writes the feed name and possibly a navigation property name in the first part. Clients should always add the UseLog-Window HTTP header to identify where in the client the request is originating from/destined to. If the log entry is due to an action performed by the sub system, the name of the sub system is appended at the very end. |
| Identification | {ClientIP} – [{Header:UseLog-Identity}] |
Identifies the client that made the request by including the IP of the client. Client applications can add to this by specifying the UseLog-Identity HTTP header on requests. |
| Query | {PathAndQuery.SubString} |
Contains part of the Url associated with the OData request. To reduce logging space, it is not repeated on all log entries of type ‘S’. For GET operations, it will be filled on the log entry representing the search (type ‘V’). |
| BatchId | Guid | Contains a GUID that binds a number of log entries together with the request the entries belong to. |