To catch all possible failures in a centralized way, you can hook external supervision results like temperature monitoring or OS status to the Platform Health Management as Health Channels.

Steps:

  1. Create Health Channel Interface
  2. Create Health Channel Recovery Notification Interface
  3. Create ports for the Health Channel in the Executable Editor
  4. Create Health Channel External Status
  5. Create Recovery Notification for a Health Channel Status

Create Health Channel Interface

To supervise an external supervision result, you need to create a I_HealthChannel Health Channel Interface for it.

  1. Open the Platform Health Management Editor.
  2. Right-click on I_Interface Interfaces.
  3. Select Create PHM Health Channel Interface.
  4. The Create PHM Health Channel Interface wizard opens.
  5. Choose a name for your Health Channel.
  6. Choose the Package and the ARXML file where the Health Channel Interface should be stored.
  7. Click Finish.
  8. You have created a I_HealthChannel Health Channel Interface. It is now listed under I_Interface Interfaces.
  9. Create the possible Statuses for your Health Channel.
  10. If a Status should Trigger a Recovery Notification then check the corresponding box.
  1. The I_HealthChannel Health Channel Interface can now be connected to an application port in the Executable.

Create Health Channel Recovery Notification Interface

To be able to notify state management or the watchdog you need to create a I_SupervisedEntityRecovery Health Channel Recovery Notification Interface for the corresponding daemon process.

  1. You are in the PHM Editor.
  1. Right-click on I_Interface Interfaces.
  2. Select Create PHM Health Channel Recovery Notification Interface.
  3. The Create PHM Health Channel Recovery Notification Interface wizard opens.
  4. Choose a name for your Health Channel Recovery Notification Interface.
  5. Choose the Package and the ARXML file where the Notification Interface should be stored.
  6. Click Finish.
  1. You have created a I_SupervisedEntityRecovery Health Channel Recovery Notification Interface. It is now listed under Interfaces. The I_SupervisedEntityRecovery Health Channel Recovery Notification Interface can now be connected to a state manager port in the Executable.

Create ports for the Health Channel

To connect the PHM interfaces for the Health Channel as well as the Recovery Notification, we need to create a port for the corresponding SWComponents in the Executable.

  1. Open the Executable Editor (Shortcut: <CTRL> + <ALT> + <D>, <E>).
  2. Select the SWComponent for the application.
  3. Select the tab Others.
  4. I_Add Add Port Prototype and check Required for your Health Channel Interface.
  5. Click Finish.
  6. The port for your Health Channel Interface is listed under Ports.
  7. Select the SWComponent for your state manager application.
  8. Select the tab Others.
  9. I_Add Create Port Prototype and check Provided for your Health Channel Recovery Notification Interface.
  10. Click Finish.
  11. The port for your Health Channel Recovery Notification Interface is listed under Ports.
  12. Go back to the PHM Editor.
  1. You now have set up the basis for communication between your application process and the state manager. Proceed with configuring the behavior of health management.

Create Health Channel External Status

  1. You are in the PHM Editor.
  2. A I_PHMContribution Contribution was created.
  1. Select the fitting I_PHMContribution Contribution for your Health Channel.
  2. Right-click on I_ExternalHealthChannel External Health Channels and select Create Health Channel External Status.
  3. A new I_ExternalHealthChannel Health Channel External Status was added.
  4. Name the new status and fill out the necessary parameters.

Parameters Health Channel External Status

Parameter

Required/
Optional

Data type

Description

Name

Required

String

Name of the Health Channel Status

Description

Optional

String

Choose a good description that explains the Health Channel Status to your future self and your colleagues.

Health Channel

Required

Reference

References Health Channel Port of a Executable process.

Recovery Notification

Optional

Element

Defines the behavior of the Recovery Notification of a Health Channel Status.

Create Recovery Notification for a Health Channel Status

  1. You are in the PHM Editor.
  2. A I_PHMContribution Health Channel External Status was created.
  1. Select the Health Channel Status that should send a Recovery Notification.
  2. Select [Create New Recovery Notification].
  3. A new section Recovery Notification appears.
  4. Fill out the parameters and map the corresponding state manager Port Prototype to the Recovery Notification process.
  1. You have successfully created a Recovery Notification for the selected Health Channel External Status

Parameters Recovery Notification

Parameter

Required/
Optional

Data type

Description

Name

Required

String

Name of the Recovery Notification

Description

Optional

String

Choose a good description that explains the Recovery Notification to your future self and your colleagues.

Retry

Required

Reference

Number of times PHM tries to send a notification to State Management before triggering a watchdog reaction.

Timeout

Optional

Integer

The maximum acceptable amount of time (seconds) that PHM is waiting for an acknowledgement by State Management after sending the notification.

Mappings

Required

Reference

Maps the ports to which the Recovery Notification is sent to.