Home

TOTVS | Plataformas e tecnologias

Árvore de páginas

Versões comparadas

Chave

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

...

Deck of Cards
id1
Card
id1
labelPasso 1

 

Para criar um stub é necessário que o serviço do ECM esteja inicializado.

 

Card
id1
labelPasso 2

 

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.

 

 

No quadro 1, é mostrado o comando necessário para criação de stubs de cada serviço disponível no ECM.

 

WebservicesComando
WorkflowEngineService

wsimport -d C:\Webservices\tmp

http://<SERVER>:<PORT>/webdesk/WorkflowEngineService?wsdl

ColleagueGroupService

wsimport -d C:\Webservices\tmp

http://<SERVER>:<PORT>/webdesk/ColleagueGroupService?wsdl

ColleagueReplacementService

wsimport -d C:\Webservices\tmp

http://<SERVER>:<PORT>/webdesk/ColleagueReplacementService?wsdl

ColleagueService

wsimport -d C:\Webservices\tmp

http://<SERVER>:<PORT>/webdesk/ColleagueService?wsdl

CompanyService

wsimport -d C:\Webservices\tmp

http://<SERVER>:<PORT>/webdesk/CompanyService?wsdl

GlobalParamService

wsimport -d C:\Webservices\tmp

http://<SERVER>:<PORT>/webdesk/GlobalParamService?wsdl

GroupService

wsimport -d C:\Webservices\tmp

http://<SERVER>:<PORT>/webdesk/GroupService?wsdl

CardService

wsimport -d C:\Webservices\tmp

http://<SERVER>:<PORT>/webdesk/CardService?wsdl

CustomFieldsService

wsimport -d C:\Webservices\tmp

http://<SERVER>:<PORT>/webdesk/CustomFieldsService?wsdl

DashBoardService

wsimport -d C:\Webservices\tmp

http://<SERVER>:<PORT>/webdesk/DashBoardService?wsdl

DocumentService

wsimport -d C:\Webservices\tmp

http://<SERVER>:<PORT>/webdesk/DocumentService?wsdl

FavoritesService

wsimport -d C:\Webservices\tmp

http://<SERVER>:<PORT>/webdesk/FavoritesService?wsdl

FolderService

wsimport -d C:\Webservices\tmp

http://<SERVER>:<PORT>/webdesk/FolderService?wsdl

SearchDocumentService

wsimport -d C:\Webservices\tmp

http://<SERVER>:<PORT>/webdesk/SearchDocumentService?wsdl

TokenService

wsimport -d C:\Webservices\tmp

http://<SERVER>:<PORT>/webdesk/TokenService?wsdl

DatasetService

wsimport -d C:\Webservices\tmp

http://<SERVER>:<PORT>/webdesk/DatasetService?wsdl

OutstandingService

wsimport -d C:\Webservices\tmp

http://<SERVER>:<PORT>/webdesk/OutstandingService?wsdl

BusinessPeriodService

wsimport -d C:\Webservices\tmp

http://<SERVER>:<PORT>/webdesk/BusinessPeriodService?wsdl

AttributionMecanismService

wsimport -d C:\Webservices\tmp

http://<SERVER>:<PORT>/webdesk/AttributionMecanismService?wsdl

Quadro 1: Comandos para criação de stubs

 

Considerações e 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.

 

 

DocumentService

Webservices responsável por realizar operações referentes a documentos do ECM. Pode ser utilizado para criar, alterar, excluir e procurar documentos, entre outras funcionalidades.

Métodos

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

 

getActiveDocument

Retorna um documento ativo.

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

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • nrDocumentId: número do documento;
  • colleagueId: matrícula do colaborador.

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 colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • nrDocumentId: número do documento;
  • colleagueId: matrícula do colaborador;
  • 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 colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • nrDocumentId: número do documento;
  • version: número da versão do documento;
  • colleagueId: matrícula do colaborador.

Retorno: DocumentDto[].

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 colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • externalDocumentId: código externo do documento;
  • colleagueId: matrícula do colaborador.

Retorno: DocumentDto[].

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 colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • nrDocumentId: número do documento;
  • version: número da versão do documento.

Retorno: DocumentSecurityConfigDto[].

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 colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • nrDocumentId: número do documento.

Retorno: ApproverWithLevelDto[].

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 colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • nrDocumentId: número do documento;
  • version: número da versão do documento.

Retorno: RelatedDocumentDto[].

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 colaborador;
  • password: senha do colaborador;
  • 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 colaborador;
  • password: senha do colaborador;
  • 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[].

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 colaborador;
  • password: senha do colaborador;
  • 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[].

updateSimpleDocument

Altera de forma simples um documento.

Método:
updateSimpleDocument(String username, String password, int companyId, int documentId, String publisherI

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 colaborador que realizará a alteração do documento;
  • documentDescription: descrição do documento;
  • attachments: arquivos anexados na alteração.

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 colaborador;
  • password: senha do colaborador;
  • 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[].

validateIntegrationRequiremeVerifica a integração do colaborador no ECM.
nts

Método:

validateIntegrationRequirements (String user, String password, int companyId)

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa.

Retorno: String.

getReportSubjectId

Retorna o código do assunto relatórios dentro do ECM.

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

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa.

Retorno: int.

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 colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • documentId: número do documento;
  • version: número da versão do documento.

Retorno: Não há retorno.

getUserPermissions

Retorna as permissões do colaborador sobre um documento.

Método:
getUserPermissions(int companyId, String user, int nrDocumentId, int version)

Parâmetros:

  • companyId: código da empresa;
  • user: login do colaborador;
  • nrDocumentId: número do documento;
  • version: número da versão do documento.

Retorno: Integer.

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 colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • parentDocumentId: número da pasta pai;
  • publisherId: matrícula do colaborador 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 colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • parentDocumentId: número da pasta pai;
  • documentDescription: descrição do documento;
  • attachments: arquivo anexado na publicação.

Retorno: WebServiceMessage[].

findMostPopularDocuments

Retorna os documentos mais acessados no ECM que o colaborador tenha permissão de acesso.

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

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • colleagueId: matrícula do colaborador;
  • nr_resultados: quantidade de documentos que serão retornados.

Retorno: DocumentDto[].

findMostPopularDocumentsOnDemand

Retorna os documentos mais acessados no ECM que o colaborador tenha permissão de acesso, paginados.

Método:
findMostPopularDocuments(String user, String password, int companyId,

String colleagueId, int nr_resultados, int limit, int lastRowId)

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • colleagueId: matrícula do colaborador;
  • nr_resultados: quantidade de documentos que serão retornados;
  • limit: número de registros a serem retornados;
  • lastRowId: última linha retornada.

Retorno: DocumentDto[].

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 colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • documentId: número do documento que será excluído;
  • colleagueId: matrícula do colaborador.

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 colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • documentId: número do documento que será excluído;
  • colleagueId: matrícula do colaborador.

Retorno: WebServiceMessage[].

findRecycledDocuments

Retorna os documentos da lixeira.

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

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • colleagueId: matrícula do colaborador.

Retorno: DocumentDto[].

restoreDocument

Restaura um documento da lixeira.

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

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • documentId: número do documento que será restaurado;
  • colleagueId: matrícula do colaborador.

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 colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • documentId: número do documento que será copiado;
  • version: versão do documento
  • colleagueId: matrícula do colaborador cuja área de upload será utilizada

Retorno: String[] nome dos arquivos que foram disponibilizados na área de upload

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 colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • documentIds: lista com os números dos documentos que serão movidos;
  • colleagueId: matrícula do colaborador com permissão para mover o documento
  • destFolder: número da pasta de destino.

Retorno: String[]

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 colaboradores dos Grupos.
1 - SOMENTE colaboradores 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 colaboradores dos Grupos / 1 - SOMENTE colaboradores comuns dos grupos)
  • restrictionType: tipo da restrição
    (0 - TODOS os colaboradores dos Grupos / 1 - SOMENTE colaboradores comuns dos grupos)

  • colleagueId: matrícula do colaborador

Retorno: WebServiceMessage[]

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

getDocumentApprovalHistory

Retorna o histórico de aprovacoes 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[]

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

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

 copyDocuments 

Realiza a cópia de vários documentos e pastas em uma única requisição.

Metodo:
copyDocuments(int companyId, String login, String password, String userId, Integer[] origins, Integer destination)

Parâmetros:

  • companyId: código da empresa;
  • login: login ou código do usuário de integração;
  • password: senha do usuário de integração;
  • userId: código do usuário;
  • origins: lista de documentos a serem copiados;
  • destination: pasta destino das cópias.

Retorno: CopyDocumentDto[]

Quadro 2: Métodos da DocumentService

 

Exemplo de utilização

No diretório de documentação do ECM 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.

 

 

WorkflowEngineService

Webservices responsável por realizar operações referentes a workflow no ECM. Pode ser utilizado para movimentar solicitações, entre outras funcionalidades.

 

Métodos

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

 

simpleStartProcess

Inicia uma solicitação simples.

Método:
simpleStartProcess(String user, String password, int companyId, String processId,

String comments, ProcessAttachmentDto[] attachments, String cardData[][])

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • processId: código do processo;
  • comments: comentários;
  • attachments: anexos da solicitação;
  • cardData: dados da ficha.

 

Retorno: String[].

 startProcess

Inicia uma solicitação.

Método:
startProcess(String user, String password, int companyId, String processId, int choosedState, String[] colleagueIds,

String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, String[][] cardData,

ProcessTaskAppointmentDto[] appointment, boolean managerMode)

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • processId: código do processo;
  • choosedState: número da atividade;
  • colleagueIds: colaborador que receberá a tarefa;
  • comments: comentários;
  • userId: matrícula do colaborador que vai iniciar a solicitação;
  • completeTask: indica se deve completar a tarefa (true) ou somente salvar (false);
  • attachments: anexos da solicitação;
  • cardData: dados da ficha;
  • appointment: apontamentos da tarefa;
  • managerMode: indica se colaborador esta iniciando a solicitação como gestor do processo.

 

Retorno: String[][].

 setDueDate

 Altera a data de prazo da tarefa.

Método:
setDueDate(String user, String password, int companyId, int processInstanceId,

String userId, int threadSequence, String newDueDate, int timeInSeconds)

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • processInstanceId: número da solicitação;
  • userId: mátricula do colaborador;
  • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista,
    este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo;
  • newDueDate: nova data de prazo da tarefa;
  • timeInSeconds: quantidade de segundos após a meia noite.

 

Retorno: String.

 setTasksComments Altera os comentários da tarefa.

 

Método:
setTasksComments(String user, String password, int companyId, int processInstanceId, String userId, int threadSequence,

String comments)

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • processInstanceId: número da solicitação;
  • userId: mátricula do colaborador;
  • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero),
    caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo;
  • comments: comentários.

 

Retorno: String.

 cancelInstance Cancela uma solicitação.

 

Método:
cancelInstance(String user, String password, int companyId,int processInstanceId, String userId, String cancelText)

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • processInstanceId: número da solicitação;
  • userId: mátricula do colaborador;
  • cancelText: comentários do cancelamento.

 

Retorno: String.

 cancelInstanceByReplacement Cancela uma solicitação utilizando colaborador substituto.

 

Método:
cancelInstanceByReplacement(String user, String password, int companyId, int processInstanceId,

String userId, String cancelText, String replacementId)

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • processInstanceId: número da solicitação;
  • userId: mátricula do colaborador;
  • cancelText: comentários do cancelamento;
  • replacementId: matrícula do colaborador substituto.

 

Retorno: String.

 getCardValue Retorna o valor de um campo da ficha.

 

Método:
getCardValue(String user, String password, int companyId, int processInstanceId, String userId, String cardFieldName)

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • processInstanceId: número da solicitação;
  • userId: mátricula do colaborador;
  • cardFieldName: nome do campo da ficha.

 

Retorno: String.

 saveAndSendTask Movimenta solicitação para próxima atividade.

 

Método:

saveAndSendTask(String user, String password, int companyId, int processInstanceId, int choosedState, String[] colleagueIds,

String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments,

String[][] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode, int threadSequence)

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • processInstanceId: número da solicitação;
  • choosedState: número da atividade;
  • colleagueIds: colaborador que receberá a tarefa;
  • comments: comentários;
  • userId: matrícula do colaborador que vai executar a tarefa;
  • completeTask: indica se deve completar a tarefa (true) ou somente salvar (false);
  • attachments: anexos da solicitação;
  • cardData: dados da ficha;
  • appointment: apontamentos da tarefa;
  • managerMode: indica se colaborador esta executando a tarefa como gestor do processo;
  • threadSequence: Indica se existe atividade paralela no processo.

Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito

dependendo da quantidade de atividade paralelas existentes no processo.

 

Retorno: String[][].

saveAndSendTaskClassic

Movimenta solicitação para próxima atividade e retorna um array de objeto com chave e valor.

Método:
saveAndSendTaskClassic(String user, String password, int companyId, int processInstanceId,

int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask,

ProcessAttachmentDto[] attachments, KeyValueDto[] cardData, ProcessTaskAppointmentDto[] appointment, boolean

managerMode, int threadSequence)

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • processInstanceId: número da solicitação;
  • choosedState: número da atividade;
  • colleagueIds: colaborador que receberá a tarefa;
  • comments: comentários;
  • userId: matrícula do colaborador que vai executar a tarefa;
  • completeTask: indica se deve completar a tarefa (true) ou somente salvar (false);
  • attachments: anexos da solicitação;
  • cardData: dados da ficha;
  • appointment: apontamentos da tarefa;
  • managerMode: indica se colaborador esta executando a tarefa como gestor do processo;
  • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero),

caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.

 

Retorno: KeyValueDto[].

saveAndSendTaskByReplacement

Movimenta solicitação para próxima atividade utilizando colaborador substituto.

Método:
saveAndSendTaskByReplacement (String user, String password, int companyId,

int processInstanceId, int choosedState, String[] colleagueIds, String comments, String userId,

boolean completeTask, ProcessAttachmentDto[] attachments, String[][] cardData,

ProcessTaskAppointmentDto[] appointment, boolean managerMode, int threadSequence, String replacementId)

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • processInstanceId: número da solicitação;
  • choosedState: número da atividade;
  • colleagueIds: colaborador que receberá a tarefa;
  • comments: comentários;
  • userId: matrícula do colaborador que vai executar a tarefa;
  • completeTask: indica se deve completar a tarefa (true) ou somente salvar (false);
  • attachments: anexos da solicitação;
  • cardData: dados da ficha;
  • appointment: apontamentos da tarefa;

  • managerMode: indica se colaborador esta executando a tarefa como gestor do processo;

  • threadSequence: Indica se existe atividade paralela no processo.

Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito

dependendo da quantidade de atividade paralelas existentes no processo;

  • replacementId: matrícula do colaborador substituto.

 

Retorno: String[][].

setAutomaticDecisionClassic

Seleciona usuário(s) e avança atividade automática.

Metodo:
setAutomaticDecisionClassic(String user, String password, int companyId, int processInstanceId,

int iTaskAutom, int iTask, int condition, String[] colleagueIds, String comments, String userId,

boolean managerMode, int threadSequence)

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • processInstanceId: número da solicitação;
  • iTaskAutom: número da atividade automática;
  • iTask: numero da atividade atual;
  • condition: numero da condição da atividade automática;
  • colleagueIds: colaborador que receberá a tarefa;
  • comments: comentários;
  • userId: matrícula do colaborador que vai executar a tarefa;
  • managerMode: indica se colaborador esta executando a tarefa como gestor do processo;

 

  • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista,
    este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo;

 

Retorno: KeyValueDto[]

takeProcessTask

Assume uma tarefa.

Método:

takeProcessTask(String user, String password, int companyId, String userId, int processInstanceId, int threadSequence)

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • userId: matrícula do colaborador;
  • processInstanceId: número da solicitação;
  • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista,
    este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.

 

Retorno: String.

takeProcessTaskByReplacement

Assume uma tarefa utilizando colaborador substituto.

Método:
takeProcessTask(String user, String password, int companyId, String userId, int processInstanceId,

int threadSequence, String replacementId)

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • userId: matrícula do colaborador;
  • processInstanceId: número da solicitação;
  • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista,
    este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo;
  • replacementId: matrícula do colaborador substituto.

 

Retorno: String.

getAttachments

Retorna os anexos de uma solicitação.

Método:
getAttachments(String user, String password, int companyId, String userId, int processInstanceId)

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • userId: matrícula do colaborador;
  • processInstanceId: número da solicitação.

 

Retorno: ProcessAttachmentDto[].

getAllActiveStates

Retorna o número da atividade em que uma solicitação esta.

Método:
getAllActiveStates(String user, String password, int companyId, String userId, int processInstanceId)

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • userId: matrícula do colaborador;
  • processInstanceId: número da solicitação.

 

Retorno: Integer[].

getActualThread

Retorna a sequência da thread de uma solicitação.

Método:
getActualThread(String user, String password, int companyId, int processInstanceId, int stateSequence)

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • userId: matrícula do colaborador;
  • stateSequence: sequência do estado.

 

Retorno: int.

getAvailableStates

Retorna o número da próxima atividade de uma solicitação.

Método:
getAvailableStates(String user, String password, int companyId, String processId,

int processInstanceId, int threadSequence)

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • processId: código do processo;
  • processInstanceId: número da solicitação;
  • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero),
    caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.

 

Retorno: Integer[].

getAvailableStatesDetail

Retorna detalhes das atividades disponíveis para seleção..

Método:
getAvailableStatesDetail(String user, String password, int companyId, String processId, int processInstanceId,

int threadSequence)

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • processId: código do processo;
  • processInstanceId: número da solicitação;
  • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista,
    este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.

 

Retorno: ProcessStateDto[].

getAvailableUsers

Retorna os colaboradores que podem executar a tarefa corrente de uma solicitação.

Método:
getAvailableUsers(String username, String password, int companyId, int processInstanceId, int state, int threadSequence)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • processInstanceId: número da solicitação;
  • state: número da atividade;
  • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista,

este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.

 

Retorno: String[].

getAvailableUsersOnDemand

Retorna os colaboradores que podem executar a tarefa corrente de uma solicitação, paginados e com busca.

Método:
getAvailableUsersOnDemand(String username, String password, int companyId, int processInstanceId,

int state, int threadSequence, int limit, int initialUser, String userSearch)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • processInstanceId: número da solicitação;
  • state: número da atividade;
  • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista,

este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo;

  • limit: número de registros a serem retornados;
  • initialUser: última linha retornada;
  • userSearch: texto a ser buscado.

Retorno: AvailableUsersDto.

getInstanceCardData

Retorna o valor dos campos da ficha de uma solicitação.

Método:
getInstanceCardData(String user, String password, int companyId, String userId, int processInstanceId)

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • userId: matrícula do colaborador;
  • processInstanceId: número da solicitação.

Retorno: String[][].

getAvailableProcess

Retorna os processos que o colaborador pode iniciar uma solicitação.

Método:
getAvailableProcess(String username, String password, int companyId, String userId)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • userId: matrícula do colaborador.

Retorno: ProcessDefinitionVersionDto[].

getAvailableProcessOnDemand

Retorna os processos que o colaborador pode iniciar uma solicitação, paginados.

Método:
getAvailableProcessOnDemand(String username, String password,

int companyId, String userId, int limit, int lastRowId)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • userId: matrícula do colaborador;
  • limit: número de registros a serem retornados;
  • lastRowId: última linha retornada.

Retorno: ProcessDefinitionVersionDto[].

updateWorkflowAttachment

Atualiza um documento do tipo 7.
Retorna uma string contendo a descrição de sucesso ou falha da operação.

Método:
updateWorkflowAttachment(String username, String password, int companyId, int processInstanceId,

String usuario, DocumentDto[] docdtos, Attachment[] attach)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • processInstanceId: número da solicitação workflow
  • usuario: usuário responsável pela edição do documento;
  • docDtos: documento ou documentos que serão publicados;
  • attachs: arquivo(s) anexado(s) na publicação;
getAvailableUsersStart

Retorna os colaboradores disponíveis na abertura de uma solicitação.

Método:
getAvailableUsersStart (String username, String password, int companyId, String processId, int state, int threadSequence)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • processId: código do processo;
  • state: número da atividade;
  • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista,

este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.

Retorno: String[].

getAvailableUsersStartOnDemand

Retorna os colaboradores disponíveis na abertura de uma solicitação, paginados e com busca.

Método:
getAvailableUsersStart (String username, String password, int companyId, String processId, int state,

int threadSequence, int limit, int initialUser, String userSearch)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • processId: código do processo;
  • state: número da atividade;
  • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista,
    este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo;
  • limit: número de registros a serem retornados;
  • initialUser: última linha retornada;
  • userSearch: texto a ser buscado.


Retorno: AvailableUsersDto.

importProcess

Importa processos workflow.

Método:
importProcess(String user, String password, int companyId,

String processId, Attachment file, boolean newProcess, boolean overWrite, String colleagueId)

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • processId: código do processo;
  • file: arquivo a ser importado;
  • newProcess: indica se deve ser criado um processo ou atualizado o existente;
  • overWrite: indica se as atividade e fluxos do processo existente dever ser sobrescritas.
  • colleagueId : matrícula do colaborador.


Retorno: String.

calculateDeadLineHours

Calcula um prazo a partir de uma data com base no expediente e feriados cadastrados no produto passando o prazo em horas.

Método:
calculateDeadLineHours(String username, String password, int companyId, String userId,

String data, int segundos, int prazo, String periodId)

Parâmetros:

  • username - Usuário de Integração
  • password - Senha de Integração
  • companyId - Código da empresa
  • userId - Matrícula do usuário
  • data - data (Tipo String no formato "yyyy-MM-dd").
  • segundos - Quantidade de segundos após a meia noite
  • prazo - Prazo que será aplicado em horas (Variável int).
  • periodId - Código de Expediente


Retorno: Objeto DeadLineDto que contem variáveis com a data e hora.

calculateDeadLineTime

Calcula um prazo a partir de uma data com base no expediente e feriados cadastrados no produto passando o prazo em minutos.

Método:
calculateDeadLineHours(String username, String password, int companyId, String userId, String data, int segundos, int prazo, String periodId)

Parâmetros:

  • username - Usuário de Integração
  • password - Senha de Integração
  • companyId - Código da empresa
  • userId - Matrícula do usuário
  • data - data (Tipo String no formato "yyyy-MM-dd").
  • segundos - Quantidade de segundos após a meia noite
  • prazo - Prazo que será aplicado em minutos (Variável int).
  • periodId - Código de Expediente


Retorno: Objeto DeadLineDto que contem variáveis com a data e hora.

exportProcess

Retorna o processo selecionado em uma String.

Método:
exportProcess (String username, String password, int companyId, String processId)

Parâmetros:

  • username - Usuário de Integração
  • password - Senha de Integração
  • companyId - Código da empresa
  • processId - Código do processo


Retorno: String que contém a definição do processo

getAllProcessAvailableToImport

Retorna uma lista de processos disponíveis para serem importados.

Método:
getAllProcessAvailableToImport (String username, String password, int companyId)

Parâmetros:

  • username - Usuário de Integração
  • password - Senha de Integração
  • companyId - Código da empresa


Retorno: ProcessDefinitionDto[]

getAllProcessAvailableToExport

Retorna uma lista de processos disponíveis para serem exportados.

Método:
getAllProcessAvailableToExport (String username, String password, int companyId)

Parâmetros:

  • username - Usuário de Integração
  • password - Senha de Integração
  • companyId - Código da empresa


Retorno: ProcessDefinitionDto[].

getHistories

Retorna lista de históricos de um processo.

Método:
getHistories (String username, String password, int companyId)

Parâmetros:

  • username - Usuário de Integração
  • password - Senha de Integração
  • companyId - Código da empresa
  • userId - Matrícula do usuário
  • processInstanceId - número da solicitação workflow


Retorno: ProcessHistoryDto[].

searchProcess

Busca processo disponíveis para inicialização.

Metodo:
searchProcess(String user, String Password, int companyId, String colleagueId, String content, boolean favorite)

Parametros

  • user - Usuário de Integração
  • password - Senha de Integração
  • companyId - Código da empresa
  • colleagueId - Matrícula do usuário
  • content – nome do processo a ser pesquisado
  • favorite – busca da lista de processos favoritos ou da listagem padrão.


Retorno: ProcessDefinitionVersionDto[]

Quadro 3: Métodos da WorkflowEngineService

Exemplos de utilização

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

 

 

GroupService

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

 

Métodos

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

 

getGroups

Retorna todos os grupos cadastrados no ECM.

Método:
getGroups(String username, String password, int companyId)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa.


Retorno: GroupDto[].

getGroup

Retorna um grupo cadastrado no ECM.

Método:
getGroups(String username, String password, int companyId, String groupId)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • groupId: código do grupo.


Retorno: GroupDto[].

createGroup

Cria um grupo no ECM.

Método:
createGroup(String username, String password, int companyId, GroupDto[] grupos)

Parâmetros:

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


Retorno: String.

 updateGroup Altera um grupo no ECM.

 

Método:
updateGroup(String username, String password, int companyId, GroupDto[] grupos)

Parâmetros:

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


Retorno: String.

 getGroupsByDescription Retorna um grupo pela descrição.

 

Método:
getGroupsByDescription(String username, String password, int companyId, String desc)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • 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 colaborador;
password: senha do colaborador;
companyId: código da empresa;
pIdiAtribuic: código da atribuição;
pDesValAtribuic: valor da atribuição.
Retorno: boolean.

 deleteGroup Exclui um grupo do ECM.

 

Método:
deleteGroup(String username, String password, int companyId, String groupId)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • GroupId: código do grupo.


Retorno: String.

Quadro 4: Métodos da GroupService

Exemplo de utilização

No diretório de documentação do ECM 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.

FavoritesService

Webservices responsável por interagir com os documentos e processos favoritos do ECM. Pode ser utilizado para pesquisar os documentos e processos favoritos de cada colaborador.

 

Método

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

 

findFavorites

Retorna os documentos favoritos do colaborador.

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

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • colleagueId : matrícula do colaborador.


Retorno: DocumentDto[].

findFavoritesOnDemand

Retorna os documentos favoritos do colaborador, paginados.

Método:
findFavoritesOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)

Parâmetros:

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


Retorno: DocumentDto[].

findFavoritesProcess

Retorna os processos favoritos do colaborador.

Método:
findFavoritesProcess (String user, String password, intcompanyId, String colleagueId)

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • colleagueId : matrícula do colaborador.


Retorno: ProcessDefinitionVersionDto[] .

 findFavoritesProcessOnDemand Retorna os processos favoritos do colaborador, paginados.

 

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

Parâmetros:

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


Retorno: ProcessDefinitionVersionDto[] .

 addDocumentToFavorites Adiciona um documento aos favoritos do colaborador informado.

 

Método:
addDocumentToFavorites(String username, String password, int companyId, int nrDocument, int nrVersao, String colleagueId)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • nrDocument: número do documento
  • nrVersao: versão do documento
  • colleagueId : matrícula do colaborador.
 removeFavoriteDocument

Método:

removeFavoriteDocument (String username, String password, int companyId, int nrDocument, String colleagueId)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • nrDocument: número do documento
  • colleagueId : matrícula do colaborador.

 Remove um documento dos favoritos do colaborador informado.

 addProcessToFavorites Adiciona um processo aos favoritos do colaborador informado.

 

Método:
addProcessToFavorites(String username, String password, int companyId,String processId, String colleagueId)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • processId: código do processo


colleagueId : matrícula do colaborador.

removeFavoriteProcess

Remove um processo dos favoritos do colaborador informado.

Método:
addProcessToFavorites(String username, String password, int companyId,String processId, String colleagueId)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • processId: código do processo.
  • colleagueId : matrícula do colaborador.
isFavoriteDocument

Verifica se documento é favorito.

Metodo:
isFavoriteDocument(String username, String password, int companyId, int nrDocument, String colleagueId)

Parâmetros:

  • username: login do usuário de integração;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • nrDocument: código do documento;
  • colleagueId: matricula do colaborador.


Retorno: Boolean

Quadro 5: Métodos da FavoritesService

 

Exemplo de utilização

No diretório de documentação do ECM 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.

 

CompanyService

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

 

Métodos

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

 

getCompanies

Retorna todas as empresas cadastradas no ECM.

Método:
getCompanies(String username, String password, String companyId)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa.


Retorno: CompanyDto[].

getCompany

Retorna uma empresa cadastrada no ECM.

Método:
getCompany(int companyId)

Parâmetros:

  • companyId: código da empresa.

Retorno: CompanyDto.

createCompany

Cria uma empresa no ECM.

Método:
createCompany(String username, String password, String companyId, String description,

String urlAccessName, String phisicalPath, String webdeskServer, String webPort)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • 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 ECM.

Método:
updateCompany(String username, String password, String companyId, String description, String urlAccessName, String phisicalPath, String webdeskServer, String webPort)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • 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 ECM.

Método:
delete(String username, String password, String companyId, Boolean deleteFiles)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • deleteFiles: indica se deve excluir o caminho físico.


Retorno: String.

Quadro 6: Métodos da CompanyService

 

Exemplo de utilização

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

 

 

SearchDocumentService

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

 

Métodos

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

 

searchDocuments

Utiliza busca simples.

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

Parâmetros:

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


Retorno: SearchResultDto[].

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 colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • colleagueId: matrícula do colaborador;
  • 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[].

searchFavoritesDocuments

Busca documentos favoritos.

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

Parametros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • colleagueId: matrícula do colaborador;
  • contente: conteúdo a ser buscado


Retorno: SearchResultDto[]

Quadro 7: Métodos da SearchDocumentService

 

Exemplo de utilização

No diretório de documentação do ECM 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.

 

 

ColleagueGroupService

Webservices responsável por realizar operações referentes aos grupos de usuários no ECM. Pode ser utilizado para relacionar um colaborador a um grupo de usuários e serve também para alterar, excluir e pesquisar esses relacionamentos criados.

 

Métodos

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

 

getColleagueGroupsByColleagueId

Retorna os grupos de usuários que um colaborador participa.

Método:
getColleagueGroupsByColleagueId(String username, String password, int companyId, String colleagueId)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • colleagueId: matrícula do colaborador.


Retorno: ColleagueGroupDto[].

getColleagueGroupsByGroupId

Retorna os colaboradores que participam de um grupo de usuários.

Método:
getColleagueGroupsByGroupId(String username, String password, int companyId, String groupId)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • groupId: código do grupo.


Retorno: ColleagueGroupDto[].

getAllColleagueGroups

Retorna todos os grupos de usuários que possuem colaboradores relacionados.

Método:

getAllColleagueGroups(String username, String password, int companyId)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa.


Retorno: ColleagueGroupDto[].

 getColleagueGroup Retorna somente um grupo de usuários que um colaborador participa.

 

Método:
getColleagueGroup(String username, String password, int companyId, String groupId, String colleagueId)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • groupId: código do grupo;
  • colleagueId: matrícula do colaborador.


Retorno: ColleagueGroupDto[].

 createColleagueGroup Associa um colaborador a um grupo de usuários.

 

Método:
createColleagueGroup(String username, String password, int companyId, ColleagueGroupDto[] grupo_colaborador)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • grupo_colaborador: grupo de usuários que estará associado a um colaborador.


Retorno: String.

 updateColleagueGroup 

Altera a associação de um colaborador a um grupo de usuários.

Método:
updateColleagueGroup(String username, String password, int companyId, ColleagueGroupDto[] grupo_colaborador)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • grupo_colaborador: grupo de usuários que será alterado.


Retorno: String.

deleteColleagueGroup

Exclui um colaborador de um grupo de usuários.

Método:
deleteColleagueGroup(String username, String password, int companyId, String groupId, String colleagueId)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • groupId: código do grupo;
  • colleagueId: matrícula do colaborador.


Retorno: String.

Quadro 8: Métodos da ColleagueGroupService

 

Exemplo de utilização

No diretório de documentação do ECM 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.

 

ColleageService

Webservices responsável por realizar operações referentes a colaboradores no ECM. Pode ser utilizado para criar, alterar, excluir e pesquisar colaboradores, entre outras funcionalidades.
Os métodos createColleague, createColleaguewithDependencies, updateColleague e updateColleaguewithDependencies, em um dos seus paramtros, 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

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

 

getColleagues

Retorna todos os colaboradores ativos.

Método:
getColleagues(String username, String password, int companyId)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa.


Retorno: ColleagueDto[].

getColleague

Retorna um colaborador.

Método:
getColleague(String username, String password, int companyId, String colleagueId)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • colleagueId: matrícula do colaborador.


Retorno: ColleagueDto[].

getGroups

Retorna os grupos de usuários que o colaborador participa.

Método:
getGroups(String username, String password, int companyId, String colleagueId)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • colleagueId: matrícula do colaborador.


Retorno: GroupDto[].

 createColleague Cria um colaborador.

 

Método:
createColleague(String username, String password, int companyId, ColleagueDto[] colegas)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • colegas: colaboradores.


Retorno: String.

 createColleaguewithDependencies Cria um colaborador com grupo de segurança e papéis workflow.

 

Método:
createColleaguewithDependencies(String username, String password, int companyId,

ColleagueDto[] colegas, GroupDto[] grupos, WorkflowRoleDto[] papeis)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • colegas: colaboradores;
  • grupos: grupos de segurança;
  • papeis: papéis workflow.


Retorno: String.

 updateColleague Altera um colaborador.

Método:
updateColleague(String username, String password, intcompanyId, ColleagueDto[] colegas)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • colegas: colaboradores.


Retorno: String.

 updateColleaguewithDependencies Altera um colaborador com grupo de segurança e papéis workflow.

 

Método:
updateColleaguewithDependencies(String username, String password, int companyId, ColleagueDto[] colegas, GroupDto[] grupos, WorkflowRoleDto[] papeis)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • colegas: colaboradores;
  • grupos: grupos de segurança;
  • papeis: papéis workflow.


Retorno: String.

 removeColleague Exclui um colaborador.

 

Método:
removeColleague(String username, String password, int companyId, String colleagId)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • colleagId: matrícula do colaborador.


Retorno: String.

 getSummaryColleagues Retorna todos os colaboradores ativos.

 

Método:
getSummaryColleagues(int companyId)

Parâmetros:

  • companyId: código da empresa.

Retorno: ColleagueDto[].

 validateColleagueLogin Valida o acesso de um colaborador no produto.

 

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

Parâmetros:

  • companyId: código da empresa;
  • colleagueId: matrícula do colaborador;
  • password: senha do colaborador.


Retorno: String.

 getColleaguesMail Retorna um colaborador utilizando um e-mail.

 

Método:
getColleaguesMail(String username, String password, int companyId, String mail)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • mail: e-mail do colaborador.


Retorno: ColleagueDto[].

 getSimpleColleague Retorna o colaborador.

 

Método:
getSimpleColleague(String username, String password)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;


Retorno: ColleagueDto.

Quadro 9: Métodos da ColleagueService

 

Exemplo de utilização

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

 

 

ColleagueReplacementService

Webservices responsável por realizar operações referentes a colaboradores substitutos no ECM. Pode ser utilizado para criar, alterar, excluir e pesquisar colaboradores substitutos, entre outras funcionalidades.

 

Métodos

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

getColleagueReplacement

Retorna um substituto de um colaborador.

Método:
getColleagueReplacement(String username, String password,

int companyId, String colleagueId, String replacementId)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • colleagueId: matrícula do colaborador origem;
  • replacementId: matrícula do colaborador substituto.


Retorno: ColleagueReplacementDto.

getReplacementsOfUser

Retorna todos os substitutos de um colaborador.

Método:
getReplacementsOfUser(String username, String password, int companyId,

String colleagueId)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • colleagueId: matrícula do colaborador origem.


Retorno: ColleagueReplacementDto[].

getValidReplacedUsers

Retorna todos os colaboradores substituidos por um substituto válido.
Método:

getValidReplacedUsers(String username, String password, int companyId, String replacementId)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • replacementId: matrícula do colaborador substituto.


Retorno: ColleagueReplacementDto[].

 getValidReplacement Retorna um substituto válido de um colaborador.

 

Método:
getValidReplacement(String username, String password, int companyId,

String colleagueId, String replacementId)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • colleagueId: matrícula do colaborador origem;
  • replacementId: matrícula do colaborador substituto.


Retorno: ColleagueReplacementDto.

 getValidReplacementsOfUser Retorna todos os substitutos válidos de um colaborador.

 

Método:
getValidReplacementsOfUser(String username, String password,

int companyId, String colleagueId)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • colleagueId: matrícula do colaborador origem.


Retorno: ColleagueReplacementDto[].

 createColleagueReplacement Cria um substituto.

 

Método:
createColleagueReplacement (String username, String password,

int companyId, ColleagueReplacementDto crDto)

Parâmetros:

  • username: login do colaborador;
  • password: senha do colaborador;
  • 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 colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • crDto: cadastro do substituto.


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 colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • colleagueId: matrícula do colaborador origem;
  • replacementId: matrícula do colaborador substituto.


Retorno: String.

Quadro 10: Métodos da ColleagueReplacementService

 

Exemplo de utilização

No diretório de documentação do ECM 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.

 

 

FolderService

Webservices responsável por realizar operações referentes a pastas no ECM. Pode ser utilizado para criar, alterar, excluir e pesquisar pastas, entre outras funcionalidades.

 

Métodos

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

getFolder

Retorna uma pasta.

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

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • nrDocumentId: número da pasta;
  • colleagueId: matrícula do colaborador origem.


Retorno: DocumentDto[].