Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

 

Método:
getConfigurations(String username, String password, int companyId)
Parâmetros:
  • 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 ("").
  • emailServermailServer: 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.

...

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


 

ECMGroupService

 

Webservice responsável por realizar operações referentes a grupos no Fluig. Pode ser utilizado para criar, alterar, excluir e procurar grupos, entre outras funcionalidades.

 

Métodos

 

Expand
titleNo quadro 18, é mostrado todos os métodos disponíveis na classe GroupService.

-

createGroup

Cria um grupo no Fluig.

 

Método:

createGroup(String username, String password, int companyId, GroupDto[] grupos)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • grupos: grupo que será criado.

 

Retorno: String.

deleteGroup

Exclui um grupo do Fluig.

 

Método:

deleteGroup(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: String.

getGroup

Retorna um grupo cadastrado no Fluig.

 

Método:

getGroups(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: GroupDto[].

getGroups

Retorna todos os grupos cadastrados no Fluig.

 

Método:

getGroups(String username, String password, int companyId)

 

Parâmetros:

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

 

Retorno: GroupDto[].

getGroupsByDescription

Retorna um grupo pela descrição.

 

Método:

getGroupsByDescription(String username, String password, int companyId, String desc)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • desc: descrição do grupo.

 

Retorno: GroupDto[].

getOcurrenceByKey

Retorna se existe configuração de segurança para atribuição e valor da atribuição.

 

Método:

getOcurrenceByKey(String username, String password, int companyId, int pIdiAtribuic, String pDesValAtribuic)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • pIdiAtribuic: código da atribuição.
  • pDesValAtribuic: valor da atribuição.

 

Retorno: boolean.

updateGroup

Altera um grupo no Fluig.

 

Método:

updateGroup(String username, String password, int companyId, GroupDto[] grupos)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • grupos: grupo que será alterado.

 

Retorno: String.

Quadro 18: Métodos da GroupService.

 

Exemplo de utilização

 

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


 

ECMOutstandingService

 

Webservice responsável por interagir com as transferências de pendências do Fluig. Pode ser utilizado para transferir pendências de um usuário para outro usuário.

 

Métodos

 

Expand
titleNo quadro 19, é mostrado todos os métodos disponíveis na classe OutstandingService.

-

transfer

Transfere pendências de um usuário para outro usuário.

 

Método:

transfer(String user, String password, int companyId, String colleagueIdFrom, String colleagueIdTo, String[] parameters)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueIdFrom: matrícula do usuário origem (suas pendências serão tranferidas para o usuário destino).
  • colleagueIdTo: matrícula do usuário destino (receberá as pendências do usuário origem).
  • parameters: array de pendências que serão transferidas para o usuário destino.

 

Retorno: String.

Quadro 19: Métodos da OutstandingService.

 

Exemplo de utilização

 

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


ECMReportService

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

Expand
titleNo quadro 5, é mostrado todos os métodos disponíveis na classe CardService.

-

xxxxx

Altera os campos de um formulário.

  

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

 

ECMSearchDocumentService

Webservice responsável por realizar operações referentes às buscas no Fluig. Pode ser utilizado para buscar documentos utilizando a busca simples e avançada.

Métodos

Expand
titleNo quadro 21, é mostrado todos os métodos disponíveis na classe SearchDocumentService.

-

advancedSearchDocuments

Utiliza busca avançada.

 

Método:

advancedSearchDocuments(String user, String password, int companyId, String colleagueId, String content, boolean  findAllDocumentTypes, boolean  findFolders, boolean  findDocuments, boolean  findCardIndex, boolean  findCards, boolean  findExternalDocument, int  documentParentId, Date  startDate, Date  finalDate)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.
  • content: conteúdo da busca.
  • findAllDocumentTypes: indica se deve buscar todos os tipos de documentos.
  • findFolders: indica se deve buscar pastas.
  • findDocuments: indica se deve buscar documentos.
  • findCardIndex: indica se deve buscar fichários.
  • findCards: indica se deve buscar fichas.
  • findExternalDocument: indica se deve buscar documentos externos.
  • documentParentId: número do documento pai.
  • startDate: data inicial.
  • finalDate: data final.

 

Retorno: SearchResultDto[].

advancedSearchDocumentsWithMetadata

Utiliza busca avançada através das opções de metadados e campos customizados.

 

Método:

advancedSearchDocuments(String user, String password, int companyId, String colleagueId, String content, SearchFields[] metadata, SearchFields[] customfields, boolean  findAllDocumentTypes, boolean  findFolders, boolean  findDocuments, boolean  findCardIndex, boolean  findCards, boolean  findExternalDocument, int  documentParentId, Date  startDate, Date  finalDate)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.
  • content: conteúdo da busca.
  • metadata: informações para busca a partir de metadados.
  • customfields: informações para busca a partir de campos customizados.
  • findAllDocumentTypes: indica se deve buscar todos os tipos de documentos.
  • findFolders: indica se deve buscar pastas.
  • findDocuments: indica se deve buscar documentos.
  • findCardIndex: indica se deve buscar fichários.
  • findCards: indica se deve buscar fichas.
  • findExternalDocument: indica se deve buscar documentos externos.
  • documentParentId: número do documento pai.
  • startDate: data inicial.
  • finalDate: data final.

 

Retorno: SearchResultDto[].

searchDocuments

Utiliza busca simples.

 

Método:

searchDocuments(String user, String password, int companyId, String colleagueId, String content)

 

Parâmetros:

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

 

Retorno: SearchResultDto[].

searchFavoritesDocuments

Busca documentos favoritos.

 

Metodo:

searchFavoritesDocuments(String user, String Password, int companyId, String colleagueId, String content)

 

Parametros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.
  • contente: conteúdo a ser buscado

 

Retorno: SearchResultDto[]

Quadro 21: Métodos da SearchDocumentService

Exemplo de utilização

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

 

ECMxxxxService

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

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

...