Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

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.

ECMXXXXService

 

ECMCompanyService

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

Métodos

Expandir
titleNo 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
titleNo 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

Expandir
titleNo 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[].

getUrlEcm

Retorna a url do servidor.

 

Método:

getUrlEcm(long companyId)

 

Parâmetros:

  • companyId: código da empresa.
Retorno: String.

Quadro 6: 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.

ECMCcccccService

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
titleNo 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.

...