Índice

outline	true
exclude	.*ndice
style	none

Objetivo

Além de algumas APIs REST, o fluig disponibiliza também uma série de Web Services SOAP (Simple Object Access Protocol). Neste documento mostraremos como habilitar ou desabilitar esses serviços, como gerar os stubs para utilizá-los em softwares terceiros e como utilizá-los dentro do próprio fluig.

Pré-requisitos

Para que se tenha uma compreensão completa destas informações, alguns conhecimentos são considerados pré-requisitos, entre eles:

Visão geral sobre o fluig
Visão geral sobre integração de sistemas
Web Services

Antes de começar

Os Web Services SOAP, apesar de continuarem funcionais, não recebem mais novos serviços nem alterações nos parâmetros de entrada. Caso haja, opte por usar a função correspondente nas APIs REST.

Como acessar

Para acessar os webservices do TOTVS Fluig Plataforma, é preciso acessar o URL https://<endereco_fluig:porta>/services.

Nossos serviços estão descritos no formato WSDL (Linguagem de Descrição de Serviços Web)

Segurança

Existem dois principais dispositivos de segurança para o uso dos Web Services SOAP.

Permissão por Web Services e/ou métodos

Por padrão, todos os usuários do fluig podem acessar os serviços. Isso facilita integrações e widgets que possam fazer uso dos serviços SOAP. Mas o administrador do sistema, caso queira, pode bloquear o uso dos serviços como um todo ou de alguns métodos.

Por motivos de retrocompatibilidade, é impossível bloquear o acesso dos serviços SOAP a todos os usuários. O fluig entende que se não há ninguém nas permissões é porque o administrador não quer configurar essa permissão, então para bloquear o acesso dos usuários normais ele deve dar permissão apenas a um usuário (o próprio administrador por exemplo);

Para bloquear o acesso a todos os métodos de um serviço, por exemplo, ECMWorkflowEngineService, o administrador deve entrar no painel de controle e acessar a opção de permissões. Pesquisar por ECMWorkflowEngineService. Irá listar tanto o acesso geral à API ECMWorkflowEngineService quanto a cada um dos métodos.

O administrador pode adicionar permissões para ele próprio no serviço geral do ECMWorkflowEngineService e isso fará com que nenhum usuário possa acessar os métodos desse serviço. Caso queira liberar um método específico , por exemplo startProcess, o administrador pode, mantendo a configuração anterior, acessar as permissões do recurso ECMWorkflowEngineService.startProcess adicionar as permissões conforme a sua necessidade.

Ou se quiser manter acesso a todos os outros métodos mas bloquear somente um método específico, ele deve manter as permissões gerais do serviço sem nenhuma configuração de permissão, e adicionar o usuário administrador nas permissões do método que deseja que seja bloqueado aos demais usuários.

Nota

title	Observação

Alguns métodos não foram criados para retornar erros. Então alguns métodos podem retornar informações vazias caso o acesso seja negado. Nestes casos, o log pode ser consultado para verificar a negação de acesso ao serviço.

Personificação

Por lidar com integrações, alguns métodos permitem que o usuário integrador tome uma ação em nome de outro usuário (por exemplo, um serviço terceiro que utiliza um usuário para integrações pode abrir um chamado em nome de um usuário normal do fluig). Você pode limitar os usuários que conseguem tomar ação em nome de outros usuários pelos Web Services entrando no painel de controle e acessando a opção de permissões. Pesquisar por Personificação.

Nota

title	Observação

Assim como nas permissões dos Web Services, o fluig entende que se não há ninguém nas permissões é porque o administrador não quer configurar essa permissão, então para bloquear o acesso dos usuários normais ele deve dar permissão apenas a um usuário (o próprio administrador por exemplo)

Permissões das funções acessadas

Independente das permissões anteriores, o fluig continua respeitando as permissões inerentes às funções acessadas. Ou seja, para configurar um processo, o usuário precisa ter acesso a página de configurar processos. Para acessar um documento, o usuário precisa ter permissão para visualizar o documento em si.

Como utilizar os Web Services em softwares terceiros

Verificando os serviços e chamadas manuais

Se você quer verificar o uso dos serviços ou mesmo fazer uma chamada individual você pode fazê-lo através de um aplicativo qualquer com suporte a requisições do tipo SOAP. Insira a url de um dos serviços disponíveis na url /services e preencha os dados conforme solicitado pelo aplicativo.

Criando rotinas automatizadas

O primeiro passo é fazer o download dos stubs, que são classes modelos que irão auxiliar no preenchimento dos dados utilizados por cada um dos serviços.

JDK 11 e superiores

Nas versões mais recentes da JDK o utilitário wsimport foi removido. Você pode baixar por outras fontes ou utilizar no lugar o Apache CXF (https://cxf.apache.org/) e gerando a biblioteca com os arquivos baixados

Bloco de código

language	bash
linenumbers	true

wsdl2java -client -d C:\stubs\ -classdir C:\stubs\ -encoding UTF-8 -compile https://<endereco_fluig:porta>/webdesk/ECMWorkflowEngineService?wsdl
jar -cvf fluig-ws-client.jar C:\stubs\*.*

JDK 8 e inferiores

Se você usa a JDK do java na versão 8 ou inferior, você pode utilizar este utilitário que disponibilizamos para gerar os stubs de todos os serviços.

Ou fazer de forma manual, caso precise apenas de um Web Service específico, usando o comando wsimport e gerando a biblioteca:

Bloco de código

language	bash
linenumbers	true

wsimport -d C:\stubs\ https://<endereco_fluig:porta>/webdesk/ECMWorkflowEngineService?wsdl
jar -cvf fluig-ws-client.jar C:\stubs\*.*

Importando a lib e desenvolvendo sua integração

Após a geração do arquivo fluig-ws-client.jar (conforme descrito nos passos anteriores) você pode desenvolver sua própria API.

Se quiser gerar uma biblioteca para usar dentro do próprio Fluig, ou mesmo alguns exemplos de como utilizar as integrações, você pode consultar nossa documentação

Para saber como ou então aprender como utilizar a biblioteca gerada, aqui você encontra um exemplo prático de utilização em artefatos publicados no fluig.

POST, não PUT

É importante salientar que todos os dados enviados (ou não enviados) em um método de alteração são considerados. Se um campo não for enviado, o sistema vai considerar que o valor dele deve ser deixado em branco, nulo ou zerado, conforme o tipo de dado. Então, mesmo que você queira apenas modificar a descrição do arquivo, você deve passar todos os outros dados do documento.

Disponibilidade dos Web Services

Lembre-se que a sua integração pode ocorrer em um momento que o fluig não está no ar. Seja por uma atualização ou regra de economia de energia, esteja preparado nas suas integrações para indisponibilidade do servidor. Ou seja, use try/catch.

Como utilizar os Web Services do Fluig no próprio Fluig?

Você pode utilizar os serviços do Fluig no próprio Fluig, da mesma forma que utiliza serviços de terceiros. Para isso, o administrador deve entrar no Painel de Controle e acessar a opção de Serviços. Criar um novo serviço do tipo SOAP, definir um nome (por exemplo ECMWorkflowEngineService, este nome será usado depois para referenciar este cadastro), uma descrição para outros identificarem que serviço é este e a URL do serviço (por exemplo, https://<endereco_fluig:porta>/webdesk/ECMWorkflowEngineService?wsdl)

Usando o editor web (sem codificação)

Na configuração de processo, crie ou edite um processo e adicione uma atividade de serviço. Acesse as propriedades dessa atividade e selecione o serviço ECMWorkflowEngineService (ou o nome que você utilizou no cadastro) e selecione a operação (por exemplo, startProcess).

Preencha os campos que serão utilizados e confirme.

Exemplo de configuração da atividade de serviço pelo editor web Image Added

Codificando

Você também pode fazer a codificação da chamada dos métodos dos serviços, fazendo com quem um dataset faça a inicialização da solicitação ou mesmo caso a opção sem codificação não atenda as suas necessidades. Para lhe ajudar, criamos este exemplo:

Bloco de código

language	js
firstline	1
title	Exemplo de integração via codificação
linenumbers	true

function startProcess() {
	var serviceHelper = ServiceManager.getService("ECMWorkflowEngineService").getBean();
    var serviceLocator = serviceHelper.instantiate("com.totvs.technology.ecm.workflow.ws.ECMWorkflowEngineServiceService");
    var service = serviceLocator.getWorkflowEngineServicePort();
    
    // Lista das matrículas de usuários que irão receber a atividade. Normalmente é um usuário, mas no caso de um consenso podem ser vários
    var colleagueIds = serviceHelper.instantiate('net.java.dev.jaxb.array.StringArray');
    colleagueIds.getItem().add("adm");
    
    // Chama o serviço para iniciar a solicitação e recebe o retorno
    // O retorno do startProcess é um String[][], ou no Soap, um StringArrayArray
    var retornoStartProcess = service.startProcess(
    		'integrador', // matrícula do usuário integrador
    		'9a411f45fcea479ffb839a3ee605c18d', // senha do usuário
    		1, // código da empresa
    		"processoASerIniciado", // código do processo
    		2, // código da atividade para qual a solicitação vai ser movimentada
    		colleagueIds, 
    		"Iniciado via ws", // Comentário da movimentação
    		'integrador', // Usuário que ficará como o inicializador da solicitação. O usuário integrador precisa ter personificação caso seja um usuário diferente do integrador
    		true, // Se vai completar a tarefa inicial (true) ou não, vai apenas salvar a solicitação para gerar um código e preencher o formulário, anexos e comentários
    		serviceHelper.instantiate('com.totvs.technology.ecm.workflow.ws.ProcessAttachmentDtoArray'), // Lista de anexos. Mesmo que não seja enviado nenhum, é necessário enviar a lista vazia
    		serviceHelper.instantiate('net.java.dev.jaxb.array.StringArrayArray'), // Dados do formulário. Mesmo que não tenha formulário ou não seja preenchido, é necessário enviar a lista vazia
    		serviceHelper.instantiate('com.totvs.technology.ecm.workflow.ws.ProcessTaskAppointmentDtoArray'), // Apontamentos da solicitação. Não é mais utilizado, mas por compatibilidade é necessário enviar a lista vazia
    		false // Se a movimentação é feita como usuário responsável pela atividade ou como gestor do processo
	);
    
    var retorno = stringArrayArrayToSimpleObject(retornoStartProcess);
    
    if (retorno.ERROR) {
    	// Interrompe a execução ou movimentação e retorna um erro com a resposta do serviço
    	throw "Solicitação não iniciada: " + retorno.ERROR;
    } else {
    	// Imprime o código da solicitação criada pelo serviço e depois imprime todos os dados que foram retornados
    	log.info("Solicitação " + retorno.iProcess + " criada com sucesso");
    	log.dir(retorno)
    }    
}


function stringArrayArrayToSimpleObject(stringArrayArray) {
	var objeto = {};
	for(var i = 0; i < stringArrayArray.getItem().size(); i++) {
		var item = stringArrayArray.getItem().get(i).getItem();
		objeto[item.get(0)] = item.get(1);
	}
	
	return objeto;
}

Ou, se preferir um exemplo um pouco maior, mas contendo mais detalhes sobre o que é cada parâmetro e desenvolvido para ser melhor re-utilizável, você pode conferir este exemplo que faz o mesmo que o exemplo anterior

Bloco de código

language	js
firstline	1
title	Exemplo de integração via codificação
linenumbers	true

//configure os dados do seu usuário integrador
var INTEGRADOR = {
	matricula: 'integrador',
	senha: '9a411f45fcea479ffb839a3ee605c18d',
	empresa: 1
};

// conforme o cadastro do fluig
var SERVICOS = {
	workflowEngineService: "ECMWorkflowEngineService"
}

/**
 * Função que cria uma solicitação via Soap no Fluig
 * 
 */
function startProcess() {
    var serviceHelper = getECMWorkflowEngineServiceHelper();
    var service = getECMWorkflowEngineService(serviceHelper);
    
    // Nome do processo a ser iniciado
    var processId = "processoASerIniciado";
        
    // Atividade para qual será movimentada a solicitação
    var choosedState = 2;
    
    // Lista das matrículas de usuários que irão receber a atividade. Normalmente é um usuário, mas no caso de um consenso podem ser vários
    var colleagueIds = createStringArray(serviceHelper);
    colleagueIds.getItem().add("adm");
    
    // Comentário da movimentação
    var comments = "Iniciado via ws";
    
    // Usuário que ficará como o inicializador da solicitação. O usuário integrador precisa ter personificação caso seja um usuário diferente do integrador
    var userId = INTEGRADOR.matricula;
    
    // Se vai completar a tarefa inicial (true) ou não, vai apenas salvar a solicitação para gerar um código e preencher o formulário, anexos e comentários
    var completeTask = true;
    
    // Lista de anexos. Mesmo que não seja enviado nenhum, é necessário enviar a lista vazia
    var attachments = createProcessAttachmentDtoArray(serviceHelper);

    // Dados do formulário. Mesmo que não tenha formulário ou não seja preenchido, é necessário enviar a lista vazia
    var cardData = createStringArrayArray(serviceHelper);
    
    // Apontamentos da solicitação. Não é mais utilizado, mas por compatibilidade é necessário enviar a lista vazia
    var appointments = createProcessTaskAppointmentDtoArray(serviceHelper);
    
    // Se a movimentação é feita como usuário responsável pela atividade ou como gestor do processo
    var managerMode = false;
    
    // Chama o serviço para iniciar a solicitação e recebe o retorno
    // O retorno do startProcess é um String[][], ou no Soap, um StringArrayArray
    var retornoStartProcess = service.startProcess(
    		INTEGRADOR.matricula, 
    		INTEGRADOR.senha, 
    		INTEGRADOR.empresa, 
    		processId, 
    		choosedState, 
    		colleagueIds, 
    		comments, 
    		userId, 
    		completeTask, 
    		attachments, 
    		cardData, 
    		appointments, 
    		managerMode
	);
    
    var retorno = stringArrayArrayToSimpleObject(retornoStartProcess);
    
    if (retorno.ERROR) {
    	// Interrompe a execução ou movimentação e retorna um erro com a resposta do serviço
    	throw "Solicitação não iniciada: " + retorno.ERROR;
    } else {
    	// Imprime o código da solicitação criada pelo serviço e depois imprime todos os dados que foram retornados
    	log.info("Solicitação " + retorno.iProcess + " criada com sucesso");
    	log.dir(retorno)
    }    
}

function getECMWorkflowEngineServiceHelper() {
    return ServiceManager.getService(SERVICOS.workflowEngineService).getBean();
}

function getECMWorkflowEngineService(serviceHelper) {
	var serviceLocator = serviceHelper.instantiate("com.totvs.technology.ecm.workflow.ws.ECMWorkflowEngineServiceService");
    return serviceLocator.getWorkflowEngineServicePort();
}

/**
 * Cria uma variável similar ao String[] que é utilizado pelo Soap
 * @param serviceHelper O wsdl que contém o mapeamento da estrutura de um objeto do tipo net.java.dev.jaxb.array.StringArray
 * @returns Um objeto do tipo net.java.dev.jaxb.array.StringArray conforme o mapeamento do wsdl
 */
function createStringArray(serviceHelper) {
	return serviceHelper.instantiate('net.java.dev.jaxb.array.StringArray');
}


/**
 * Cria uma variável similar ao String[][] que é utilizado pelo Soap
 * @param serviceHelper O wsdl que contém o mapeamento da estrutura de um objeto do tipo net.java.dev.jaxb.array.StringArrayArray
 * @returns Um objeto do tipo net.java.dev.jaxb.array.StringArrayArray conforme o mapeamento do wsdl
 */
function createStringArrayArray(serviceHelper) {
	return serviceHelper.instantiate('net.java.dev.jaxb.array.StringArrayArray');
}


/**
 * Cria uma variável similar ao ProcessAttachmentDto[] que é utilizado pelo Soap
 * @param serviceHelper O wsdl que contém o mapeamento da estrutura de um objeto do tipo com.totvs.technology.ecm.workflow.ws.ProcessAttachmentDtoArray
 * @returns Um objeto do tipo com.totvs.technology.ecm.workflow.ws.ProcessAttachmentDtoArray conforme o mapeamento do wsdl
 */
function createProcessAttachmentDtoArray(serviceHelper) {
	return serviceHelper.instantiate('com.totvs.technology.ecm.workflow.ws.ProcessAttachmentDtoArray');
}

/**
 * Cria uma variável similar ao ProcessTaskAppointmentDto[] que é utilizado pelo Soap. 
 * 
 * Estes apontamentos não são mais usados, mas como não devemos mexer na assinatura dos métodos Soap para não quebrar os stubs já gerados é obrigatório mandar, ainda que vazio
 * 
 * @param serviceHelper O wsdl que contém o mapeamento da estrutura de um objeto do tipo com.totvs.technology.ecm.workflow.ws.ProcessTaskAppointmentDtoArray
 * @returns Um objeto do tipo com.totvs.technology.ecm.workflow.ws.ProcessTaskAppointmentDtoArray conforme o mapeamento do wsdl
 */
function createProcessTaskAppointmentDtoArray(serviceHelper) {
	return serviceHelper.instantiate('com.totvs.technology.ecm.workflow.ws.ProcessTaskAppointmentDtoArray');
}

/**
 * Transforma um objeto do tipo StringArrayArray (String[][]) em um objeto Javascript
 * 
 * <item>
 *   <item>campo</item>
 *   <item>valor</item>
 * </item>
 * 
 * Vira:
 * 
 * {'campo': 'valor'}
 * 
 * @param stringArrayArray
 * @returns Um objeto do tipo javascript 
 */
function stringArrayArrayToSimpleObject(stringArrayArray) {
	var objeto = {};
	for(var i = 0; i < stringArrayArray.getItem().size(); i++) {
		var item = stringArrayArray.getItem().get(i).getItem();
		objeto[item.get(0)] = item.get(1);
	}
	
	return objeto;
}

Objetivo

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.

Criar Stubs

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.

Image Removed

Figura 1: Exemplo de criação de stub

Expandir

title	Lista de webservices

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.

Considerações Métodos de Update

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.

ECMAttributionMecanismService

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.

Métodos

Expandir

title	No quadro 2, é mostrado todos os métodos disponíveis na classe AttributionMecanismService.

-

getAttributionMecanism

Retorna os mecanismos de atribuição da empresa.

Método:

getAttributionMecanism(String user, String password, int companyId)

Parâmetros:

user: login do usuário.
password: senha do usuário.
companyId: código da empresa.

Retorno: AttributionMecanismDto[].

Quadro 2: Métodos da AttributionMecanismService.

Exemplo de utilização

No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosAttributionMecanismService é disponibilizada a classe AttributionMecanismServiceClient.java, esta exemplifica a utilização de todos os métodos da classe AttributionMecanismService.

ECMBusinessPeriodService

Webservice responsável por realizar operações referentes aos expedientes cadastrados no Fluig. Pode ser utilizado para pesquisar os expedientes de uma determinada empresa.

Métodos

Expandir

title	No quadro 3, é mostrado todos os métodos disponíveis na classe BusinessPeriodService.

-

getBusinessPeriods

Retorna os expedientes da empresa.

Método:

getBusinessPeriods(String user, String password, int companyId)

Parâmetros:

user: login do usuário.
password: senha do usuário.
companyId: código da empresa.

Retorno: BusinessPeriodDto[].

Quadro 3: Métodos da BusinessPeriodService.

Exemplo de utilização

No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosBusinessPeriodService é disponibilizada a classe BusinessPeriodServiceClient.java, esta exemplifica a utilização de todos os métodos da classe BusinessPeriodService.

ECMCardIndexService

Webservice responsável por realizar operações referentes aos formulários cadastrados no Fluig.

Métodos

Expandir

title	No quadro 4, é mostrado todos os métodos disponíveis na classe CardIndexService.

-

createSimpleCardIndex	Criação simples de um formulário. Método: createSimpleCardIndex (String user, String password, int companyId, int parentDocumentId, String publisherId, String documentDescription, String cardDescription, AttachmentArray attachments, CardEventDtoArray customEvents) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. parentDocumentId: numero do formulário. publisherId: código do autor. documentDescription: descrição. cardDescription: nome. attachments: arquivo anexo. customEvents: eventos. Retorno: WebServiceMessageArray [].
createSimpleCardIndexWithDataset	Criação simples de um formulário com datasets. Método: createSimpleCardIndexWithDataset (String user, String password, int companyId, int parentDocumentId, String publisherId, String documentDescription, String cardDescription, String datasetName, AttachmentArray attachments, CardEventDtoArray customEvents) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. parentDocumentId: numero do formulário. publisherId: código do autor. documentDescription: descrição. cardDescription: nome. datasetName: nome do dataset. attachments: arquivo anexo. customEvents: eventos. Retorno: WebServiceMessageArray [].
createSimpleCardIndexWithDatasetPersisteType	Criação simples de um formulário com datasets determinando o tipo da persistência (Formulário ou Lista). createSimpleCardIndexWithDatasetPersisteType (String user, String password, int companyId, int parentDocumentId, String publisherId, String documentDescription, String cardDescription, String datasetName, AttachmentArray attachments, CardEventDtoArray customEvents, Integer persistenceType) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa; parentDocumentId: numero do formulário. publisherId: código do autor. documentDescription: descrição. cardDescription: nome. datasetName: nome do dataset. attachments: arquivo anexo. customEvents: eventos. persistenceType: tipo da persistência que será utilizada. Retorno: WebServiceMessageArray [].
getActiveCardIndex	Retorna o formulário ativo. Método: getActiveCardIndex (String user, String password, int companyId, int documentId, String colleagueId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. documentId: número do formulário. colleagueId: número do usuário. Retorno: DocumentDtoArray [].
getAttachmentsList	Retorna a lista de anexos do formulário. Método: getAttachmentsList (String user, String password, int companyId, int documentId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. documentId: numero do formulário. Retorno: StringArray [].
getCardIndexContent	Retorna o conteúdo de um formulário. Método: getCardIndexContent (String user, String password, int companyId, int documentId, String colleagueId, int version, String nomeArquivo) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. documentId: numero do formulário. colleagueId : matrícula do usuário para a verificação de permissão nos formulários. version: número da versão do formulário. nomeArquivo: nome do arquivo anexo. Retorno: byte[].
getCardIndexesWithoutApprover	Retorna os formulários sem aprovadores que o usuário tenha permissão. Método: getCardIndexesWithoutApprover(String user, String password, int companyId, String colleagueId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. colleagueId : matrícula do usuário para a verificação de permissão nos formulários. Retorno: DocumentDto[].
getCustomizationEvents	Retorna os eventos do formulário. Método: getCustomizationEvents (String user, String password, int companyId, int documentId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. documentId: número do formulário. Retorno: CardEventDtoArray [].
getFormFields	Retorna os campos do formulário. Método: getFormFields(String user, String password, int companyId, int documentId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. documentId: número do formulário. Retorno: String[].
updateSimpleCardIndex	Atualização simples do formulário. Método: updateSimpleCardIndex (String user, String password, int companyId, int documentId, String publisherId, String cardDescription, String descriptionField, AttachmentArray attachments, CardEventDtoArray customEvents) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. documentId: número do formulário. publisherId: código do autor. cardDescription: nome. descriptionField: descrição. attachments: arquivo anexo. customEvents: eventos. Retorno: WebServiceMessageArray [].
updateSimpleCardIndexWithDataset	Atualização simples do formulário com datasets. Método: updateSimpleCardIndexWithDataset (String user, String password, int companyId, int documentId, String publisherId, String cardDescription, String descriptionField, String datasetName, AttachmentArray attachments, CardEventDtoArray customEvents) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. documentId: número do formulário. publisherId: código do autor. cardDescription: nome. descriptionField: descrição. datasetName: nome do dataset. attachments: arquivo anexo. customEvents: eventos. Retorno: WebServiceMessageArray [].

Quadro 4: Métodos da CardIndexService.

Exemplo de utilização

No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosCardIndexService é disponibilizada a classe CardIndexServiceClient.java, esta exemplifica a utilização de todos os métodos da classe CardIndexService.

ECMCardService

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.

Métodos

Expandir

title	No quadro 5, é mostrado todos os métodos disponíveis na classe CardService.

-

updateCardData	Altera os campos de um formulário. Método: updateCardData(int companyId, String user, String password, int cardId, CardFieldDto[] cardData) Parâmetros: companyId: código da empresa. user: login do usuário. password: senha do usuário. cardId: número do formulário. cardData: campos do formulário que serão alterados. Retorno: WebServiceMessage[].
create	Cria um formulário. Método: create(int companyId, String user, String password, CardDto[] carddtos) Parâmetros: companyId: código da empresa. user: login do usuário. password: senha do usuário. carddtos: formulário que será criado. Retorno: WebServiceMessage[].
deleteCard	Exclui um formulário e envia para a lixeira. Método: deleteCard(int companyId, String user, String password, int cardId) Parâmetros: companyId: código da empresa. user: login do usuário. password: senha do usuário. cardId: número do formulário. Retorno: WebServiceMessage[].
updateCard	Altera os metadados de um formulário. Método: updateCard(int companyId, String user, String password, CardDto[] cardDtos, Attachment[] attachs, DocumentSecurityConfigDto[] docsecurity, ApproverDto[] docapprovers, RelatedDocumentDto[] reldocs) Parâmetros: companyId: código da empresa. user: login do usuário. password: senha do usuário. cardDtos: formulário que será alterado. attachs: anexos do formulário. docsecurity: segurança do formulário. docapprovers: aprovadores do formulário. reldocs: documentos relacionados do formulário. Retorno: WebServiceMessage[].
getCardVersion	Retorna a versão de um formulário. Método: getCardVersion(int companyId, String user, String password, int nrDocumentId, int version, String colleagueId) Método: Parâmetros: companyId: código da empresa. user: login do usuário. password: senha do usuário. nrDocumentId: número do formulário. version: versão do formulário. colleagueId: matrícula do usuário. Retorno: CardDto[].

Quadro 5: Métodos da CardService.

Exemplo de utilização

No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosCardService é disponibilizada a classe CardServiceClient.java, esta exemplifica a utilização de todos os métodos da classe CardService.

ECMColleagueGroupService

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.

Métodos

Expandir

title	No quadro 6, é mostrado todos os métodos disponíveis na classe ColleagueGroupSevice.

-

getColleagueGroupsByColleagueId	Retorna os grupos que um usuário participa. Método: getColleagueGroupsByColleagueId(String username, String password, int companyId, String colleagueId) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa. colleagueId: matrícula do usuário. Retorno: ColleagueGroupDto[].
getColleagueGroupsByGroupId	Retorna os usuários que participam de um grupo de usuários. Método: getColleagueGroupsByGroupId(String username, String password, int companyId, String groupId) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa. groupId: código do grupo. Retorno: ColleagueGroupDto[].
getAllColleagueGroups	Retorna todos os grupos que possuem usuários relacionados. Método: getAllColleagueGroups(String username, String password, int companyId) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa. Retorno: ColleagueGroupDto[].
getColleagueGroup	Retorna somente um grupo que determinado usuário participa. Método: getColleagueGroup(String username, String password, int companyId, String groupId, String colleagueId) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa. groupId: código do grupo. colleagueId: matrícula do usuário. Retorno: ColleagueGroupDto[].
createColleagueGroup	Associa um usuário a um grupo. Método: createColleagueGroup(String username, String password, int companyId, ColleagueGroupDto[] grupo_colaborador) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa; grupo_colaborador: grupo que estará associado a um usuário. Retorno: String.
updateColleagueGroup	Altera a associação de um usuário a um grupo. Método: updateColleagueGroup(String username, String password, int companyId, ColleagueGroupDto[] grupo_colaborador) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa. grupo_colaborador: grupo de usuários que será alterado. Retorno: String.
deleteColleagueGroup	Exclui um usuário de um grupo. Método: deleteColleagueGroup(String username, String password, int companyId, String groupId, String colleagueId) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa. groupId: código do grupo. colleagueId: matrícula do usuário. Retorno: String.

Quadro 6: Métodos da ColleagueGroupService.

Exemplo de utilização

No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosColleagueGroupService é disponibilizada a classe ColleagueGroupServiceClient.java, esta exemplifica a utilização de todos os métodos da classe ColleagueGroupService.

ECMColleagueReplacementService

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.

Métodos

Expandir

title	No quadro 7, é mostrado todos os métodos disponíveis na classe ColleagueReplacementService.

-

getColleagueReplacement	Retorna um substituto de um usuário. Método: getColleagueReplacement(String username, String password, int companyId, String colleagueId, String replacementId) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa. colleagueId: matrícula do usuário origem. replacementId: matrícula do usuário substituto. Retorno: ColleagueReplacementDto.
getReplacementsOfUser	Retorna todos os substitutos de um usuário. Método: getReplacementsOfUser(String username, String password, int companyId, String colleagueId) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa. colleagueId: matrícula do usuário origem. Retorno: ColleagueReplacementDto[].
getValidReplacedUsers	Retorna todos os usuário substituídos por um substituto válido. Método: getValidReplacedUsers(String username, String password, int companyId, String replacementId) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa; replacementId: matrícula do usuário substituto. Retorno: ColleagueReplacementDto[].
getValidReplacement	Retorna um substituto válido de um usuário. Método: getValidReplacement(String username, String password, int companyId, String colleagueId, String replacementId) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa. colleagueId: matrícula do usuário origem. replacementId: matrícula do usuário substituto. Retorno: ColleagueReplacementDto.
getValidReplacementsOfUser	Retorna todos os substitutos válidos de um usuário. Método: getValidReplacementsOfUser(String username, String password, int companyId, String colleagueId) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa; colleagueId: matrícula do usuário origem. Retorno: ColleagueReplacementDto[].
createColleagueReplacement	Cria um substituto. Método: createColleagueReplacement (String username, String password, int companyId, ColleagueReplacementDto crDto) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa. crDto: cadastro do substituto. Retorno: String.
updateColleagueReplacement	Altera o cadastro de um substituto. Método: updateColleagueReplacement (String username, String password, int companyId, ColleagueReplacementDto crDto) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa. crDto: cadastro do usuário. Retorno: String.
deleteColleagueReplacement	Exclui o cadastro de um substituto. Método: deleteColleagueReplacement(String username, String password, int companyId, String colleagueId, String replacementId) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa. colleagueId: matrícula do usuário origem. replacementId: matrícula do usuário substituto. Retorno: String.

Quadro 7: Métodos da ColleagueReplacementService

Exemplo de utilização

No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosColleagueReplacementService é disponibilizada a classe ColleagueReplacementServiceClient.java, esta exemplifica a utilização de todos os métodos da classe ColleagueReplacementService.

ECMColleagueService

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.

Métodos

Expandir

title	No quadro 8, é mostrado todos os métodos disponíveis na classe ColleagueService.

-

getColleagues	Retorna todos os usuários ativos. Método: getColleagues(String username, String password, int companyId) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa. Retorno: ColleagueDto[].
getColleague	Retorna um usuário. Método: getColleague(String username, String password, int companyId, String colleagueId) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa. colleagueId: matrícula do usuário. Retorno: ColleagueDto[].
getGroups	Retorna os grupos que o usuário participa. Método: getGroups(String username, String password, int companyId, String colleagueId) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa. colleagueId: matrícula do usuário. Retorno: GroupDto[].
createColleague	Cria um usuário. Método: createColleague(String username, String password, int companyId, ColleagueDto[] colleagues) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa. colleagues: usuários. Retorno: String.
createColleaguewithDependencies	Cria um usuário com grupos e papéis. Método: createColleaguewithDependencies(String username, String password, int companyId, ColleagueDto[] colleagues, GroupDto[] grupos, WorkflowRoleDto[] papeis) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa. colleagues: usuários. grupos: grupos. papeis: papéis. Retorno: String.
updateColleague	Altera um usuário. Método: updateColleague(String username, String password, int companyId, ColleagueDto[] colleagues) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa. colleagues: usuários. Retorno: String.
updateColleaguewithDependencies	Altera um usuário com grupos e papéis. Método: updateColleaguewithDependencies(String username, String password, int companyId, ColleagueDto[] colleagues, GroupDto[] grupos, WorkflowRoleDto[] papeis) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa. colleagues: usuários. grupos: grupos. papeis: papéis. Retorno: String.
removeColleague	Exclui um usuário. Método: removeColleague(String username, String password, int companyId, String colleagueId) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa. colleagueId: matrícula do usuário. Retorno: String.
getSummaryColleagues	Retorna todos os usuários ativos. Método: getSummaryColleagues(int companyId) Parâmetros: companyId: código da empresa. Retorno: ColleagueDto[].
validateColleagueLogin	Valida o acesso de um usuário no produto. Método: validateColleagueLogin(int companyId, String colleagueId, String password) Parâmetros: companyId: código da empresa. colleagueId: matrícula do usuário. password: senha do usuário. Retorno: String.
getColleaguesMail	Retorna um usuário utilizando um e-mail. Método: getColleaguesMail(String username, String password, int companyId, String mail) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa. mail: e-mail do usuário. Retorno: ColleagueDto[].
getSimpleColleague	Retorna o usuário. Método: getSimpleColleague(String username, String password) Parâmetros: username: login do usuário. password: senha do usuário. Retorno: ColleagueDto.
getColleagueWithMap	Retorna uma mensagem informando se o usuário foi criado corretamente. Método: getColleagueWithMap(String colleagueXML, String username, String password) Parâmetros: username: login do usuário. password: senha do usuário. colleagueXML: lista normalizada de documentos. Retorno: String.
getColleagueByLogin	Retorna o usuário a partir do login. Método: getColleagueByLogin(String username, String password) Parâmetros: username: login do usuário. password: senha do usuário. Retorno: ColleagueDto.

Quadro 8: Métodos da ColleagueService.

Exemplo de utilização

No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\ExemplosColleagueService é disponibilizada a classe ColleagueServiceClient.java, esta exemplifica a utilização de todos os métodos da classe ColleagueService.

ECMCompanyService

Webservice responsável por realizar operações referentes à empresa no Fluig. Pode ser utilizado para criar, alterar, excluir e pesquisar empresas, entre outras funcionalidades.

Métodos

Expandir

title	No quadro 9, é mostrado todos os métodos disponíveis na classe CompanyService.

-

getCompanies	Retorna todas as empresas cadastradas no Fluig. Método: getCompanies(String username, String password, String companyId) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa. Retorno: CompanyDto[].
getCompany	Retorna uma empresa cadastrada no Fluig. Método: getCompany(int companyId) Parâmetros: companyId: código da empresa. Retorno: CompanyDto.
createCompany	Cria uma empresa no Fluig. Método: createCompany(String username, String password, String companyId, String description, String urlAccessName, String phisicalPath, String webdeskServer, String webPort) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa. description: descrição da empresa. urlAccessName: URL de acesso. phisicalPath: caminho físico. webdeskServer: servidor. webPort: porta. Retorno: String.
updateCompany	Altera uma empresa no Fluig. Método: updateCompany(String username, String password, String companyId, String description, String urlAccessName, String phisicalPath, String webdeskServer, String webPort) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa. description: descrição da empresa. urlAccessName: URL de acesso. phisicalPath: caminho físico. webdeskServer: servidor. webPort: porta. Retorno: String.
delete	Exclui uma empresa do Fluig. Método: delete(String username, String password, String companyId, Boolean deleteFiles) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa. deleteFiles: indica se deve excluir o caminho físico. Retorno: String.

Quadro 9: Métodos da CompanyService

Exemplo de utilização

No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\Exemplos Webservices\ExemplosCompanyService é disponibilizada a classe CompanyServiceClient.java, esta exemplifica a utilização de todos os métodos da classe CompanyService.

ECMCustomFieldsService

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.

Métodos

Expandir

title	No quadro 10, é mostrado todos os métodos disponíveis na classe CustomFieldsService.

-

createCustomFields	Cria um campo customizado. Método: createCustomFields(String user, String password, int companyId, CustomFieldsDto[] customFieldsDto) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. customFieldsDto: campo customizado que será criado. Retorno: String.
updateCustomFields	Altera um campo customizado. Método: updateCustomFields(String user, String password, int companyId, CustomFieldsDto[] customFieldsDto) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. customFieldsDto: campo customizado que será alterado. Retorno: String.
removeCustomField	Exclui um campo customizado. Método: removeCustomField(String user, String password, int companyId, String customFieldsId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. customFieldsId: código do campo customizado. Retorno: String.
getAllCustomField	Retorna todos os campos customizados. Método: getAllCustomField(String user, String password, int companyId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. Retorno: CustomFieldsDto[].
setDocumentCustomFields	Cria ou altera um campo customizado em um documento. Método: setDocumentCustomFields(String user, String password, int companyId, DocumentCustomFieldsDto[] documentCustomFieldsDto) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. documentCustomFieldsDto: documento com campo customizado. Retorno: String.
removeDocumentCustomField	Exclui um campo customizado de um documento. Método: removeDocumentCustomField(String user, String password, int companyId, String customFieldsId, int documentId, int version) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. customFieldsId: código do campo customizado. documentId: número do documento. version: versão do documento. Retorno: String.
getAllDocumentCustomField	Retorna todos os campos customizados de um documento. Método: getAllDocumentCustomField(String user, String password, int companyId, int documentId, int version) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. documentId: número do documento. version: versão do documento. Retorno: DocumentCustomFieldsDto[].

Quadro 10: Métodos da CustomFieldsService

Exemplo de utilização

No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosCustomFieldsService é disponibilizada a classe CustomFieldsServiceClient.java, esta exemplifica a utilização de todos os métodos da classe CustomFieldsService

ECMDashBoardService

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.

Métodos

...

title	No quadro 11, é mostrado todos os métodos disponíveis na classe DashBoardService.

-

...

findMyDocuments

...

Retorna os documentos do usuário que precisam ser aprovados.

Método:

findMyDocuments(String user, String password, int companyId, String colleagueId)

Parâmetros:

user: login do usuário.
password: senha do usuário.
companyId: código da empresa.
colleagueId: matrícula do usuário.

Retorno: DocumentDto[].

...

findMyDocumentsOnDemand

...

Retorna os documentos do usuário que precisam ser aprovados, paginados.

Método:

findMyDocumentsOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)

Parâmetros:

user: login do usuário.
password: senha do usuário.
companyId: código da empresa.
colleagueId: matrícula do usuário.
limit: número de registros a serem retornados.
lastRowId: última linha retornada.

Retorno: DocumentDto[].

...

findDocumentsToApprove

...

Retorna os documentos que o usuário precisa aprovar.

Método:

findDocumentsToApprove(String user, String password, int companyId, String colleagueId)

Parâmetros:

user: login do usuário.
password: senha do usuário.
companyId: código da empresa.
colleagueId: matrícula do usuário.

Retorno: DocumentDto[].

...

findDocumentsToApproveOnDemand

...

Retorna os documentos que o usuário precisa aprovar, paginados.

Método:

findDocumentsToApproveOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)

Parâmetros:

user: login do usuário.
password: senha do usuário.
companyId: código da empresa.
colleagueId: matrícula do usuário.
limit: número de registros a serem retornados.
lastRowId: última linha retornada.

Retorno: DocumentDto[].

...

findAgreementDocuments

...

Retorna os documentos do usuário que estão em consenso.

Método:

findAgreementDocuments(String user, String password, int companyId, String colleagueId)

Parâmetros:

user: login do usuário.
password: senha do usuário.
companyId: código da empresa.
colleagueId: matrícula do usuário.

Retorno: DocumentDto[].

...

findCheckoutDocuments

...

Retorna os documentos do usuário que estão em checkout.

Método:

findCheckoutDocuments(String user, String password, int companyId, String colleagueId)

Parâmetros:

user: login do usuário.
password: senha do usuário.
companyId: código da empresa.
colleagueId: matrícula do usuário.

Retorno: DocumentDto[].

...

findCancelledTasks

...

Retorna as tarefas atribuidas ao usuário que foram canceladas.

Método:

findCancelledTasks(String user, String password, int companyId, String colleagueId)

Parâmetros:

user: login do usuário.
password: senha do usuário.
companyId: código da empresa.
colleagueId: matrícula do usuário.

Retorno: WorkflowProcessDto[].

...

findCompletedTasks

...

Retorna as tarefas atribuidas ao usuário que foram finalizadas.

Método:

findCompletedTasks(String user, String password, int companyId, String colleagueId)

Parâmetros:

user: login do usuário.
password: senha do usuário.
companyId: código da empresa.
colleagueId: matrícula do usuário.

Retorno: WorkflowProcessDto[].

...

findConsensusTasks

...

Retorna as tarefas atribuidas ao usuário que estão em consenso.

Método:

findConsensusTasks(String user, String password, int companyId, String colleagueId)

Parâmetros:

user: login do usuário.
password: senha do usuário.
companyId: código da empresa.
colleagueId: matrícula do usuário.

Retorno: WorkflowProcessDto[].

...

findTransferredTasks

...

Retorna as tarefas atribuidas ao usuário que foram transferidas.

Método:

findTransferredTasks(String user, String password, int companyId, String colleagueId)

Parâmetros:

user: login do usuário.
password: senha do usuário.
companyId: código da empresa.
colleagueId: matrícula do usuário.

Retorno: WorkflowProcessDto[].

...

findWorkflowTasks

...

Retorna as tarefas do usuário que estão abertas.

Método:

findWorkflowTasks(String user, String password, int companyId, String colleagueId)

Parâmetros:

user: login do usuário.
password: senha do usuário.
companyId: código da empresa.
colleagueId: matrícula do usuário.

Retorno: WorkflowProcessDto[].

...

findWorkflowTasksOnDemand

...

Retorna as tarefas do usuário que estão abertas, paginadas.

Método:

findWorkflowTasksOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)

Parâmetros:

user: login do usuário.
password: senha do usuário.
companyId: código da empresa.
colleagueId: matrícula do usuário.
limit: número de registros a serem retornados.
lastRowId: última linha retornada.

Retorno: WorkflowProcessDto[].

...

findMyRequests

...

Retorna as solicitações abertas que foram inicializadas pelo usuário.

Método:

findMyRequests(String user, String password, int companyId, String colleagueId)

Parâmetros:

user: login do usuário.
password: senha do usuário.
companyId: código da empresa.
colleagueId: matrícula do usuário.

Retorno: WorkflowProcessDto[].

...

findMyRequestsOnDemand

...

Retorna as solicitações abertas que foram inicializadas pelo usuário, paginadas.

Método:

findMyRequestsOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)

Parâmetros:

user: login do usuário.
password: senha do usuário.
companyId: código da empresa.
colleagueId: matrícula do usuário.
limit: número de registros a serem retornados.
lastRowId: última linha retornada.

Retorno: WorkflowProcessDto[].

...

findMyManagerTasks

...

Retorna as tarefas gerenciadas pelo usuário.

Método:

findMyManagerTasks(String user, String password, int companyId, String colleagueId)

Parâmetros:

user: login do usuário.
password: senha do usuário.
companyId: código da empresa.
colleagueId: matrícula do usuário.

Retorno: WorkflowProcessDto[].

...

findExpiredWorkflowTasks

...

Retorna as tarefas do usuário que estão em atraso

Método: findExpiredWorkflowTasks(String user, String password, int companyId, String colleagueId)

Parâmetros:

user: login do usuário.
password: senha do usuário.
companyId: código da empresa.
colleagueId: matrícula do usuário.

Retorno: WorkflowProcessDto[].

...

fillStatusTask

...

Retorna a quantidade de tarefas atrasadas, no prazo e sem prazo de um usuário.

Método:

fillStatusTask(String user, String password, int companyId, String colleagueId)

Parâmetros:

user: login do usuário.
password: senha do usuário.
companyId: código da empresa.
colleagueId: matrícula do usuário.

Retorno: int[].

...

fillChronoTasks

...

Retorna a quantidade de tarefas com prazo de conclusão que foram atribuidas ao usuário e não foram finalizadas.

Método:

fillChronoTasks(String user, String password, int companyId, String colleagueId, int yearIni, int yearFin, int mounthIni, int mounthFin, int dayIni, int dayFin, int kindTask)

Parâmetros:

user: login do usuário.
password: senha do usuário.
companyId: código da empresa.
colleagueId: matrícula do usuário.
yearIni: ano inicial.
yearFin: ano final.
mounthIni: mês inicial.
mounthFin: mês final.
dayIni: dia inicial.
dayFin: dia final.
kindTask: tipo da tarefa.

Retorno: int[].

...

fillTypeTasks

...

Retorna os tipos de tarefas que o usuário possui.

Método:

fillTypeTasks(String user, String password, int companyId, String colleagueId)

Parâmetros:

user: login do usuário.
password: senha do usuário.
companyId: código da empresa.
colleagueId: matrícula do usuário.

Retorno: TaskVODto[].

...

fillTypeTasksOfReplacement

...

Retorna os tipos de tarefas que o usuário substituto possui.

Método:

fillTypeTasksOfReplacement(String user, String password, int companyId, String colleagueId, String replacementId)

Parâmetros:

user: login do usuário.
password: senha do usuário.
companyId: código da empresa.
colleagueId: matrícula do usuário.
replacementId: matrícula do usuário substituto.

Retorno: TaskVODto[].

...

getOpenTasksByColleagueGroups

...

Retorna as tarefas atribuídas a um grupo que o usuário participa.

Método:

getOpenTasksByColleagueGroups(String user, String password, int companyId, String colleagueId)

Parâmetros:

user: login do usuário.
password: senha do usuário.
companyId: código da empresa.
colleagueId: matrícula do usuário.

Retorno: WorkflowTaskDto[].

...

getOpenTasksByColleagueGroupsOnDemand

...

Retorna as tarefas atribuídas a um grupo que o usuário participa, paginadas.

Método:

getOpenTasksByColleagueGroupsOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)

Parâmetros:

user: login do usuário.
password: senha do usuário.
companyId: código da empresa.
colleagueId: matrícula do usuário.
limit: número de registros a serem retornados.
lastRowId: última linha retornada.

Retorno: WorkflowTaskDto[].

...

getOpenTasksByColleagueRoles

...

Retorna as tarefas atribuídas a um papel que o usuário participa.

Método:

getOpenTasksByColleagueRoles(String user, String password, int companyId, String colleagueId)

Parâmetros:

user: login do usuário.
password: senha do usuário.
companyId: código da empresa.
colleagueId: matrícula do usuário.

Retorno: WorkflowTaskDto[].

...

getOpenTasksByColleagueRolesOnDemand

...

Retorna as tarefas atribuidas a um papel workflow que o usuário participa, paginadas.

Método:

getOpenTasksByColleagueRolesOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)

Parâmetros:

user: login do usuário.
password: senha do usuário.
companyId: código da empresa.
colleagueId: matrícula do usuário.
limit: número de registros a serem retornados.
lastRowId: última linha retornada.

Retorno: WorkflowTaskDto[].

...

getSummaryRequests

...

Retorna os contadores de pendências da Home.

Método:

getSummaryRequests(int companyId, String user, String password, String colleagueId)

Parâmetros:

companyId: código da empresa.
user: login do usuário.
password: senha do usuário.
colleagueId: matrícula do usuário.

Retorno: HomeRequestSummaryDto[].

...

Retorna a url do servidor.

Método:

getUrlEcm(long companyId)

Parâmetros:

...

Retorno: String.

Quadro 11: Métodos da DashBoardService

Exemplo de utilização

No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosDashBoardService é disponibilizada a classe DashBoardClient.java, esta exemplifica a utilização de todos os métodos da classe DashBoardService.

ECMDataServiceService

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.

Métodos

...

title	No quadro 12, é mostrado todos os métodos disponíveis na classe DataServiceService.

-

...

createDataService

...

Cria um serviço externo.

Método:

createDataService(int companyId, String user, String password, DataServiceDto[] dataServiceDto)

Parâmetros:

companyId: código da empresa.
user: login do usuário.
password: senha do usuário.
dataServiceDto: serviço externo que será criado.

Retorno: String.

...

Remove um serviço externo.

Método:

deleteDataService(int companyId, String user, String password, String dataServiceName)

Parâmetros:

...

Retorno: void.

...

Retorna todos os serviços externos cadastrados.

Método:

getAllServices(int companyId, String user, String password)

Parâmetros:

companyId: código da empresa.
user: login do usuário.
password: senha do usuário.

Retorno: dataServiceDto[].

...

Retorna um serviço externo.

Método:

loadDataService(int companyId, String user, String password, String dataServiceName)

Parâmetros:

companyId: código da empresa.
user: login do usuário.
password: senha do usuário.
dataServiceName: nome do serviço externo.

Retorno: dataServiceDto.

...

Atualiza um serviço externo.

Método:

createDataService(int companyId, String user, String password, DataServiceDto[] dataServiceDto)

Parâmetros:

companyId: código da empresa.
user: login do usuário.
password: senha do usuário.
dataServiceDto: serviço externo que será atualizado.

Retorno: void.

Quadro 12: Métodos da DataServiceService.

Exemplo de utilização

No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosDataServiceService é disponibilizada a classe DataServiceService.java, esta exemplifica a utilização de todos os métodos da classe DataServiceService.

ECMDatasetService

Webservice responsável por interagir com os datasets do Fluig. Pode ser utilizado para pesquisar os datasets existentes.

Métodos

Expandir

title	No quadro 13, é mostrado todos os métodos disponíveis na classe DatasetService.

-

getAvailableDatasets	Retorna todos os datasets disponíveis. Método: getAvailableDatasets(int companyId, String user, String password) Parâmetros: companyId: código da empresa. user: login do usuário. password: senha do usuário. Retorno: Object[].
getDataset	Retorna as informações de um dataset. Método: getDataset(int companyId, String user, String password, String name, String[] fields, SearchConstraintDto[] constraintsDto, String[] order) Parâmetros: companyId: código da empresa. user: login do usuário. password: senha do usuário. name: nome do dataset. fields: campos que serão retornados do dataset. constraintsDto: filtro dos registros que irão compor o dataset. order: campos utilizados para ordenar o dataset. Retorno: DatasetDto.
addDataset	Cria um dataset. Método: addDataset(int companyId, String user, String password, String datasetName, String description, String impl) Parâmetros: companyId: código da empresa. user: login do usuário. password: senha do usuário. datasetName: nome do dataset que será criado. description: descrição do dataset. impl: implementação para criação do dataset. Retorno: String.
deleteDataset	Remove um dataset. Método: deleteDataset(int companyId, String user, String password, String datasetName) Parâmetros: companyId: código da empresa. user: login do usuário. password: senha do usuário. datasetName: nome do dataset que será removido. Retorno: void.
updateDataset	Atualiza um dataset. Método: updateDataset(int companyId, String user, String password, String datasetName, String description, String impl) Parâmetros: companyId: código da empresa. user: login do usuário. password: senha do usuário. datasetName: nome do dataset que será atualizado. description: descrição do dataset. impl: implementação do dataset. Retorno: void.

Quadro 13: Métodos da DatasetService

Exemplo de utilização

No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosDatasetService é disponibilizada a classe DatasetServiceClient.java, esta exemplifica a utilização de todos os métodos da classe DatasetService.

ECMDocumentService

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.

Métodos

Expandir

title	No quadro 14, é mostrado todos os métodos disponíveis na classe DocumentService.

-

approveDocument	Aprova ou reprova documento pendente de aprovação. Metodo: approveDocument(int companyId, String userId, String password, int documentId, int version, String approverId, boolean approved, String observation) Parâmetros: user: código do usuário de integração. password: senha do usuário de integração. companyId: código da empresa. documentId: código do documento a ser aprovado. version: versão do documento a ser aprovado. approverId: código do aprovador approved: true se aprova o documento e false caso o documento sera reprovado. observation: observação da aprovação ou rejeição. Retorno: WebServiceMessage[]
copyDocumentToUploadArea	Copia os arquivos (principal e anexos) de um documento para a area de upload do usuário. Isto permite que os documentos tornem-se acessíveis via FTP. Método: copyDocumentToUploadArea(String user, String password, int companyId, int documentId, int version, String colleagueId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. documentId: número do documento que será copiado. version: versão do documento colleagueId: matrícula do usuário cuja área de upload será utilizada Retorno: String[] nome dos arquivos que foram disponibilizados na área de upload
createDocument	Cria um documento. Método: createDocument(String user, String password, int companyId, DocumentDto[] docDtos, Attachment[] attachs, DocumentSecurityConfigDto[] docSecurity, ApproverDto[] docApprovers, RelatedDocumentDto[] relDocs) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. docDtos: documento que será publicado. attachs: arquivo anexado na publicação. docSecurity: segurança do documento que será publicado. docApprovers: aprovadores do documento que será publicado. relDocs: documentos relacionados ao documento que será publicado. Retorno: WebServiceMessage[].
createDocumentWithApprovementLevels	Cria um documento com nível de aprovação. Método: createDocumentWithApprovementLevels(String user, String password, int companyId, DocumentDto[] docDtos, Attachment[] attachs, DocumentSecurityConfigDto[] docSecurity, ApproverWithLevelDto[] docApproversLevels, ApprovalLevelDto[] levels, RelatedDocumentDto[] relDocs) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. docDtos: documento que será publicado. attachs: arquivo anexado na publicação. docSecurity: segurança do documento que será publicado. docApproversLevel: nível de aprovação que os aprovadores do documento estão inseridos. levels: níveis de aprovação que o documento terá. relDocs: documentos relacionados ao documento que será publicado. Retorno: WebServiceMessage[].
createSimpleDocument	Cria um documento simples. Método: createSimpleDocument(String user, String password, int company, int parentDocumentId, String publisherId, String documentDescription, Attachment[] attachments) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. parentDocumentId: número da pasta pai. publisherId: matrícula do usuário que publicará o documento. documentDescription: descrição do documento. attachments: arquivo anexado na publicação. Retorno: WebServiceMessage[].
createSimpleDocumentPrivate	Cria um documento simples na pasta particular. Método: createSimpleDocumentPrivate(String colleagueId, String password, int companyId, int parentDocumentId, String documentDescription, Attachment[] attachments) Parâmetros: colleagueId: login do usuário. password: senha do usuário. companyId: código da empresa. parentDocumentId: número da pasta pai. documentDescription: descrição do documento. attachments: arquivo anexado na publicação. Retorno: WebServiceMessage[].
deleteDocument	Exclui um documento e o envia para a lixeira. Método: deleteDocument(String user, String password, int companyId, int documentId, String colleagueId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. documentId: número do documento que será excluído. colleagueId: matrícula do usuário. Retorno: WebServiceMessage[].
destroyDocument	Exclui um documento da lixeira. Método: destroyDocument(String user, String password, int companyId, int documentId, String colleagueId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. documentId: número do documento que será excluído. colleagueId: matrícula do usuário. Retorno: WebServiceMessage[].
destroyDocumentApproval	Exclui documento pendente de aprovação. Metodo: destroyDocumentApproval(String userId, String password, int companyId, int documentId, String publisherId) Parâmetros: user: código do usuário de integração. password: senha do usuário de integração. companyId: código da empresa. documentId: código do documento a excluido. publisherId: código do publicador. Retorno: WebServiceMessage[]
findMostPopularDocuments	Retorna os documentos mais acessados no Fluig que o usuário tenha permissão de acesso. Método: findMostPopularDocuments(String user, String password, int companyId, String colleagueId, int nr_resultados) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. colleagueId: matrícula do usuário. nr_resultados: quantidade de documentos que serão retornados. Retorno: DocumentDto[].
findMostPopularDocumentsOnDemand	Retorna os documentos mais acessados no Fluig que o usuário tenha permissão de acesso, paginados. Método: findMostPopularDocuments(int companyId, String user, String password, String colleagueId, int limit, int lastRowId) Parâmetros: companyId: código da empresa. user: login do usuário. password: senha do usuário. colleagueId: matrícula do usuário. limit: número de registros a serem retornados. lastRowId: última linha retornada. Retorno: DocumentDto[].
findRecycledDocuments	Retorna os documentos da lixeira. Método: findRecycledDocuments(String user, String password, int companyId, String colleagueId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. colleagueId: matrícula do usuário. Retorno: DocumentDto[].
getActiveDocument	Retorna um documento ativo. Método: getActiveDocument(String user, String password, int companyId, int nrDocumentId, String colleagueId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. nrDocumentId: número do documento. colleagueId: matrícula do usuário. Retorno: DocumentDto[].
getApprovers	Retorna os aprovadores de um documento. Método: getApprovers(String user, String password, int companyId, int nrDocumentId, int version) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. nrDocumentId: número do documento. version: número da versão do documento. Retorno: ApproverWithLevelDto[].
getDocumentApprovalHistory	Retorna o histórico de aprovações do documento solicitado. Metodo: getDocumentApprovalHistory(String user, String password, int companyId, int documentId, int version) Parâmetros: user: código do usuário de integração. password: senha do usuário de integração. companyId: código da empresa. documentId: código do documento que se deseja visualizar o status. version: versão do documento (caso seja informada a versão 0 sera solicitada a ultima versão do documento). Retorno: DocumentApprovementHistoryDto[]
getDocumentApprovalStatus	Retorna o status do documento com relação a aprovação. O status do documento pode ser: 0 - Aprovado. 1 - Rejeitado. 2- Em aprovação. Método: getDocumentApprovalStatus(String user, String password, int companyId, int documentId, int version) Parâmetros: user: código do usuário de integração. password: senha do usuário de integração. companyId: código da empresa. documentId: código do documento que se deseja visualizar o status. version: versão do documento (caso seja informada a versão 0 sera solicitada a ultima versão do documento). Retorno: DocumentApprovalStatusDto[]
getDocumentByExternalId	Retorna um documento pelo código externo. Método: getDocumentByExternalId(String user, String password, int companyId, String externalDocumentId, String colleagueId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. externalDocumentId: código externo do documento. colleagueId: matrícula do usuário. Retorno: DocumentDto[].
getDocumentContent	Retorna o byte do arquivo físico de um documento, caso o usuário tenha permissão para acessá-lo. Método: getDocumentContent(String user, String password, int companyId, int nrDocumentId, String colleagueId, int documentoVersao, String nomeArquivo) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. nrDocumentId: número do documento. colleagueId: matrícula do usuário. documentVersao: número da versão do documento. nomeArquivo: nome do arquivo. Retorno: byte[].
getDocumentVersion	Retorna a versão de um documento. Método: getDocumentVersion(String user, String password, int companyId, int nrDocumentId, int version, String colleagueId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. nrDocumentId: número do documento. version: número da versão do documento. colleagueId: matrícula do usuário. Retorno: DocumentDto[].
getRelatedDocuments	Retorna todos os documentos relacionados de um documento. Método: getRelatedDocuments(String user, String password, int companyId, int nrDocumentId, int version) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. nrDocumentId: número do documento. version: número da versão do documento. Retorno: RelatedDocumentDto[].
getReportSubjectId	Retorna o código do assunto de relatórios dentro do Fluig. Método: getReportSubjectId(String user, String password, int companyId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. Retorno: int.
getSecurity	Retorna a segurança de um documento. Método: getSecurity(String user, String password, int company, int nrDocumentId, int version) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. nrDocumentId: número do documento. version: número da versão do documento. Retorno: DocumentSecurityConfigDto[].
getUserPermissions	Retorna as permissões do usuário sobre um documento. Método: getUserPermissions(int companyId, String user, int nrDocumentId, int version) Parâmetros: companyId: código da empresa. user: login do usuário. nrDocumentId: número do documento. version: número da versão do documento. Retorno: Integer.
moveDocument	Move documentos para pasta destino. Método: moveDocument(String user, String password, int companyId, int[] documentIds, String colleagueId, int destfolder) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. documentIds: lista com os números dos documentos que serão movidos. colleagueId: matrícula do usuário com permissão para mover o documento destFolder: número da pasta de destino. Retorno: String[]
removeSecurity	Remove a segurança de um documento. Método: removeSecurity(String user, String password, int companyId, int documentId, int version) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. documentId: número do documento. version: número da versão do documento. Retorno: Não há retorno.
restoreDocument	Restaura um documento da lixeira. Método: restoreDocument(String user, String password, int companyId, int documentId, String colleagueId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. documentId: número do documento que será restaurado. colleagueId: matrícula do usuário. Retorno: WebServiceMessage[].
updateDocument	Altera um documento. Método: updateDocument(String user, String password, int companyId, DocumentDto[] docDtos, Attachment[] attach, DocumentSecurityConfigDto[] docSecurity, ApproverDto[] docApprovers, RelatedDocumentDto[] relDocs) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. docDtos: documento que será alterado. attachs: arquivo anexado na alteração. docSecurity: segurança do documento que será alterado. docApprovers: aprovadores do documento que será alterado. relDocs: documentos relacionados ao documento que será alterado. Retorno: WebServiceMessage[].
updateDocumentWithApprovementLevels	Altera um documento com nível de aprovação. Métodos: updateDocumentWithApprovementLevels(String user, String password, int companyId, DocumentDto[] docDtos, Attachment[] attach, DocumentSecurityConfigDto[] docSecutiry, ApproverWithLevelDto[] docApprovers, ApprovalLevelDto[] levels, RelatedDocumentDto[] relDocs) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. docDtos: documento que será alterado. attachs: arquivo anexado na alteração. docSecurity: segurança do documento que será alterado. docApprovers: nível de aprovação que os aprovadores do documento estão inseridos. levels: níveis de aprovação que o documento terá. relDocs: documentos relacionados ao documento que será alterado. Retorno: WebServiceMessage[].
updateGroupSecurityType	Modifica a tipo da segurança dos grupos na permissão e na restrição. Existem duas opções que são representadas por um inteiro: 0 - TODOS os usuários dos Grupos. 1 - SOMENTE usuários comuns dos grupos. Método: updateGroupSecurityType(String user, String password, int companyId, int documentId, int version, int permissionType, int restrictionType, String colleagueId) Parâmetros: user: código do usuário de integração. password: senha do usuário de integração. companyId: código da empresa. documentId: código do documento. version: versão do documento. permissionType: tipo da permissão (0 - TODOS os usuários dos Grupos / 1 - SOMENTE usuários comuns dos grupos) restrictionType: tipo da restrição (0 - TODOS os usuários dos Grupos / 1 - SOMENTE usuários comuns dos grupos) colleagueId: matrícula do usuário Retorno: WebServiceMessage[]
updateSimpleDocument	Altera de forma simples um documento. Método: updateSimpleDocument(String username, String password, int companyId, int documentId, String publisherId, String documentDescription, Attachment[] attachments) Parâmetros: username: login do usuário de integração. password: senha do usuário de integração. companyId: código da empresa. documentId: número do documento que será alterado. publisherId: matrícula do usuário que realizará a alteração do documento. documentDescription: descrição do documento. attachments: arquivos anexados na alteração. Retorno: WebServiceMessage[].
validateIntegrationRequirements	Verifica a integração do usuário no Fluig. Método: validateIntegrationRequirements (String user, String password, int companyId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. Retorno: String.

Quadro 14: Métodos da DocumentService

Exemplo de utilização

No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosDocumentService é disponibilizada a classe DocumentServiceClient.java, esta exemplifica a utilização de todos os métodos da classe DocumentService.

ECMFavoritesService

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.

Métodos

Expandir

title	No quadro 15, é mostrado todos os métodos disponíveis na classe FavoritesService.

-

addDocumentToFavorites	Adiciona um documento aos favoritos do usuário informado. Método: addDocumentToFavorites(String username, String password, int companyId, int nrDocument, int nrVersao, String colleagueId) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa. nrDocument: número do documento nrVersao: versão do documento colleagueId : matrícula do usuário. Retorno: void.
addProcessToFavorites	Adiciona um processo aos favoritos do usuário informado. Método: addProcessToFavorites(String username, String password, int companyId,String processId, String colleagueId) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa. processId: código do processo colleagueId : matrícula do usuário. Retorno: void.
findFavorites	Retorna os documentos favoritos do usuário. Método: findFavorites(String user, String password, int companyId, String colleagueId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. colleagueId : matrícula do usuário. Retorno: DocumentDto[].
findFavoritesOnDemand	Retorna os documentos favoritos do usuário, paginados. Método: findFavoritesOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. colleagueId : matrícula do usuário. limit: número de registros a serem retornados. lastRowId: última linha retornada. Retorno: DocumentDto[].
findFavoritesProcess	Retorna os processos favoritos do usuário. Método: findFavoritesProcess (String user, String password, int companyId, String colleagueId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. colleagueId : matrícula do usuário. Retorno: ProcessDefinitionVersionDto[] .
findFavoritesProcessOnDemand	Retorna os processos favoritos do usuário, paginados. Método: findFavoritesProcess (String user, String password, int companyId, String colleagueId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. colleagueId : matrícula do usuário. limit: número de registros a serem retornados. lastRowId: última linha retornada. Retorno: ProcessDefinitionVersionDto[] .
isFavoriteDocument	Verifica se documento é favorito. Método: isFavoriteDocument(String username, String password, int companyId, int nrDocument, String colleagueId) Parâmetros: username: login do usuário de integração. password: senha do usuário. companyId: código da empresa. nrDocument: código do documento. colleagueId: matricula do usuário. Retorno: Boolean.
removeFavoriteDocument	Remove um documento dos favoritos do usuário informado. Método: removeFavoriteDocument (String username, String password, int companyId, int nrDocument, String colleagueId) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa. nrDocument: número do documento colleagueId : matrícula do usuário. Retorno: void.
removeFavoriteProcess	Remove um processo dos favoritos do usuário informado. Método: addProcessToFavorites(String username, String password, int companyId,String processId, String colleagueId) Parâmetros: username: login do usuário. password: senha do usuário. companyId: código da empresa. processId: código do processo. colleagueId : matrícula do usuário. Retorno: void.

Quadro 15: Métodos da FavoritesService

Exemplo de utilização

No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosFavoritesService é disponibilizada a classe FavoritesServiceClient.java, esta exemplifica a utilização de todos os métodos da classe FavoritesService.

ECMFolderService

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.

Métodos

Expandir

title	No quadro 16, é mostrado todos os métodos disponíveis na classe FolderService.

-

createFolder	Cria uma pasta. Método: createFolder(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverDto[] docapprovers ) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. docdtos: pasta que será criada. docsecurity: segurança da pasta. docapprovers: aprovadores da pasta. Retorno: WebServiceMessage[].
createFolderWithApprovementLevels	Cria uma pasta com nível de aprovação. Método: createFolderWithApprovementLevels(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverWithLevelDto[] docapprovers, ApprovalLevelDto[] levels) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. docdtos: pasta que será criada. docsecurity: segurança da pasta. docapprovers: aprovadores em níveis. levels: níveis de aprovação da pasta. Retorno: WebServiceMessage[].
createSimpleFolder	Cria uma pasta simples. Método: createSimpleFolder(String user, String password, int companyId, int parentDocumentId, String publisherId, String documentDescription) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. parentDocumentId: número do documento pai. publisherId: matrícula do usuário publicador. documentDescription: descrição da pasta. Retorno: WebServiceMessage[].
deleteDocument	Exclui uma pasta e envia para a lixeira. Método: deleteDocument(String user, String password, int companyId, int documentId, String colleagueId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. documentId: número da pasta. colleagueId: matrícula do usuário. Retorno: WebServiceMessage[].
destroyDocument	Exclui uma pasta da lixeira. Método: destroyDocument(String user, String password, int companyId, int documentId, String colleagueId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. documentId: número da pasta. colleagueId: matrícula do usuário. Retorno: WebServiceMessage[].
findRecycledDocuments	Retorna todos os documentos da lixeira de um usuário. Método: findRecycledDocuments(String user, String password, int companyId, String colleagueId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. colleagueId: matrícula do usuário. Retorno: DocumentDto[].
getApprovers	Retorna os aprovadores de uma pasta. Método: getApprovers(String user, String password, int companyId, int nrDocumentId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. nrDocumentId: número da pasta. Retorno: ApproverWithLevelDto[].
getChildren	Retorna todos os documentos de uma pasta. Método: getChildren(String user, String password, int companyId, int documentId, String colleagueId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. documentId: número da pasta. colleagueId: matrícula do usuário. Retorno: DocumentDto[].
getFolder	Retorna uma pasta. Método: getFolder(String user, String password, int companyId, int nrDocumentId, String colleagueId ) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. nrDocumentId: número da pasta. colleagueId: matrícula do usuário origem. Retorno: DocumentDto[].
getPrivateChildren	Retorna todos os documentos de uma pasta particular. Método: getPrivateChildren(String user, String password, int companyId, int parentDocumentId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. documentId: número da pasta. Retorno: DocumentDto[].
getRootFolders	Retorna as pastas root que um usuário tem acesso, exceto a pasta particular. Método: getRootFolders(String user, String password, int companyId, String colleagueId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. colleagueId: matrícula do usuário. Retorno: DocumentDto[].
getSecurity	Retorna a segurança de uma pasta. Método: getSecurity(String user, String password, int companyId, int nrDocumentId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. nrDocumentId: número da pasta. Retorno: DocumentSecurityConfigDto[].
getSubFolders	Retorna todas as subpastas e arquivos de um pasta. Método: getSubFolders(String user, String password, int companyId, int documentId, String colleagueId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. documentId: número da pasta. colleagueId: matrícula do usuário. Retorno: DocumentDto[].
getSubFoldersOnDemand	Retorna todas as subpastas e arquivos de um pasta, paginados. Método: getSubFoldersOnDemand(int companyId, String user, String password, int documentId, boolean privatefolder, String[] documenttypes, int limit , int lastRowId, String colleagueId) Parâmetros: companyId: código da empresa. user: login do usuário. password: senha do usuário. documentId: número da pasta. privatefolder: identifica se é uma pasta particular. documenttypes: tipos de documentos das pastas. limit: número de registros a serem retornados. lastRowId: última linha retornada. colleagueId: matrícula do usuário. Retorno: DocumentDto[].
getSubFoldersPermission	Retorna todas as subspastas em que o usuário tenha a permissão informada. Método: getSubFoldersPermission(String user, String password, int companyId, int documentId, String colleagueId, int permission) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. documentId: número da pasta particular. colleagueId: matrícula do usuário. permission: permissão sobre a pasta. Retorno: DocumentDto[].
getSubPrivateFolders	Retorna todas as subpastas de uma pasta particular. Método: getSubPrivateFolders(String colleagueId, String password, int companyId, int documentId) Parâmetros: colleagueId: matrícula do usuário. password: senha do usuário. companyId: código da empresa. documentId: número da pasta particular. Retorno: DocumentDto[].
getUserPermissions	Retorna a permissão de um usuário sobre uma pasta. Método: getUserPermissions(int companyId, String user, int nrDocumentId, int version) Parâmetros: companyId: código da empresa. user: matrícula do usuário. nrDocumentId: número da pasta. version: versão da pasta. Retorno: Integer.
restoreDocument	Restaura uma pasta da lixeira. Método: restoreDocument(String user, String password, int companyId, int documentId, String colleagueId) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. documentId: número da pasta. colleagueId: matrícula do usuário. Retorno: WebServiceMessage[].
updateFolder	Altera uma pasta. Método: updateFolder(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverDto[] docapprovers) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. docdtos: pasta que será alterada. docsecurity: segurança da pasta. docapprovers: aprovadores da pasta. Retorno: WebServiceMessage[].
updateFolderWithApprovementLevels	Altera uma pasta com nível de aprovação. Método: updateFolderWithApprovementLevels(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverWithLevelDto[] docapprovers, ApprovalLevelDto[] levels) Parâmetros: user: login do usuário. password: senha do usuário. companyId: código da empresa. docdtos: pasta que será alterada. docsecurity: segurança da pasta. docapprovers: aprovadores em níveis. levels: níveis de aprovação da pasta. Retorno: WebServiceMessage[].
updateSimpleFolder	Altera de forma simples uma pasta. Método: updateSimpleFolder(String user, String Password, int companyId, DocumentDto[] docdtos) Parâmetros: user: login do usuário password: senha do usuário companyId: código da empresa docdtos: pasta que será alterada. Retorno: WebServiceMessage[].

Quadro 16: Métodos da FolderService

Exemplo de utilização

No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosFolderService é disponibilizada a classe FolderServiceClient.java, esta exemplifica a utilização de todos os métodos da classe FolderService.

ECMGlobalParamService

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.

Métodos

...

title	No quadro 17, é mostrado todos os métodos disponíveis na classe GlobalParamService.

-

...

createGlobalParam

...

Cria parâmetros gerais para uma empresa.

Método:

createGlobalParam(String username, String password, int companyId, GlobalParamDto[] global)

Parâmetros:

username: login do usuário.
password: senha do usuário.
companyId: código da empresa.
global: parâmetros gerais da empresa.

Retorno: String.

...

getConfigurations

Retorna as informações de configuração do sistema.

...

username: login do usuário.
password: senha do usuário.
companyId: código da empresa.

Retorno: SystemInfo.

...

getGlobalParam

...

Retorna os parâmetros gerais de uma empresa.

Método:

getGlobalParam(String username, String password, int companyId)

Parâmetros:

username: login do usuário.
password: senha do usuário.
companyId: código da empresa.

Retorno: GlobalParamDto[].

...

getVolumes

...

Retorna os volumes da empresa.

Método:

getVolumes(String user, String password, int companyId)

Parâmetros:

user: login do usuário.
password: senha do usuário.
companyId: código da empresa.

Retorno: VolumeDto[].

...

updateConfigurations

...

Altera as configurações do sistema.

Método:
updateConfigurations( String username,String password, int companyId, String dbDriver, String dbUser, String dbPassword, String dbServer,
String dbPort,String dbScheme, String dbInstance, String emailServer, String emailPort, String emailSender, boolean emailDefaultSender, String emailUser, String emailPassword, boolean emailTLS,String paramsRMTPTPort, String lsType, String paramsLSHost, String paramsLSPort, String paramsOpenOfficeDir, String paramsOpenOfficePorts, String portsSetName)

Parâmetros:

username: login do usuário.
password: senha do usuário.
companyId: código da empresa.
dbDriver: driver do banco de dados (MySql- com.mysql.jdbc.Driver. SQLServer - net.sourceforge.jtds.jdbc.Driver. Oracle -oracle.jdbc.driver.OracleDriver)
dbUser: username banco de dados.
dbPassword: password banco de dados.
dbServer: servidor de conexão do banco de dados.
dbPort: porta servidor banco de dados.
dbScheme: database.
dbInstance: instância do banco, utilizada para SQLServer, caso não seja o caso passar em branco ("").
emailServer: nome do servidor SMTP.
emailSender: e-mail do remetente padrão do produto.
emailPort: porta do servidor SMTP.
emailDefaultSender:
emailUser: usuário de email, somente se o servidor necessitar de autenticação.
emailPassword: password do email, somente se o servidor necessitar de autenticação.
emailTLS: servidor utilizará criptografia no envio de email (true/false)
paramsRMTPTPort: porta utilizada pelo Flex.
lsType: tipo de licença utilizada, LM/LS.
paramsLSHost: servidor de licenças.
paramsLSPort: porta servidor de licenças.
paramsOpenOfficeDir: diretório de instalação do OpenOffice
paramsOpenOfficePorts: porta utilizado pelo OpenOffice
portsSetName: porta utilizadas pelo sistema (ports-default, ports-01, ports-02)

Retorno: String.

...

updateGlobalParam

...

Altera parâmetros gerais de uma empresa.

Método:

updateGlobalParam(String username, String password, int companyId, GlobalParamDto[] global)

Parâmetros:

username: login do usuário.
password: senha do usuário.
companyId: código da empresa.
global: parâmetros gerais da empresa.

Retorno: String.

Quadro 17: Métodos da GlobalParamService.

Exemplo de utilização

No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosGlobalParamService é disponibilizada a classe GlobalParamServiceClient.java, esta exemplifica a utilização de todos os métodos da classe GlobalParamService.

ECMcxxxService

Webservice responsável por realizar operações referentes à empresa no Fluig. Pode ser utilizado para criar, alterar, excluir e pesquisar empresas, entre outras funcionalidades.

Métodos

Expandir

title	No quadro 5, é mostrado todos os métodos disponíveis na classe CardService.

-

xxxxx	Altera os campos de um formulário.

Quadro 6: Métodos da xxxxx

Exemplo de utilização

No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosXXXX é disponibilizada a classe xxxxx.java, esta exemplifica a utilização de todos os métodos da classe xxxxxxx.

...

Atalhos

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 32

Nova versão Atual

Chave

Índice

Objetivo

Pré-requisitos

Antes de começar

Como acessar

Segurança

Permissão por Web Services e/ou métodos

Personificação

Permissões das funções acessadas

Como utilizar os Web Services em softwares terceiros

Verificando os serviços e chamadas manuais

Criando rotinas automatizadas

JDK 11 e superiores

JDK 8 e inferiores

Importando a lib e desenvolvendo sua integração

POST, não PUT

Disponibilidade dos Web Services

Como utilizar os Web Services do Fluig no próprio Fluig?

Usando o editor web (sem codificação)

Codificando

Objetivo

Criar Stubs

Considerações Métodos de Update

ECMAttributionMecanismService

Métodos

Exemplo de utilização

Métodos

Exemplo de utilização

ECMCardIndexService

Métodos

Exemplo de utilização

ECMCardService

Métodos

Exemplo de utilização

ECMColleagueGroupService

Métodos

Exemplo de utilização

ECMColleagueReplacementService

Métodos

Exemplo de utilização

ECMColleagueService

Métodos

Exemplo de utilização

ECMCompanyService

Métodos

Exemplo de utilização

ECMCustomFieldsService

Métodos

Exemplo de utilização

ECMDashBoardService

Métodos

Exemplo de utilização

ECMDataServiceService

Métodos

Exemplo de utilização

ECMDatasetService

Métodos

Exemplo de utilização

ECMDocumentService

Métodos

Exemplo de utilização

ECMFavoritesService

Métodos

Exemplo de utilização

ECMFolderService

Métodos

Exemplo de utilização

ECMGlobalParamService

Métodos

Exemplo de utilização

ECMcxxxService

Métodos

Exemplo de utilização