pres:gerti:manuais:manual_de_integracao_informa

Diferenças

Aqui você vê as diferenças entre duas revisões dessa página.

Link para esta página de comparações

Ambos lados da revisão anterior Revisão anterior
Próxima revisão		 Revisão anterior
pres:gerti:manuais:manual_de_integracao_informa [05/07/2016 16:13] – bholiveirapres:gerti:manuais:manual_de_integracao_informa [26/12/2017 19:36] (atual) – [INFORMA: Manual de Integração] maugusto
Linha 1: Linha 1:
-====== Informa: Manual de Integração - Recepção de Dados ======+====== INFORMA - Manual de Integração ======
  
 ===== Introdução ===== ===== Introdução =====
Linha 15: Linha 15:
  
 ==== Objetivo do Projeto ====  ==== Objetivo do Projeto ==== 
-O objetivo deste projeto é automatizar o processo de envio de informações das licitações e contratações que os Jurisdicionados devem prestar ao TCE-GO. Para automatizar a recepção dos dados, foram implementados vários web services que permitirão à SEGPLAN (Secretaria de Gentão e Pknejamento) integrar-se ao sistema INFORMA e enviar os dados cadastrados no sistema COMPRAS-Net. +O objetivo deste projeto é automatizar o processo de envio de informações das licitações e contratações que os Jurisdicionados devem prestar ao TCE-GO. Para automatizar a recepção dos dados, foram implementados vários web services que permitirão à SEGPLAN (Secretaria de Gestão e Planejamento) integrar-se ao sistema INFORMA e enviar os dados cadastrados no sistema COMPRAS-Net. 
  
 O escopo inicial é atender a demanda de integrar-se ao sistema COMPRAS-Net, porém os jurisdicionados poderão utilizar deste recurso para envio de informações de outros sistemas de gestão de licitações. Pois há vários órgão que não utilizam o COMPRAS-Net. O escopo inicial é atender a demanda de integrar-se ao sistema COMPRAS-Net, porém os jurisdicionados poderão utilizar deste recurso para envio de informações de outros sistemas de gestão de licitações. Pois há vários órgão que não utilizam o COMPRAS-Net.
Linha 53: Linha 53:
  
 === Serviço de Formulário (ServiceFormulario.svc)===  === Serviço de Formulário (ServiceFormulario.svc)=== 
-O serviço de formulários está disponível no endereço web https://informa.ws.tce.go.gov.br/ServiceFormulario.svc, o qual contem os métodos relatados abaixo.+O serviço de formulários está disponível no endereço web https://informa-ws.tce.go.gov.br/ServiceFormulario.svc, o qual contem os métodos relatados abaixo.
 Qualquer falha de validação ou falha inesperada, para todos os métodos descritos abaixo, será acionada uma exceção do tipo FaultException e na sua mensagem será informada qual o problema ocorrido e se possível a forma de resolve-lo. Qualquer falha de validação ou falha inesperada, para todos os métodos descritos abaixo, será acionada uma exceção do tipo FaultException e na sua mensagem será informada qual o problema ocorrido e se possível a forma de resolve-lo.
  
Linha 304: Linha 304:
  </wsdl:port>  </wsdl:port>
  </wsdl:service>  </wsdl:service>
-</wsdl:definitions>+   </wsdl:definitions>
  
  
 === Serviço de Informação (ServiceInformacao.svc) ===  === Serviço de Informação (ServiceInformacao.svc) === 
-O serviço de informações está disponível no endereço web https://informa.ws.tce.go.gov.br/ServiceInformacao.svc, o qual contem os métodos relatados abaixo.+O serviço de informações está disponível no endereço web https://informa-ws.tce.go.gov.br/ServiceInformacao.svc, o qual contem os métodos relatados abaixo.
 Qualquer falha de validação ou inesperada, para todos os métodos descritos abaixo, será acionada uma exceção do tipo FaultException, na qual conterá as informações de validação criticadas ou o erro inesperado e a forma de resolver o erro. Qualquer falha de validação ou inesperada, para todos os métodos descritos abaixo, será acionada uma exceção do tipo FaultException, na qual conterá as informações de validação criticadas ou o erro inesperado e a forma de resolver o erro.
  
Linha 315: Linha 315:
 Através deste método é possivel enviar a informação desejada e receber de volta o id da informação cadastrada. Os valores a serem informados deve seguir a tabela abaixo.  Através deste método é possivel enviar a informação desejada e receber de volta o id da informação cadastrada. Os valores a serem informados deve seguir a tabela abaixo. 
  
-Campo Tipo Descrição +^Campo^ Tipo^ Descrição^ 
-idOrgao long Código do órgão, obtido no método de consulta de orgãos +|idOrgao |long |Código do órgão, obtido no método de consulta de orgãos| 
- +|dtoInformação |DtoInformacao|Objeto detalhado na seção seguinte.|
-dtoInformação DtoInformacao +
-Objeto detalhado na seção seguinte.+
  
 == Envia Arquivo (EnviaArquivo)==  == Envia Arquivo (EnviaArquivo)== 
 Através deste método é possível enviar os arquivos relacionados a informação, sendo que está informação já deve ser sido enviada anteriormente, importante ressaltar que esta informação deve necessáriamente estar com o status “Em Elaboração”. Os valores a serem informados deve seguir a tabela abaixo. Através deste método é possível enviar os arquivos relacionados a informação, sendo que está informação já deve ser sido enviada anteriormente, importante ressaltar que esta informação deve necessáriamente estar com o status “Em Elaboração”. Os valores a serem informados deve seguir a tabela abaixo.
  
-Campo Tipo Descrição +^Campo^ Tipo^ Descrição^ 
-idOrgao long Código do órgão, obtido no método de consulta de orgãos +|idOrgao |long |Código do órgão, obtido no método de consulta de orgãos| 
- +|idInformacao |long |Código da informação em situação “Em Elaboração”| 
-idInformacao long Código da informação em situação “Em Elaboração” +|dtoArquivos |DtoArquivos |Objeto detalhado na seção seguinte.|
-dtoArquivos DtoArquivos Objeto detalhado na seção seguinte.+
  
 == Remove Arquivo (RemoveArquivo)==  == Remove Arquivo (RemoveArquivo)== 
 Através deste método é possível remover os arquivos relacionados à informação enviada anteriormente. Os valores a serem informados deve seguir a tabela abaixo, caso a remoção seja realizada com sucesso o método retornará “verdadeiro” confirmando a remoção. Importante ressaltar que esta informação deve estar com o status “Em elaboração”. Através deste método é possível remover os arquivos relacionados à informação enviada anteriormente. Os valores a serem informados deve seguir a tabela abaixo, caso a remoção seja realizada com sucesso o método retornará “verdadeiro” confirmando a remoção. Importante ressaltar que esta informação deve estar com o status “Em elaboração”.
  
-Campo Tipo Descrição +^Campo^ Tipo^ Descrição^ 
-idOrgao long Código do órgão, obtido no método de consulta de orgãos +|idOrgao |long |Código do órgão, obtido no método de consulta de orgãos| 
- +|idInformacao |long |Código da informação em situação “Em Elaboração”| 
-idInformacao long Código da informação em situação “Em Elaboração” +|dtoArquivos |DtoArquivos |Objeto detalhado na seção seguinte.|
-dtoArquivos DtoArquivos Objeto detalhado na seção seguinte.+
  
 == Envia TCE (EnviaTce)==  == Envia TCE (EnviaTce)== 
 Através deste método é possível marcar a informação como completa, “enviando” a mesma para o Tribunal de Contas do Estado e bloqueando a edição. Durante este processo todos os campos são verificados, quanto a obrigatoriedade, validação de CPF/CNPJ, validação de valor informado e o tipo esperado, entre outros.  Através deste método é possível marcar a informação como completa, “enviando” a mesma para o Tribunal de Contas do Estado e bloqueando a edição. Durante este processo todos os campos são verificados, quanto a obrigatoriedade, validação de CPF/CNPJ, validação de valor informado e o tipo esperado, entre outros. 
  
-Campo Tipo Descrição +^Campo^ Tipo^ Descrição^ 
-idOrgao long Código do órgão, obtido no método de consulta de orgãos +|idOrgao |long |Código do órgão, obtido no método de consulta de orgãos| 
- +|idInformacao |long |Código da informação em situação “EmElaboração”|
-idInformacao long Código da informação em situação “EmElaboração”+
  
 == WSDL==  == WSDL== 
Linha 601: Linha 596:
  </wsdl:port>  </wsdl:port>
  </wsdl:service>  </wsdl:service>
-</wsdl:definitions>+   </wsdl:definitions>
  
  
Linha 607: Linha 602:
 === Objetos de transferência de dados ===  === Objetos de transferência de dados === 
 Os objetos de transporte utilizados nas requisições e retorno dos métodos dos serviços, descritos na seção anterior estão descritos abaixo: Os objetos de transporte utilizados nas requisições e retorno dos métodos dos serviços, descritos na seção anterior estão descritos abaixo:
-DtoFormulario+ 
 +**DtoFormulario** 
 a) Descrição: a) Descrição:
 +
 Objeto que representa um formulário ativo, identificando suas seções e campos passíveis de recebimento da informação. Quando um nova versão do formulário para determinado tipo de formulário for lançada as informações abaixo podem ser atualizada, dada a natureza dinâmica de todo formulário, sempre é recomendado que se faça uma consulta dos formulários para se obter as seções e os campos atualmente aceitos para determinado formulário. Objeto que representa um formulário ativo, identificando suas seções e campos passíveis de recebimento da informação. Quando um nova versão do formulário para determinado tipo de formulário for lançada as informações abaixo podem ser atualizada, dada a natureza dinâmica de todo formulário, sempre é recomendado que se faça uma consulta dos formulários para se obter as seções e os campos atualmente aceitos para determinado formulário.
  
 b) Propriedades: b) Propriedades:
 +
 i) Id*: Numero identificador do formulário. i) Id*: Numero identificador do formulário.
  
Linha 629: Linha 628:
  
 * Campos obrigatórios para o Envio de um formulário. * Campos obrigatórios para o Envio de um formulário.
-DtoSecao+ 
 +**DtoSecao** 
 a) Descrição: a) Descrição:
 +
 Objeto organizador dos campos que formam um formulário. É na seção que se identifica se os campos são usados apenas para uma retificação e se a seção é do tipo lista, aceitando mais de uma linha durante o envio da informação. Objeto organizador dos campos que formam um formulário. É na seção que se identifica se os campos são usados apenas para uma retificação e se a seção é do tipo lista, aceitando mais de uma linha durante o envio da informação.
  
Linha 636: Linha 638:
  
 b) Propriedades: b) Propriedades:
 +
 i) Id: Numero identificador da seção. i) Id: Numero identificador da seção.
  
Linha 646: Linha 649:
 v) Campos: Lista com todos os campos desta seção. Este Dto é esclarecido abaixo. v) Campos: Lista com todos os campos desta seção. Este Dto é esclarecido abaixo.
  
-DtoCampo+**DtoCampo** 
 a) Descrição: a) Descrição:
 +
 Objeto que contêm todas as informação de um campo, que será utilizado tanto para o Envio da Informação, como para a Consulta de um formulário.  Objeto que contêm todas as informação de um campo, que será utilizado tanto para o Envio da Informação, como para a Consulta de um formulário. 
  
 b) Propriedades: b) Propriedades:
 +
 i) Id*: Identificador único do Meta Campo, que é obtido na Consulta de formulário e sempre deve ser informado ao enviar uma informação. i) Id*: Identificador único do Meta Campo, que é obtido na Consulta de formulário e sempre deve ser informado ao enviar uma informação.
  
Linha 660: Linha 666:
  
 v) Ordem: Identifica qual é a posição do campo ao exibir para o usuário na tela.  v) Ordem: Identifica qual é a posição do campo ao exibir para o usuário na tela. 
 +
 vi) Sequencia*: Campo importante para o envio da informação. Este campo representa a linha de uma seção do tipo lista, devendo ser preenchido sequencialmente iniciando com 1. Para a seção do tipo fixa este valor não precisa ser preenchido. vi) Sequencia*: Campo importante para o envio da informação. Este campo representa a linha de uma seção do tipo lista, devendo ser preenchido sequencialmente iniciando com 1. Para a seção do tipo fixa este valor não precisa ser preenchido.
 +
 vii) Valor*: Campo que representa o valor para o campo, apesar do campo aceitar uma sequência de caracteres, o campo será validado quanto ao seu tipo (item iii, acima), assim que a informação for enviada ao sistema.  vii) Valor*: Campo que representa o valor para o campo, apesar do campo aceitar uma sequência de caracteres, o campo será validado quanto ao seu tipo (item iii, acima), assim que a informação for enviada ao sistema. 
 +
 viii) Md5Arquivo: Campo que representa a string de validação do tipo MD5 dos bytes de um arquivo. Para o campo do  Tipo “Arquivo” será possível enviar no campo Valor uma URL, para que o webservice obtenha o mesmo da internet e valide o conteudo obtido com o MD5 informado neste campo, reduzindo assim o trafego de dados pela rede. viii) Md5Arquivo: Campo que representa a string de validação do tipo MD5 dos bytes de um arquivo. Para o campo do  Tipo “Arquivo” será possível enviar no campo Valor uma URL, para que o webservice obtenha o mesmo da internet e valide o conteudo obtido com o MD5 informado neste campo, reduzindo assim o trafego de dados pela rede.
  
 * Campos obrigatórios para o Envio de um formulário. * Campos obrigatórios para o Envio de um formulário.
-EnumTipoDado+ 
 +**EnumTipoDado** 
 a) Descrição: a) Descrição:
 Enumerador com todas as opções possíveis para o tipo do Campo. Enumerador com todas as opções possíveis para o tipo do Campo.
  
 b) Opções: b) Opções:
 +
 i) Texto (1) - Tipo texto. i) Texto (1) - Tipo texto.
  
Linha 696: Linha 708:
  
 xiv) CpfOuCnpj (14) - Tipo CPF ou CNPJ, sem formação. xiv) CpfOuCnpj (14) - Tipo CPF ou CNPJ, sem formação.
-DtoArquivo+ 
 +**DtoArquivo** 
 a) Descrição: a) Descrição:
 Objeto que representa um campo do tipo arquivo. Objeto que representa um campo do tipo arquivo.
Linha 702: Linha 716:
  
 b) Propriedades: b) Propriedades:
 +
 i) Id*: Identificador único do Meta Campo, que é obtido na Consulta de formulário e sempre deve ser informado ao enviar um arquivo. i) Id*: Identificador único do Meta Campo, que é obtido na Consulta de formulário e sempre deve ser informado ao enviar um arquivo.
  
Linha 711: Linha 726:
  
 * Campos obrigatórios para o Envio de um formulário. * Campos obrigatórios para o Envio de um formulário.
-DtoInformação+ 
 +**DtoInformação** 
 a) Descrição: a) Descrição:
 +
 Objeto que representa uma informação, identificando suas seções e campos relacionados.  Objeto que representa uma informação, identificando suas seções e campos relacionados. 
  
 b) Propriedades: b) Propriedades:
 +
 i) Id*: Número do informação caso ela já tenha sido enviada anteriormente. i) Id*: Número do informação caso ela já tenha sido enviada anteriormente.
  
  • pres/gerti/manuais/manual_de_integracao_informa.1467735229.txt.gz
  • Última modificação: 05/07/2016 16:13
  • por bholiveira