Keep business rules and raise findings

Write down what the system is meant to do, add evidence, mark a rule as checked and raise a finding when it breaks.

In short

Rules is the fourth part of Analytics › Reports. A rule says what the system is meant to do, where it belongs and the evidence that it holds. A finding raised against a rule shows in the Code quality report. Your rules are yours alone.

Before you start

• Who: anyone signed in with Analytics on. Nobody else sees your rules.
• Plan: Analytics is part of every plan, Free included.
• First: nothing.

Add a rule

1. Open Analytics › "Reports" and choose "Rules".
2. Press "New rule".
3. Write "What the rule says" and its "Source": the module, service or script it belongs to. Turn on "Comes from documentation" only when it does; a rule inferred from code is the weaker claim.
4. Under "Evidence", press "Add evidence", choose its kind - Code, Documentation, Test or Runtime - and write where it is.
5. Press "Save".

Check a rule and raise a finding

1. Click a rule in the list. It opens beside the list.
2. To record that you checked it today, turn on "Mark as checked today" and press "Save", or choose "Mark as checked today" in the row's menu.
3. Under "Findings raised against it", write "What went wrong", choose a "Severity" - Warning, High or Critical - and press "Raise a finding".
4. Click a finding's title to open it on its own page.

Good to know

• "Last checked" moves only when you mark a rule as checked. An edit on its own never does.
• "Search rules" and "Based on" (Documentation or Inferred from code) narrow the list.
• "Open findings" counts what is failing against a rule. Code quality names the rules that open findings say are broken.

If something goes wrong

• "Say what the rule is." / "Say where the rule belongs.": both are needed before "Save".
• "No rule matches": clear the search and "Based on".

Related

• /help/analytics/report-catalog
• /help/analytics/running-a-report