Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Field

Types

Description

Incident Title

Incident

Investigation

Action

Resolution

Closure

Signoff

Title of the relevant incident.

Incident Responsible person

Incident

Investigation

Resolution

Closure

Signoff

Name of the staff selected as incident responsible person.

Incident Code

Incident

Investigation

Resolution

Closure

Signoff

The code of the relevant incident will be included as a hyperlink. This will apply to all notification types, except ‘Risk’.

Info

Note: For the hyperlink to work, it is important that the 'Disable hyperlinks in email snippets for all incident and compliance notifications' setting under Incident Settings > Miscellaneous Settings, is not active.

Incident type

Incident

Type that the relevant incident belongs to.

Investigation due

Investigation

Investigation due date.

Primary investigator

Investigation

Name of the staff selected as incident primary investigator.

Secondary investigator

Investigation

Name/s of staff selected as incident secondary investigator/s.

Action Title

Action

Action title.

Action Responsible officer

Action

Name of the staff selected as action responsible officer.

Action Start Date

Action

Action start date.

Action end date

Action

Action end date.

Action Status

Action

Current status of the action.

Action % complete

Action

Current action % complete.

Resolution Status

Resolution

Resolved or not.

Close Status

Close

Close/ Open.

Signoff Status

Signoff

Approved / denied.

Incident type

Incident

Type that the relevant incident belongs to.

Investigation due

Investigation

Investigation due date.

Primary investigator

Investigation

Name of the staff selected as incident primary investigator.

Secondary investigator

Investigation

Name/s of staff selected as incident secondary investigator/s.

Action Title

Action

Action title.

Action Responsible officer

Action

Name of the staff selected as action responsible officer.

Action Start Date

Action

Action start date.

Action end date

Action

Action end date.

Action Status

Action

Current status of the action.

Action % complete

Action

Current action % complete.

Resolution Status

Resolution

Resolved or not.

Close Status

Close

Close/ Open.

Signoff Status

Signoff

Approved / denied.

Notifications Settings

This settings page lets you configure notifications to be sent out as email, SMS, or APIs upon various trigger criteria, according to a selected notification template, to various recipients, users, user roles, or additional recipients. Notifications can be based on a trigger type. Further, create custom notifications for incident objects, with custom trigger criteria, using custom trigger criteria configuration equations.

...

Field

Description

Notification Name

Define a name for the notification. Name should be unique.

Notification Type

A dropdown including the notification types: incident, investigation, action, resolution, close, signoff, risk, submission, custom, and incident review, notification delivery failure.

Info

Note: Based on the selected notification type, the Trigger Criteria, Notification Template, and Notification Recipient options to select from will vary.

Type

This dropdown will be displayed only for the notification types: Submission and Custom.

Object

This dropdown will be displayed only for the notification types: Submission and Custom. And based on the selected submission or custom type, the object list will vary.

Trigger Criteria

List of all trigger criteria available for the selected notification type. Refer Trigger Criteria title below for more information.

Notification Template

Lists all notification templates created via Incident Settings > Notification Templates filtered by the notification type.

Notification Recipient

Select multiple recipients via their role within the incident to receive a notification. Recipient list will differ according to the notification type selected. Options available will be:

  • Incident – Incident creator, incident responsible officer, unit manager, director, business unit manager, service profile manager, incident submitter, incident approver, reporting officer of incident responsible officer, custom staff, unit manager of the linked hierarchy node of the notification and below, staff dropdown.

  • Investigation – Primary investigator, secondary investigator, unit manager, incident creator, incident responsible officer, director, business unit manager, service profile manager, reporting officer of incident responsible officer.

  • Action – Incident responsible officer, action responsible officer, unit manager, incident creator, director, business unit manager, service profile manager, action submitter, action approver, reporting officer of incident responsible officer, reporting officer of action responsible officer.

  • Resolution – Resolved by, unit manager, incident creator, incident responsible officer, director, business unit manager, service profile manager, reporting officer of incident responsible officer officer. 

  • Close – Closed by, incident creator, incident responsible officer, unit manager, director, business unit manager, service profile manager, reporting officer of incident responsible officer officer. 

  • Signoff – Incident responsible officer, signoff authority, signoff submitter, incident creator, unit manager, director, business unit manager, service profile manager, reporting officer of incident responsible officer officer. 

  • Risk – Evaluated by, unit manager, incident creator, incident responsible officer, director, business unit manager, service profile manager, reporting officer of incident responsible officer officer. 

  • Submission – Unit manager, incident creator, incident responsible officer, director, business unit manager, service profile manager, reporting officer of incident responsible officer officer. 

  • Custom – Unit manager, director, business unit manager, service profile manager, incident creator, incident responsible officer, reporting officer of incident responsible officer officer. 

  • Incident Review – Incident creator, incident responsible officer, reporting officer of incident responsible officer officer.

  • Notification Delivery Failure – Unit manager, director, business unit manager, service profile manager, incident creator, incident responsible officer, reporting officer of incident responsible officer officer. 

Users

Select multiple users from the list of staff members that don't fall into any recipient or role category. This will allow to select a set of users to receive notifications when the criteria triggers.

Info

Note: If the user does not have permission to view the object, they will not be able to view the object, but will get an email notification.

User Role

Select multiple user roles created via Incident Settings > User Roles, to send a notification to all users assigned under that user role.;

Custom Fields 

If any user does not fall under the standard set of notification recipients, users, or user role category, and want to create a new staff category, the custom fields can be used to add this field/responsible person(s) here.

This will be written as follows: {{ObjectName.FieldName}}

Example:

{{Action.CustomStaff}} – this custom field will be created under the Action Notification Type, having a dropdown list of Custom Staff members to send out this notification to.

Active

Tick this checkbox to mark this notification as active, and deselect to mark it as inactive.

Trigger Type

Select when the trigger will be executed from the following options:

  • On Save – selecting this option will execute the trigger when the user makes a change and clicks the 'Save' button.

  • On Auto Save – selecting this option will execute the trigger when the 'Auto Save' setting (under Miscellaneous Settings) is turned ON. When the auto save cycle runs in the background, if there has been any new changes in an incident record which requires an email to trigger, it will execute.

Info

Note: The ‘On Auto-Save’ option is not applicable for the following triggers:

  • Incident: New incident creation, Password reset, Web account created, Incident Deleted, Incident Submitted, Incident Approved, Incident Rejected Rejected. 

  • Action: Action submitted, Action Approved, Action Rejected.

  • Sign off: Phase submitted for sign off, Phase approved, Phase rejected.

  • Submission.

Notifications will not trigger if the incident is in ‘Draft’ state.

  • Open – selecting this option will execute the trigger for API based notifications; where an API based dropdown can be configured using API notifications. The system will send an API request when the dropdown is set to 'Open' and then receive an API notification with the data values to populate the dropdown. This has nothing to do with email or SMS notifications.

...

  • Submitted – Notification triggered for a submission type notification for various items submitted. The submission Type and Object can be specified to trigger this email notification.

  • Custom trigger criteria – Although this option is available, this is not functional yet.

  • Submission failed – Notification trigged for a submission type notification when the submitted submitted. 

Custom

  • Custom trigger criteria – Refer Custom Trigger Criteria Configuration title below for more details.

...

  • Notify Upon Delivery Failure.

Custom Trigger Criteria Configuration

...

  • STEP 3: Under Menu > Framework > Incident Settings > Notifications, set up a custom API notification template with the below setup:

    • Notification Type: 'Custom' field within any Object.

    • Type: [Applies to ALL types]

    • Object: Select the object for which the API dropdown is configured.

    • Trigger Criteria: Custom Trigger Criteria.

    • Notification Template: Select the Notification Template created in STEP 2. In the event there aren’t any notification templates created, the 'Active' tick box will remain disabled.

    • Trigger Type: Open (This is because the API call will trigger a request when clicked to open the dropdown to select a value.)

    • Fields: Select the fields for which the dropdown is configured.

    • Response Trigger Criteria Configurations (include the below syntax for each API-based dropdown):

...