Show TOC

App Extensibility: Retrieve Safety InformationLocate this document in the navigation structure

Use

You can extend Retrieve Safety Information according to your business needs for different aspects. For this purpose, the following extensibility options are available:

  • Add new or remove existing fields in the app

  • Add new or remove existing tabs

  • Add new functionality on the basic information tab

  • Add new or remove existing sections on all tabs of the app

  • Extend the location details dialog

  • Introduce new location details dialog

Add New Fields or Remove Existing Fields in the App

To add customer fields to the app master list UI, the following extensibility entities are available on the different software layers. You have to extend each of these entities according to your specific business needs:

UI

Back End/ABAP

View

Extension Point

Design Time: Gateway Entity

Design Time: Extension Include (in DDIC Structure)

Runtime: Superclass/ Method to Be Redefined

S2.view.xml

extItemS2

ChemicalAtLocation

EHHSSS_GW_SAFINF_CHM_LOC_INCL

Superclass: CL_BADI_SAFINF_DPC_EXAMPLE

Method: IF_EHHSS_BADI_SAFETY_INFO_DPC~FILL_CHM_AT_LOC_EXT

Superclass: CL_BADI_SAFINF_MPC_EXAMPLE

Method: IF_EHHSS_BADI_SAFETY_INFO_MPC~ENHANCE_GW_SERVICE_ENTITY_MPC

Superclass: CL_EHHSS_SAFETY_INFO_DPC_EXT

Method: CHEMICALATLOCATI_GET_ENTITYSET

Note

You can redefine this method using the extensibility BAdIs described below.

Add New Tabs or Remove Existing Tabs

To add custom tabs to the app details area, the following extensibility entities are available on the different software layers. You have to extend each of these entities according to your specific business needs:

UI

Back End/ABAP

View

Extension Point

Design Time: Gateway Entity

Design Time: Extension Include (in DDIC Structure)

Runtime: Superclass/ Method to Be Redefined

S3.view.xml

extChangeTabsS3

ChemicalAtLocation

Hazard

Class Control

EHHSSS_GW_SAFINF_CHM_LOC_INCL

EHHSSS_GW_SAFINF_HAZ_CLASS_INC

EHHSSS_GW_SAFINF_CONTROL_INCL

Superclass: CL_EHHSS_SAFETY_INFO_DPC_EXT

Method: CHEMICALATLOCATI_GET_ENTITYSET

Method: HAZARDCLASSES_GET_ENTITYSET

Method: CONTROLS_GET_ENTITYSET

Note

You must redefine the OData service EHHSS_SAFETY_INFO_SRV as well.

Add New Functionality on the Basic Information Tab

To add customer sections to the app UI or add new views with more detailed information on the existing tabs (for example, to enhance the personal protective equipment section), the following extensibility entities are available on the different software layers. You have to extend each of these entities according to your specific business needs:

UI

Back End/ABAP

View

Extension Point

Design Time: Gateway Entity

Design Time: Extension Include (in DDIC Structure)

Runtime: Superclass/ Method to Be Redefined

BasicInfoTab.fragment.xml

extPPES3

Control

EHHSSS_GW_SAFINF_CONTROL_INCL

Superclass: CL_EHHSS_SAFETY_INFO_DPC_EXT

Method: CONTROLS_GET_ENTITYSET

Note

You must redefine the OData serviceEHHSS_SAFETY_INFO_SRV as well.

Add New or Remove Existing Sections on All Tabs of the App

To add customer fields, sections, or custom information on each tab details view, the following extensibility entities are available on the different software layers. You have to extend each of these entities according to your specific business needs:

UI

Back End/ABAP

View

Extension Point

Design Time: Gateway Entity

Design Time: Extension Include (in DDIC Structure)

Runtime: Superclass/ Method to Be Redefined

BasicInfoTab.fragment.xml

extAddSectionsBasicInfoTabS3

ChemicalAtLocation

HazardClass

Control

EHHSSS_GW_SAFINF_CHM_LOC_INCL

EHHSSS_GW_SAFINF_HAZ_CLASS_INC

EHHSSS_GW_SAFINF_CONTROL_INCL

Superclass: CL_EHHSS_SAFETY_INFO_DPC_EXT

Method: Define your own method

Note

You must redefine the OData service EHHSS_SAFETY_INFO_SRV as well.

FirstAidTab.fragment.xml

extAddSectionsFirstAidTabS3

ChemicalAtLocatiom

Person

EHHSSS_GW_SAFINF_CHM_LOC_INCL

EHFNDS_GW_PERS_INCL

FireFightTab.fragment.xml

extAddSectionsFireFightTabS3

ChemicalAtLocation

EHHSSS_GW_SAFINF_CHM_LOC_INCL

SpillsTab.fragment.xml

extAddSectionsSpillsTabS3

ChemicalAtLocation

EHHSSS_GW_SAFINF_CHM_LOC_INCL

AttachmentsTab.fragment.xml

extAddSectionsAttachmentsTabS3

Attachment

EHFNDS_GW_ATT_INCL

Extend the Location Details Dialog

To add customer fields to the existing location details dialog, the following extensibility entities are available on the different software layers. You have to extend each of these entities according to your specific business needs:

UI

Back End/ABAP

View

Extension Point

Design Time: Gateway Entity

Design Time: Extension Include (in DDIC Structure)

Runtime: Superclass/ Method to Be Redefined

LocationDialog.view.xml

extLocationDialogInsertDetails

Location

EHFNDS_GW_LOC_INCL

Superclass: CL_EHHSS_SAFETY_INFO_DPC_EXT

Method: LOCATIONS_GET_ENTITY

Note

You must redefine the OData service EHHSS_SAFETY_INFO_SRV as well.

Introduce New Location Details Dialog

To change the location details dialog completely by adding a new dialog to the app, the following extensibility entities are available on the different software layers. You have to extend each of these entities according to your specific business needs:

UI

Back End/ABAP

View

Extension Point

Design Time: Gateway Entity

Design Time: Extension Include (in DDIC Structure)

Runtime: Superclass/ Method to Be Redefined

LocationDialog.view.xml

extLocationDialogChange

Location

EHFNDS_GW_LOC_INCL

Superclass: CL_EHHSS_SAFETY_INFO_DPC_EXT

Method: LOCATIONS_GET_ENTITY

Note

You must redefine the OData service EHHSS_SAFETY_INFO_SRV as well.

Further Extensibility Entities

Business Add-Ins (BAdIs)

The following BAdIs are available for extensibility purposes:

  • BAdI: Extend Data of Gateway Service of Retrieve Safety Information App (BADI_EHHSS_SAFINF_DPC)

    You can use this BAdI to extend the data of the gateway service of Retrieve Safety Information app.

  • BAdI: Extend Model of Gateway Service of Retrieve Safety Information App (BADI_EHHSS_SAFINF_MPC)

    You can use this BAdI to extend the model of the gateway service of Retrieve Safety Information app.

These BAdIs are available in Customizing for SAP EHS Management under Start of the navigation path Risk Assessment Next navigation step Fiori Apps for Risk Assessment End of the navigation path.

Extension Includes

In addition to the extension includes described above, the following extension include is available:

DDIC

Extension Include

Use

EHHSSS_GW_SAFINF_SETTING

EHHSSS_GW_SAFINF_SETTING_INCL

Customer extension include for the gateway proxy structure for the app back-end settings.

If there are additional fields available in the OData service, you can display these fields on the UI. For more information, see the extensibility documentation for the respective SAP NetWeaver release on your front-end server at http://help.sap.com/fiori_implementation Start of the navigation path Extensibility Information for SAP Fiori Next navigation step Extending the UI Layer Next navigation step UI Extensibility Workflow Next navigation step  Next navigation step Checking the SAP-Enabled Extension Options Next navigation step Extension Points End of the navigation path.

Extension Points

Additional extension points are not available:

If there are additional fields available in the OData service, you can display these fields on the UI. For more information, see the extensibility documentation for the respective SAP NetWeaver release on your front-end server at http://help.sap.com/fiori_implementation Start of the navigation path Extensibility Information for SAP Fiori Next navigation step Extending the UI Layer Next navigation step UI Extensibility Workflow Next navigation step  Next navigation step Checking the SAP-Enabled Extension Options Next navigation step Extension Points End of the navigation path.

UI Controller Hooks

To plug in and execute custom code, the following hooks are available in the controller code:

Controller

Hook

Use

S3.controller.js

this.extHookOpenLocationOverview

Allows you to extend the location information displayed in a dialog by returning an object with custom properties. Use property popoverHeight to set a fixed height for the dialog.

This controller hook extends the location information. It allows you to provide implementation of an object with additional information about a location. The parameters model and bindingContext handle the reading of this information from the OData model. To display this information in a location overview dialog, the LocationDialog.view.xml view has to be extended (using the extension point extLocationDialogInsertDetails). Then, the fields inserted in the extended view must be bound with properties with the same name as the properties contained in the object which is returned by this hook method.

If there are additional UI controller hooks available in the controller code, you can add own code. For more information, see the extensibility documentation for the respective SAP NetWeaver release on your front-end server at http://help.sap.com/fiori_implementation Start of the navigation path Extensibility Information for SAP Fiori Next navigation step Extending the UI Layer Next navigation step UI Extensibility Workflow Next navigation step  Next navigation step Checking the SAP-Enabled Extension Options Next navigation step UI Controller Hooks End of the navigation path.

Display of UI Controls

The following UI controls can be hidden on the app UI:

View

Control ID

Use

S2.view.xml

infoToolbar

Allows you to display information about the assigned location of the logged in user

toolbarIcon

Icon displayed on the right side of the toolbar

internalNames

Internal chemical names displayed on the master list view

signalWord

Signal word from the classification of a chemical displayed on the master list view

riskLevel

Maximum inherent risk level for a chemical on the master list view

S3.view.xml

chemicalName

Internal chemical names displayed on the details view

chemicalSignalWord

Signal word from the classification of a chemical on the details view

chemicalRiskLevel

Maximum inherent risk level for a chemical on the details view

Basic_Info_Tab

Basic Information tab ID (used to encapsulate the three different sections on the tab: Hazard Classification, Protective Equipment, and Behavior)

First_Aid_Tab

First Aid tab ID (used to encapsulate the different sections on the First Aid tab)

Fire_Fight_Tab

Fire Fighting tab ID (used to encapsulate the different sections on the Fire Fighting tab)

Spills_Tab

Accidental Release Measures tab ID (used to encapsulate the different sections on the Accidental Release Measures tab)

Attachments_Tab

Attachments tab ID (used to encapsulate the section on the Attachments tab)

LocationDialog.view.xml

qoLocDetails

Section for location detail information

qoLocDescriptionLabel

Location description (label and text control)

qoLocDescriptionText

qoLocPlantLabel

Plant name of a location (label and text control)

qoLocPlantText

qoLocOrgUnitLabel

Organizational unit of a location (label and text control)

qoLocOrgUnitText

qoLocCostCenterLabel

Cost center of a location (label and text control)

qoLocCostCenterText

qoLocAddress

Section for location address information

qoLocAddressHeader

Location address (label and text control)

qoAddress_addr

BasicInfoTab.fragment.xml

SF_Hazards

Used to encapsulate the section on the Basic Information tab: Hazard Classification

SF_PPE

Used to encapsulate the section on the Basic Information tab: Protective Equipment

SF_Behaviour

Used to encapsulate the section on the Basic Information tab: Behavior

FirstAidTab.fragment.xml

SF_ErmergencyPerson

Used to encapsulate the section for local emergency contact on the First Aid tab

SF_GeneralAdvice

Used to encapsulate the section for general advice on the First Aid tab

SF_Inhalation

Used to encapsulate the section for inhalation on the First Aid tab

SF_EyeContact

Used to encapsulate the section for eye contact on the First Aid tab

SF_SkinContact

Used to encapsulate the section for skin contact on the First Aid tab

FireFightTab.fragment.xml

SF_ExtingMedia

Used to encapsulate the section for suitable extinguishing media on the Fire Fighting tab

SF_UnExtingMedia

Used to encapsulate the section for unsuitable extinguishing media on the Fire Fighting tab

SpillsTab.fragment.xml

SF_PERSONAL_PRECAUTIONS

Used to encapsulate the section for personal precautions on the Accidental Release Measures tab

SF_ENV_PRECAUTIONS

Used to encapsulate the section for environmental precautions on the Accidental Release Measures tab

SF_CLEAN_UP_METHODS

Used to encapsulate the section for cleaning up methods on the Accidental Release Measures tab

LocationDialog.view.xml

ATTACHMENTS

Used to encapsulate the list section on the Attachments tab

For more information about hiding UI controls, see the extensibility documentation for the respective SAP NetWeaver release on your front-end server at http://help.sap.com/fiori_implementation Start of the navigation path Extensibility Information for SAP Fiori Next navigation step Extending the UI Layer Next navigation step UI Extensibility Workflow Next navigation step  Next navigation step Checking the SAP-Enabled Extension Options Next navigation step Hiding UI Controls End of the navigation path.

More Information

For a general description of the extensibility options and procedures of SAP Fiori apps, see http://help.sap.com/fiori_implementation Start of the navigation path Extensibility Information for SAP Fiori End of the navigation path.