AvePoint Docs
Contact support
Contact support
English

Home > Settings > Register Agents

Export to PDF

Register Agents

The Agent management page allows you to register agents to connect AvePoint Opus to on-premises content sources (File System servers and SharePoint On-Premises) to access and manage the content.

Click the Guidance (Icon: Guidance) icon to view the procedures for connecting AvePoint Opus to on-premises content sources.

When a new agent version is available, a notification will appear in Notifications (Button: Notifications). It is recommended that you update agents to the latest version to enhance performance and ensure access to new functionalities.

Generate and Download Certificate

AvePoint Opus supports the use of private and public key pair certificates, and they are both automatically generated by AvePoint Opus.

Refer to the following steps to prepare the certificate:

  1. Click Certificate.

  2. Click Generate certificate to automatically generate a new certificate.

  3. *Note: The newly generated certificate will become the default certificate for all newly registered agents.

  4. Click the Download (Button: Download) button to download the public key certificate and then use it to register an AvePoint app in AvePoint Online Services > Administration > App registrations.

  5. To change the default certificate that will be used by all newly registered agents, select the default option next to the certificate.

  6. To upload the default certificate to all active agents in the system, click Upload to all agents.

    *Note: For the inactive agents, you need to re-register agents to connect with the content sources.

  7. If a certificate has expired or is no longer useful, click the Delete (Button: Delete) button next to the certificate and then click OK to confirm the deletion.

Get Application (Client) ID

After registering an API app in AvePoint Online Services, copy the application (client) ID of the app and then click Client ID to specify the client ID.

Register Agent

Refer to the following steps to register an agent to connect AvePoint Opus to on-premises content sources:

  1. Click Register Agent.

  2. Enter the agent's name and an optional description.

  3. Select the content source that you would like to connect AvePoint Opus to:

    *Note: One server can have only one agent installed. If the File System server is also a SharePoint web front-end server, you can select two content sources here. Otherwise, please register multiple agents to connect different content sources separately.

    • File System

    • SharePoint On-Premises

  4. Click Save to register an agent.

Agent status and the operations you can perform on an agent are detailed as below:

- **Not** **installed** – This status will be displayed after you register an agent in AvePoint Opus. You can click **Delete** to delete the agent. - **Active** – This status will be displayed after you install and configure an agent on a File System server. You can click **Disable** **agent** to disable the agent. - **Disabled** – This status will be displayed after you disable an agent. You can click **Delete** to delete the agent, or click **Enable** **agent** to enable the agent. - **Update** **required** – This status will be displayed when a new version with a different major release identifier is available. For example, the agent version is 13.*x*.*x*.*x*, and the new available version is 14.*x*.*x*.*x*. You need to download the installer to update your agents to the latest version. Make sure there are no running jobs while updating the agents. If a new version with a different minor release or update identifier is available, you can choose whether to update your agents. - **Active with** **exception** – This status will be displayed when the server where the agent has been installed is not a SharePoint web front-end server. As a result, AvePoint Opus cannot connect to your SharePoint On-Premises environment.

Generate and Download Configuration File

After registering an agent, click the Download configuration file link next to the agent. Copy the installation code and then click Download to download the configuration file and keep it locally. A configuration file is automatically generated per agent. The configuration file, together with the installation code, is required during the agent installation and configuration.

Download Installer

Click Download installer to download an agent package and then complete the agent installation and configuration.

The following table lists the system requirements of the agent server for File System.

ComponentsRequirements/AvePoint Recommendations
Operating System EditionWindows Server 2012 R2 DatacenterWindows Server 2016 StandardWindows Server 2016 DatacenterWindows Server 2019 Datacenter
Number of CPU Cores64-Bit, 4 Cores
Available Physical MemoryRecommended: 8 GB or above
Available Disk SpaceRecommended: 60 GB or above
NetworkingThe agent server has a network connection with AvePoint Online Service and AvePoint Opus, and can connect to the File System by UNC path.
.NET Framework Version.NET Framework 4.8 or above
Transport Layer Security (TLS) VersionTLS 1.2 is enabled.

Refer to the following steps to install and configure an agent:

  1. Copy the agent package to the server to which you want to connect AvePoint Opus for File System/SharePoint On-Premises records management.

    *Note: For SharePoint On-Premises, make sure you install the agent to the SharePoint WFE (Web Front End) Server.

  2. Click the CloudAgentDownloader.exe file.

  3. In the Welcome to Agent Installation Wizard step, click Start.

  4. In the License agreement step, select the I accept the terms in the license agreement checkbox, and then click Next.

  5. In the Installation location step, select a location to install the agent to, and then click Next. By default, the installation location is C:\Program Files\AvePoint. You can click Change to select another location.

  6. In the Prerequisites check step, wait until the prerequisites check has passed, and then click Download agent.

  7. After the agent package download is complete, click Install to install the agent.

  8. After the agent is installed, click Start configuration to start the agent configuration.

  9. In the Agent configuration step, choose whether to connect using a proxy server. If you choose to use a proxy server, specify the proxy host, proxy port, and user account credentials. Click Next.

  10. Browse the agent configuration file, enter the installation code, and then click Next.

  11. Enter the agent account name and the password, and then click Next.

    *Note: Make sure the agent account has the required permissions. For detailed instructions, refer to Permissions for the Agent Account.

  12. After a message appears indicating that you have successfully installed and configured the agent, click Finish to exit the wizard.

  13. Navigate to AvePoint Opus > Agent management, and then click Refresh. The agent status is updated to Active.

After installing and configuring an agent, you can update the agent configuration file or the agent account information. Open the Start Menu on the machine where the agent is installed, and then find the Cloud Agent Configuration Tool to update the agent configuration file or the agent account information.