Setting up a ServiceChannel Integration

Obtaining the ServiceChannel Client ID and Secret for ESMS

To set up the ServiceChannel integration in ESMS, you will need to retrieve the ServiceChannel Client ID and Client Secret that is automatically generated when you register a new app client in ServiceChannel. 

The WennSoft ESMS client must be registered with ServiceChannel by an Administrator.

1. In ESMS, choose Click Here in the ServiceChannel integration setup page to access the Service Channel Admin Integration Access page or in your web browser go to https://sb2login.servicechannel.com/account/logon?&returnUrl=http%3a%2f%2fsb2.servicechannel.com%2fsc%2fAccount%2fLogOn%3freturnUrl%3d%2fsc%2fadmin%2fintegration%2fapiaccess.
2. Enter your ServiceChannel admin login credentials and choose Login.
3. On the ServiceChannel App Registration page, choose Add new client.
4. In the Add API Client Info window, enter the following information:
   • Product Name - Enter a name for the WennSoft ESMS integration. 
   • Callback URI - Enter the following URI:  https://admin.key2act.me/integrations/89df02aa-da3e-4c30-b707-c429b7565a34/oauth-callback

5. Verify that Mobile Application is unchecked.
6. Choose Save.
7. The Client ID and Client Secret for the API Client are displayed on the screen. 
8. You will need to copy and then paste the ID and Secret into the appropriate fields in the ServiceChannel Integration in ESMS.

Setting up the Integration

1. Log into ESMS.
2. In Admin, choose the Integrations icon from the navigation pane.
3. Choose MANAGE to the right of the application to be integrated.
4. Choose CONFIGURE INTEGRATION.

5. Complete the field(s).

   

   The Integration Name is primarily for your use. Only the Client ID, Secret, and/or Keys are unique identifiers specific for your organization.

6. Choose CONFIGURE. 
   The app drawer located at the top left updates to include the newly-integrated applications.

Verifying Signature Agent Entity Triggers

This integration requires that the following entities in Signature Agent to be turned on. The entity trigger allows Signature Agent to push entity data to the ESMS database any time a change is made in the system that affects that entity. GP Customer, Location, and Equipment are tied to an ESMS Client, Site, and Equipment, respectively. ESMS maintains the Signature hierarchy so that if a change is made to a Signature Equipment, the parent Location and Customer will also be created in ESMS and linked to the proper ESMS entity.

• Appointment

• Equipment

  

  The Equipment Type is set to OTHER in ESMS.

• GP Customer
• Location
• Service Call
• Service Option
• Technician

Changes made in ESMS will not overwrite data in the source application. Likewise, changes in Signature will not overwrite ESMS-specific data such as Client Name, Client Address, Site Name, Site Address, ESMS Equipment Name, and ESMS Equipment Type.

To verify the triggers are turned on:

1. Log into Signature Agent Configuration.
2. Choose the CDC Configuration tab.
3. Expand the database and then choose the company.
4. Choose the entity trigger and then choose Start.

The Signature Integration must also be set up to automatically populate Signature data into ESMS.