Pular para o conteúdo principal
Versão: 2.2.1

viewScorecardMetricValuesData

Este método possibilita recuperar:

  • Valores de todos os indicadores ativos de um Scorecard homologado ou sem revisão;

Se o usuário não tiver permissão para visualizar em algum indicador do Scorecard, o web service não retornará os valores daquele indicador.

Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.

Classe Java
Requisiçãoweb/wwwroot/ws/java/strategy/ViewScorecardMetricValuesDataRequestType.java
Retornoweb/wwwroot/ws/java/strategy/ViewScorecardMetricValuesDataResponseType.java

Requisição:

IdentificadorRequeridoDescrição
IDSCORECARDXIdentificador do scorecard
NRYEARXAno

Estrutura da requisição:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:strategy">
<soapenv:Header/>
<soapenv:Body>
<urn:viewScorecardMetricValuesData>
<!--You may enter the following 2 items in any order-->
<urn:idscorecard>?</urn:idscorecard>
<urn:nryear>?</urn:nryear>
</urn:viewScorecardMetricValuesData>
</soapenv:Body>
</soapenv:Envelope>

Retorno:

IdentificadorDescrição
returnSUCESSO: Retorna um vetor com os metadados:

- SCMETRICS: Matriz; Indicadores do Scorecard.
- SCMETRIC: Matriz; Indicador do Scorecard.
IDSCORECARD: String; Identificador do Scorecard.
- IDSCMETRIC: String; Identificador do indicador do Scorecard.
- NMCONFIGVIEW: String; Nome do Perfil de visualização.
- NMSCOREITEMOWNER: String; Elemento superior do indicador.
- FGFREQUENCY : String; Frequência do indicador. (1 - Anual; 2 - Semestral; 3 - Quadrimestral; 4 - Trimestral; 5 - Bimestral; 6 - Mensal; 7 - Quinzenal; 8 - Semanal; 9 - Diário; 10 - Por Evento)
- FGRANGESCALE: Configuração da faixa do indicador.
- NMMETRICTYPE: String; Nome do tipo de indicador.
- NMOWNER: String; Responsáveis pelo indicador.
- FGDUEMEASURE: String; Situação do vencimento do indicador. (1 - Em dia; 2 - Em atraso)
- IDMEASUNITY: String; Unidade de medida do indicador.
- PERIODS: Matriz; Períodos do indicador.
- PERIOD: Período do indicador.
- NMPERIOD: String; Nome do período.
- VLACTUAL: String; Medição do período.
- VLTARGET: String; Meta do período.
- VLPERCENT: String; Percentual do período.
- NMRANGEPERIOD: String; Situação da faixa do período.
- VLPOINTS: String; Pontuação do período.
- VLVARIATION: String; Valor da variação do período.
- VLPERDIFFERENCE: String; Valor da diferença do percentual do período.
- VLTARGETTYPE1: String; Valor do Campo adicional 1 do período.
- VLTARGETTYPE2: String; Valor do Campo adicional 2 do período.
- VLTARGETTYPE3: String; Valor do Campo adicional 3 do período.
- VLWEIGHT: String; Peso do período.
- FGTREND: String; Tendência do período (1 - Tendência crescente; 2 - Tendência constante; 3 - Tendência decrescente).
- VLTREND: String; Valor da tendência do período.
- VLAVERAGE: String; Valor da média do período.
- VLAMPLITUDE: String; Valor da amplitude do período.
- VLVARIANCE: String; Valor da variância do período.
- VLSTANDARDDEV: String; Valor do desvio padrão do período.
- VLCOEFVARIATION: String; Valor do coeficiente de variação do período.
- VLGROWTHLASTPERIOD: String; Percentual de crescimento em relação ao período anterior.
- VLGROWTHLASTYEAR: String; Percentual de crescimento em relação ao mesmo período ano anterior.
- VLACTUALACCUM: String; Medição acumulada do período.
- VLTARGETACCUM: String; Meta acumulada do período.
- VLPERCENTACCUM: String; Percentual acumulado do período.
- NMRANGEACCUMPERIOD: String; Situação da faixa acumulada do período.
- VLPOINTSACCUM: String; Pontuação acumulada do período.
- VLVARIATIONACCUM: String; Valor da variação acumulada do período.
- VLPERDIFFACCUM: String; Valor do desvio do percentual acumulado do período.
- VLTARGETTYPE1ACCUM: String; Valor do campo adicional 1 acumulado do período.
- VLTARGETTYPE2ACCUM: String; Valor do campo adicional 2 acumulado do período.
- VLTARGETTYPE3ACCUM: String; Valor do campo adicional 3 acumulado do período.
- VLRHYTHMIC: String; Valor do ritmo do período.
- VLRHYTHMICNECESSAR: String; Valor do ritmo necessário do período.
- FGTRENDACCUM: String; Tendência acumulada do período (1 - Tendência crescente; 2 - Tendência constante; 3 - Tendência decrescente).
- VLTRENDACCUM: String; Valor da tendência acumulada do período.
- VLPERCENTACCUMACHIVE: String; Percentual de atingimento acumulado do período.
- VLGROWTHLASTYEARTODATE: String; Percentual de crescimentoem relação ao mesmo período acumulado do ano anterior.
- VLACTUALACCUM2: String; Medição acumulada 2 do período.
- VLTARGETACCUM2: String; Meta acumulada 2 do período.
- VLPERCENTACCUM2: String; Percentual acumulado 2 do período.
- NMRANGEACCUM2PERIOD: String; Situação da faixa acumulada 2 do período.
- VLPOINTSACCUM2: String; Pontuação acumulada 2 do período.
- VLVARIATIONACCUM2: String; Valor da variação acumulada 2 do período.
- VLPERDIFFACCUM2: String; Valor do desvio do percentual acumulado 2 do período.
- VLTARGETTYPE1ACCUM2: String; Valor do campo adicional 1 acumulado 2 do período.
- VLTARGETTYPE2ACCUM2: String; Valor do campo adicional 2 acumulado 2 do período.
- VLTARGETTYPE3ACCUM2: String; Valor do campo adicional 3 acumulado 2 do período.

FALHA: Mensagem com o erro ocorrido.
errorRetorna o código de erro:
1 - Parâmetro IDSCORECARD não informado.
2 - Parâmetro NRYEAR não informado.
3 - NRYEAR não é um número válido.
4 - Campo NRYEAR inválido. Digite um valor numérico entre 1970 e 2050.