The Hazard Analysis and Risk Assessment (HARA) solution supports users with hazard identification and safety goal creation using the Coverage Matrix and Safety Analysis views. This article describes how to configure the views.


Prerequisites

  • The SWExtension.HazardIdentification extension file is located in the swExplorer client installation
  • The SWExtension.HazardIdentification extension is activated in Configure the explorer
  • Assignment of the SW Architect role in the database


Note: With the release of R32, there are now two separate configurations whereas in earlier versions there was only one (Hazard Analysis).


The configuration is done in the Configure the explorer dialog, accessible from the File tab. The extension views to be configured are Coverage Matrix and Safety Analysis



Coverage Matrix

Abstract Data Pattern


Example Configuration

<CoverageMatrixConfigs>
<!--Hazards veiw: a view to elicit and overview hazards -->
<CoverageMatrixConfig id="11">
<MainItem itemType="CNDE"/>
<ViewSettings>
<Caption>Hazards</Caption>
<RibbonGroup>HARA</RibbonGroup>
<Description>A view to elicit and overview hazards</Description>
<Image typeImage="206"/>
</ViewSettings>
<Parameters>
<Parameter caption="HARA Analysis Area" name="p" hintContextPath="I2AHA" >
<Values>
<ForEachPathReference path="I2AHA">
<AddValue/>
</ForEachPathReference>
</Values>
</Parameter>
</Parameters>
<MappingItem itemType="TSHA">
<UIName>Hazard</UIName>
<PartFromMainToMapping partType="DEHA" />
<Attributes>ABAN</Attributes>
<DefaultMappingName>#{Column} of #{Row}</DefaultMappingName>
</MappingItem>
<NotApplicableItem itemType ="26NH">
<UIName>N/A</UIName>
<PartFromMainToMapping partType="I2NHZDS"/>
<Attributes>ABAN</Attributes>
<DefaultMappingName>#{Column} of #{Row}</DefaultMappingName>
</NotApplicableItem>
<ColumnItems>
<UIName>Guideword</UIName>
<PathFromMain>$p/I2GWCT/I2GL</PathFromMain>
<PartFromMappings>
<PartFromMapping partType="I2GW" defItemType="26GW" />
</PartFromMappings >
</ColumnItems>
<RowItems>
<UIName>Item detail</UIName>
<PathFromMain>/DEIT/I2SID union /DEIT/I2IRQ</PathFromMain>
<PartFromMappings>
<PartFromMapping partType ="I2HO" defItemType="2SE90" />
<PartFromMapping partType="I2HARQ" defItemType="CONTRACT" />
<PartFromMapping partType="I2HO" defItemType="2SE91" />
</PartFromMappings>
</RowItems>
</CoverageMatrixConfig>
<!--Hazardous events veiw: a view to elicit and overview hazardous events-->

<CoverageMatrixConfig id="22">
<MainItem itemType="CNDE"/>
<ViewSettings>
<Caption>Hazardous events</Caption>
<RibbonGroup>HARA</RibbonGroup>
<Description>A view to elicit and overview hazardous events</Description>
<Image typeImage="204"/>
</ViewSettings>
<Parameters>
<Parameter caption="HARA Analysis Area" name="p" hintContextPath="I2AHA" >
<Values>
<ForEachPathReference path="I2AHA">
<AddValue/>
</ForEachPathReference>
</Values>
</Parameter>
</Parameters>
<MappingItem itemType="TSHE">
<UIName>Hazardous event</UIName>
<PartFromMainToMapping partType="DEHE" />
<Attributes>HEID;2BSE;SEVARG;2BEC;EXPARG;2BCY;CONARG;26AR</Attributes>
<DefaultMappingName>#{Column} of #{Row}</DefaultMappingName>
</MappingItem>
<NotApplicableItem itemType ="NHZEV">
<UIName>N/A</UIName>
<PartFromMainToMapping partType="NNHZEV"/>
<Attributes>HEID;2BSE;SEVARG;2BEC;EXPARG;2BCY;CONARG;26AR</Attributes>
<DefaultMappingName>#{Column} of #{Row}</DefaultMappingName>
</NotApplicableItem>
<ColumnItems>
<UIName>Situation</UIName>
<PathFromMain>$p/I2STCN/I2CMPSIT</PathFromMain>
<PartFromMappings>
<PartFromMapping partType ="HEH" defItemType="TSHA" />
<PartFromMapping partType="I2CMPST" defItemType="I2COMSIT" />
<PartFromMapping partType="I2GH" defItemType="26GH" />
<PartFromMapping partType="TRASIT" defItemType="I2LA" />
</PartFromMappings >
</ColumnItems>
<RowItems>
<UIName>Hazard</UIName>
<PathFromMain>/DEHA</PathFromMain>
<PartFromMappings>
<PartFromMapping partType ="HEH" defItemType="TSHA" />
<PartFromMapping partType="I2CMPST" defItemType="I2COMSIT" />
<PartFromMapping partType="I2GH" defItemType="26GH" />
<PartFromMapping partType="TRASIT" defItemType="I2LA" />
</PartFromMappings>
</RowItems>
</CoverageMatrixConfig>
</CoverageMatrixConfigs>

Explanation of the Configuration Elements

The <CoverageMatrixConfigs> and <CoverageMatrixConfig id=""> elements build the structure of the configuration and the individual configurations. The id attribute in <CoverageMatrixConfig> identifies the specific configuration, and should be a unique string value when multiple configurations exist in CoverageMatrixConfigs.


<MainItemType itemType="">  identifies the item type for which the configuration is valid. The itemType attribute is the SID of the main item type.


<ViewSettings> includes options that control the appearance in the UI:

  • The <Caption> text is the name of the configured view displayed in the View drop-down menu and as a label for a ribbon button.
  • The <RibbonGroup> text specifies the optional ribbon group where the button will be available.
  • The <Description> text specifies a hint that will be presented in the ribbon, if the <RibbonGroup> is specified.
  • The optional <Image> defines the icon to be used for the button. (See available icons.)


The optional <Parameters> offers parameterization, allowing the user to select which item to include in the view. The value of the parameters can be used further down in <PathFromMain> for both <CoulmnItems> and <RowItems>.


The <MappingItem itemType=""> defines the mapping item properties, which are SID, UIName, PartFromMainToMapping item, attributes, and default name. The attribute itemType is the SID of the mapping item type.

  • <UIName> specifies the user interface label for the mapping item.
  • <PartFromMainToMapping partType=""/> specifies the part type from the main item type to mapping item type. The attribute partType is the part SID from the main item type to mapping item type.
  • <Attributes> is for the attribute SIDs for the mapping item type, which will result in including them in both the view and Create New window. The following Attribute types and occurrences are supported: 
    • Boolean: Single
    • Date: Single
    • Enumeration: Single
    • Float: Single
    • Integer: Single
    • String: Single
    • Text: Single
  • <DefaultMappingName> defines the default name for the mapping item, which can be a combination between ColumnValue, StringValue, and RowValue (in any order).


The <NotApplicableItem itemType="">, similar to the <MappingItem itemType="">, defines the not-applicable Item properties, which are UIName, SID, PartFromMainToMapping item, attributes, and default name. The attribute itemType is the SID of the not-applicable mapping item type.


The <ColumnItems> includes options that control the appearance in the UI, collecting column items and defining part(s) from mapping to column item.  

  • <UIName> specifies the user interface label for the column item type.
  • <PathFromMain> is a path expression (see SystemWeaver Path Query Language) to find all column items. This path can include parameter(s), allowing users to select which item to include in a column list.
  • <PartFromMappings> is a grouping for PartFromMapping to ColumnItems. This tag can include one or more <PartFromMapping partType="" defItemType=""/>.
  • <PartFromMapping partType="" defItemType=""/> specifies the part type from the mapping item to the column item. The partType attribute is the SID of the PartFromMapping item to column item and the defItem attribute is the SID of the defobj item (column item).

 

The <RowItems>, similar to<ColumnItems>, includes options that control the appearance in the UI, collecting row items and defining part(s) from mapping to row item.  

  • <UIName> specifies the user interface label for the row item type.
  • <PathFromMain> is a path expression (see SystemWeaver Path Query Language) to find all row items. This path can include parameter(s), allowing users to select which item to include in a row list.
  • <PartFromMappings> is a grouping for PartFromMapping to RowItems. This tag can include one or more <PartFromMapping partType="" defItemType=""/>.
  • <PartFromMapping partType="" defItemType=""/> specifies the part type from the mapping item to the row item. The partType attribute is the SID of the part from mapping item to row item and the defItem attribute is the SID of the defobj item (row item).


Example Result

Hazards

Hazardous Events


Safety Analysis


Abstract Data Pattern


Example Configuration

<SafetyAnalysisConfigs>        
<SafetyAnalysisConfig id="33">
<MainItem itemType="CNDE"/>
<ViewSettings>
<Caption>Safety goals</Caption>
<RibbonGroup>HARA</RibbonGroup>
<Description>A view to elicit and overview safety goal</Description>
<Image typeImage="125"/>
</ViewSettings>

<MappingItem itemType="EASG">
<UIName>Safety goal</UIName>
<PartFromMainToMappingItem partType="DESG"/>
<Attributes>REID;EAA1</Attributes>
<DefaultMappingName> XYZ of #{Row}</DefaultMappingName>
</MappingItem>

<RowItems>
<UIName>Hazardous event</UIName>
<PathFromMain>/DEHE[@26CAS != 'QM']</PathFromMain>
<PartFromMappingItem partType="SGDF"/>
<Attributes>26SG;26AS</Attributes>
</RowItems>
</SafetyAnalysisConfig>
</SafetyAnalysisConfigs>

Explanation of the Configuration Elements

The <SafetyAnalysisConfigs> and <SafetyAnalysisConfig id=""> elements build the structure of the configuration and the individual configurations. The id attribute in <SafetyAnalysisConfig > identifies the specific configuration, and should be a unique string value when multiple configurations exist in SafetyAnalysisConfigs.


 <MainItem itemType=""/>  identifies the item type for which the configuration is valid. The itemType attribute is the SID of the main item type.
<ViewSettings> see the view setting description for the CoverageMatrixConfigs above.

The <MappingItem itemType=""> defines the mapping item properties, which are SID, UIName, PartFromMainToMappingItem , attributes, and default name. The attribute itemType is the SID of the mapping item type.

  • <UIName> specifies the user interface label for the mapping item.
  • <PartFromMainToMappingItem partType=""/> specifies the part type from the main item type to mapping item type. The attribute partType is the part SID from the main item type to mapping item type.
  • <Attributes> is for the attribute SIDs for the mapping item type, which will result in including them in both the view and Create New window. The following Attribute types and occurrences are supported: 
    • Boolean: Single
    • Date: Single
    • Enumeration: Single
    • Float: Single
    • Integer: Single
    • String: Single
    • Text: Single
  • <DefaultMappingName> defines the default name for the mapping item, which can be a combination between  StringValue and RowValue (in any order).

The <RowItems> includes options that control the appearance in the UI, collecting row items and defining part from mapping to row item.  

  • <UIName> specifies the user interface label for the row item type.
  • <PathFromMain> is a path expression (see SystemWeaver Path Query Language) to find all row items. 
  • <PartFromMappingItem partType=""/> specifies the part type from the mapping item to the row item. The partType attribute is the SID of the part from mapping item to row item.
  • <Attributes> is for the attribute SIDs for the mapping item type, which will result in including them in the view. The following Attribute types and occurrences are supported: 
    • Boolean: Single
    • Date: Single
    • Enumeration: Single
    • Float: Single
    • Integer: Single
    • String: Single
    • Text: Single



Example Result


What's Next?

Check out examples of configured safety grids, graphs and charts