Skip to main content
Skip table of contents

Setting up a Signature Integration

Obtaining the Signature Integration Key

The Signature Integration Key is found in Signature Agent Configuration in the Edit Company Connection on the Access tab. Customer Success Manager will work with you to get the Signature Agent Configuration installation scheduled.

  1. In Signature Agent Configuration, choose the company database and then choose Properties.
  2. In the Edit Company Connection window, choose the Access tab.
  3. Choose Show and copy the API key.
  4. In ESMS, paste the key in the Integration Key field.

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.
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.