Índice:

Objetivo:

       O objetivo deste documento é trazer uma visão do que é e como funciona os serviços do Mashup via WebService.

Introdução:

       O serviço do Totvs Mashups permite a integração de qualquer aplicativo de qualquer sistema operacional e linguagem de programação. A sua implementação foi feita em cima da WCF (Windows Communication Foundation) utilizando o padrão WS-*, XML e SOAP para a comunicação. Mas é expansível a outros padrões suportados pela WCF da plataforma Microsoft.NET.

       Neste documento estão detalhados todos os métodos disponíveis e classes usadas para a comunicação com o WebService. 

       Imagem Demostrativa:

Métodos Disponíveis no WebService:

   GetServiceTypes:

       Através desta função é possível obter uma lista dos tipos de Mashups disponíveis. Na arquitetura do Totvs Mashups, podem ser criados vários tipos diferentes, como:

• MashupStudioService – Mashups criados com a ferramenta Mashup Studio
• MetadataService – Serviços de informações dos Mashups
• WebServices – Mashups baseados em WebServices

  Parâmetros: (SOAConnectionData)

  Resultados: Array de strings com a lista de ServiceTypes.

 Classe: SOAConnectionData:

• ClientID: String – ID do Client do Totvs Mashups
• UserName: String – Nome do usuário do Totvs Mashups
• Password: String – Senha do usuário

  GetServiceNames:

       Através desta função é possível obter uma lista dos Mashups disponíveis para o ServiceType selecionado. Cada ServiceType pode ter vários Mashups publicados.

  Parâmetros: (SOAConnectionData; ServiceType: String)

  Resultados: Array de strings com a lista de Mashups.

   GetServicesInfo:

Através desta função é possível obter uma lista com detalhes dos Mashups disponíveis para o SearchType e SearchValue informados. Esta função retorna diversas informações sobre os Mashups que estão definidas na classe SOAServiceInfo.

Parâmetros:

• SOAConnectionData
• SearchType: Enumerado (All, ServiceName, ServiceTitle, Description, Provider, Tag)
• SearchValue: String

Resultados: Array de SOAServiceInfo.

Classe: SOAServiceInfo

• ServiceType: String – Tipo de serviço do Mashup
• ServiceName: String – Nome do Mashup
• ServiceVersion: Integer – Versão do Mashup
• ServiceTitle: String – Título do Mashup
• ServiceProvider: String – Provedor dos dados do Mashup
• ServiceDescription: String – Descrição detalhada do Mashup
• ServiceTags: Strings – Tags relacionadas ao Mashup
• ServiceDate: DateTime – Data da publicação/alteração do Mashup

GetService

Através desta função é iniciado o processo de execução do Mashup, ela retorna todas as informações de execução do Mashup como Parâmetros e Resultados da execução do Mashup.

Parâmetros: (SOAConnectionData; ServiceType: String; ServiceName: String; ServiceVersion: Integer)

Resultados: SOAServiceData.

Classe: SOAServiceData

• ServiceExecutionID: String – ID da execução do Mashup
• ServiceType: String – Tipo de serviço do Mashup
• ServiceName: String – Nome do Mashup
• ServiceVersion: Integer – Versão do Mashup
• ServiceTitle: String – Título do Mashup
• CurrentState: String – Estado da execução do Mashup
• CurrentStateDescription: String – Descrição do estado da execução do Mashup
• Data: Array de SOAData – Dados da execução do Mashup
• DataKind: Enumerado – Tipo do dado do Mashup:
  • Param: Indica que o dado é um parâmetro do Mashup
  • Info: Indica que o dado é uma informação a ser mostrada do Mashup
  • Result: Indica que o dado é um resultado da execução do Mashup
  • Internal: Indica que é um dado para uso interno do Mashup
• DataType: Enumero – Indica o tipo de dado do valor
  • Boolean: Indica um dado do tipo boolean (True, False);
  • Integer: Indica um dado de tipo número inteiro;
  • Number: Indica um dado de tipo número (Double), deve ser usado o separador de decimal “.” (Ponto) e sem separador de milhar;
  • DateTime: Indica um dado no formato data/hora canônico (aaaa-MM-dd hh:mm:ss), caso o valor indicar somente hora, a data deve ser igual a “01/01/0001”;
  • String: Indica um dado do tipo texto;
  • List: Indica um dado que contem uma lista de valores/descrições;
  • Image: Indica um dado que contem uma imagem (JPEG com Codificação Base64);
  • Table: Indica um dado que contem uma tabela de valores detalhada abaixo;
• Name: String – Nome do dado do Mashup
• Description: String – Descrição do dado do Mashup
• StateName: String – Indica o nome do estado referente ao dado (somente para parâmetros)
• Value: String – Contém o valor do dado de acordo com o tipo de dado.
• ListItems: Array de SOADataListItem (válido somente para o DataType = List)
• Columns: Array de SOAData (válido somente para o DataType = Table)
• Required: Boolean – Indica se o parâmetro é obrigatório para a execução do Mashup
• Code: String – Código do valor do item da Lista
• Description: String – Descrição do item da Lista

Classe: SOAData

Classe: SOADataListItem