KBEC-00262 - Using the --expand switch for getProperties

Summary

Using getProperty or getProperties results in property reference errors.

Solution

Property reference errors occur because property expansion is enabled by default.

Specifically, getProperties (like getProperty) fetches the property(s) in question and attempts to expand any $[ec:] strings embedded in the value(s), recursively.

Use the "--expand 0" switch with ectool (or its equivalent with ec-perl) to avoid this expansion and return the embedded $[ec:] strings as-is.

Examples

Example of error received:

$: ectool getProperties --projectName "ProjectName"
ectool error [NoSuchProperty]: Invalid property path: Evaluating property 'jobStepId' in project 'ProjectName'
No such property: 'jobStepId'
Evaluation failed
Found no match in any context
Details:
Evaluating property 'jobStepId' in project 'ProjectName'
No such property: 'jobStepId'
Evaluation failed
Found no match in any context

Example of --expand usage

ectool getProperties --projectName "ProjectName" --expand 0

Applies to

Product versions: All supported versions
OS versions: All supported OS

This article is part of our Knowledge Base and is provided for guidance-based purposes only. The solutions or workarounds described here are not officially supported by CloudBees and may not be applicable in all environments. Use at your own discretion, and test changes in a safe environment before applying them to production systems.