The article highlights the importance of using ServiceNow Data Preservers to prevent API configuration mix-ups during environment cloning in a HappySignals integration, ensuring accurate feedback data.
When integrating HappySignals with ServiceNow, it's critical to ensure that environment-specific API configuration data, such as API keys, endpoints, and shared secrets, remain intact during environment cloning. Without proper precautions, these sensitive details can be overwritten, leading to production and non-production feedback data being mixed up.
Why Are Data Preservers Important for HappySignals?
HappySignals relies on unique API configurations in each ServiceNow environment to properly route feedback to the correct HappySignals tenant. If these configurations are overwritten during a ServiceNow instance clone:
- Test feedback from a non-production environment could be mistakenly sent to the production tenant.
This mix-up compromises the integrity of the feedback, leading to faulty data analysis and potential security risks.
What Are ServiceNow Data Preservers?
ServiceNow Data Preservers allow you to prevent specific records or fields from being copied over during the cloning process. For HappySignals, preserving API keys, endpoints, and shared secrets is essential to maintain distinct configurations between environments.
Step-by-Step Guide to Set Up a Data Preserver for HappySignals API Keys and Endpoints
-
Navigate to the Data Preserver Setup:
- In your ServiceNow instance, go to the navigation bar and type "System Clone > Preserve Data."
- Select Preserve Data from the options.
-
Create a New Data Preserver:
- Click the New button to create a new data preserver rule.
-
Define the Data Preserver Properties:
- Name: Enter a meaningful name, such as "HappySignals Integration Properties" (as shown in the screenshot).
- Table: From the drop-down menu, select System Property [sys_properties] since the HappySignals API and endpoint configurations are stored here.
-
Add Filter Conditions:
- In the Conditions section, click Add Filter Condition.
- Set the filter as follows:
- Name → is one of them.
- Select the following 9 properties from the drop-down list:
x_pgo_happysignals.endpoint
x_pgo_happyportal.endpoint
x_pgo_happy_it_ex.global.endpoint
x_pgo_happysignals.apikey
x_pgo_happyportal.apikey
x_pgo_happy_it_ex.global.apikey
x_pgo_happysignals.word
x_pgo_happyportal.word
x_pgo_happy_it_ex.global.word
These properties should be preserved to avoid mixing configurations between environments during cloning.
-
Save the Data Preserver:
- After setting up the conditions, click Update to save the data preserver rule.
-
Assign Clone Profiles (Optional):
- If applicable, you can assign this data preserver to specific clone profiles by selecting them in the Clone Profiles section.
Once completed, this Data Preserver will ensure that the HappySignals API keys, endpoints, and other integration-related properties are not overwritten during environment cloning, keeping your configurations intact across production and non-production environments.
Consequences of Not Using Data Preservers
Without Data Preservers, you risk:
- Exposing production API details in non-production environments.
- Mixing up test and production feedback, leading to inaccurate metrics.
By setting up ServiceNow Data Preservers, you maintain the accuracy and security of your HappySignals integration across all environments, ensuring reliable feedback collection.