⚙️ Creating and Configuring Rules for GermainUX Analytics
📄 Overview
Rules provide an advanced way to customize GermainUX Analytics using custom logic.
A Rule can analyze and transform data, detect conditions, generate insights or events, trigger automated actions, process action results, and determine what should happen next.
This page explains how to create, configure, test, and deploy a Rule.
📋 Before You Begin
Before creating a Rule, determine what you want it to accomplish.
For example:
📊 Analytics
|
Capability |
|---|
|
Analyze or transform monitored data |
|
Detect a specific condition or pattern |
|
Categorize or enrich data |
|
Correlate information |
|
Generate a custom metric, event, or insight |
Create a Rule
Go to:
Germain Workspace > Left Menu > Settings > Analytics > Rules
Click + to create a Rule.
Or start the rule creation from the Wizard page:
Configure the Rule properties and add the custom logic required for your use case.
🔧 Configure the Rule
✏️ Name
Enter a unique and descriptive name that identifies the purpose of the Rule.
For example:
|
Example Name |
Code Sample |
|---|---|
|
Detect Repeated Checkout Error |
|
|
Categorize Salesforce Errors |
|
|
Analyze Slow Transactions |
|
|
Trigger Remediation for Service Failure |
|
🧠 Rule Logic
Add the logic that GermainUX should execute.
Rules can evaluate monitored data and context to determine:
|
Decision Area |
|---|
|
What data should be analyzed |
|
Which conditions should be detected |
|
How data should be categorized or transformed |
|
Whether an event or insight should be generated |
|
Whether an automated action should be triggered |
|
How the result of an action should be processed |
|
What should happen next |
Rules support custom expressions and logic using MVEL.
✅ Validate the Rule
After configuring or modifying the Rule, click Validate.
Validation helps identify syntax and configuration issues before the Rule is used.
Resolve any reported issues and validate again until the Rule is valid.
Then save the configuration.
🔗 Assign the Rule
After the Rule has been created and validated, assign it to the GermainUX configuration or component where the custom logic should execute.
Depending on the use case, the Rule may be associated with:
|
Association |
|---|
|
Monitoring configuration |
|
Analytics |
|
Data processing |
|
An automated action |
|
A technology-specific component |
Select the Rule in the applicable configuration and save your changes.
A restart of the applicable GermainUX Engine may be required for some configuration changes to take effect.
🧪 Test the Rule
Test custom Rules in a non-production environment before enabling them in production.
Verify that:
|
Check |
|---|
|
The Rule receives the expected data |
|
Conditions are detected correctly |
|
Data is analyzed or transformed as expected |
|
Generated events or insights are correct |
|
Automated actions occur only under the intended conditions |
|
Action results are processed correctly |
|
Unexpected data does not trigger unintended behavior |
For Automation Rules, also verify permissions, credentials, execution limits, and failure handling.
📡 Monitor the Rule
After deploying the Rule, verify its behavior using the applicable GermainUX analytics, events, logs, dashboards, or automation results.
Confirm that the Rule:
|
Monitor Item |
|---|
|
Executes when expected. |
|
Produces the expected analytical result or action. |
|
Does not generate unnecessary events or actions. |
|
Handles unexpected conditions appropriately. |
|
Continues to behave as expected as monitored applications and data change. |
📝 Modify a Rule
To modify an existing Rule:
-
Go to Germain Workspace > Settings > Analytics > Rules.
-
Select the Rule.
-
Modify the configuration or logic.
-
Click Validate.
-
Resolve any validation issues.
-
Save the Rule.
-
Test the updated behavior before broad production use.
Changes to Rules used in production should follow your organization's testing and change-management procedures.
🛡️ Security
Rules can perform powerful analytical and automation operations.
When configuring Rules:
|
Security Consideration |
|---|
|
Use the minimum permissions required. |
|
Secure credentials and sensitive information. |
|
Validate external inputs before using them in commands or actions. |
|
Limit the scope of automated actions. |
|
Avoid including sensitive information directly in Rule logic. |
|
Test potentially impactful actions in a non-production environment. |
|
Follow your organization's security, privacy, approval, and change-management requirements. |
📚 Related Documentation
ℹ️ Get Help
The Germain Team can help you set this up. Contact GermainUX Support.
Component: Engine
Feature Availability: 2014.1 or later