Rules Documentation

{% for rule_id, rule in rules.items() %} {% if not rule.depends_on %}

{% for dependency in rule.dependencies recursive %} {%- set dependent_rule_name -%} {% if dependency.run_if == True %} {{ rules[dependency.id].name + " (run if pass)"}} {% elif dependency.run_if_not == True %} {{ rules[dependency.id].name + " (run if fails)" }} {% else %} {{ rules[dependency.id].name }} {% endif %} {%- endset -%} {% if not rules[dependency.id].dependencies %}

{%- if rules[dependency.id].name != dependency.id -%} {{dependency.id}}:

{% else %} {{dependent_rule_name}} {% endif %}

{% else %}

{%- if dependent_rule_name != dependency.id -%} {{dependency.id}}:

{% else %} {{dependency.id}} {% endif %}

{% if rules[dependency.id].dependencies %} {{ loop(rules[dependency.id].dependencies) }} {% endif %}

{% endif %} {% endfor %}

{% for rule_id, rule in rules.items() %}

{% if rule.depends_on %}

{% endif %} {% if rule.depends_on and rule.name != rule_id %}

{{rule_id}}: {{rule.name}}

{% else %}

{% endif %}

{{rule.description}}

{% if rule.override_level == 1 %} {% else %} {% endif %} {% for dependency in rule.dependencies %} {% if dependency["run_if"] == True %} {% endif %} {% if dependency["run_if_not"] == True %} {% endif %} {% endfor %} {% for param in rule.parameters %} {% if rule.override_level == 2 and param.name == 'Override Guidance' %} {% endif %} {% endfor %}

ID	{{rule.id}}
Overrides	Disabled	Enabled
Conditional Execution	Evaluate only if rule {{rules[dependency["id"]].id}}: {{rules[dependency.id].name}} passes
Conditional Execution	Evaluate only if rule {{rules[dependency["id"]].id}}: {{rules[dependency.id].name}} fails
{{ param.name }}	{{ param.value }}

{% if rule.doctests %}

Rule Tests

{% for test_result in rule.doctest_stats %} {% if test_result.total != "None" %}

{% for doctest in rule.doctests %} {% if doctest.result == test_result.doctest_result %} {% endif %} {% endfor %}

Test No. Payload Context

Test No.	Payload	Context
{{doctest.doctest_no}}	`{{ doctest.payload \| json_print }}`	{% if doctest.context %} `{{ doctest.context \| json_print }}` {% else %} `N/A` {% endif %}

                                      
                                        {{ doctest.payload | json_print }}

{% if doctest.context %}

                                      
                                        {{ doctest.context | json_print }}

{% else %}

N/A

{% endif %}

{% endif %} {% endfor %}

{% else %} {% endif %}

{% if rule.rule_type == "Rule" %} Logic (click to show code)

{{rule.comments}}

{{rule.source}}

{% else %}

Logic

{% if rule.rule_type == "All" %} {% elif rule.rule_type == "Any" %} {% endif %} {% for dependency in rule.dependencies %} {% endfor %}

`# Pass if all dependent results pass (see list below), Fail if any result Fails`			`# Pass if at least one of the dependant results pass (see list below). Fail if none result in a Pass`
Dependent Rule ID	Rule	Description
{{rules[dependency.id].id}}	{{rules[dependency.id].name}}	{{rules[dependency.id].description}}

{% endif %}

{% endfor %}