In this Article:
- Overview
- Environments
- Prerequisites
- Enabling Environments
- Managing Environments
- Logical Sources
- Assigning Environments and Logical Sources
- Environment Metadata Workflows
- Copy Rule to Environment
- Promotion Relationships
- Rule Synchronization
- Resynchronizing Rules
- Synchronization Across Multiple Environments
- Lock Editing
Overview
The Environments feature helps you manage separate workspaces for your software throughout its development lifecycle. With Environments, you can safely build, test, and release features without affecting your live system or customers.
This feature includes three default environments: Dev (Development), UAT (User Acceptance Testing), and Prod (Production)
Environments
An environment is a separate workspace where your software lives during different stages of development. Think of it like separate rooms for different activities:
| Environment | Purpose | Who Uses It |
|---|---|---|
| Dev (Development) | Build new features and test code | Developers |
| UAT (User Acceptance Testing) | Test features before release | Testing team, business users |
| Prod (Production) | Live version for real customers | End users, customers |
Prerequisites
Before using Environments:
- Admin permissions required to enable the feature
- Access to Organization settings
- The Environments feature must be enabled in your account
Enabling Environments
- Navigate to Admin → Organization → Environments.
- Enable Manage Environments.
- Save the configuration.
Once enabled:
- The Environment Management section becomes available.
- Logical Source appears as an asset type in the asset dictionary.
- Environment selection becomes available domains and sub-domains.
Managing Environments
Navigate to:
Admin → Organization → Environments
Administrators can:
- Create environments
- Edit environment names
- Delete environments
- Reorder environments
Environment Order
Environment order defines the promotion path.
Example:
| Order | Environment |
|---|---|
| 1 | Dev |
| 2 | QA/Test |
| 3 | UAT |
| 4 | Prod |
The order is persisted and used when validating promotions between environments.
Logical Sources
A Logical Source represents the same business dataset across multiple environments. Logical sources are available when the environments feature is enabled. They are used to connect compatible data sources so that rules can be copied between matching environments and sources.
Example:
| Environment | Physical Source |
|---|---|
| Dev | Customer_DB_DEV |
| QA | Customer_DB_QA |
| Prod | Customer_DB_PROD |
All three data sources can be linked to a single Logical Source:
Assigning Environments and Logical Sources
To configure a Data Source:
- Open the Data Source.
- Go to settings and under the General.
- Select an Environment.
- Assign a Logical Source.
- Save changes.
The assigned Environment and Logical Source are displayed throughout the platform, including asset detail pages.
When no logical source is available, users can click Create a logical source and be redirected to the Asset Dictionary to add one.
Environment Metadata Workflows
When Environments are enabled, workflow-enabled Domains and Sub-Domains include an Environment selection.
Users can:
- Select one or more environments
- Apply workflows to specific environments
- Choose None to retain existing workflow behavior
If Environments are disabled:
- Environment selection is not displayed.
- Existing workflow behavior remains unchanged.
After the user submits the updates for approval, the owner receives an email to review and approve the changes.
Copy Rule to Environment
Copy to Environment lets you copy a rule from one environment to another, provided the source data source and logical source are compatible. The copied rule appears in the target environment and shows its relationship to the source rule. This makes it easy to promote or replicate rules across environments while keeping track of the original and copied versions.
Requirements
A rule can only be promoted when:
- Source and target Data Sources share the same Logical Source.
- Valid target environments exist.
- Promotion validation passes.
If selected rules do not share the same Logical Source, promotion is not allowed.
Copying a Rule
- Open a DQ Rule.
- Select Copy to Environment.
- Choose the target Environment.
- Confirm the action.
A new rule is created in the target environment.
Bulk Copying
Bulk copying lets users copy multiple rules to another environment in a single action, as long as the selected rules meet the required criteria. This helps teams move rules more efficiently across environments while keeping the process consistent and controlled.
Note: Bulk copying is available only when the selected rules share the same data source and logical source. The target environment must also be valid for all selected rules before the copy can proceed. When these conditions are met, users can copy the selected rules together instead of handling them one by one.
Summary of the copied rule:
Promotion Relationships
After promotion:
The source and target rules maintain a relationship.
Example:
Dev Rule
↓
QA Rule
↓
Prod Rule
The relationship section displays:
- Source rule
- Target rule
- Promotion history
- Synchronization status
Rule Synchronization
In Sync
Rules are considered In Sync when:
- No changes exist between promoted versions.
- Source and target rules contain the same configuration.
Out of Sync
Rules become Out of Sync when changes are made to any promoted version.
Examples:
- Threshold changes
- Scope changes
- Alert modifications
- Rule logic updates
When this occurs:
- Sync indicators appear.
- Relationship views show Out-of-Sync status.
- Users can compare differences.
The comparison identifies:
- Modified fields
- Current values
- Previous values
This helps users understand exactly what changed.
Resynchronizing Rules
To synchronize rules again:
- Open the updated rule.
- Select Copy to Environment.
- Choose the affected environment.
The target rule is updated and synchronization is restored.
Synchronization Behavior Across Multiple Environments
Consider the following promotion path:
UAT → Dev → Prod
If:
- A rule is copied from UAT to Dev
- The Dev rule is modified
- The Dev rule is copied to Prod
Then:
- Dev and Prod may match each other
- Both may still differ from the original UAT version
In this scenario, the rule chain remains Out of Sync because not all promoted versions are aligned.
Synchronization is evaluated across the complete promotion chain.
Lock Editing
Lock editing is another key capability in the Environments feature. When a rule is locked, it cannot be edited until it is unlocked.
This feature is useful when:
- Rules are under review
- Rules are awaiting promotion
- Production rules should remain unchanged
Lock a Rule
- Open the DQ Rule.
- Select Lock Editing.
After locking:
- Editing controls become disabled.
- Rule modification is prevented.
- Visual indicators show the rule is locked.
Note: Once a rule is locked, all users are prevented from editing it across synced rules.
Unlock a Rule
- Open the DQ Rule.
- Select Unlock Editing.
Editing capabilities are immediately restored.
Bulk Locking
Users can also:
- Select multiple rules from the listing page
- Apply Lock Editing in bulk
Bulk actions follow the same validation rules as individual actions.
0 Comments