ORRE-BRA Tracker: Adding Risk Assessment Elements

ORRE-BRA Tracker: Adding Risk Assessment Elements

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.


Configuring Risk Assessment Elements

  1. 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.

  2. 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
        }
      }
    }
    

Configuration Structure

Each risk assessment element has two configuration sections:

  1. orre-bra-tracker-config: Specifies how data is displayed in the ORRE-BRA tracker.

  2. 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
    }
  }
}

ORRE-BRA Tracker Configuration

The orre-bra-tracker-config section defines how the ORRE-BRA tracker handles risk data. It includes the following fields:

  1. 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
    }
  2. residual-ri-profile-table:

    • Handles residual risk profile data.

    "residual-ri-profile-table": { "key": 0 }

  3. residual-ri-by-category-table:

    • Maps residual risk data by category.

    "residual-ri-by-category-table": { "key": 12 }

  4. 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 }
  }
}


Risk Assessment Tracker Configuration

The risk-assessment-tracker-config section specifies the source fields for risk data:

  1. Keys:

    • harm-choice-list-key


    • post-occurrence-key


    • post-ri-key


    • post-ri-wiki-key


    • severity-key


    • tracker-name

  2. 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"
      }
    }
    

Adding a New Element (dfmea)

To add a new element, configure both the tracker and the ORRE-BRA settings.

  1. 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"
      }
    }
  2. 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.

Final Example

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.



    • Related Articles

    • ORRE - BRA Risk Analysis

      In this use case, the goal is to automate the addition of MAX RI values from Accepted Hazard Analysis in the system to the ORRE-BRA for Streamlined ORRE-BRA Risk Analysis. A table will be created for a risk matrix and consolidate selected existing ...
    • Exporting fields with hide if logic

      Exporting Fields with “Hide If” Logic A set of macros has been added to mergeFields.v m to allow for conditionally exporting those fields in templates. For each of the following tracker names, there's a table that represents: What field will be ...
    • Environment Promotion Best Practices

      Overview Utilizing a staging environment with development, test, stage (optional), and production servers is a standard practice in software development that ensures code quality, stability, and reliability before it reaches the end-users. The same ...
    • Updating DTM Export

      Basics The DTM (and all) excel exports are written in a markdown language called Java Excel Template Translator (JETT). Fundamentals The most fundamental keys to understanding and the most important takeaway from the DTM export file are that: The ...
    • DTM (Digital Trace Matrix) Export

      DTM (Digital Trace Matrix) Export DTM stands for Digital Trace Matrix. The DTM Excel template has been created to export the DTM report based on the model and the already-defined reference structure. The configuration diagram associated with the DTM ...