The SC (QPR Metrics) object contains functions for retrieving information from QPR Metrics models.

 

 

Functions available for the SC object

 

SubObjects

•Product: All non-archived models.

•Model: All objects in the model.

•Scorecard: All model objects linked to the scorecard, all model objects in the scorecard.

•ModelObject: All model objects linked to the model object.

 

ChildObjects

•Product: All non-archived models.

•Scorecard: All child scorecards in the scorecard hierarchy.

•Measure: All child measures in the measure hierarchy.

 

ParentObjects

•Scorecard: All parent scorecards in the scorecard hierarchy.

•Measure: All parent measures in the measure hierarchy.

 

BySymbol(symbol=<SYMBOL>)

•Model: Scorecard matching the symbol (identifier in user interface).

•Scorecard: Element matching the symbol (identifier in user interface).

 

For example [SC.1938773693].bysymbol(symbol="ASIASO").bysymbol(symbol="FINANCIAL") returns Metrics element having symbol "FINANCIAL" in a scorecard having symbol "ASIASO" in model having ID 1938773693.

 

<typename>

Valid type names:

Product level:

•Model

Model level:

•<model object type group (corresponding attribute: typegroupname)>

•Alert

•ElementType

•Element

•LinkedElement

•Scorecard

•Period

•PeriodLevel

•Range

•Series

•ValueSettings

•InformationItem

•Integration

•<model object type (corresponding attribute: typename)>

•<element type defined for the model (e.g. "Measure")>: If the name contains spaces, you can omit those. For example Strategic Objective can be called as StrategicObjective.

 

<relationname>

Valid relations by type:

•ModelObject

oBaseObject: When ModelObject is a reference element, this returns the original element

oScorecard: Returns the scorecard ModelObject is connected to.

oInformationItems: Information items connected to ModelObject

•Element

oElementType: Returns the type of Element.

o<model object relation names, see ModelObject>

•Measure

oParentObjects: Measure's parent object(s)

oChildObjects: Measure's child objects

oReferences: Measure's reference elements

oUnit: Measure's unit

oValueSettings: Measure value settings.

oPeriodLevel: Measure's period level

oUsers: Users assigned to roles for the measure

o<element relation names, see Element>

•Scorecard

oParentObjects: Scorecard's parent scorecard

oChildObjects: Scorecard's child scorecards

oBaseScorecard: Scorecard's base scorecard

oUsers: Users assigned to roles for the scorecard

oTopElement: Scorecard's top element.

oMeasures: Measures in the scorecard.

o<model object relation names, see ModelObject>

o<measure relation names (for top element)>

•PeriodLevel

oFirstPeriod: The first period in the defined period level.

oLastPeriod: The last period in the defined period level.

oCurrentPeriod: Returns the period which contains the current date. If none of the periods contain the current date, no results are returned.

oPeriods: All periods within the period level.

•Period

oNextPeriod: The next period.

oPreviousPeriod: The previous period.

oPeriodLevel: The period level to which the period belongs to.

•ValueSetting

oElements: All elements using the value settings. Scorecard parameter can be used to return only elements that belong to defined scorecard(s). Valid values for the scorecard parameter are a set, a scorecard identifier, scorecard name, or a comma-separated list of scorecard identifiers. For example [SC.123.456].elements(scorecard="SC123.1").

•Range

oValuesettings: Value settings object for the range

oMaxSeries: Range's upper limit series

oMinSeries: Range's lower limit series

 

<hierarchyname>

Valid hierarchies:

•Scorecards: Scorecard hierarchy

•Measures: Measure hierarchy