Alert Configuration
In this topic ShowHide
About this page
This page is used to set rules for alerts. Alerts notify chief investigators,
project managers or office staff when specific conditions arise so that
issues can be addressed. For example, a rule could be defined to display
when the institution is providing cash and in-kind in excess of 50% of
the project cost. A list of applicable alerts will display at the top
of selected CPT pages when the conditions of one or more defined rules
are met.
Rules will be evaluated against projects based on input or changes made
in an eForm when the Costing Status
is Valid. A
Valid status means that there are no validation issues with project
input, and the tool has calculated the cost and price at least once. This
status is shown in the Costing Status
field in an eForm. This is commonly part of a costing and pricing summary
page along with the Costing and Pricing
Tool button to enter the tool.
Alerts are aggregated. If more than one applies to a project, they will
all appear in the list shown at the top of selected CPT pages. This list
will also appear on eForm pages that include the read-only Costing
and Pricing Tool Alerts (ALERTS) system field in an eForm template.
Prerequisites
• Knowledge of
eForm design and elements is required to be able to select the elements
to use in rules.
• Understanding
of mathematical operators and formula construction is required for rule
definition.
Add an alert
To add a new alert, follow the steps below:
1. In RME
> Projects > Funding Rules > Alert Configuration page,
ensure that the common alert configuration has been completed, as outlined
in the table below. These settings apply to all alert rules.
2. In the Alert Rules section, click Add at the top right of the grid.
The Alert Rule page displays.
3. In the Rule Name field (mandatory) of the
Alert Rule page, enter a name for the alert so that is can be easily identified
and distinguishable from other rules.
4. Ensure that
the Current? flag is Yes
so that the rule will be active and evaluated for CPT eForms.
5. In the Alert Message field (mandatory),
enter the message to display in the alert list on defined CPT and eForm
pages. As this may appear on many pages, make sure that the message can
be clearly understood by your users without the context of a particular
page.
6. The Alert Rule field (mandatory) is
used to build the condition/s under which the alert should display.
• Each
condition includes at least one element (field, DDA or numeric expression),
an operator, and at least one other element.
• A
rule can comprise of one condition, or more than one condition, using
an operator between each (AND, OR). To expand a rule, you can add another
condition line. You can add more than one, as needed.
• You
can also group conditions to form a sub-condition to which you can apply
a different operator.
• This
is a highly-flexible rule builder. The instructions below are at a high
level - you can add as many conditions and groups as you wish, with different
operators. Take care in constructing rules as there is no system validation
for conditions or rule due to dynamic and custom nature of eForm templates.
Be wary of creating very complex rules as they may be difficult to test,
manage or maintain. For guidance, see the Examples
section below or contact the ResearchMaster Client Engagement Team.
7. To start building
the rule, in the first dropdown, select the eForm element you want to
use, from a field, DDA, or a numeric expression, as outlined in the table
below.
The dropdown then dynamically displays options based on your selection.
8. In an operator
field, select the math or comparison function for the condition from the
options that dynamically display based on your previous selection.
Possible options are described in the table below.
9. In the next
dropdown, select Option to display
a list of options based on the selection in the first dropdown. If a Numeric
Expression, repeat steps 7 to 9 to complete additional condition options
and operators.
10. If you need
to define more conditions for the rule, add a new line by selecting the
Add Condition option at the top
right. The operator between the initial condition and new one is AND by default. You can change this
to OR by clicking the field down
arrow.
11. If you want
to add a new group to contain one or more conditions, select the Add Group option at the top right.
This create a parenthesis to the rule formula. It is useful, for example,
if the rule includes multi-line conditions and you want to use different
operators between a group of them. For example: (group 1 - multiline using
AND) OR (group 2 - multi-line using AND)
12. To remove
a condition, select the red cross (x)
displayed at the end of the condition fields.
Manage Alert Rules
You manage alert rules in the Funding
Rules page. You can delete rules and export the grid details (Current?,
Alert Message and Rule Name).
Examples
1) Non-institution led ARC or NHMRC contribution > 30%
Non-institution led ARC or NHMRC projects where the institution contribution
is more than 30% of the total cost.
2) Non institute led contribution > 50%
The institution is providing cash and in-kind in excess of 50% of the
project cost.
Page layout: Can only customise field properties; default layout cannot be changed
Product Key: Costing and Pricing Tool
Page ID: CPT027.htm
The Costing
and Pricing Tool Alerts system field is included in default
Page View layouts for CPT pages (CPT012 - CPT018, CPT023, and
CPT029). If you customise, or have customised, any of these page
layouts, you will need to add this field element back into the
layout, positioned at the top of the page for the alert to display.