Getting HappySignals Service Experience application up and running in your ServiceNow instance is usually very easy and quick. We will be also helping you throughout the installation and set up process.
If you encounter any issues with the Service Experience product during or after installation, please contact us on firstname.lastname@example.org
Before you start:
There are couple of things to note before starting the installation process.
- make sure you have administrator access to the ServiceNow instance where you are installing the application
- make sure you have access to the HappySignals cloud service
- make sure you have received the following information from HappySignals:
- End-point URLs to your HappySignals cloud services.
Generally, the end-point URL looks something like: https://[your company name].happysignals.com
- A shared secret, which is used to make sure generated feedbacks come from your environment
- API-key for two way integration between HappySignals cloud service and your ServiceNow Instance
- End-point URLs to your HappySignals cloud services.
- make sure you have requested the Service Experience application from the ServiceNow store. For details on how to do this, see our article on "How to proceed when you want to download our Application from ServiceNow Store?"
Installing the application:
Installation of the application is very straight forward and requires only few steps to be complete:
- In the ServiceNow application navigator, find the "System Applications" module. In the "System Applications" module expand the "All Available Applications" section and click on the "All" menu item.
- In the "All applications" page, type "HappySignals" to the search bar. In the application list below find the Service Experience application and click the "Install"-button. Confirm the installation in the modal that pops up.
- Wait for the install to complete and you have successfully installed the HappySignals Service Experience to your ServiceNow instance.
Configuring the application:
Once you have installed the HappySignals Service Experience application to your instance you can start the configuration process.
Before you begin:
- switch your application scope to "Service Experience"
- create a new update set to "Service Experience" application scope, so you can capture and transfer the configuration changes to test and production instances later.
Now, you are ready to set up the General Properties:
General properties of the application determine how the application connects to HappySignals cloud service,
- in the ServiceNow application navigator find the HappySignals Service Experience application and click on the "General Properties" module.
- we have provided some defaults on the properties which work for most of our customers, but the exact configurations will depend on how you set up your organizational processes. We recommend that you start with our default set up, test and learn how things work with Service Experience and then modify the properties as needed.
- The main properties you need in order to get the Service Experience application working in your instance are described below.
Property Description Default value Happy Cloud Service end-point This is the end-point URL to your HappySignals cloud service. Generally, this looks something like: https://[your company name].happysignals.com https://support.happysignals.com/need-subscription/wow? The word for proof of origin in email functionality. This is the shared secret provided to your company by us. [none] HappySignals vendor API key This is the API key that is required for two-way integration between HappySignals cloud service and ServiceNow. ●●●●●●●
- Once you have set up these three main properties you can move on to setting up the email properties.
Setting up email properties:
Email properties determine what data is received and passed on to HappySignals cloud service from a ticket in ServiceNow when feedback is asked. We have provided defaults for most of the properties which work for many of our customers, but the exact configuration will depend on your organizational processes and the data that is available in your ServiceNow instance.
- in the ServiceNow application navigator, find the HappySignals Service Experience application and click on the "Email Properties" module.
- email properties are divided into three sections:
- general email properties, which determine the format (HTML or VML) for our feedback buttons in emails and their background colour.
- incident, which determines which fields in the incident record are used to pass data on to HappySignals cloud service.
- requested item, which determines which fields in the requested item record are used to pass data on to HappySignals cloud service.
- Incident and Requested Item sections, should contain ServiceNow field names from incident or requested item tables, that contain the data you want to pass on to HappySignals cloud service. You can also use dot walking to access related data in the record - i.e. caller_id.location.country will return the country of incident's caller. It is also possible to use literal values in the configurations by surrounding the configured value with quotation marks ("). For example, "Incident" will set the corresponding parameter's value as Incident without resolving it using incident record.
Configure email notifications:
The final step in the configuration process is to add the HappySignals email script to the email notifications where you want the surveys to be sent out.
Before you begin:
- switch your application scope to "Global"
- create a new update set in the global application scope, so you can capture and transfer email configuration changes to test and production instances later.
Now in the ServiceNow application navigator find the email notifications under "System Notifications -> Email -> Notifications"
Find and open the incident notification where your organisation wants to measure service experience. Generally, service experience is measured when the incident is resolved by a service desk agent.
Once you have found and opened the correct notification:
- navigate to the "What it will contain" -tab and look for the "Message HTML" field.
add the following mail script to the "Message HTML" field. This script will add the service experience feedback buttons to the notification email.
- the contents of the notification and placement of the script are up to you, but we hope that you take a look at our best practices on email notifications.
- once you are happy with the notification content, click on the "Update"-button (or "Save"). After the notification has been saved, you can check that the feedback buttons are showing up in the notification by clicking on the "Preview Notification"-button.
Once you are finished with the incident notification, you can repeat the process for the requested item notification. Since usually, the requested items do not have resolved state, the service experience is measured when the requested item is closed.
Now the base set up for the Service Experience is complete and it's time to test that everything works.
Make sure everything works as intended:
Testing that the Service Experience application works is fairly straight forward.
- create a new Incident in your ServiceNow instance.
- make sure the incident contains data you want to send to HappySignals cloud service.
- resolve the incident you created.
- in the ServiceNow application navigator, find email log under "System Logs -> Emails" and check that an email has been created for the incident you resolved.
- open the email and click on "Preview HTML Body". In the preview click on one of the feedback buttons and our feedback form should open to a new window or a tab. Fill out the feedback form and click "Submit" on the bottom of the page.
- Now in your ServiceNow application navigator find the HappySignals integration job under "HappySignals Service Experience -> Integration Job".
- Set the integration job to "Active", if not already. Then click on on the "Execute Now", button to fetch all new feedbacks from the HappySignals cloud service to your ServiceNow instance.
- Now in the application navigator find the HappySignals feedback list under "HappySignals Service Experience -> HappySignals Feedbacks". Open the list and check that your feedback appears on the list.
You have now tested that the feedback buttons on the email notifications are being generated correctly, the feedback is collected by HappySignals cloud service and that the integration between the cloud service and your ServiceNow instance is working correctly. For additional test cases see our examples before production use.
Remember, if you encounter any issues with the Service Experience product during or after installation, please contact us on email@example.com