Please enable JavaScript to view this site.

QPR Knowledge Base 2023.1

  •      
  • Navigation: Developer's Guide > QPR API > The Object Model > QPR Metrics > SCModel Commands

    CreateScorecard

    Scroll Prev Top Next More

    Revision history:

    Introduced in QPR 7.2.1

    Last changed in QPR 2012

     

    Creates a new scorecard of given name and identifier. If ParentId is given, sets the scorecard referred by ParentID as a parent scorecard for the new scorecard. Returns Id of a new scorecard in Id parameter. System generates identifier for the created scorecard if Identifier parameter is empty. Top element is also created automatically.

     

    Synopsis:

     

    SCModel.CreateScorecard(Name, Identifier, ParentId, out Id)

     

    Parameters:

     

    Name: String

    Identifier: String, can be left empty

    ParentId: Integer. 0 if created to top level, some existing scId otherwise

    Id: Integer. Id of the created scorecard

     

    Required Rights:

     

    Administrator or Model Administrator rights to the SCModel.

     

    Return Values:

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

     

    RV_SUCCESS

    RV_MODEL_NOT_OPEN

    RV_NO_RIGHTS

    RV_MODEL_IS_LOCKED

    RV_CANNOT_SET_PARENT_SCORECARD

    RV_INVALID_NAME

    RV_IDENTIFIER_IS_RESERVED

    RV_INVALID_IDENTIFIER

    RV_UNKNOWN_ERROR

     

    Example Procedure:

     

    iRet = SCModel.CreateScorecard("New SC", "", 0, id)