Help Center

Local Agents

The Local Agents page in Syncrofy allow you to view the status of each local agent present within the system. Administrators, or users with the required “Permissions,” can register, edit, refresh/test, configure local agent details, and add/remove connectors.

 

Managing Local Agent Version

  1. Click the User icon and the "Settings" link.
  2. Under “Company Settings,” select "Local Agent."
  3. The "Version" panel at the top left of your screen will allow you to manage your local agent's version with the following options:
  • Auto-Update button: Allows you toggle between enabling Syncrofy to automatically update to the latest local agent version or allowing you to do it manually. "You're up to date" indicates you have the latest version.
  • Version: Displays the current version of the local agent.
  • Last Update: Displays the date, time, and who carried out the last local agent update.
  • Auto-Update: Indicates whether this function is turned off/on. 

Viewing and Testing Local Agent Connection Status

  1. Click the User icon and the "Settings" link.
  2. Under “Company Settings,” select "Local Agent."
  3. The "Connection" panel at the top right of your screen will allow you to view the local agent's connection status and will display the following information:
  • Local Agent to Cloud: Displays the current connection status from local agent to the cloud.
  • Cloud to Local Agent: Displays the current connection status from cloud to local agent.
  • Last Ping: Displays date and time of last contact between the local agent and cloud.

Note: To refresh the connection to re-test it, click Refresh in the upper right-hand corner of the "Connection" panel.

 
Deleting a Local Agent

  1. Click the User icon and the "Settings" link.
  2. Under “Company Settings,” select "Local Agent."
  3. Click the Delete Local Agent button in the upper right-hand corner of the screen.
  4. The Local Agent is now deleted. 

Note: To recover a deleted Local Agent, please contact support@syncrofy.com

Advanced Options

You can view the configuration of your local agent including technical details, related exceptions, and connectors. 

  1. Click the User icon and the "Settings" link.
  2. Under “Company Settings,” select "Local Agent."
  3. The "Advanced" panel at the bottom of your screen will allow you to view and manage technical details pertaining to the local agent. They include:
  • URL: Web address of the local agent.
  • API Connection: Port numbers of the local agent.
  • Exceptions: Directory path where exceptions are located.
  • Database: The name, address, username, and password of your local agent's database.

To edit the above information, click the Edit Details button on the right side of the "Advanced" panel. Enter the desired changes into the text boxes. Then, click the Confirm Changes button to save.


Managing Connectors

You can view the details of the local agent connectors including name, type, created on date, and status.

  1. Click the User icon and the "Settings" link.
  2. Under “Company Settings,” select "Local Agent."
  3. The "Advanced" panel at the bottom of your screen will allow you to view and manage local agent connectors (below "Details").

To delete a connector, click the Delete icon to the right of the "Created On" date. To add a new connector:

  1. Click the Add Connector button on the right side of the "Connectors" page.
  2. Select the connecter "Type" from the dropdown menu. 
  3. Then, type in the "Name" and "Path" in the provided text boxes.
  4. Click the Add Connector button to save.