Engine Management

First published on: 07/24/2023/11:18 pm

Project engines are used by Saltbox Integrations to run workflows. Each project has its own engine, which is responsible for running all of the workflows within that project.

When running, an engine executes each workflow, either on a schedule (for scheduled triggers), or upon secured API or event-based connections. An engine may be stopped, which will halt all workflow execution. If configured, schedules will be tracked during the down time and run automatically on engine restart, otherwise missed schedules will be ignored.

From time to time, an engine may require a restart, such as when project settings or workflow trigger schedules are updated. Use the engine status button on any project page to restart the engine, as outlined below.

Viewing Engine Status

An engine is assigned to each project to control all of its workflows, so engine status is displayed on all project-level pages. The status is displayed on the upper-right of any project page. The refresh button (marker 1 below) can be used to immediately refresh the latest status.

Starting, Stopping or Restarting an Engine

A running engine must be restarted before certain updates will be loaded. These include:

• Project setting updates, including connector configs
• Workflow Trigger schedule updates
• Queued engine upgrades

A running engine must be stopped before:

• Managing a connector
• Deleting a workflow

Engine actions can be managed using the status button (marker 1 below).

Viewing Engine Logs

In the rare circumstance where an engine does not behave as expected, detailed logs are found in System Information (marker 1 below) > Logs. These may be downloaded and used to troubleshoot engine issues.

Managing Project Engine Hosts

Project Engines are hosted on a cloud container or app server. When a critical issue occurs, such as an error when loading engines across multiple projects, the host itself may need to be restarted.

Access to this page requires that the user belog to the Tenant Admin user access group. Tenant Admins can manage hosts, users, and tenant details.

To manage the host related to a project, first, determine where the project is hosted.

• Open the Project menu (marker 1 below) and navigate to Project Settings (marker 2 below).

• Expand the section Project Engine Hosts (marker 1 below) and inspect the host name (marker 2 below).

• Open the Utilities menu and go to Saltbox App Hosts (markers 1 and 2 below). If you don’t see this menu, request access to the Tenant Admin group from your admin and log out/in to refresh your level of access.

• Find the project’s host (marker 1 below), and use the Actions menu (marker 2 below), then restart the app host. Note that this will disrupt all project engines that use the host, so caution should be exercised before performing this action.

• Refresh the host list (next to the search bar) to refresh the host status. Once the host is “Running” again, project engines that are set to auto-start will begin their startup routine. Otherwise, you may manually start engines as needed.

Previous

Next