Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

In this article we will show you how you can search through the logs that have been generated by a workflowblock, to find information on what was transferred, and when it happened.

Info

Canvas logs block output responses and stores the data for 30 days.

The three search types

Canvas provides different ways of searching through the logged data. The following screenshots will illustrate the differences between the three search types:

1) Search option “All data”:

“All data” simply returns all data output from a block in a given time range:

...

2) Search option “By response”:

“By response” is only available if you have defined a search model for a block, which lets you search for specific values in specific fields (for example search for specific employee numbers, order numbers, etc.)

...

3) Search option “By user log”:

“By user log” lets you type in a text string to search through all messages generated using logger.log() in the block code. (Note that search string should not be placed within quotation marks, i.e. just Test, not “Test”).

...

Creating a search

To search through logged items for a given workflow, go to the workflow editor and click the search icon🔍:

...

  • Under Block select which block you want to search the logs for

  • Under Search option select gives you the type option of data to search for

  • “All data” lets you search through all data returned by the block as output (as defined in the search model)

  • “By user log” lets you search for all messages generated in the block code, using the logger.log() function

    three search types described above (“All data”, “By response”, and “By user log”)

  • Search From and Search To specify the search range

  • Hide in result lets you choose results to filter out, for example if the block ran but did not provide a response

  • A text search field will be shown if you are using the search option “By user log”. This lets you to search for all logged messages containing a certain string.
    Note: The string should not be placed within quotation marks (i.e. not “Test”, just Test).

...

Click the Find button to start execute the search.

Viewing the search results

When the search has finished it will show status Completed, and it will show how many matches was found:

...