Version: 2.2.3

viewScMetricData

This method allows recovering:

Data of an indicator associated with the scorecard;

If the user does not have permission to view the Scorecard indicator, the web service will not return the indicator data. To insert each of these items, it is necessary to follow the standard documented below.

Java class
Request	web/wwwroot/ws/java/strategy/ViewScMetricDataRequestType.java
Return	web/wwwroot/ws/java/strategy/ViewScMetricDataResponseType.java

Request:

ID #	Required	Description
idscmetric	X	Scorecard indicator ID #

Request structure:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:strategy">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:viewScMetricData>
         <urn:idscmetric>?</urn:idscmetric>
      </urn:viewScMetricData>
   </soapenv:Body>
</soapenv:Envelope>

Return:

ID #	Description
return	SUCCESS: Returns a vector with the metadata: ▪ IDSCORECARD: String; Scorecard indicator ID #. ▪ IDSCMETRIC: String; Scorecard indicator ID #. ▪ NMCONFIGVIEW: String; Name of the view profile of the indicator. ▪ NMMETRIC: String; Indicator name. ▪ NMSCOREITEMOWNER: String; Upper level indicator element. ▪ FGFREQUENCY: String; Indicator frequency. (1 - Yearly; 2 - Biannual; 3 - Four-month-period; 4 - Quarterly; 5 - Bimonthly; 6 - Monthly; 7 - Biweekly; 8 - Weekly; 9 - Daily; 10 - Based on event) ▪ FGRANGECONFIG: String; Indicator range configuration. ▪ NMMETRICTYPE: String; Indicator type name. ▪ NMOWNER: String; Users responsible for the indicator. ▪ FGDUEMEASURE: String; Indicator due date status. (1 - On time; 2 - Past due) ▪ IDMEASUNITY: String; Indicator measurement unit. ▪ SUBMETRICS: Matrix; Scorecard indicator sub-indicators. ▪ SUBMETRIC: Scorecard sub-indicator. ▪ IDSCORECARD: String; Scorecard indicator ID #. ▪ IDSCMETRIC: String; Scorecard indicator ID #. ▪ NMMETRIC: String; Indicator name. ▪ FGFREQUENCY: String; Indicator frequency. (1 - Yearly; 2 - Biannual; 3 - Four-month-period; 4 - Quarterly; 5 - Bimonthly; 6 - Monthly; 7 - Biweekly; 8 - Weekly; 9 - Daily; 10 - Based on event) FAILURE: Message with the error found.
error	Returns the error code: 1 - IDSCMETRIC parameter not entered. 2 - IDSCMETRIC not found. 3 - The logged user does not have permission to view the indicator. 4 - It was not possible to recover the indicator data as it is inactive. 5 - It was not possible to recover the indicator data as it is in an obsolete Scorecard revision.

ID #

Description

return

SUCCESS: Returns a vector with the metadata:

▪ IDSCORECARD: String; Scorecard indicator ID #.
▪ IDSCMETRIC: String; Scorecard indicator ID #.
▪ NMCONFIGVIEW: String; Name of the view profile of the indicator.
▪ NMMETRIC: String; Indicator name.
▪ NMSCOREITEMOWNER: String; Upper level indicator element.
▪ FGFREQUENCY: String; Indicator frequency. (1 - Yearly; 2 - Biannual; 3 - Four-month-period; 4 - Quarterly; 5 - Bimonthly; 6 - Monthly; 7 - Biweekly; 8 - Weekly; 9 - Daily; 10 - Based on event)
▪ FGRANGECONFIG: String; Indicator range configuration.
▪ NMMETRICTYPE: String; Indicator type name.
▪ NMOWNER: String; Users responsible for the indicator.
▪ FGDUEMEASURE: String; Indicator due date status. (1 - On time; 2 - Past due)
▪ IDMEASUNITY: String; Indicator measurement unit.
▪ SUBMETRICS: Matrix; Scorecard indicator sub-indicators.
▪ SUBMETRIC: Scorecard sub-indicator.
▪ IDSCORECARD: String; Scorecard indicator ID #.
▪ IDSCMETRIC: String; Scorecard indicator ID #.
▪ NMMETRIC: String; Indicator name.
▪ FGFREQUENCY: String; Indicator frequency. (1 - Yearly; 2 - Biannual; 3 - Four-month-period; 4 - Quarterly; 5 - Bimonthly; 6 - Monthly; 7 - Biweekly; 8 - Weekly; 9 - Daily; 10 - Based on event)

FAILURE: Message with the error found.

error

Returns the error code:
1 - IDSCMETRIC parameter not entered.
2 - IDSCMETRIC not found.
3 - The logged user does not have permission to view the indicator.
4 - It was not possible to recover the indicator data as it is inactive.
5 - It was not possible to recover the indicator data as it is in an obsolete Scorecard revision.