Before You Begin
Set the goal first
Validate the Rule
Catch syntax and config errors
Test the Rule
Verify before enabling in production
Security
Guardrails for powerful rules
Creating and Configuring Rules for GermainUX Analytics
Overview
Rules provide an advanced way to customize GermainUX Analyticsusing 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
- 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
Name
Enter a unique and descriptive name that identifies the purpose of the Rule. For example:
Rule Logic
Add the logic that GermainUX should execute. Rules can evaluate monitored data and context to determine:- 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
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:- Monitoring configuration
- Analytics
- Data processing
- An automated action
- A technology-specific component
Test the Rule
Test custom Rules in a non-production environment before enabling them in production. Verify that:- 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
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:- 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:1
Go to Germain Workspace > Settings > Analytics > Rules
2
Select the Rule
3
Modify the configuration or logic
4
Click Validate
5
Resolve any validation issues
6
Save the Rule
7
Test the updated behavior before broad production use
Security
Rules can perform powerful analytical and automation operations. When configuring Rules:- 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
Contact GermainUX Support
The Germain Team can help you set this up.
Can't find what you need?
Search all GermainUX docs with Ctrl + K, or use the feedback buttons at the bottom of this page to tell us what is missing.
The content of this document is proprietary to GERMAIN SOFTWARE LLC.