locked
What is the "Description" field used for? RRS feed

  • Question

  • Just about every object in PPS has a description field under properties.  However, I have never seen how or where this field is applied or used.  Can someone shed some light on what it is for?  Is there any way to alias a report title with what is in the description field, for example??

    Tuesday, November 13, 2007 10:15 PM

Answers

  • The description field is just another piece of metadata that can be used to describe and add value to an element. Just about any object created in any application these days has a description area where a text string can be entered in order to provide more detailed information about said object. Users often wish to obtain more information about individual elements within a dashboard solution; this is where you would present them with any text entered into the description field of these elements.

    There are some uses for the description property within the context of a dashboard. For example, the description property of a KPI can be exposed in a Scorecard as can any custom property values and person responsible value. These scorecard KPI properties can also be passed to other scorecards or reports within a dashboard element using filter links.

    The description property for any element can be easily accessed from the PPSMonitoring system database and via the PPSWeb service. The system DB is the easiest, though if you simply want to access the description.

    Code Block

    USE PPSMonitoring

    GO;

     

    SELECT

    CASE ObjectType

    WHEN 1 THEN 'KPI'

    WHEN 2 THEN 'Scorecard'

    WHEN 3 THEN 'Report'

    WHEN 4 THEN 'Indicator'

    WHEN 5 THEN 'Data Source'

    WHEN 6 THEN 'Dashboard' END AS ObjectType

    ,[Name] as ObjectName

    ,[Description] as ObjectDescription

    ,[Owner] as ObjectOwner

    ,SerializedXML as XMLElementDefinition

    FROM FCObject;

     

     

    HTH,

    Nick

    Saturday, November 17, 2007 8:29 AM

All replies

  • The description field is just another piece of metadata that can be used to describe and add value to an element. Just about any object created in any application these days has a description area where a text string can be entered in order to provide more detailed information about said object. Users often wish to obtain more information about individual elements within a dashboard solution; this is where you would present them with any text entered into the description field of these elements.

    There are some uses for the description property within the context of a dashboard. For example, the description property of a KPI can be exposed in a Scorecard as can any custom property values and person responsible value. These scorecard KPI properties can also be passed to other scorecards or reports within a dashboard element using filter links.

    The description property for any element can be easily accessed from the PPSMonitoring system database and via the PPSWeb service. The system DB is the easiest, though if you simply want to access the description.

    Code Block

    USE PPSMonitoring

    GO;

     

    SELECT

    CASE ObjectType

    WHEN 1 THEN 'KPI'

    WHEN 2 THEN 'Scorecard'

    WHEN 3 THEN 'Report'

    WHEN 4 THEN 'Indicator'

    WHEN 5 THEN 'Data Source'

    WHEN 6 THEN 'Dashboard' END AS ObjectType

    ,[Name] as ObjectName

    ,[Description] as ObjectDescription

    ,[Owner] as ObjectOwner

    ,SerializedXML as XMLElementDefinition

    FROM FCObject;

     

     

    HTH,

    Nick

    Saturday, November 17, 2007 8:29 AM
  • Thanks, Nick. 

     

    Per your statement: For example, the description property of a KPI can be exposed in a Scorecard

     

    How would one expose this property?  For example, if I describe the KPI's thresholds in the description, how can I expose the description property to display somewhere on the scorecard?

    Monday, November 19, 2007 4:58 PM
  • The KPI description, name and person responsible are available as outgoing filter link items in a scorecard when contained in a dashboard. The easiest way is to pass the values into the parameters of an SSRS report and show the results there.

     

    Cheers,

    Nick

     

    Monday, November 19, 2007 7:08 PM