In today’s data-driven landscape, maintaining accurate and up-to-date settings in your monitoring platforms is crucial. When working with DataGaps, ensuring that parameters reflect the current state of your data sources and monitoring requirements is essential for optimal performance and reliable alerts. Whether you are updating a threshold, changing an API key, or modifying a database connection string, the process of updating parameters in DataGaps must be handled with precision.
This guide will walk you through a comprehensive, step-by-step process to safely and efficiently update a parameter in DataGaps. Follow these instructions to avoid common pitfalls and ensure your monitoring policies remain effective and accurate.
What Is a Parameter in DataGaps?
In the context of DataGaps, a parameter typically refers to any configurable field or variable that determines behavior across various test cases, data sources, validations, or alerting logic. Examples of parameters include:
- API Tokens: Used to authenticate with external data providers.
- Date Ranges: Define the period over which certain checks are executed.
- Threshold Values: Metrics that trigger alerts when exceeded.
- Database Credentials: Control access to source or target systems.
Because these parameters influence the precise operation of DataGaps tests and rules, keeping them accurate is critical to maintaining data quality monitoring tasks.
Why Updating Parameters Is Important
Updating parameters is often necessary in a range of practical scenarios, such as:
- Updating expiring security tokens or passwords
- Tuning thresholds based on new business expectations
- Switching data sources or destinations
- Fixing misconfigurations that affect test performance
Incorrect or outdated parameters may lead to failed tests, incorrect alerts, or even unnoticed data issues—for example, NULL-value fields, missing rows, or invalid formats.
Step-by-Step Guide to Updating a Parameter in DataGaps
Step 1: Log In to the DataGaps Platform
Begin by accessing your DataGaps portal. Use your authorized credentials to log in securely.
If your organization employs Single Sign-On (SSO), be sure to use your organization’s login portal. Incorrect login paths may affect access to sensitive parameters depending on your role.
Step 2: Navigate to the Correct Project or Environment
Parameters are often set according to specific projects or environments—such as “Production,” “Staging,” or “Development.” Navigate carefully using the left panel or top navigation bar to reach the right environment where the parameter resides.
Failing to select the right environment might result in changes being made to an incorrect dataset, leading to inconsistent monitoring results.
Step 3: Open the Parameters Section
Once you are inside the right environment or project space, do the following:
- Click on “Settings” or “Configuration” from the sidebar.
- Select “Parameters” from the dropdown or linked pane.
This will open a comprehensive list of all user-defined and system-level parameters associated with that environment.
Step 4: Search and Select the Parameter to Edit
Use the search bar or filtering options to locate the exact parameter you wish to modify. Parameters may be alphabetically ordered or grouped based on application type or usage frequency.
Example parameter types include:
- Threshold_Max_Transaction_Amount
- API_KEY_PROD
- Max_Retry_Count
Click on the row containing the parameter. A details pane or editor window will appear, allowing you to see the current value and metadata like last update time, assigned users, and environment scope.
Step 5: Make the Necessary Edits
Click the “Edit” or “Pencil” icon next to the parameter. Carefully make necessary changes. Input fields may vary based on the parameter type—some accept numerical inputs while others support string or date inputs.
Always double check changes for spelling accuracy (especially in keys and paths) and ensure the new value aligns with business or compliance requirements.
Best Practices When Editing:
- Never paste sensitive values (like passwords or API keys) from unsecured sources.
- If it’s a threshold or numeric value, verify with business stakeholders before changing.
- For date values, confirm the format (ISO, MM-DD-YYYY, etc.) matches what the underlying system expects.
Step 6: Save and Deploy the Changes
After verifying your edits, click “Save” or “Update”. Depending on your organization’s setup, this action may auto-deploy the changes or queue them for later implementation.
If DataGaps prompts you to validate or run a draft test post-edit, it’s advised to do so. This ensures that your updated parameter is recognized and does not disrupt existing monitoring logic.
Note:
Some configurations may require version control or approvals before the change is activated. Be sure to follow your organization’s deployment and review protocols as needed.
Step 7: Run a Validation Check
Run a test using a typical dataset or the “Test Parameter” feature available on the parameter page, if accessible. This simulates how the updated parameter behaves under normal conditions.
Look for:
- No runtime errors
- Successful validation messages
- Expected alert threshold outcomes
If validation fails, roll back the change or consult a team member before deploying into production.
Step 8: Audit and Document the Change
Every parameter change should be logged appropriately. Use DataGaps’ built-in activity logging or maintain an external change management file, depending on your process.
Details to log include:
- Parameter name
- Previous value
- New value
- Date and time of change
- User/Administrator who performed the update
This will promote transparency and help with troubleshooting or compliance audits later on.
Additional Tips and Security Considerations
- Use Environment-Specific Parameters: Always separate credentials and thresholds between environments to avoid production issues.
- Apply Role-Based Permissions: Only authorized users should be allowed to edit sensitive or critical parameters.
- Enable Audit Trails: Most enterprise setups allow version history logs. Use them for rollback if needed.
Following these practices will ensure your monitoring setup is secure and performance-optimized.
Troubleshooting Common Issues
- Parameter Not Saving: Ensure you have edit permissions. Check for special character issues or format mismatches.
- No Effect After Update: The associated test or job might be using a cached version. Restart the job or clear cache.
- Validation Fails: Roll back the changes or consult DataGaps documentation for format constraints.
If issues persist, contact DataGaps technical support or your internal DevOps team for escalated support.
Conclusion
Maintaining accurate control over parameters in DataGaps is not just a best practice—it’s a critical requirement for data quality and operational confidence. From adjusting thresholds based on shifting trends to rotating expired security tokens, updating parameters is a responsibility that must be carried out with care and clarity.
By following the steps outlined above with proper planning and validation, you can ensure that your DataGaps installation remains accurate, secure, and reliable. Proper auditing, testing, and documentation practices will also help you track the changes and maintain compliance across all environments.