Installing 1E DataSync Agent

The DataSync Agent enables your 1E SaaS instance to retrieve data from on-premises sources. Installation and configuration of the 1E DataSync Agent are necessary if you use any of the following components in your 1E Platform instance:

• Content Distribution

• Virtual Desktop Experience

Requirements

You will need the following items before you can start the installation.

"ProxyEnabled": true,
"ProxyUrl": "http://10.20.30.43:80"

msiexec /i DataSyncAgent.msi PROXY_ENABLED=1 /qn <rest of command line>

Preparation

To install the DataSync Agent, you'll need the MSI installer and the following information from 1E. You can download the installer from the 1E Support Portal. The parameters are included in one or more TXT files provided during the SaaS provisioning process. Typically, 1E supplies one TXT file for each Sync use case. All parameters are required.

Interactive installation

To run the installation interactively, log on to the host computer using the installation account, then start the installer.

1. Run the DatasyncAgent.msi.

2. On the Welcome screen, click Next.

   

3. On the End-User License Agreement screen, check I accept the terms in the License Agreement, and click Next.

   

4. On the DataSync API Parameters screen, enter the parameter values you have been provided, and click Next.

   

5. On the Data Source Connection Details screen, enter the parameter value that you constructed earlier, and click Next.

   

6. On the Ready to install 1E DataSync Agent screen, click Install to begin the installation.

   

7. On completion, click Finish to close the installer.

8. The DataSync service will be installed as 1E DataSync Agent and run under the Network Service account.

Silent installation

1. To run the installation silently, log on to the host computer using the installation account.

2. Download the latest DataSyncAgent.msi.

3. Start the installer using a command line similar to below. You should have been given a TXT file with the command line you need for installing a single DataSync Agent supporting a single Sync. However, you must first reconstruct the SQL_SERVER_DATA_SOURCES parameter by replacing the placeholder text using the guidance in Preparation.

   Copy

   msiexec.exe /i DataSyncAgent.msi /l*vx DataSyncAgent.install.log /qn DATA_SYNC_API_URL=https://prod-datasyncsvc1e.azurewebsites.net/ AUTH_SERVICE_URL=https://prod-authservice1e.azurewebsites.net/ CLIENT_CERT_TOKEN=<token> SQL_SERVER_DATA_SOURCES="CMSync|ACME-CM01.acme.local|CM_CAS" PROXY_ENABLED=1

   The installer will automatically detect and configure your system proxy.

   If your environment uses a proxy server, it's recommended you use a command like the example to enable proxy server mode for the Data Sync Agent during installation. Otherwise, the traffic might not recognize the proxy settings.

4. The service will be installed as 1E DataSync Agent and run under the Network Service account.

Upgrade

To upgrade an existing installation:

1. Ensure the current DataSync Agent is running.

2. Run the upgrade command using the relevant command line (No token required). For example:

   Copy

   msiexec.exe /i DataSyncAgent.msi /l*vx DataSyncAgent.install.log DATA_SYNC_API_URL=https://prod-datasyncsvc1e.azurewebsites.net/ AUTH_SERVICE_URL=https://prod-authservice1e.azurewebsites.net/ SQL_SERVER_DATA_SOURCES="CMSync|ACME-CM01.acme.local|CM_CAS" PROXY_ENABLED=1

3. The upgrade will keep your existing settings, and no token is required.

Verify your installation

1. Check if the 1E DataSync Agent service is running:

   Copy

   Get-Service -Name "1E DataSync Agent"
   

2. Verify your proxy settings in: %ProgramFiles%\1E\DataSyncAgent\appsettings.json

3. Confirm certificate validity:

   Copy

   $certPath = "C:\ProgramData\1E\DataSyncAgent\Certs\ClientCert.p12"
   $cert = New-Object System.Security.Cryptography.X509Certificates.X509Certificate2
   $cert.Import($certPath)
   $cert.NotAfter

Post installation

1. Once the installer finishes it will have created a Windows service for the Agent called 1E DataSync Agent.

2. The service will start immediately and start sending data from the specified sources.

3. The first sync is full, afterward only differences are synced. The Agent maintains a snapshot for each dataset at:

   %ALLUSERSPROFILE%\1E\DataSyncAgent\Snapshots\{syncname}\{dataset}

Review Agent logs

You should review the installation and service logs for errors. Unless otherwise specified on the command-line, the Agent installer creates an installation log in the %temp% folder of the logged on user. The DataSync Agent service log file is created by default at:

%ProgramData%\1E\DataSyncAgent\Logs\DataSyncAgent.log

The log shows details of each Sync cycle:

• The frequency of each cycle depends on the Sync use-case. The cycle starts when the Agent is started.

• Within each cycle, there are pairs of entries for each data set, saying Syncing data set and Done syncing data set in HH:MM:SS.SSSSSSSS.

• Syncing data set does a SQL query then uploads events. If there is an issue with the SQL query, an entry is displayed showing the query and the error, and the process moves onto the next data set.

• Done syncing indicates events for the data set have been uploaded, and either says No events sent if no new data, or lists the types of new events (Truncates, Inserts, Updates, Deletes, SnapshotCompletes).

Device grooming

The 1E Platform can execute a device grooming task that removes devices which haven't connected to the platform within a specified number of days (99 days by default). When devices are groomed, a deletion event is triggered. To utilize this feature, you need to request its activation for your platform instance, with values tailored to your organization's needs.