Avionté Agent Manager

Overview

Updated 06/23/2021

The Agent Manager is a simple utility that handles the process of deploying job packages to Agent installations and configures environments for Agent to target. Avionté Agent is an automated, continuously-running Microsoft Windows service used to schedule background tasks

Details about Agent including its installation and update instructions can be found in the Avionté Agent article.

Agent Manager is sent to both Console and GUI users in a zip folder called Manager.zip. Manager.zip must be extracted to a local machine before executing any files (The user will always be working a local environment.) The zip folder should be extracted to the same machine running Agent.

Setup Information

External Users (GUI)

The Agent Manager is sent to a user via a .zip folder containing all of the files necessary for installation and configuration. The .zip file must be extracted to a local machine folder before executing any files from the .zip. The user will always be working in a local environment. When installing, ideally, Agent should be placed on a server other than the client's database server or the web server (which is exposed to web users.) Administrative permission is needed to access AgentManager.exe Once the .zip file has been saved to a local machine, right-click on the AgentManager.exe and click "Run as administrator"

Configurations

• AgentServiceRestartTimeoutSeconds: default 30 seconds
• This will be used as timeout in seconds when attempting to start or stop the agent service.

• LinkForwarderUrlFormat : URL format for LinkForwarder

• Logs will be generated to path below with file names starting with AgentManager
• %ProgramData%\Avionte\Agent\Logs\

• Quartz/JobTrigger related configurations as follows, these are overridden
• QuartzServerScheme tcp by default
• QuartzServerAddress: 127.0.0.1 default
• QuartzServerPort: 8081 default
• QuartzServerName: remote

GUI

A graphical user interface enables access to the Agent Manager. The left-hand panel displays instances of the MS Windows service, Avionté Agent. As options are selected from the menu in the left-hand panel, actions and fields become available in the right-hand panel. 

Element

Description

Service instances

Avionté Agent is the MS Windows service used to schedule background tasks for the Avionté application. A "service instance" refers to a particular version of Avionté Agent being managed by the Avionté Agent Manager utility.

Multiple service instances may be managed at one time with the Agent Manager. 

A service instance contains Environments and Packages. 

Add a Service Instance

1. Click the Add link next to the Service instances heading in the left-hand panel.
   
   
   
   
   
2. Fields for the additional instance will display.
    
   
   
   Populate the fields according to these definitions:
   
   

   Service name	The name of the specific instance of Avionte Agent. Each instance must have a unique name which can be inserted after "AvionteAgent-"
   Service user	The name of the credentialed Agent user creating the service instance. Only users with permission may create a service instance.  Note: To avoid user credential confusion, do not create a Service User that is any user account used by an Avionté employee to access your system. It is also recommended the Service User not be either of the general accounts "Avionté Web" or "Resource Site". Click the Browse button to search for and select service users.
   Password	The credentialed user's Agent password.

Remove a Service Instance

Uninstalls an existing service instance

Environment

 

An Environment is the name of a customer's environment in Agent. A self-hosted customer's environment will always be local. The user will always be working in a local environment.

Add an Environment

1. Click the Add environment button in the Service instance space
   
   

• Adds or updates an environment (Environments table)
• Parameters:
• name: Corresponds to Environment.Name
• connectionString: Corresponds to
• Verifies the connection string before saving changes
• Environment.ConnectionString
  
  
• Fields for the additional instance will display.
   
  
  
  Populate the fields according to these definitions:
  
  

  Avionte database	The name of the database being accessed.  Click the Browse button to open a Connection Properties GUI that is used to identify, and connect to, a specific data source.
  Environment name	The name given to the new environment.

Remove an Environment

• Removes an existing environment (Environments table and related entries in DisabledJobs and ExecutionResults)
• Parameters:
• name: Corresponds to dbo.Environment.EnvironmentName

Package

Install Package

• Adds or updates a job package (Package table)
• Parameters:
• packagePath: The path to the job package (zip) to set up
• installPath: The path to install the package into
• Uses the name of the package (file name without extension) as the "GroupName" value in Package
• Unzips the package into a sub­folder of the installPath; the subfolder name matches the package name
• Ex: If the packagePath is C:\Downloads\Suite.zip and the installPath is C:\Agent\Jobs\, the contents of Suite.zip will be unzipped to C:\Agent\Jobs\Suite\
• If the package already exists in the Package table (by GroupName), the contents of the configured Path will be zipped up as a backup and then deleted; the backup zip file remains in the Path folder

Remove Package

1. Click Remove next to the package name
   
   

• Removes an existing package (Package table)
• Parameters:
• If a record exists in Package matching the specified
• installPath: The path to the installed package installPath parameter, the files at that path are zipped up as a backup and then deleted, and the Package entry is deleted