Config.Read

Reads a YAML file from the Custom Configs folder.

Syntax

Config.Read "config_name"

Returns

reference to CustomConfig object

Arguments

Name	Required	Type	Description
config name	Yes	Any text e.g. "Hello, World!"

Details

Add a '.yml' or '.yaml' file to the Custom Configs folder inside the SER config directory. Pass the file name without its extension. If no matching file exists, this method returns an invalid reference. Learn more about YAML: https://www.cloudbees.com/blog/yaml-tutorial-everything-you-need-get-started

Possible errors

• The config name resolves outside the SER custom config directory.

Validated examples using this method

• roundReport

On a running server

Use serhelp Config.Read to inspect the reference generated by your installed SER version.