The ORRE-BRA listener now supports adding unlimited risk assessment elements. Each element must follow the same JSON structure for the listener to function properly. This guide explains how to configure a new risk assessment element to appear on ORRE-BRA tracker items.
Locate the Configuration Keys: In the orre-bra section of the Application Configuration JSON, you’ll find two main keys:
"orre-bra-tracker-name": Defines the tracker name.
"risk-assessment-elements": A list of strings representing the risk assessment elements.
Add Risk Assessment Elements: Each element listed in "risk-assessment-elements" must have a corresponding configuration object.
Example with hazard-analysis:
{
"orre-bra": {
"orre-bra-tracker-name": "ORRE-BRA",
"risk-assessment-elements": ["hazard-analysis"],
"hazard-analysis": {
// ... configurations
}
}
}
Adding Another Element (dfmea):
{
"orre-bra": {
"orre-bra-tracker-name": "ORRE-BRA",
"risk-assessment-elements": ["hazard-analysis", "dfmea"],
"hazard-analysis": {
// ... configurations
},
"dfmea": {
// ... configurations
}
}
}
Each risk assessment element has two configuration sections:
orre-bra-tracker-config: Specifies how data is displayed in the ORRE-BRA tracker.
risk-assessment-tracker-config: Specifies the data sources for the tracker.
Example Structure:
{
"hazard-analysis": {
"orre-bra-tracker-config": {
// Display configurations
},
"risk-assessment-tracker-config": {
// Data source configurations
}
}
}
The orre-bra-tracker-config section defines how the ORRE-BRA tracker handles risk data. It includes the following fields:
justification-table:
Maps fields like "harm-wiki-link-key" and "risk-index-key".
"justification-table": {
"harm-wiki-link-key": 0,
"key": 4,
"risk-index-key": 1
}residual-ri-profile-table:
Handles residual risk profile data.
"residual-ri-profile-table": { "key": 0 }residual-ri-by-category-table:
Maps residual risk data by category.
"residual-ri-by-category-table": { "key": 12 }risk-assessment-items-choice-list:
Specifies how items are selected.
"risk-assessment-items-choice-list": { "key": 2 }Full Example (hazard-analysis):
{
"orre-bra-tracker-config": {
"justification-table": {
"harm-wiki-link-key": 0,
"key": 4,
"risk-index-key": 1
},
"residual-ri-profile-table": { "key": 0 },
"residual-ri-by-category-table": { "key": 12 },
"risk-assessment-items-choice-list": { "key": 2 }
}
}
The risk-assessment-tracker-config section specifies the source fields for risk data:
Keys:
harm-choice-list-key
post-occurrence-key
post-ri-key
post-ri-wiki-key
severity-key
tracker-name
Example (hazard-analysis):
{
"risk-assessment-tracker-config": {
"harm-choice-list-key": 3,
"post-occurrence-key": 8,
"post-ri-key": 10,
"post-ri-wiki-key": 13,
"severity-key": 5,
"tracker-name": "Hazard Analysis"
}
}
To add a new element, configure both the tracker and the ORRE-BRA settings.
Define Tracker Configuration:
"dfmea": {
"orre-bra-tracker-config": {
"justification-table": {
"harm-wiki-link-key": 3,
"key": 3,
"risk-index-key": 4
},
"residual-ri-profile-table": { "key": 1 },
"residual-ri-by-category-table": { "key": 13 },
"risk-assessment-items-choice-list": { "key": 1 }
},
"risk-assessment-tracker-config": {
"harm-choice-list-key": 3,
"post-occurrence-key": 8,
"post-ri-key": 10,
"post-ri-wiki-key": 18,
"severity-key": 5,
"tracker-name": "dFMEA"
}
}Add dfmea to the List:
"risk-assessment-elements": ["hazard-analysis", "dfmea"]
Note that when you save the "risk-assessment-elements" in the application configuration, codebeamer will translate the list into the following structure:
[
{ "text:" "hazard-analysis" },
{ "text": "dfmea" }
]This is expected and new elements can be added either way.
Complete Configuration:
{
"orre-bra": {
"orre-bra-tracker-name": "ORRE-BRA",
"risk-assessment-elements": ["hazard-analysis", "dfmea"],
"hazard-analysis": {
"orre-bra-tracker-config": {
"justification-table": {
"harm-wiki-link-key": 0,
"key": 4,
"risk-index-key": 1
},
"residual-ri-profile-table": { "key": 0 },
"residual-ri-by-category-table": { "key": 12 },
"risk-assessment-items-choice-list": { "key": 2 }
},
"risk-assessment-tracker-config": {
"harm-choice-list-key": 3,
"post-occurrence-key": 8,
"post-ri-key": 10,
"post-ri-wiki-key": 13,
"severity-key": 5,
"tracker-name": "Hazard Analysis"
}
},
"dfmea": {
"orre-bra-tracker-config": {
"justification-table": {
"harm-wiki-link-key": 3,
"key": 3,
"risk-index-key": 4
},
"residual-ri-profile-table": { "key": 1 },
"residual-ri-by-category-table": { "key": 13 },
"risk-assessment-items-choice-list": { "key": 1 }
},
"risk-assessment-tracker-config": {
"harm-choice-list-key": 3,
"post-occurrence-key": 8,
"post-ri-key": 10,
"post-ri-wiki-key": 18,
"severity-key": 5,
"tracker-name": "dFMEA"
}
}
}
}
With these changes, any updates to ORRE-BRA or dFMEA items will automatically reflect in the tracker.