Globals
Learn more about globals and how they are used to store variables on the Digibee Integration Platform.
Overview
Globals are variables stored in the platform that can be reused across multiple pipelines and capsules. Once created, a global can be referenced in any text field of a connector's configuration form.
Because the value is defined in a single place, updating a global applies the change everywhere it is used. Globals can also be restricted to specific projects, so each variable is only available where it's needed.
Managing globals
You can access the Globals page from the Build page, by clicking the Globals tab, or by clicking the Digibee logo in the upper-left corner, selecting Settings, and then finding the Globals page.
The Globals list shows the Global Name, Category, Description, and Running Pipelines for each global, and can be filtered by Category and Deprecated status (Yes or No).
Creating a global
On the Globals page, click Create new and fill in the fields:
Global name
The name used to reference the global in pipelines and capsules. Use only lowercase letters, numbers, hyphens (-), or dots (.), up to 60 characters and without accents.
Category
Defines how the value is validated. See the available categories below.
Description
A short explanation of the global's purpose.
Project Availability
Defines whether the global is available to all projects or only selected ones. On the Globals listing page, you only see globals available to all projects or to ones you have access to.
Prod environment / Test environment / Other environments
The value of the global in each environment, up to 10,000 characters per field.
The category you select determines which values the global accepts. The platform validates each environment value against the category before saving:
URL
A valid URL.
A valid email address.
ID
Numbers only.
Cron
A valid cron expression.
JDBC
A valid connection string.
Other
Any value. Use this option for lists.
Then click Save. A confirmation window appears, and you must click Create to create the global.
Editing a global
To edit a global, go to the Globals list and click the row of the global you want to edit.
You can:
Update the category.
Update the description.
Mark the global as deprecated. Learn more about deprecating a global.
Define new rules for Project Availability.
Update the environment values.
View all pipelines that use the global.
After editing the global, click Save. A confirmation window appears, and you must click Edit to confirm the changes.
All changes are applied immediately to pipelines that use the global and have not yet been deployed. Deployed pipelines only receive the new values after being redeployed, and a warning on the pipeline card in the Run page reminds you to do so.
Deprecating a global
Deprecating a global makes it unavailable for new pipelines or new pipeline versions. Existing deployments keep working unless redeployed.
To deprecate a global:
In the Globals list, click the row of the global you want to deprecate.
Enable the Deprecated toggle.
Click Save.
Deleting a global
Deleting a global permanently removes it from the Platform. You cannot delete globals that are currently used in pipelines, whether deployed or not. To proceed, remove or replace the global in all pipelines before deleting it.
To delete a global:
In the Globals list, click the three dots of the global you want to delete.
Select Delete.
Confirm the action in the confirmation window.
Using globals
Globals can be referenced in any text field of a connector's configuration form. To use a global:
Open the pipeline or capsule.
Select the connector you want to configure.
In the target field, type
{{. In the autocomplete list, select global and type a dot (.) to see the available variables.
You can also add the reference manually:
Replace globalName with the name of the global. For example: {{global.db-timeout}}.
Last updated
Was this helpful?