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

viewMetricValuesData

Este método possibilita recuperar:

  • Valores de um indicador ativo que faz parte de um Scorecard homologado ou sem revisão;

Se o usuário não tiver permissão para visualizar o indicador do Scorecard, o web service não retornará os valores do 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/ViewMetricValuesDataRequestType.java
Retornoweb/wwwroot/ws/java/strategy/ViewMetricValuesDataResponseType.java

Requisição:

IdentificadorRequeridoDescrição
idscmetricXIdentificador do indicador 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: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>

Retorno:

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

▪IDSCORECARD: String; Identificador do Scorecard.
▪IDSCMETRIC: String; Identificador do indicador do Scorecard.
▪NMMETRIC: String; Nome do indicador.
▪NMCONFIGVIEW: String; Nome do perfil de visualização do indicador.
▪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)
▪FGRANGECONFIG: String; Configuração da faixa do indicador.
▪NMMETRICTYPE: String; Nome do tipo do 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.
oNMPERIOD: String; Nome do período.
oVLACTUAL: String; Medição do período.
oVLTARGET: String; Meta do período.
oVLPERCENT: String; Percentual do período.
oNMRANGEPERIOD: String; Situação da faixa do período.
oVLPOINTS: String; Pontuação do período.
oVLVARIATION: String; Valor da variação do período.
oVLPERDIFFERENCE: String; Valor da diferença do percentual do período.
oVLTARGETTYPE1: String; Valor do Campo adicional 1 do período.
oVLTARGETTYPE2: String; Valor do Campo adicional 2 do período.
oVLTARGETTYPE3: String; Valor do Campo adicional 3 do período.
oVLWEIGHT: String; Peso do período.
oFGTREND: String; Tendência do período (1 - Tendência crescente; 2 - Tendência constante; 3 - Tendência decrescente).
oVLTREND: String; Valor da tendência do período.
oVLAVERAGE: String; Valor da média do período.
oVLAMPLITUDE: String; Valor da amplitude do período.
oVLVARIANCE: String; Valor da variância do período.
oVLSTANDARDDEV: String; Valor do desvio padrão do período.
oVLCOEFVARIATION: String; Valor do coeficiente de variação do período.
oVLGROWTHLASTPERIOD: String; Percentual de crescimento em relação ao período anterior.
oVLGROWTHLASTYEAR: String; Percentual de crescimento em relação ao mesmo período do ano anterior.
oVLACTUALACCUM: String; Medição acumulada do período.
oVLTARGETACCUM: String; Meta acumulada do período.
oVLPERCENTACCUM: String; Percentual acumulado do período.
oNMRANGEACCUMPERIOD: String; Situação da faixa acumulada do período.
oVLPOINTSACCUM: String; Pontuação acumulada do período.
oVLVARIATIONACCUM: String; Valor da variação acumulada do período.
oVLPERDIFFACCUM: String; Valor do desvio do percentual acumulado do período.
oVLTARGETTYPE1ACCUM: String; Valor do campo adicional 1 acumulado do período.
oVLTARGETTYPE2ACCUM: String; Valor do campo adicional 2 acumulado do período.
oVLTARGETTYPE3ACCUM: String; Valor do campo adicional 3 acumulado do período.
oVLRHYTHMIC: String; Valor do ritmo do período.
oVLRHYTHMICNECESSAR: String; Valor do ritmo necessário do período.
oFGTRENDACCUM: String; Tendência acumulada do período (1 - Tendência crescente; 2 - Tendência constante; 3 - Tendência decrescente).
oVLTRENDACCUM: String; Valor da tendência acumulada do período.
oVLPERCENTACCUMACHIVE: String; Percentual de atingimento acumulado do período.
oVLGROWTHLASTYEARTODATE: String; Percentual de crescimento em relação ao mesmo período acumulado do ano anterior.
oVLACTUALACCUM2: String; Medição acumulada 2 do período.
oVLTARGETACCUM2: String; Meta acumulada 2 do período.
oVLPERCENTACCUM2: String; Percentual acumulado 2 do período.
oNMRANGEACCUM2PERIOD: String; Situação da faixa acumulada 2 do período.
oVLPOINTSACCUM2: String; Pontuação acumulada 2 do período.
oVLVARIATIONACCUM2: String; Valor da variação acumulada 2 do período.
oVLPERDIFFACCUM2: String; Valor do desvio do percentual acumulado 2 do período.
oVLTARGETTYPE1ACCUM2: String; Valor do campo adicional 1 acumulado 2 do período.
oVLTARGETTYPE2ACCUM2: String; Valor do campo adicional 2 acumulado 2 do período.
oVLTARGETTYPE3ACCUM2: 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 IDSCMETRIC não informado.
2 - Parâmetro NYEAR não informado.
3 - NYEAR não é um número válido.
4 - Campo NYEAR inválido. Digite um valor numérico entre 1970 e 2050.
5 - IDSCMETRIC não encontrado.
6 - O usuário conectado não possui permissão para visualizar o indicador.
7 - Não foi possível recuperar os dados do indicador, pois ele está inativo.
8 - Não foi possível recuperar os dados do indicador, pois ele está em uma revisão de Scorecard obsoleta.