Configure the Project

First published on: 02/22/2024/6:53 pm

Video: Project Settings Management for Saltbox Integrations

Each setting for configuring a project is outlined below. (If your project is already configured, skip to "Open the Project".)

• Select "Project Menu" at the top left of the screen.
• Select "Project Settings". 

On the project settings page, you can access everything related to the project, including:  

• General Settings 
• Template Settings 
• Advanced Settings 
• Project Engine Host Settings 
• Project Configuration Variables 
• Connector Configurations 

General Settings 

General settings include project name, project environment, description, and start mode. 

• The project name was previously configured and cannot be changed.  

• The environment and description fields are customizable. 

• "Start Mode" indicates whether the project’s engine will auto-restart when the underlying host is restarted (e.g., if a server is restarted).

  • Start mode should be enabled for live production projects, but the setting is optional for other environments. 

Template Settings 

View or assign a template to the project.

Templates allow projects to be managed centrally or used as a starting point for custom integrations.  

Advanced Settings 

• Set the maximum number of concurrent requests. 
• Choose whether to include pre-release versions of connectors.
• Choose whether to lock the project’s settings and workflows.

Additional details for each of these settings are provided in the tooltips setting. 

Project Engine Host Settings 

Determine where the project is hosted (e.g., cloud-hosted versus dedicated app server).

Generally, this setting shouldn't be changed. 

Project Configuration Variables 

Project configuration variables are used within Workflow Designer and Workflow Trigger filters to standardize common settings.

Any variables added to the project will appear in this table.

To add a new variable, use the "Add" button (+) to the right of the project configuration variables table (marker 1 below). 

Connector Configurations 

• Define credential sets for the project to allow the connector to authenticate the connection on behalf of an individual or account.
  • For example, you must configure your API key and API secret to connect to a Shopify web store to pull new orders.
• Each vendor provides its own authentication method, which may include API key/secret pairs, web store URL, etc.
• The connector configurations table will display previously saved configurations.
• To add a new connector configuration, use the add button (+) to the right of the connector configurations table (marker 2 below).
• In the connector configuration window, you'll be prompted to fill in the required settings.
  • Most settings provide setup tooltips; hover over a field’s info icon for context hints. 

Once you've updated the project settings, press the save button at the top-right side of the project settings toolbar (marker 1 below). 

Previous