QPR Installation Instructions

ApplyInheritanceProperties

ApplyInheritanceProperties

Previous topic Next topic  

ApplyInheritanceProperties

Previous topic Next topic JavaScript is required for the print function  

Revision history:

Introduced in QPR 7.5.1

 

Applies inheritance properties from a base scorecard to a linked scorecard or a chain of linked scorecards. The inheritance properties can be set with the SCModel.SetProperty function using the INHERITANCEOPTIONS attribute.

 

Synopsis:

 

SCModel.ApplyInheritanceProperties(ScorecardId, ApplyParam, ApplyWholeChain)

 

Parameters:

 

ScorecardId: Integer. In the case ApplyParam is APPLY_BASESCORECARD, this parameter defines the ID of a scorecard to which properties should be inherited from its base scorecard. In the case ApplyParam is APPLY_TO_ATTACHEDSCORECARDS, this parameter defines the scorecard from which inheritance properties should be applied to scorecards linked to it.

ApplyParam: String. APPLY_BASESCORECARD or APPLY_TO_ATTACHEDSCORECARDS. See above for description of the different options.

ApplyWholeChain: Integer (boolean). This is used when ApplyParam is APPLY_TO_ATTACHEDSCORECARDS. Setting this to 1 (true) applies the parameters to the whole chain, and in the case this is 0 (false), only the scorecards linked directly to ScorecardId are affected. Use 0 here with APPLY_BASESCORECARD ApplyParam.

 

Required Rights:

 

Administrator or Model Administrator rights to the SCModel.

 

Return Values:

Below are listed the return values that this function can return:

 

RV_APPLICATION_QUIT_CALLED

RV_NOT_CONNECTED_TO_SERVER

RV_NOT_AUTHENTICATED

RV_SUCCESS

RV_MODEL_NOT_OPEN

RV_NO_RIGHTS

RV_ELEMENT_NOT_FOUND

RV_INVALID_PARAMETER

RV_UNKNOWN_ERROR

 

Example Procedure:

 

iRet = SCModel.ApplyInheritanceProperties(SCId, 'APPLY_TO_ATTACHEDSCORECARDS', 1)