slmetric.config.Configuration.open

Class: slmetric.config.Configuration
Package: slmetric.config

Create configuration object associated with XML configuration file in the base workspace

Syntax

Co = slmetric.config.Configuration.open('FileName','myConfig.xml',... 'Location', pwd)

Description

Reads the contents of an XML file containing Metrics Dashboard customizations into memory and returns the corresponding configuration object. The XML file contains customizations pertaining to metric thresholds and custom metric families. If you modify the contents of the configuration object, invoke the save method to write to the associated XML file.

Co = slmetric.config.Configuration.open('FileName','myConfig.xml',... 'Location', pwd) reads a configuration file.

Note

If you do not supply an input argument, the slmetric.config.Configuration.open command reads the contents of the default Metrics Dashboard configuration XML file into memory and returns the corresponding slmetric.dashboard.Configuration object.

Input Arguments

FileName — Name of XML file

character vector | string scalar

Name of XML file containing Metrics Dashboard customizations pertaining to metric thresholds and custom metric families.

Data Types: char

Location — Folder containing XML file

character vector | string scalar

Name of folder containing XML file that contains Metrics Dashboard customizations pertaining to metric thresholds and custom metric families. This input argument is optional.

Data Types: char

locale — Name of folder containing XML file

character vector | string scalar

Name of folder containing XML file that contains Metrics Dashboard customizations. This input argument is optional.

Data Types: char

Output Arguments

Co — Configuration object

character vector | string scalar

slmetric.config.Configuration object that you want to open.

Data Types: char

Examples

Access an Existing Configuration Object

Use the open method to add an existing slmetric.config.Configuration object to the base workspace. As an input, specify the name of the XML file that contains the information on the custom metric families and metric thresholds corresponding to the configuration object. If you modify the information that this configuration object contains, use the slmetric.config.Configuration.save method to save this information to the XML file.

CONF = slmetric.config.Configuration.open('FileName', 'myConfig.xml',...
 'Location', pwd()); 

Version History

Introduced in R2018b