Workers

Workers are locally installed, registered machines that can process the work items added to the queues of a remote agent. The workers request work items from the remote agent. The remote agent sends workers work items from the queues. When the workers are done, they return the completed work items back to the remote agent.

The number of workers and queues you can have for the dedicated bot remote worker is determined by your license.

Installing and Registering a Worker

System requirements

Windows 10, Windows 11, Windows Server 2016, Windows Server 2019, or Windows Server 2022
Microsoft Visual C++ 2017 Redistributable (x64) -14.11.25325
Microsoft Visual C++ 2017 Redistributable (x86) -14.11.25325
.NET 4.7.2 or later

Components included on installation

Remote Workers: These workers are used with general remote agents that contain the Remote Agent Web Service Plugin, the Laserfiche Remote Data Source Plugin, or the Remote Script Source Plugin.
Bot Worker: This worker is only used with the Dedicated Bot Remote Agent that contains Laserfiche Bot Remote Process Plugin.
Laserfiche Worker Configuration Tool: This tool allows you to register and deregister workers.

Services installed

**Services Installed**
Component Name	Service Name	Service Display Name
Remote Worker 1	LFPALocalAgent	Laserfiche Remote Worker 1
Remote Worker 2	LFPALocalAgent2	Laserfiche Remote Worker 2
Remote Worker 3	LFPALocalAgent3	Laserfiche Remote Worker 3
Bot Worker	LFPABotAgent	Laserfiche Bot Worker

Installing workers

On the configuration page for your remote agent, click the Workers tab in the top left.
Under Installation Instructions, select Download. This will download an executable file to your computer.
Run the setup.exe file. This creates a Windows service that automatically performs work when your machine starts up.

If you downloaded the file from the Dedicated Bot Remote Agent, select Bot Worker Installation. If you downloaded the file from another remote agent, select Remote Worker Installation.
In the installation wizard's Welcome step, click Next.
Read the terms of the End-User License Agreement. If you agree, select I accept the terms in the License Agreement and click Next.
In the Choose Setup Type step, select the workers you want to install. You can install up to three remote workers and one bot worker.
Optional: Configure where the workers will be installed, next to Install directory.
Click Next.
In the Laserfiche Service Settings step, specify the credentials the workers will use. Click Next.
In the Ready to Install step, click Install to start the installation process.
In the Prerequisites step, a green check will appear next to installed items and a red X will appear next to items that have not been installed. If one or more of the items on the list has a red X next to it, install that item and then click Retry. Alternatively, select Bypass Prerequisites and click Next.

Important: Bypassing prerequisites may cause workers to function incorrectly and is not recommended.

If all the items installed successfully, click Next.
Click Finish to exit the installation wizard. The Laserfiche Worker Configuration Tool will start by default.

Configuring workers

The Laserfiche Worker Configuration tool lets you register the worker to the remote agent pool. You can launch this tool from the last page of the installation wizard or from the Windows Start menu.
In the Laserfiche Worker Configuration tool, click the Register worker button next to the worker you want to register.
Choose how you want to register the worker:
- Generating a registration token: Navigate to the Worker tab of the remote agent's web page in Laserfiche Cloud. Click Generate new registration token at the bottom of the installation instructions, and copy the token. Then, in the Laserfiche Worker Configuration tool, enter your Laserfiche account ID number and the token, and click Register.
- Signing into Laserfiche: Click the Sign into Laserfiche button and then enter your credentials. Select the remote agent you want to register a worker to from the drop-down menu in the Laserfiche Worker Configuration tool. Click Register.
The Current registered worker page shows a summary of the registered worker and offers and option to deregister it, if desired. Click Close.
Continue registering workers from the Laserfiche Worker Configuration tool. You can also start and stop workers' services here. Click Refresh to view the workers' current statuses.

Removing workers

To remove a worker, you must both deregister it on the local machine and delete it in Laserfiche Cloud.

Note: Depending on the connection between the local machine and Laserfiche Cloud, the worker may be deleted from Laserfiche Cloud when it's deregistered or you may need to delete it manually.

To deregister a worker

Open the Laserfiche Worker Configuration tool.
Click the Register worker gear button next to the worker you want to deregister.
Click Deregister.

To delete a worker

Open the remote agent you want to delete a worker from.
On the Workers tab, click the trashcan button next to the worker you want to delete.
Confirm the deletion.

Unattended Installation and Configuration

Unattended installation and registration is supported for users to install and register workers by running command line scripts.

Unattended Installation

You can append parameters to the setup file to customize the installation.

On the configuration page for your remote agent, click the Workers tab in the top left.
Under Installation Instructions, select Download. This will download an executable file to your computer.
Copy the .exe file to a permanent location.
Right-click the .exe file and extract the contents.
Open the Windows Command Prompt from the Windows System folder.
Enter command line arguments in the format: setup_exe_path operation argument_name=argument_value. The setup_exe path is here: [ExtractedFolder]\en\LocalAgent\SetupLf.exe for both remote workers and bot workers.

Note: By default, the worker service will run as local system.

Use the following parameters to customize the installation:

**Parameters**
SetupLF.exe Parameters	Definition	Example	Notes
-log logpath	Specifies the directory in which the installation logs will be stored. If this parameter is not specified, no log file will be saved.	-log "C:\Logs"
-silent	The installation will proceed without displaying any dialogs to the user. Note: Microsoft Installer 4.5 must already be installed on the computer for a silent install to complete successfully.
-noui	The installation will prompt the user to accept the license agreement but will not prompt them for any other information. The user will see the installation progress and any error messages.
-iacceptlicenseagreement	This parameter allows you to indicate your acceptance of the license agreement within the command line string itself. This parameter is meant to be used in tandem with -noui, in which case -noui will display progress bars and error messages but will not prompt the user to accept the license agreement.
-botagent	Only install the bot worker component		If this parameter is not added, only the remote worker 1 component will be installed
INSTALLDIR="InstallDir"	Install or uninstall package to a specified directory	INSTALLDIR="D:\Laserfiche"
ADDLOCAL="LFPALocalAgent"	Only install remote worker 1
ADDLOCAL="LFPALocalAgent2"	Only instal remote worker 2
ADDLOCAL="LFPALocalAgent3"	Only install remote worker 3
ADDLOCAL="LFPABotAgent"	Only install the bot worker
INSTALLLEVEL="1"	Only install remote worker 1
INSTALLLEVEL="2"	Only install remote worker 1 and remote worker 2
INSTALLLEVEL="3"	Only install remote worker 1, remote worker 2, and remote worker 3
INSTALLLEVEL="100"	Install all components
ADDLOCAL="ALL"	Install all components
LFPALocalAgentSVCACCOUNTNAME="Account"	Specify an account name for the remote worker 1 service		If no value is specified for this parameter, the default service account in local system will be used
LFPALocalAgentSVCACCOUNTPASSWORD="Password"	Specify a password for the remote worker 1 service		If no value is specified for this parameter, the default service account in local system will be used
LFPALocalAgent2SVCACCOUNTNAME="Account"	Specify an account name for the remote worker 2 service		If no value is specified for this parameter, the default service account in local system will be used
LFPALocalAgent2SVCACCOUNTPASSWORD="Password"	Specify a password for the remote worker 2 service		If no value is specified for this parameter, the default service account in local system will be used
LFPALocalAgent3SVCACCOUNTNAME="Account"	Specify an account name for the remote worker 3 service		If no value is specified for this parameter, the default service account in local system will be used
LFPALocalAgent3SVCACCOUNTPASSWORD="Password"	Specify a password for the remote worker 3 service		If no value is specified for this parameter, the default service account in local system will be used
LFPABotAgentSVCACCOUNTNAME="Account"	Specify an account name for the bot worker service		If no value is specified for this parameter, the default service account in local system will be used
LFPABotAgentSVCACCOUNTPASSWORD="Password"	Specify a password for the bot worker service		If no value is specified for this parameter, the default service account in local system will be used
REMOVE="LFPALocalAgent"	Uninstall remote worker 1
REMOVE="LFPALocalAgent2"	Uninstall remote worker 2
REMOVE="LFPALocalAgent3"	Uninstall remote worker 3
REMOVE="LFPABotAgent"	Uninstall the bot worker
REMOVE="ALL"	Uninstall all components

Examples:

To install worker 1 with a specific account:

SetupLf.exe -silent -log "{log path}" ADDLOCAL="LFPALocalAgent" LFPALocalAgentSVCACCOUNTNAME="DOMAIN\USERNAME" LFPALocalAgentSVCACCOUNTPASSWORD="xxxx"

To Install worker 1 and the bot worker with local system in directory "D:\test":

SetupLf.exe -silent -log "{log path}" ADDLOCAL="LFPALocalAgent,LFPABotAgent" INSTALLDIR="D:\\test\"

Uninstall bot worker in directory "D:\test":

SetupLf.exe -silent -log "{log path}" REMOVE="LFPABotAgent" INSTALLDIR="D:\\test\"

Install all workers with specific accounts:

SetupLf.exe -silent -log "{log path}" INSTALLLEVEL="100" LFPALocalAgentSVCACCOUNTNAME="DOMAIN\USERNAME" LFPALocalAgentSVCACCOUNTPASSWORD="xxxx" LFPALocalAgent2SVCACCOUNTNAME="DOMAIN\USERNAME" LFPALocalAgent2SVCACCOUNTPASSWORD="xxxx" LFPALocalAgent3SVCACCOUNTNAME="DOMAIN\USERNAME" LFPALocalAgent3SVCACCOUNTPASSWORD="xxxx" LFPABotAgentSVCACCOUNTNAME="DOMAIN\USERNAME" LFPABotAgentSVCACCOUNTPASSWORD="xxxx"

Uninstall all workers:

SetupLf.exe -silent REMOVE="ALL"

Unattended Configuration

Unattended configuration supports three operations:

register: Use a registration token to register a worker
credential: Sign into Laserfiche, and then choose the remote agent to register
deregister: Deregister a worker

Open the Windows Command Prompt from the Windows System folder.
Enter command line arguments in the format: config_exe_path operation argument_name:argument_value. By default, the unattended configuration utility's path is [InstallDir]\ProcessAutomationWorkerAgent\[WorkerFeatureFolder]\ConfigTools\Laserfiche.ProcessAutomation.LocalAgentUnattendedConfig.exe

Note: If the argument value has spaces, use quotation marks around the value. For example, remoteAgentName:'Dedicated Bot Remote Agent'

Use the following launch arguments to register or deregister workers.

token: The worker's registration token. You can generate tokens from the Worker tab of the remote agent's web page in Laserfiche Cloud. Click Generate new registration token at the bottom of the installation instructions, and copy the token.
accountid: Your Laserfiche Cloud account ID
username: The username of the account that will sign into Laserfiche Cloud
password: The password for the account that will sign into Laserfiche Cloud
remoteAgentName: The display name of the remote agent you want to register to

Examples:

To register a worker using a registration token, use these argument:

..\Laserfiche.ProcessAutomation.LocalAgentUnattendedConfig.exe register accountid:accountid token:token

Note: accountid is used to retrieve the region-based default server name.

Note: The accountid and token command line parameters are required when registering a token via registration token.

To register a worker by signing in to Laserfiche, use this argument:

..\Laserfiche.ProcessAutomation.LocalAgentUnattendedConfig.exe credential accountid:accountid username:username password:password remoteagentname:remoteagentname

Note: The accounted, username, password, and remoteagentname command line parameters are required when registering a worker using credentials.

To deregister a worker

..\Laserfiche.ProcessAutomation.LocalAgentUnattendedConfig.exe deregister

Running the Worker

Once registered, the worker appears in the Workers tab as a new subsection titled with the name you provided during registration. You may have to refresh the Workers tab to see any recent changes.

The Windows service for the worker will automatically start after installation. It will also start whenever Windows starts. Services for each component are:

**Services**
Component Name	Service Name	Service Display Name
Remote Worker 1	LFPALocalAgent	Laserfiche Remote Worker 1
Remote Worker 2	LFPALocalAgent2	Laserfiche Remote Worker 2
Remote Worker 3	LFPALocalAgent3	Laserfiche Remote Worker 3
Bot Worker	LFPABotAgent	Laserfiche Bot Worker

Next Steps