Alerts
Alerts define who is notified and what information is included in the messages sent in response to real-time failures in Inspections.
Settings
| Field | Description |
|---|---|
| Name | Unique name of the Alert. |
| Description | Notes about the Alert. This is only displayed on the Alert's page. |
| Include Linked Charts | If a Chart Test is linked to the Test that failed, an image of the chart will be attached to emails. |
| Email Users | Users that will receive an email when this Alert is triggered. |
| Additional Emails | Other email addresses that will receive an email when this Alert is triggered. |
| Email Template | Body of the email. Template expressions can be used to include context. Microsoft Outlook will sometimes incorrectly render lines of text of over 1,000 characters. Try breaking long text onto multiple lines if this behavior is experienced. |
| Text Message Users | Users that will receive an SMS text message when this Alert is triggered. |
| Additional Phone Numbers | Other phone numbers that will receive an SMS text message when this Alert is triggered. |
| Text Message Template | Text message content. Template expressions can be used to include context. |
Templates
Expressions are used in templates to replace values from the Test that caused the real-time failure. Information about the Test, Sub-Inspection, Process, Part, and more can be included in the template.
Expressions are included in templates by using double curly braces:
When the Alert is sent, the value of the expression is replaced into the message:
Default Values
Default values may be provided using the pipe character followed by the default value within double quotes
When the Alert is sent, if no value is set for the expression, the default value will be used. Default value strings may not contain other expressions.
Expressions
Expressions are case-sensitive, cannot be nested within each other, and must not be partially formatted. Any whitespace inside the curly braces is ignored.
inspection
The name of the Inspection.
subinspection
The name of the Sub-Inspection.
test
The Test that triggered this Alert.
The following properties can be accessed via the test keyword:
test.label
char
The Characteristic recorded by the Test. If the triggering Test is not an SPC Test, this value will be blank.
The following properties can be accessed via the char keyword:
char.namechar.descriptionchar.subgroupSizechar.lowerSpecchar.upperSpecchar.xTargetchar.lowerReasonableLimitchar.upperReasonableLimitchar.lowerFixedControlchar.upperFixedControlchar.lowerIndLimitchar.upperIndLimitchar.mavchar.processTargetchar.rTargetchar.lowerRFixedControlchar.upperRFixedControl
process
The Process recorded by the Test.
The following properties can be accessed via the process keyword:
process.nameprocess.ncuCostprocess.sampleSizeprocess.acceptableDefectPercentageprocess.goalYieldprocess.acceptableYieldprocess.acceptableAvailabilityprocess.acceptablePerformanceprocess.acceptableQualityprocess.acceptableOEEprocess.goalAvailabilityprocess.goalPerformanceprocess.goalQualityprocess.goalOEE
part
The Part recorded by the Test.
The following properties can be accessed via the part keyword:
part.name
failures
A comma-delimited list of real-time failures recorded by the Test.
note
The note recorded by the Test.
values
The values recorded by the Test. The format of this output is dependent on the data type of the Test.
For example, the template
will have its output displayed as
- (SPC)
The values were 1.8, 2.7, 3.6. - (DMS)
The values were Sample Size: 1, total Defects: 10, total NCU: 4. - (OEE)
The values were Scheduled Time: 720, Available Time: 706.
trace
The Traceability recorded by the Test. Traceability must be accessed with the trace keyword, followed by the Internal ID of the Traceability.
The following properties can be accessed via the trace keyword:
trace.n.nameThe name of the Traceability.trace.n.valueThe value of the Traceability recorded by the Test.
For example, if the Internal ID of the Machine Traceability is 3, the Machine submitted with the data can be accessed as
Examples
Inspection and Test Labels
Template
Output
Characteristic Values
Template
Output
Failures, Values, and Traceability
Template
Values: {{ values }}
Failures: {{ failures }}
{{ trace.12.name }}: {{ trace.12.value | "Not set" }}
{{ trace.4.name }}: {{ trace.4.value | "Not set" }}
Output
Import/Export
Alerts can be imported and exported using the following CSV structure.
| Column Header | Create | Update | Allows Multiple | Description |
|---|---|---|---|---|
| ID | Not Allowed | Required | No | Alert's Internal ID |
| Name | Required | Optional | No | String |
| Hidden | Optional | Optional | No | True | False |
| Description | Optional | Optional | No | String |
| Add Email User | Optional | Optional | Yes | A GS User's username |
| Remove Email User | Not Allowed | Optional | Yes | A GS User's username |
| Add Additional Email | Optional | Optional | Yes | An email address to add |
| Remove Additional Email | Not Allowed | Optional | Yes | An email address to remove |
| Email Template | Optional | Optional | No | String |
| Add Phone User | Optional | Optional | Yes | A GS User's username |
| Remove Phone User | Not Allowed | Optional | Yes | A GS User's username |
| Add Additional Phone | Optional | Optional | Yes | A phone number to add |
| Remove Additional Phone | Not Allowed | Optional | Yes | A phone number to remove |
| Text Message Template | Optional | Optional | No | String |
