-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathRCT_project_output_test_report.schema.yaml
159 lines (150 loc) · 6.1 KB
/
RCT_project_output_test_report.schema.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
---
# RCT_project_output_test_report.schema.yaml
# The purpose file is to provide a separated source from the main schema file to describe the
# output reports from the Ruleset Checking Tool
# Based on
# https://github.com/pnnl/ruleset-checking-tool/blob/RR/WX/validate_output_report/docs/_output_project_test_report_template.md
Schema:
Object Type: "Meta"
References:
- "ASHRAE229"
Title: "Project Output Test Report from Ruleset Checking Tool"
Description: "Schema addition for ASHRAE 229 related to output from the Ruleset Checking Tool for Software Testing"
RulesetCheckingToolProjectOutputReport:
Object Type: "Data Group"
Data Elements:
title:
Description: "Title of project output report from Ruleset Checking Tool"
Data Type: "String"
Notes: "Existing template value shows- ASHRAE STD 229P RULESET CHECKING TOOL"
purpose:
Description: "Reason for the report"
Data Type: "String"
Notes: "Existing template value shows- Project Testing Report"
tool_name:
Description: "Name of the ruleset checking tool that produced the data file"
Data Type: "String"
tool_version:
Description: "Versions number of the ruleset checking tool that produced the data file"
Data Type: "String"
Notes: "Generally a version number for the software such as 1.0.2"
ruleset:
Description: "Names the ruleset including appropriate year, organization, and section."
Data Type: "String"
Required: True
Notes: "Existing template value shows- ASHRAE 90.1-2019 Performance Rating Method (Appendix G)"
date_run:
Description: "Time stamp for the output report"
Data Type: "Timestamp"
Required: True
Notes: "Existing template value shows- 2022-02-01T18:25:43-05:00"
schema_version:
Description: "Version of the Standard 229 Rule Evaluation Schema corresponding to the tests."
Required: True
Data Type: "String"
rpd_files:
Description: "A list of names of RPD files"
Data Type: "[{FileDescription}]"
Notes: "Existing template value shows- user_rmr.json, baseline_rmr.json, proposed_rmr.json"
Required: True
rules:
Description: "List of rule that is being evaluated"
Data Type: "[{Rule}]"
Required: True
Rule:
Object Type: "Data Group"
Data Elements:
rule_id:
Description: "The identification of the specific rule"
Data Type: "String"
Required: True
Notes: "Existing template value shows- 1-1"
description:
Description: "Textual description of the rule"
Data Type: "String"
Notes: "Existing template value shows- Description of rule 1-1."
evaluation_type:
Description: "Indicator if full evaluated rule"
Data Type: "<EvaluationTypeOptions>"
standard_section:
Description: "Section number for rule"
Data Type: "String"
Notes: "Existing template value shows- G3.1.2.2"
data_group_names:
Description: "A list of names of the data groups being evaluated"
Data Type: "[String]"
Notes: "The would include the names of the Standard 229 Rule Evaluation Schema data groups as strings such as Space or FluidLoop. For more complex rules it may not be practical to list all the data groups and this could be then left empty."
evaluations:
Description: "List of evalations perfomed"
Data Type: "[{Evaluation}]"
Required: True
Notes: "Existing template value shows- "
Evaluation:
Object Type: "Data Group"
Data Elements:
data_group_id:
Description: "The ID of the data group being evaluated"
Data Type: "String"
Required: True
Notes: "The ID of any type of data group. This is a string and not a reference data type since the RPD file would be separate. Existing template value shows- 1"
outcome:
Description: "Outcome"
Data Type: "<OutcomeOptions>"
Notes: "Existing template value shows- PASS"
messages:
Description: "List of messages from evaluation"
Data Type: "[String]"
calculated_values:
Description: ""
Data Type: "[{CalculatedValue}]"
Notes: "Not same as template since template shows key-value pairs"
OutcomeOptions:
Object Type: "Enumeration"
Enumerators:
PASS:
Description: "Pass"
FAIL:
Description: "Fail"
NOT_APPLICABLE:
Description: "Not applicable"
UNDETERMINED:
Description: "Undetermined"
EvaluationTypeOptions:
Object Type: "Enumeration"
Enumerators:
FULL:
Description: "Full Evaluation"
APPLICABILITY:
Description: "Applicability Evaluation"
CalculatedValue:
Object Type: "Data Group"
Data Elements:
variable:
Description: "Variable"
Data Type: "String"
Notes: "Existing template value shows- calculated_value1"
value:
Description: "Value"
Data Type: "(Numeric, Boolean, String)"
Notes: "Existing template value shows- 1.0"
unit:
Description: "Units"
Data Type: "String"
Notes: "For example- Btu/(hr*ft2*R)"
source:
Description: "The source of the value"
Data Type: "String"
Notes: "The source of the value which may be that is a from one or more models, from the ruleset, or an expected value. If from a model the strings should represent the enumeration values for RulesetModelDescription.type in the 229 Ruleset Evaluation Schema. For 90.1 Appendix G would be USER, PROPOSED, BASELINE_0, BASELINE_90, BASELINE_180, BASELINE_270."
FileDescription:
Object Type: "Data Group"
Data Elements:
ruleset_model_type:
Description: "Describes the type of model associated with the file."
Data Type: "String"
Required: True
Notes: "A string representation of the enumeration value for RulesetModelDescription.type in the 229 Ruleset Evaluation Schema. For 90.1 Appendix G would be USER, PROPOSED, BASELINE_0, BASELINE_90, BASELINE_180, BASELINE_270"
file_name:
Description: "Value"
Data Type: "String"
Required: True
Notes: "The name of the json file with file extension and may include the file path. Existing template value shows- user_rmr.json, baseline_rmr.json, proposed_rmr.json"