Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

« Previous Version 11 Next »

Launch Signature Agent Configuration

This is the user interface that is used to configure the CDC and Event triggers.

  1. Launch Signature Agent Configuration.
  2. On the Login window, enter the following information:
    • SQL Instance
    • Authentication
    • Login
    • Password
  3. Select Login. 
  4. The Signature Agent Configuration is divided into two tabbed sections:
    • Home: The Home tab is where Signature Agent is configured.
    • CDC Configuration: The CDC tab is used to set up the CDC for the database for capturing state changes to the database tables.

Set up Change Data Capture (CDC) Configuration

Creating the CDC change options is the first step in setting up Signature Agent.

  1. In Signature Agent Configuration, select the CDC Configuration tab.
  2. In the Name column, expand the Dynamics GP database.
  3. Select the company database.
  4. Select Create Objects to create the CDC change options that are listed on the right side of the window.
  5. The following entities are available:
    • Appointment
    • Equipment
    • GP Customer
    • Job
    • Job Cost Code
    • Location
    • Service Call
    • Service Option
    • Technician
  6. To enable an entity, select the entity name and then select  Start from the menu bar. For example, enable Job to track changes to the job tables for job appointments. To disable an entity, select  Stop from the menu bar.
    • Enabled entities are indicated with a green  icon.
    • Disabled entities are indicated with a red  icon.

Configure Signature Agent

Each company that will be used with Signature Agent Configuration will need to be set up by associating the company to a Signature Agent Service that will be monitored for changes.

  1. On the Home tab, create a new company by choosing New Company or choose an existing company.
  2. From the menu bar, select Properties.
  3. In the Edit Company Connection window, complete the following tabs:
    • Database
    • Access
    • Company Info
    • Dispatcher Email
    • Maintenance

Database Tab

Enter the company database settings.

  1. Enter the Company Name. This is only used for the display name in the Tenant tree to the left.
  2. Enter the Database Name or choose Browse and then select the company database.
  3. Enter the database Username and Password.
  4. Select Test Connection to verify that the database settings are correct and can connect to the database. You will be prompted to save the settings prior to the test running. 
  5. The Access Key is generated at this time and can be found on the Access tab.

Access Tab

  1. Select Show to view the Incoming Access Key and the API Key.
    • The Incoming Access Key is generated by the database once the company is saved prior to testing the configuration. This key is used as a unique identifier. 
    • The API Key is automatically generated from Key2Act.

  2. The Email Alias is the email address that your customers will use when sending an email to create a service call. For example, if you create an alias of Fabrikam, your customers would send an email for a service to fabrikam@servicerequests.io.

  3. You can select the Agent Service drop-down to perform the following service options. These options are also available from the menu bar on the Home tab.
    • Install Service
    • Uninstall Service
    • Reinstall Service
    • Restart Service

Company Info Tab

Enter the company information that can be included in some of the communications.

  • Company Name
  • Company URL
  • Address
  • City
  • State
  • Zip
  • Phone Number
  • Email

Dispatcher Emails

Mark the Dispatcher email address checkbox(es) to indicate where notifications of service call updates should be sent. 

The email addresses displayed are set up in the User Roles section of Schedule Administrator Settings.

Maintenance Tab

This section is used for setting up a Maintenance Schedule. The Next Scheduled Eventing Pause is used to stop Signature Agent from accessing the database.

  1. Select Edit.
  2. In the Eventing Schedule Editor window, create an optional schedule to pause the Eventing Engine.
    1. Select Weekly or Monthly.
      • Weekly - Select the day(s).
      • Monthly - Select the day number and the frequency.
    2. Select the Time of Day and Frequency.
    3. Enter the Duration (Hours).
  3. Select Preview to view what the next 10 occurrences would be based on the setup. Select OK to return to the Eventing Schedule Editor.
  4. Select OK. The Tenant tree now displays the company and automatically creates Event Triggers.

View the Log File

Select View Event Log from the menu bar to view the log.txt file that displays information about trigger events. For example, an email for service was received and a response is sent out.


  • No labels