Skip to content

Conversation

@beckyjackson
Copy link
Collaborator

Resolves #75 and resolves #76

Message Tables

Message tables provide a standard table output for logging messages (info, warn, or error) that can be converted into formatting and notes in the spreadsheet using apply. As long as the table follows the format described below, any type of message can be applied to the sheets. One example is the errors from ROBOT template.

These tables are applied to the sheets as formats and notes. The three levels of logging will be formatted with a black border and the following backgrounds:

  • error: light red background
  • warn/warning: light yellow background
  • info: light blue background

The notes and formats will be added to any existing, but will take priority over the existing notes and formats.

These tables must have the following headers:

  • table: name of the table that the message occurs in
  • cell: A1 format of cell location

The following fields are optional:

  • level: severity of logging; error, warn, or info - if not included, this will default to "error"
  • rule ID: an IRI or CURIE to uniquely identify the message
  • rule: descriptive name of the message - this is converted to a "header" of the cell note
  • message: details about the message, e.g., instructions on how to fix a problem
  • suggestion: a suggested value to replace the existing value

The only required fields are table and cell. If no other fields are provided, the cell will be highlighted red with a note that says "ERROR". We strongly recommend using either a rule ID or rule to identify the message, and message text to provide more details.

@beckyjackson beckyjackson merged commit a3bbec0 into master Oct 7, 2020
@jamesaoverton jamesaoverton deleted the message-tables branch September 23, 2021 14:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rework columns in "problems tables" Rename "problems tables" to "messages tables"

3 participants