Install and Configure the Workflow Task Runner

The Workflow Task Runner is a command line task runner that performs workflow replication operations.

Prerequisites

The Workflow TaskRunner requires .net 6 to be installed.

  1. Download and install the Windows .NET Runtime 6.0.x from https://dotnet.microsoft.com/download/dotnet/6.0

Deploy the Colectica Workflow TaskRunner

  1. First, make sure the Colectica Workflow web application is installed and configured.

  2. Download the Colectica Workflow TaskRunner package. This will be named ColecticaWorkflowTaskRunner-version.zip and should be included with your Colectica Workflow delivery.

  3. Before extracting the Workflow TaskRunner package, make sure Windows does not have the file blocked. To check this:

    1. In Windows Explorer, right click the Zip file and choose Properties.

    2. Near the bottom of the Properties window, in the Security area, see if there is a checkbox labeled Unblock.

    3. If there is an Unblock checkbox, check the box and click OK.

    4. If there is no such checkbox, proceed to the next step.

  4. Extract the contents of the Elastic Indexer package. In this documentation, the directory to which you extract the file will be referred to as ColecticaWorkflowTaskRunner\.

  5. Edit Workflow Task Runner Config files.

    1. In the ColecticaWorkflowTaskRunner\ directory, rename the appsettings.json.dist configuration file to appsettings.json.

    2. Update the Workflow Task Runner’s configuration settings. The configuration in the Workflow Task Runner is the same as the Workflow configuration in the Workflow Web application. Use the same settings from the Workflow Web application’s configuration file.

Run the Workflow Task Runner

  1. Open a command shell and navigate to ColecticaWorkflowTaskRunner\.

  2. Run the following command:

    Colectica.Workflow.TaskRunner.exe
    

Reoccurring task for the Task Runner

  1. The Workflow Task Runner should be run periodically to perform the workflow operations using the Windows Task Scheduler. An interval of 5 minutes is recommended. Also set the Start In directory to the directory containing the task runner executable.

Note

For more information about Windows Task Scheduler, see https://docs.microsoft.com/en-us/windows/win32/taskschd/task-scheduler-start-page