viewMetricValuesData

This method allows recovering:

• Values of an active indicator that is part of a released Scorecard or one without revision;

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

Java class
Request	web/wwwroot/ws/java/strategy/ViewMetricValuesDataRequestType.java
Return	web/wwwroot/ws/java/strategy/ViewMetricValuesDataResponseType.java

Request:

ID #	Required	Description
idscmetric	X	Scorecard indicator ID #
nryear	X	Year

Request structure:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:strategy">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:viewMetricValuesData>
         <!--You may enter the following 2 items in any order-->
         <urn:idscmetric>?</urn:idscmetric>
         <urn:nryear>?</urn:nryear>
      </urn:viewMetricValuesData>
   </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 #. ▪NMMETRIC: String; Indicator name. ▪NMCONFIGVIEW: String; Name of the view profile of the indicator. ▪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. ▪PERIODS: Matrix; Indicator periods. ▪PERIOD: Indicator period. ▪NMPERIOD: String; Period name. ▪VLACTUAL: String; Period measurement. ▪VLTARGET: String; Period target. ▪VLPERCENT: String; Period percentage. ▪NMRANGEPERIOD: String; Period range status. ▪VLPOINTS: String; Period score. ▪VLVARIATION: String; Period variation value. ▪VLPERDIFFERENCE: String; Period percentage difference value. ▪VLTARGETTYPE1: String; Value of Additional field 1 of the period. ▪VLTARGETTYPE2: String; Value of Additional field 2 of the period. ▪VLTARGETTYPE3: String; Value of Additional field 3 of the period. oVLWEIGHT: String; Period weight. oFGTREND: String; Period trend (1 - Upward trend; 2 - Constant trend; 3 - Downward trend). oVLTREND: String; Period trend value. oVLAVERAGE: String; Period average value. oVLAMPLITUDE: String; Period range value. oVLVARIANCE: String; Period variance value. oVLSTANDARDDEV: String; Period standard deviation value. oVLCOEFVARIATION: String; Period coefficient of variation value. oVLGROWTHLASTPERIOD: String; Growth percentage regarding the previous period. oVLGROWTHLASTYEAR: String; Growth percentage regarding the same period in the previous year. oVLACTUALACCUM: String; Period accumulated measurement. oVLTARGETACCUM: String; Period accumulated target. oVLPERCENTACCUM: String; Period accumulated percentage. oNMRANGEACCUMPERIOD: String; Period accumulated range status. oVLPOINTSACCUM: String; Period cumulative rate. oVLVARIATIONACCUM: String; Period cumulative variation value. oVLPERDIFFACCUM: String; Period percentage accumulated deviation value. oVLTARGETTYPE1ACCUM: String; Value of the accumulated additional field 1 of the period. oVLTARGETTYPE2ACCUM: String; Value of the accumulated additional field 2 of the period. oVLTARGETTYPE3ACCUM: String; Value of the accumulated additional field 3 of the period. oVLRHYTHMIC: String; Period rhythm value. oVLRHYTHMICNECESSAR: String; Period necessary rhythm value. oFGTRENDACCUM: String; Period accumulated trend (1 - Upward trend; 2 - Constant trend; 3 - Downward trend). oVLTRENDACCUM: String; Period accumulated trend value. oVLPERCENTACCUMACHIVE: String; Period cumulative achievement percentage. oVLGROWTHLASTYEARTODATE: String; Growth percentage regarding the same accumulated period in the previous year. oVLACTUALACCUM2: String; Period accumulated measurement 2. oVLTARGETACCUM2: String; Period accumulated target 2. oVLPERCENTACCUM2: String; Period percentage accumulated 2. oNMRANGEACCUM2PERIOD: String; Period accumulated range 2 status. oVLPOINTSACCUM2: String; Period cumulative rate 2. oVLVARIATIONACCUM2: String; Period cumulative variation 2 value. oVLPERDIFFACCUM2: String; Period percentage accumulated 2 deviation value. oVLTARGETTYPE1ACCUM2: String; Value of the additional field 1 accumulated 2 of the period. oVLTARGETTYPE2ACCUM2: String; Value of the additional field 2 accumulated 2 of the period. oVLTARGETTYPE3ACCUM2: String; Value of the additional field 3 accumulated 2 of the period. FAILURE: Message with the error found.
error	Returns the error code: 1 - IDSCMETRIC parameter not entered. 2 - NYEAR parameter not entered. 3 - NYEAR is not a valid number. 4 - NYEAR field invalid. Type a numeric value between 1970 and 2050. 5 - IDSCMETRIC not found. 6 - The logged user does not have permission to view the indicator. 7 - It was not possible to recover the indicator data as it is inactive. 8 - It was not possible to recover the indicator data as it is in an obsolete Scorecard revision.