Avionté Agent

Overview

Updated 10/22/2021

This section features summaries about Agent-related items including Agent Manager, an Agent glossary, and a list of available Agent jobs.

Agent
Agent Manager
Agent Glossary
Agent Jobs
Install Agent
    Install Agent for Suite v15.2 and Older
    Install Agent for Suite v16.1 and Newer
Update Agent
Determine Current Version
Update 15.2 and Older
Update 16.1 and Newer

Agent

Avionté employs an automated, continuously-running Microsoft Windows service called Agent. This service is used to schedule background tasks such as "CareerBuilderProcessor," which updates Career Builder job post statuses to the Avionté system once per day. 

The scheduled Agent "jobs" running behind the scenes ensure the data used and displayed in Avionté processes is current and accurate.

Agent Manager

Agent is made up of packages that contain tasks. Tasks are installed to each customer's instance of Agent with a utility called Agent Manager. Agent manager deploys job packages to Agent installations and configures environments for Agent to target.  Agent Manager is installed when the Avionté Agent is installed. 

• Click here for more information on the Agent Manager

Back to Top

Agent Glossary

Term	Description
Agent Manager Application	The software that manages environments and packages in the Avionté Agent.
Agent Software Application	The software installed for each instance.
Service Instance	A window service that is installed as  a copy of the Agent Software Application.  It is independently managed from any other Service Instance on this server. The Service Instance is named by the user performing the installation.
Environment	An environment is an Avionté Suite database. Generally, most customers have one environment used for production. Sometime a customer will have additional ones for testing upgrades (parallel) or training.
Package	Groups of software that a service instance can execute. Within each group, there are one or more agent Jobs.  Each job will run 1x per day at a particular time or multiple times per day, perhaps once a second or once an hour depending upon the nature of the activity the job needs to do.  They run unattended, like clockwork.  Typically, a group is focused on a particular piece of functionality that Avionte provides.  Avionté currently provides three different packages: Suite – Jobs used to support mostly what use to be in a feature of sql server called SQL Jobs. When Aero was crafted, additional jobs were added in support of its feature set. Greenshades – we have several customer who have chosen to use our advanced tax services and there is a job package required to use that service ACA – as part of the aca effort we identified several processes that can run in the background several times per day to run the necessary calculations needed by various steps in ACA.

Back to Top

Agent Jobs

Below are the current jobs scheduled in the Avionté Agent.

Job	Frequency	Package	Description
AcaEligibilityMeasurementProcessor	1x/hour	ACA	Responsible for calculating hours worked during a measurement period and determining whether the employee should be treated as full-time or non-full-time for the associated stability period. This job runs 1x/hour unless it finds records to process, in which case it will run for one minute then check for more records. If it finds more records the job will run again, then check for more, and so on. When no more records are recognized, the job will rest until its next scheduled time. Within the four ACA jobs (ACA Eligibility Measurement Processor, ACA Eligibility Measurement Scheduler, ACA Eligibility Remeasurement Processor, and ACA Employment Dilineator), if a job attempts to run while another is in progress, the first job will return to rest for one hour then re-attempt.  All ACA jobs will not do any work until the user completes the Benefit import process and acknowledges the errors or the user fixes all errors and acknowledges the process is complete.  At that point, the ACA jobs will start processing records and will track run statistics into the database table aca.ServiceStatus. All ACA jobs initially start at a random time followed by a frequency based on that initial start time. A job with a run frequency of 1x/hour that initially started at 3:19 a.m. will run next at 4:19 a.m. A job with a run frequency of 1x/day that initially started at 1:23 p.m. will run next at 1:23 p.m. the following day. A job executed as a result of an occurrence (e.g. multiple job executions due to a large volume of records being processed) will return to a frequency based on the job's initial run time.
AcaEligibilityMeasurementScheduler	1x/hour	ACA	Schedules initial and standard eligibility measurements based on the employer’s eligibility configuration. This job runs 1x/hour unless it finds records to process, in which case it will run for one minute then check for more records. If it finds more records the job will run again, then check for more, and so on. When no more records are recognized, the job will rest until its next scheduled time. Within the four ACA jobs (ACA Eligibility Measurement Processor, ACA Eligibility Measurement Scheduler, ACA Eligibility Remeasurement Processor, and ACA Employment Dilineator), if a job attempts to run while another is in progress, the first job will return to rest for one hour then re-attempt.  All ACA jobs will not do any work until the user completes the Benefit import process and acknowledges the errors or the user fixes all errors and acknowledges the process is complete.  At that point, the ACA jobs will start processing records and will track run statistics into the database table aca.ServiceStatus. All ACA jobs initially start at a random time followed by a frequency based on that initial start time. A job with a run frequency of 1x/hour that initially started at 3:19 a.m. will run next at 4:19 a.m. A job with a run frequency of 1x/day that initially started at 1:23 p.m. will run next at 1:23 p.m. the following day. A job executed as a result of an occurrence (e.g. multiple job executions due to a large volume of records being processed) will return to a frequency based on the job's initial run time.
AcaEligibilityRemeasurementProcessor	1x/hour	ACA	Checks for changes to information on which eligibility measurements were based then updates measurements as necessary. This job runs 1x/hour unless it finds records to process, in which case it will run for one minute then check for more records. If it finds more records the job will run again, then check for more, and so on. When no more records are recognized, the job will rest until its next scheduled time. Within the four ACA jobs (ACA Eligibility Measurement Processor, ACA Eligibility Measurement Scheduler, ACA Eligibility Remeasurement Processor, and ACA Employment Dilineator), if a job attempts to run while another is in progress, the first job will return to rest for one hour then re-attempt.  All ACA jobs will not do any work until the user completes the Benefit import process and acknowledges the errors or the user fixes all errors and acknowledges the process is complete.  At that point, the ACA jobs will start processing records and will track run statistics into the database table aca.ServiceStatus. All ACA jobs initially start at a random time followed by a frequency based on that initial start time. A job with a run frequency of 1x/hour that initially started at 3:19 a.m. will run next at 4:19 a.m. A job with a run frequency of 1x/day that initially started at 1:23 p.m. will run next at 1:23 p.m. the following day. A job executed as a result of an occurrence (e.g. multiple job executions due to a large volume of records being processed) will return to a frequency based on the job's initial run time.
AcaEmployeeSynchronizer	1x/two hours	ACA	Following the initial import of employees, this job imports new employees from the Core application database into the ACA Companion application. If this job executes while an Employee import is being performed in the ACA Companion application, this job will go back to sleep for another two hours.  Statistics for this job are not tracked in the database table aca.ServiceStatus.
AcaEmploymentDelineator	1x/hour	ACA	Determines employment start and stop dates for purposes of the look-back method of calculating average hours worked. This job runs 1x/hour unless it finds records to process, in which case it will run for one minute then check for more records. If it finds more records the job will run again, then check for more, and so on. When no more records are recognized, the job will rest until its next scheduled time. Within the four ACA jobs (ACA Eligibility Measurement Processor, ACA Eligibility Measurement Scheduler, ACA Eligibility Remeasurement Processor, and ACA Employment Dilineator), if a job attempts to run while another is in progress, the first job will return to rest for one hour then re-attempt.  All ACA jobs will not do any work until the user completes the Benefit import process and acknowledges the errors or the user fixes all errors and acknowledges the process is complete.  At that point, the ACA jobs will start processing records and will track run statistics into the database table aca.ServiceStatus. All ACA jobs initially start at a random time followed by a frequency based on that initial start time. A job with a run frequency of 1x/hour that initially started at 3:19 a.m. will run next at 4:19 a.m. A job with a run frequency of 1x/day that initially started at 1:23 p.m. will run next at 1:23 p.m. the following day. A job executed as a result of an occurrence (e.g. multiple job executions due to a large volume of records being processed) will return to a frequency based on the job's initial run time.
AcaFormBatchRunReportCleanup	1x/day	ACA	Performs a removal of all but the most recent data runs that were produced by a data generation or regeneration in the ACA Companion application's Report preparation tab. The job also deletes generated 1095 and 1094 data that is no longer needed.
AgedDataMaintainer	1x/day	Suite	Cleans out old, unnecessary data from the AdvanceQueryParameterUserValue, PaymentCheckDeductionTemp, SessionItem, TransactionSelectionBatchItem, QuickPlace, and QuickPlaceSession tables.
AssignmentProcessor	1x/day	Suite	Processes assignment-related cleanup in the asg_SetActiveAssignmentSchedule stored procedure.  The task also manages EndDates and IsActive settings on assignments.  It also closes some assignments that may be in error when there are duplicates.
BackgroundCheckReportRetriever	1x/hour	Suite	Retrieves pending background check reports for plugins that support the pull strategy.
CareerBuilderProcessor	1x/hour	Suite	Updates the local job posting status.  Retrieves any candidates who have applied since the last task.
CustomerProcessor	1x/day	Suite	Updates the FinancialSummary report.  Computes HighLimits if configured. Processes finance charges by rebuilding the FinancialSummary table each time it runs by using: fs_GetCustomerFinancialSummaryAR fs_GetCustomerFinancialSummaryOrderAsgCount fs_GetCustomerFinancialSummarySales
EmployeeAcaProcessor	1x/day	ACA	Determines if an employee is eligible for group health coverage based on ACA regulations
EmployeeAcaUpdater	1x/day	ACA	Determines if an employee is eligible for group health coverage based on ACA Regulations.
EmployeeProcessor	1x/day	Suite	Updates EmployeeRecordType based on settings.
EVerifyResolutionProcessor	1x/hour	Suite	Pulls back any new case resolutions.
LegacyResumeMigrator	Every 15 seconds	Suite	Migrates the most recent legacy resume (not Aero-parsed) of any employee that has not had a resume parsed through Aero. Named "Non-Aero Talent Sync" prior to 16.1. As of 16.2, searches for any resume that has been parsed into the system, but has not yet been previewed. This task is performed so that, when a user does want to look at that resume, the Quick Preview will already be available and the user will not have to wait for the display to process.
MassMailScheduleProcessor	1x/day	Suite	Schedules Mass Mail messages to be sent.
MassMailSender	1x/min	Suite	Sends requested Mass Mail messages.
MonthlyCoverageOfferGenerator	1x/hourly	ACA	Takes the health care plan offers made to employees and splits their enrollments and declinations into individual months for the employee and their dependents.  The data generated is used to fill in monthly coverage areas on the 1094-C (lines 23-25) and the 1095-C (lines 14-22). The job also calculates: the lowest eligible employee contribution the "best" offer of coverage code and safe harbor code whether the employee was enrolled in one or more plans for the month if the enrollment dates cover the entire month whether the offer(s) made to the employee would cover that entire month. This job runs 1x per day, however, if it has more records to process, it will run for one minute then check for more jobs.  If more records are recognized, the job will run again for one minute. This will continue until all work is done at which point, the job will rest until its next scheduled time. Statistics for this job are not tracked in the database table aca.ServiceStatus.
MonthlyStatementLetterSender	1x/day	Suite	Sends monthly statements on open invoices. Processes finance charges by calling: Inv_ProcessOverdueCustomerInvoices Inv_GetCustomersWithInvoiceBalance to build the invoice data.
OrderProcessor	1x/day	Suite	Processes order related cleanup in ord_ProcessOrderStatus sproc.
PeoplenetListener	1x/min	Suite	Pulls down pay files from Peoplenet along with any errors.
PeoplenetSender	1x/day	Suite	Resends all order assignments with a Peoplenet clock.

Back to Top

Install Agent 

Agent was originally created without Agent Manager, a companion utility that enables the management of Agent environments and packages. Agent Manager became available with the 16.1 Suite release. Suite versions 15.2 and older require a different installation process than Suite versions 16.1 and newer.

Back to Top

Install Agent for Suite v15.2 and Older

Use these steps to install Avionté Suite which contains Agent. Agent Manager is not used with Suite versions 15.2 or older.

1. Avionté will place a copy of the Suite installer on the client FTP. Double-click the installer file to begin the Avionté Foundation Setup process. 
   
   
2. The  Destination Folder window displays with a default address in the field. Click Change to browse for a different location. Click Next to accept the location and prompt the next screen.
   
   
   
   
3. The Database Connection Information window displays with auto-populated server and database fields. Click Build Connection and ensure the connection to your database is properly configured.
   
   
   
   
4. On the Connection Properties dialog, ensure the correct server name and database information has been entered.

• Click Test Connection to ensure the settings are valid.
• Click the Use SQL Server Authentication radio button to use a SQL user name and password instead of Windows Authentication (which doesn't require a password in this setup.)
• Enter a User name.
• Enter a Password.
  
  
• Click OK to return to the Database Connection Information window.
  
  
  
  
• Click Next to on the Database Connection Information window to proceed.
  
  
• The Service User Account window displays. By default, a check mark is placed in the Use Local System Account check box. To use a different account, remove the check box and browse for a different account. Enter a User name and Password. Click Next.
  
  
  
  
• The Setup Code Details window displays. Enter the Setup Code supplied by Avionté.
  
  
  
  
• Click Next. 
  
  
• The Ready to install Avionté Foundation window displays. Click Install. 
  
  

• If subsequent windows installation windows prompt from the computer, click Yes.
  
  
• The Completed the Avionté Foundation Setup Wizard window displays. Click Finish.
  
  
  
  
• Confirm the installation.

• Agent installation can be confirmed in a variety of areas on the PC
• Windows folders installation location
  
  
  
  
• Windows Services window
  
  
  
  
  
• Windows Programs and Features
  
  

Back to Top

Install Agent for Suite v16.1 and Newer

Use these steps to install Agent and Agent Manager if the Suite version is 16.1 or newer.

1. Avionté will place a copy of the Agent installer in the Tools folder and all client-appropriate Agent packages in the Job Packages folder on a client's specific FTP site. Download the Tools folder and the Job Packages folder to a local machine. 
   

• 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.)
  
  
• Open the Tools folder. 
  
  
• From the Tools folder, open the Agent folder.
  
  
• From the Agent folder, open the available version of Agent.
  
  
• Open the Avionte.Agent.Installer.msi file. This is the file that will install Avionté Agent and Agent Manager.
  
  
• Follow the on-screen steps to select your server and a database designated for the Avionté Agent. It is recommended that this database is named "AvionteAgent."
  

• 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.) For more information, visit the
  • Click here for more information on Avionte Agent Manager.
    
    
• Following the on-screen steps, a prompt will ask to launch Agent Manager. Click Launch Agent Manager.
  
  
• The Avionte Agent - Getting Started window displays. In Area 1, the name of the chosen database is displayed in the first field. This is the database used by Agent Manager. Click Browse to access your Connection Properties to configure the Agent Windows service that will be located in the database.

• This is known as a "Service Instance." The name of the instance will include the prefix "AvionteAgent-" followed by the name of the service.
  
  
  
  
• In Area 2, Click Browse to select a user that the service instance will use to run.

• The recommended practice is to create and use a new service user - a username not used by a human.
  
  
• Enter a password in the Password field.

• The password must match the password recognized by the directory.
  
  
  
  
• In Area 3, the first package to be installed will be selected. Click Browse and navigate to the Job Packages folder. Select the Suite job package. 
  
  
  
  
• Navigate to the Job Packages folder placed on your FTP site.
  
  
  
  
• Select the Suite package.
  
  
• Click Install. The Avionté Agent Manager application is now displayed with the Suite job package displayed in the tree directory to the left. 
  
  
  
  
• To add a subsequent package, click Install package. 
  
  
• Click Browse and navigate to the Job Packages folder on the FTP site.
  
  
• Select the next job package to be installed (i.e. ACA or Greenshades).
  
  
• Click Install. The newly installed job package appears in the tree directory on the left.
  
  
  
  
• Confirm the installation.

• The installation of Agent can be confirmed in more than one way.
• Access the PC's Services window. In the image below, two versions of Agent (old and new) are installed.
  
  
  
  
• Access Programs and Features to view multiple instances of Agent currently installed (older versions of Agent are part of Avionté Foundation).
  
  

Notes

With version 15.2 of the Core application, database migrations will install a database used by Agent.  The data within this database should be backed up by the customer.  This should not be directly modified by an Avionté DBA. Agent is responsible for adding and removing entries from here and it is possible to cause these agent jobs to enter a failure state if the data is tweaked at unexpected times or tweaked with invalid values. Additionally, certain jobs are not intended to be run and it is possible to inadvertently initiate these jobs which may be destructive to the running system.

Self-hosted customers should add a windows scheduled task to restart Agent once per day.  This should be done before the tasks start running at night which is typically around 11:00 p.m. local time.

• Click here for more information on the Avionté Agent Manager 

Back to Top

Update Agent

Agent packages and Agent itself may occasionally need to be updated in order to support new functionality. For instance, with the deployment of the ACA Companion application package, Agent version 1.2 is required. If you are running a version of Avionté Core application older than Suite 16.1, a new version of Agent will need to be installed. If you have Avionté version Suite 16.1 or newer, you will need to update your existing Agent.

Version	Prerequisites
ACA Package requirement - 16.1 and newer	Update Avionté Agent to the most recent version,Version 1.2.  Install the ACA Agent Job package to Avionté Agent. Click here for more information on the Avionté Agent Manager.
ACA Package requirement - 15.2 and older	Download the newest version of Avionté Agent, Version 1.2. The old version of Agent and the new version will run side-by-side. The old version of Agent contains specific Avionté core application jobs that will not be duplicated when the new version of Agent is downloaded.  Install the ACA Agent Job package to the new Avionté Agent (just downloaded). Click here for more information on the Avionté Agent Manager.

Back to Top

Determine Current Version

There are a variety of ways to determine the version of Agent installed.

• If you are able navigate to the “Agent” directory and view the “Avionte.Suite.Win.Agent.exe” file, then you have an older version of Agent.
  
  
  
  
• For newer versions of Agent, the default destination folder is "C:\Program Files (x86)\Avionte\Agent" and in the "Service" subfolder you will see the "Avionte.Agent.Service.exe" file.
  
  
  
  
• You can see that Agent is available by looking in the Services snap-in that is built into Windows.
  
  
  
  
• You can also see that Avionté Foundation (Agent is a part of this) is installed if you go to Programs and Features.
  
  
  
  
• As with older versions of Agent,  newer versions of Agent are available by looking in the Services snap-in.
  
  
  
  
• And by looking in Programs and Features.
  
  

Back to Top

Update 15.2 and Older

When new versions of Suite are pushed out to the customer, Agent should be automatically updated if there were any updates that are in that release. The new version is available from the FTP site. Packages are a concept introduced when Agent was split apart from Suite, so customers don’t need to update packages.

Back to Top

Update 16.1 and Newer

Once an update for Agent is placed on the FTP site, open the installer.msi file and go through the standard installation described above. Updated packages are made available on the FTP as well. The updated packages are installed with Agent Manager.

Back to Top