Manage configuration variables

Storing secret and plain text information as key-value pairs in Skedulo.

Overview

The Configuration variables feature allows you to store variables as key-value pairs in Skedulo. These values can then be referred to by customizations, extensions, and other parts of the solution so that variables are not hard-coded. They may be authentication keys or other pieces of information that need to be configured differently depending on the environment where the referring code is deployed.

Examples of where variables can be used

Variables can currently be used in connected functions and in webhook and triggered action URLs and headers.

Types of configuration variables

The variables can be saved as one of the following types:

Secret - A value that is encrypted in the backend and cannot be retrieved by users.

Visible - A plain text value that is in the clear in the UI and database.

View configuration variables

To view configuration variables in the web app, do the following:

  • In admin settings, navigate to Developer tools > Configuration variables. The Configuration variables page displays.

The Configuration variables list in admin settings.

Customize the list columns

The list of configuration variables allows you to customize your view by selecting which columns are visible. To do this, do the following steps:

  1. In the Configuration variables list page, click Columns.
  2. Select to show, or deselect to hide columns in the list.
  3. Click Confirm to change your list to show your selected columns, or Cancel to return to the list without making changes to your view.

Options for showing and hiding columns of the configuration variables list.

Add configuration variables

To view configuration variables in the web app, do the following:

  1. In admin settings, navigate to Developer tools > Configuration variables.
  2. Click Create variable.
  3. Enter a Name for the variable that is unique and consists of uppercase letters, numbers, and underscores only (no spaces).
  4. Click to select the variable type; Secret or Visible.
  5. Enter the Value.
  6. Optionally enter a Description to help understand and identify the purpose of the variable in future.
  7. Click Save to create the variable, or click Cancel to discard your changes and return to the Configuration variables list without creating the variable.

Fields to create an entry on the configuration variables list.

Edit a configuration variable value or description

The value and description fields can be changed. To update a configuration variable, do the following steps:

  1. In Settings > Configuration variables, click the name of the variable to edit.
  2. Make the required changes. Note that editing a variable value will replace it and can impact systems that are using it.
  3. Click Save to update the variable, or click Cancel to return to the Configuration variables list without making changes.

Delete a configuration variable

To delete a configuration variable, do the following steps:

  1. In Settings > Configuration variables, click the name of the variable to delete.
  2. Click Actions > Delete.
  3. Click Yes to confirm the deletion and return to the details page, or No to cancel without deleting the variable.