Histórico da Página

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.

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 ("").
• mailServer: 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.

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.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

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.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

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

Atributos de Retorno:

• companyId

• groupDescription

• groupId

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

Atributos de Retorno:

• companyId

• groupDescription

• groupId

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

Atributos de Retorno:

• companyId

• groupDescription

• groupId

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.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

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.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

createSimpleReport

Cria um relatório de maneira simplificada no Fluig.

Método:

createSimpleReport(String username, String password, int companyId, int parentDocId, String reportDescription, Attachment[] attachments)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• parentDocId: código da pasta pai.
• reportDescription: descrição do relatório.
• attachments: anexos do relatório.

Retorno: WebServiceMessage[].

Estrutura de retorno com sucesso

Estrutura de retorno com erro

getActiveReport

Retorna um relatório ativo no Fluig.

Método:

getActiveReport(int companyId, String username, String password, String documentId)

Parâmetros:

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

Retorno: DocumentDto.

getAttachmentsList

Retorna uma lista de anexos do relatório no Fluig.

Método:

getAttachmentsList(String username, String password, int companyId, String documentId)

Parâmetros:

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

Retorno: String[].

getReportContent

Retorna o arquivo físico de um relatório.

Método:

getReportContent(String username, String password, int companyId, int nrDocumentId, String colleagueId, int documentoVersao, String fileName)

Parâmetros:

• username: 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.
• documentoVersao: versão do documento.
• fileName: nome do arquivo.

Retorno: byte[].

getRepots

Retorna os relatórios disponíveis.

Método:

getRepots(String username, String password, int companyId)

Parâmetros:

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

Retorno: DocumentDto[].

updateSimpleReport

Atualiza um relatório de maneira simplificada no Fluig.

Método:

createSimpleReport(String username, String password, int companyId, int docId, String reportDescription, Attachment[] attachments, String versionOption)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• docId: código da pasta pai.
• reportDescription: descrição do relatório.
• attachments: anexos do relatório.
• versionOption: informa se deseja atualizar a versão do relatório.

Retorno: WebServiceMessage[].

Estrutura de retorno com sucesso

Estrutura de retorno com erro

createWorkflowRole

Cria um papel no Fluig.

Método:

createWorkflowRole(String username, String password, int companyId, workflowRoleDto role)

Parâmetros:

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

Retorno: String.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

deleteWorkflowRole

Exclui um papel do Fluig.

Método:

deleteWorkflowRole(String username, String password, int companyId, String roleId)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• roleId: código do papel a ser excluído.

Retorno: String.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

getWorkflowRole

Retorna um papel cadastrado no Fluig.

Método:

getWorkflowRole(String username, String password, int companyId, String roleId)

Parâmetros:

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

Retorno: WorkflowRoleDto.

Atributos de Retorno:

• companyId
• roleDescription
• roleId

getWorkflowRoles

Retorna todos os papéis cadastrados no Fluig.

Método:

getWorkflowRoles(String username, String password, int companyId)

Parâmetros:

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

Retorno: WorkflowRoleDto[].

Atributos de Retorno:

• companyId
• roleDescription
• roleId

updateWorkflowRole

Atualiza um papel no Fluig.

Método:

updateWorkflowRole(String username, String password, int companyId, workflowRoleDto role)

Parâmetros:

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

Retorno: String.

Estrutura de retorno com sucesso

Estrutura de retorno com erro