A missing variable is a variable that has been added to an article, clause, spec note, org note and table but is not set up in the ‘Organization variables’, 'Project variables' or 'Master variables' areas. Knowing what causes missing variables will help you to avoid this. When they occur, missing variables can be re-added.
Please note: 'Variables' are available with 'Premium'.
What causes a variable to become missing?
When a variable is in use, it can become missing by any of these methods:
- Renaming or deleting an org-level variable that is inherited.
- This includes changes in upper or lower case for letters. Variable names are case-sensitive.
- Renaming or deleting a project/ master-level variable.
- This includes changes in upper or lower case for letters. Variable names are case-sensitive.
- Copying a project/ master-level variable with an article or clause into another project or master when the variable has not been set up in that project or master.
- Copying an org/ project/ master-level variable with an article or clause into another organization when the variable has not been set up in that organization.
- ‘Variable in use’ refers to a variable added to an article, clause, spec note, org note or table.
How to spot missing variables
Missing variables are shown as a red chip with '!' icon.
A screenshot of a missing variable with the red board and '!' icon.
Publishing a missing variable
When a missing variable in an article or clause is published, Chorus will publish the variable name. The published specification will indicate the missing variable. It will not publish the variable value. This is to avoid the published specification text containing an error.
- In the specification editor:
- In the published specification, Chorus will publish the variable as '[Missing variable "the variable name"]
- The variable name is preceded by '[Missing variable...]'
- The variable name is published instead of the variable value to avoid the specification containing the wrong meaning and to indicate the missing state.
- The missing variable is enclosed in square brackets.
Checking for missing variables
You can find missing variables in a spec by running the ‘Spec check’ report. Please see Finding variables using the Spec check report.
Fixing missing variables
It is quite easy to fix missing variables. They are caused by the variable having been deleted or renamed or by not being set up at all.
To fix a variable, we recommend:
- Establish whether the missing variable was an org-level variable or set up in the context of an individual project or master. If it is an org-level variable, it may be missing in all of the projects/ masters where it has been used.
- Recreate the variable. It must have the same variable name that was set up originally. Be careful to recreate the variable name with the same letter case (variables are case-sensitive).