Logging

Log data provide information about completed processes. These data, for example, help you to analyze processes and to find possible causes for errors. In the “Logging” area you can retrieve the individual log entries, whereby you can filter them using various search criteria.

Use the search mask

Using the search mask on the left side you can you can retrieve particular log entries, whereby the retrieval of data can be filtered according to certain criteria. To retrieve log entries, proceed as follows:

  • Possibly select a log type from the “Log type” menu to filter the retrieval of log entries by a log type. You can choose between the options “Error”, “Information” and “Warning”.
  • Possibly select a code to filter the retrieval of log entries by certain operations. To do so, proceed as follows:
    1. Click on the three dots across button in the “Code” field  to call up the corresponding dialog box.
    2. Select a code by transfering it from the left column to the right column. To do so, click on the respective code. You can also select multiple codes.
    3. Click on the ACCEPT button to confirm your selection. Afterwards the dialog box closes.
  • Possibly enter an external ID in the “External ID” field  to filter the retrieval of log entries by an external ID.
  • Possibly enter a product number in the field “Product number” to filter the retrieval of log entries by a product number.
  • Possibly select a date from which on you want to retrieve log entries:
    1. Click on the Calendar button in the “Created from” field to show the datepicker menu.
    2. Click on the desired date. Then the datepicker menu closes.
  • Possibly select a date until which on you want to retrieve log entries:
    1. Click on the Calendar button in the “Created to” field to show the datepicker menu.
    2. Click on the desired date. Then the datepicker menu closes.
  • If you like to show all the log data that is retrieved according to the search parameters even if their number exceeds the specified limit*, select the option YES from the “Display all data” menu .
  • To carry out the search, click on the SEARCH button .
    Once the search was executed, all the log entries which were captured by the search will be listed in the table on the right side.
  • To cancel reset the search, click on the RESET button .
Note
All the search parameters are optional. Hence, you can leave the input fields empty.
INFO
Using the property logentries.cap.server you can specify the maximum number of log entries to be loaded. By default, the property is set to “1000”.

“Logging” table

This table shows the log entries which were captured by the search.

INFO
Using the column header tools you can filter table entries or adjust their sequence. In order to filter table entries you can also use the free-text search.

Use the action menu

Via the action menu in the footer you can apply different actions on the listed log entries. To do so, proceed as follows:

  • To call up the action menu, click on the "Action menu" icon (Aktionsmenü) in the footer.
  • To invert the selection of ticked table cells, click on the "Invert selection" option of the action menu.
  • To export selected log entries as a .xlsx or .csv file, use the "Export" action. Further information you can find here.
  • To copy selected log entries to the clipboard, use one of the "Clipboard" actions. Further information you can find here.
INFO
You can place frequently used actions on the Favorites button. Then you can call them up without having to go via the action menu. To do so, drag the respective actions over the Favorites button and drop them there. Afterwards you can access these actions via the drop-down menu of the Favorites button.

 

Use cases

Retrieve log data for a product

Using an example, this section explains how to retrieve log data for a product where the log data is limited to warnings from a particular time period.

  1. From the “Log type” menu , select the option “Warning” .
  2. Enter the product number of the product in the “Product number” field.
  3. Select the date from which on you want to retrieve log entries:
    1. Click on the Calendar button in the “Created from” field to show the datepicker menu.
    2. Click on the appropriate date. The datepicker menu closes and the selected date is shown in the “Created from” field.
  4. Select the date until which on you want to retrieve log entries:
    1. Click on the Calendar button in the “Created to” field to show the datepicker menu.
    2. Click on the appropriate date. The datepicker menu closes and the selected date is shown in the “Created to” field.
  5. Click on the SEARCH button to execute the search.
    Once the search was executed, all the log entries which were captured by the search will be listed in the table on the right side.

FAQ

Why might not all log entries be loaded, even though they match the search parameters?

The property logentries.cap.server allows you to specify the maximum number of log entries to be loaded. By default, this property is set to 1000. To load all log entries matched by the search parameters, even if their number exceeds the default limit, select “Yes” from the “Display large data” menu.