O objetivo deste documento é descrever a utilização de Webservices, mostrar e explicar todos seus métodos, disponibilizar exemplos de classes que utilizam esses Webservices e mostrar exemplos de geração de stubs que são necessários para que os client’s possam se comunicar com o serviço.
Os stubs são necessários para que os client’s que utilizam os métodos dos Webservices possam se comunicar com o serviço.
Para criar um stub é necessário que o serviço do Fluig esteja inicializado. Depois de iniciar o serviço, deve-se abrir o Prompt de comando e utilizar a sintaxe: wsimport -d <output_directory> <wsdl_url>, onde output_directory é o diretório onde o stub será criado e wsdl_url é a url de acesso ao serviço. Após isso, basta apertar Enter e o resultado aparecerá conforme mostra a figura 1.
Figura 1: Exemplo de criação de stub
No quadro 1, é mostrado o comando necessário para criação de stubs de cada serviço disponível no Fluig.
Webservices (WSDL) | Comando |
ECMAttributionMecanismService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMAttributionMecanismService?wsdl |
ECMBusinessPeriodService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMBusinessPeriodService?wsdl |
ECMCardIndexService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMCardIndexService?wsdl |
ECMCardService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMCardService?wsdl |
ECMColleagueGroupService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMColleagueGroupService?wsdl |
ECMColleagueReplacementService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMColleagueReplacementService?wsdl |
ECMColleagueService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMColleagueService?wsdl |
ECMCompanyService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMCompanyService?wsdl |
ECMCustomFieldsService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMCustomFieldsService?wsdl |
ECMDashBoardService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMDashBoardService?wsdl |
ECMDataServiceService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMDataServiceService?wsdl |
ECMDatasetService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMDatasetService?wsdl |
ECMDocumentService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMDocumentService?wsdl |
ECMFavoritesService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMFavoritesService?wsdl |
ECMFolderService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMFolderService?wsdl |
ECMGlobalParamService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMGlobalParamService?wsdl |
ECMGroupService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMGroupService?wsdl |
ECMOutstandingService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMOutstandingService?wsdl |
ECMReportService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMReportService?wsdl |
ECMSearchDocumentService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMSearchDocumentService?wsdl |
ECMSignalService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMSignalService?wsdl |
ECMTokenService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMTokenService?wsdl |
ECMWorkflowEngineService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMWorkflowEngineService?wsdl |
ECMWorkflowRoleService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMWorkflowRoleService?wsdl |
Quadro 1: Comandos para criação de stubs.
Para os métodos de update que recebem objetos complexos (DocumentDto, ColleagueDto, GroupDto, etc) é obrigatório passar todos os campos do objeto alterado. Os campos não informados serão substituídos por branco, nulo ou zero, dependendo do seu tipo.
Para evitar esta situação, sugerimos sempre utilizar os métodos get para recuperar o objeto, efetuar as alterações nos campos necessários e enviá-lo para o método update.
Webservice responsável por realizar operações referentes aos mecanismos de atribuição cadastrados no Fluig. Pode ser utilizado para pesquisar os mecanismos de atribuição de uma determinada empresa.
-
Quadro 2: Métodos da AttributionMecanismService.
|
Faça o download da classe AttributionMecanismServiceClient.java, esta exemplifica a utilização dos principais métodos da classe AttributionMecanismService.
Webservice responsável por realizar operações referentes aos expedientes cadastrados no Fluig. Pode ser utilizado para pesquisar os expedientes de uma determinada empresa.
-
Quadro 3: Métodos da BusinessPeriodService. |
Faça o download da classe BusinessPeriodServiceClient.java, esta exemplifica a utilização dos principais métodos da classe BusinessPeriodService.
Webservice responsável por realizar operações referentes aos formulários cadastrados no Fluig.
-
Quadro 4: Métodos da CardIndexService. |
Faça o download da classe CardIndexServiceClient.java, esta exemplifica a utilização dos principais métodos da classe CardIndexService.
Webservice responsável por realizar operações referentes a formulários no Fluig. Pode ser utilizado para criar, alterar, excluir e pesquisar formulários, entre outras funcionalidades.
-
Quadro 5: Métodos da CardService. |
Faça o download da classe CardServiceClient.java, esta exemplifica a utilização dos principais métodos da classe CardService.
Webservice responsável por realizar operações referentes aos grupos de usuários no Fluig. Pode ser utilizado para relacionar um usuário a um grupo de usuários e serve também para alterar, excluir e pesquisar esses relacionamentos criados.
-
Quadro 6: Métodos da ColleagueGroupService. |
Faça o download da classe ColleagueGroupServiceClient.java, esta exemplifica a utilização dos principais métodos da classe ColleagueGroupService.
Webservice responsável por realizar operações referentes a usuários substitutos no Fluig. Pode ser utilizado para criar, alterar, excluir e pesquisar usuários substitutos, entre outras funcionalidades.
-
Quadro 7: Métodos da ColleagueReplacementService |
Faça o download da classe ColleagueReplacementServiceClient.java, esta exemplifica a utilização dos principais métodos da classe ColleagueReplacementService.
Webservice responsável por realizar operações referentes a usuários no Fluig. Pode ser utilizado para criar, alterar, excluir e pesquisar usuários, entre outras funcionalidades.
Atenção: Os métodos createColleague, createColleaguewithDependencies, updateColleague e updateColleaguewithDependencies, em um dos seus parâmetros, recebe uma lista de ColleagueDto, nos objetos destas listas os valores para os campos de senha (password) devem ser criptografados com o algoritmo de hash MD5.
-
Quadro 8: Métodos da ColleagueService. |
Faça o download da classe ColleagueServiceClient.java, esta exemplifica a utilização dos principais métodos da classe ColleagueService.
Webservice responsável por realizar operações referentes à empresa no Fluig. Pode ser utilizado para criar, alterar, excluir e pesquisar empresas, entre outras funcionalidades.
-
Quadro 9: Métodos da CompanyService |
Faça o download da classe CompanyServiceClient.java, esta exemplifica a utilização dos principais métodos da classe CompanyService.
Webservice responsável por interagir com os campos customizados do Fluig. Pode ser utilizado para criar, alterar, excluir e pesquisar campos customizados, entre outras funcionalidades.
-
Quadro 10: Métodos da CustomFieldsService |
Faça o download da classe CustomFieldsServiceClient.java, esta exemplifica a utilização dos principais métodos da classe CustomFieldsService.
Webservice responsável por interagir com a central de tarefas do Fluig. Pode ser utilizado para pesquisar as informações que estão disponíveis na central de tarefas.
-
Quadro 11: Métodos da DashBoardService |
Faça o download da classe DashBoardClient.java, esta exemplifica a utilização dos principais métodos da classe DashBoardService.
Webservice responsável por interagir com os serviços externos do Fluig. Pode ser utilizado para criar, alterar, excluir e pesquisar os serviços externos existentes.
-
Quadro 12: Métodos da DataServiceService. |
Webservice responsável por interagir com os datasets do Fluig. Pode ser utilizado para pesquisar os datasets existentes.
-
Quadro 13: Métodos da DatasetService |
Faça o download da classe DatasetServiceClient.java, esta exemplifica a utilização dos principais métodos da classe DatasetService.
Webservice responsável por realizar operações referentes a documentos do Fluig. Pode ser utilizado para criar, alterar, excluir e procurar documentos, entre outras funcionalidades.
-
Quadro 14: Métodos da DocumentService |
Faça o download da classe DocumentServiceClient.java, esta exemplifica a utilização dos principais métodos da classe DocumentService.
Webservice responsável por interagir com os documentos e processos favoritos do Fluig. Pode ser utilizado para pesquisar os documentos e processos favoritos de cada usuário.
-
Quadro 15: Métodos da FavoritesService |
Faça o download da classe FavoritesServiceClient.java, esta exemplifica a utilização dos principais métodos da classe FavoritesService.
Webservice responsável por realizar operações referentes a pastas no Fluig. Pode ser utilizado para criar, alterar, excluir e pesquisar pastas, entre outras funcionalidades.
-
Quadro 16: Métodos da FolderService |
Faça o download da classe FolderServiceClient.java, esta exemplifica a utilização dos principais métodos da classe FolderService.
Webservice responsável por interagir com as configurações dos parâmetros gerais do Fluig. Pode ser utilizado para criar, alterar e pesquisar os parâmetros gerais.
-
Quadro 17: Métodos da GlobalParamService. |
Faça o download da classe GlobalParamServiceClient.java, esta exemplifica a utilização dos principais métodos da classe GlobalParamService.
Webservice responsável por realizar operações referentes a grupos no Fluig. Pode ser utilizado para criar, alterar, excluir e procurar grupos, entre outras funcionalidades.
-
Quadro 18: Métodos da GroupService. |
Faça o download da classe GroupServiceClient.java, esta exemplifica a utilização dos principais métodos da classe GroupService.
Webservice responsável por interagir com as transferências de pendências do Fluig. Pode ser utilizado para transferir pendências de um usuário para outro usuário.
-
Quadro 19: Métodos da OutstandingService. |
Exemplo de utilização
Faça o download da classe OutstandingServiceClient.java, esta exemplifica a utilização dos principais métodos da classe OutstandingService.
Webservice responsável por realizar operações referentes a relatórios no Fluig. Pode ser utilizado para criar, alterar, excluir e procurar relatórios, entre outras funcionalidades.
-
Quadro 20: Métodos da ReportService. |
Faça o download da classe ReportServiceClient.java, esta exemplifica a utilização dos principais métodos da classe ReportService.
Webservice responsável por realizar operações referentes às buscas no Fluig. Pode ser utilizado para buscar documentos utilizando a busca simples e avançada.
-
Quadro 21: Métodos da SearchDocumentService |
Faça o download da classe SearchDocumentServiceClient.java, esta exemplifica a utilização dos principais métodos da classe SearchDocumentService.
Webservice responsável por interagir com os token’s do Fluig. Pode ser utilizado para pesquisar e validar os token’s existentes.
-
Quadro 22: Métodos da TokenService. |
Faça o download da classe TokenServiceClient.java, esta exemplifica a utilização dos principais métodos da classe TokenService.
Webservice responsável por realizar operações referentes a workflow no Fluig. Pode ser utilizado para movimentar solicitações, entre outras funcionalidades.
-
Quadro 23: Métodos da WorkflowEngineService |
Faça o download da classe WorkflowEngineServiceClient.java, esta exemplifica a utilização dos principais métodos da classe WorkflowEngineService.
Webservice responsável por realizar operações referentes a papéis no Fluig. Pode ser utilizado para criar, alterar, excluir e procurar papéis, entre outras funcionalidades.
-
Quadro 24: Métodos da WorkflowRoleService |