Exporting the contents of the component log
The export contains information on the Check-In/Check-Out of the components that are displayed in the Component log dialog in the UserClient.
The entries of the Component log can be filtered by the following criteria before the export:
- The start and the end time
- A period of days
- The component ID
Settings for the ExportModule
In addition to the keys described in the Parameter file section, the parameter file can also contain the following keys specifically for this export.
Section Filter
In the [Filter] section, the following keys can be configurated:
| Key | Values |
|---|---|
| FilterFrom | Start of the time period according to which entries are to be filtered (as a timestamp in UTC format). The date is included in the filter. To output only the differences to the last export, you can enter the value LastExecution here. The timestamp of the last executed export is entered under this key in the [Result] section. |
| FilterTo | End of the time period according to which entries are to be filtered (as a timestamp in UTC format). The date is not included in the filter. |
| LastXDays | Period in days for which entries are to be exported. |
| ComponentId | Component ID by which the entries are to be filtered. |
Example call
Parameter file Componentlog.ini
[Common]
ReportType=Componentlog
ExportFile=D:\Test\Componentlog.csv
[Filter]
FilterFrom=`<2021-4-17T08:12Z>`
FilterTo=<2021-4-21T18:00Z
[User]
Account={User}
Password={Password}
Output file
The export can be generated in either CSV or JSON format, depending on your selected output option.
The CSV output file contains the following columns.
| Column | Description |
|---|---|
| Component id | Component ID |
| Component type | Component type |
| Session id | Session ID |
| Timestamp (local) | Timestamp (local time) |
| Timestamp (UTC) | Time stamp (UTC) |
| Directory | Component directory |
| Name | Component name |
| Command | Action, that was executed on the specified version |
| User name | User name |
| User id | User ID |
| Computer name | Computer name |
| Version | Version, in which the action (Check-Out or change of lock status) was executed by the user |
| Version timestamp (local) | Version timestamp (local time) |
| Version timestamp (UTC) | Version timestamp (UTC) |
| Message | Text of the message that was issued by the server for the action |
| Comment | Comment that was specified when the respective action was executed (e.g. when changing the lock status) |
| Server name | Server name |
Related topics