Install Dataedo Agent

To use the Scheduler, you need to configure the Dataedo Agent first.

All task schedules are created and managed through the Portal. The Agent listens for these scheduled executions and performs them using Dataedo Desktop on the backend. The Agent must run in the background for scheduled tasks to execute.

Dataedo Agent is a Windows service that you can set up with a dedicated installer. It is responsible for:

• Creating executions from planned tasks,
• Performing executions,
• Sending execution results and error logs to the Portal,
• Allowing the Portal to display clear error statuses and stack traces for failed tasks,
• Managing Agents (for example, removing inactive Agents from the repository).

caution

Currently, only one Agent per repository is allowed.

Installation on Windows

Dataedo Agent can run on either Windows or Docker. This section will explain the Windows installation.

Prepare an encrypted connection string

During the installation, you will be asked for a connection string to your repository. The connection string will include both the repository connection details and the account used to connect.

For security reasons, Datedo encrypts the connection string. You can obtain the encrypted connection string either from:

• Dataedo Portal's System Settings page

• From the login form in the Recent connections screen - right-click on the repository you would like to use and click on the Copy encrypted connection string option.

Windows account

The agent requires a local Windows account with Log on as a service permission to run the service. To add the permission to an existing account, follow the steps mentioned in the Microsoft System Center article Enable Service Logon.

If the connection string uses Windows Authentication, ensure the service account has access to the repository database. It should be assigned to the USERS within the database.

Installation process

After preparing the connection string, run the installer as an administrator.

Accept the license to continue.

Choose either the default or a custom installation path for the Agent. If using a custom path, avoid protected folders such as Program Files or the Documents folder.

When prompted, provide the connection string. The app will display the details used for the connection.

Choose whether you want the Agent service to run using a preexisting account or to create a new one. If the account doesn't have the Log on as a service permission, the installer can grant it directly.

Provide the account username and password.

Choose the name for the Agent service.

Wait for the installation process to finish and the service to start.

After the installation finishes, the installer will confirm that the Agent is up and running.

Troubleshooting

View Error Details in the Portal

To review error details:

1. Open the Portal.
2. Go to Connectors > Schedule.
3. Locate the failed task in the Calendar.
4. Expand the task and select the History tab.
5. Click Check error details to view the message and stack trace.

Cancellation Pending Status

When you cancel a scheduled task in the Portal, it will show as "Cancellation pending" until it reaches a safe stopping point. This status improves visibility but does not mean the task has stopped immediately.

Updating

Use the Installer's Update option to install a new version of Agent.

Modifying the configuration

To modify the Agent's configuration, run the Agent Installer and choose the Configure option.

Select the instance you want to modify:

Choose the setting you want to modify:

Then provide the new settings.

Restarting

You can restart the Agent service by manually stopping and starting it.

Stopping

You can stop the Agent service in two ways:

• Run the Command Prompt with administrator privileges and type SC STOP "Dataedo Agent".
• Open Windows Services, find the service called Dataedo Agent, right-click it and select Stop from the context menu.

Starting

You can start the Agent service in two ways:

• Run the Command Prompt with administrator privileges and type SC START "Dataedo Agent".
• Open Windows Services, find the service called Dataedo Agent, right-click it and select Start from the context menu.

Uninstalling

To uninstall Dataedo Agent, use the Uninstall option in the Dataedo Installer.