Guia de ReferOncia Utilizatpo de Webservices PDF

ECM - Webservices
Guia de Referência Utilização

de Webservices
ECM - Webservices
Copyright © 2009 TOTVS S.A. Todos os direitos reservados.
Nenhuma parte deste documento pode ser copiada, reproduzida, traduzida ou transmitida por
qualquer meio eletrônico ou mecânico, na sua totalidade ou em parte, sem a prévia autorização
escrita da TOTVS S.A., que reserva-se o direito de efetuar alterações sem aviso prévio. A TOTVS
S.A não assume nenhuma responsabilidade pelas conseqüências de quaisquer erros ou
inexatidões que possam aparecer neste documento.
TOTVS S.A.
Av. Santos Dumont, 831, Joinville, SC, Brasil, CEP 89.222-900
2
ECM - Webservices
Índice
Objetivo............................................................................................... 6
Criar Stubs.......................................................................................... 6
Considerações Métodos de Update .................................................. 8
DocumentService ............................................................................... 9
Métodos ......................................................................................................... 9
Exemplo de utilização .................................................................................. 20
WorkflowEngineService .................................................................. 21
Métodos ....................................................................................................... 21
GroupService.................................................................................... 34
Métodos ....................................................................................................... 34
FavoritesService .............................................................................. 37
Método ......................................................................................................... 37
CompanyService .............................................................................. 41
Métodos ....................................................................................................... 41
SearchDocumentService ................................................................. 44
Métodos ....................................................................................................... 44
ColleagueGroupService ................................................................... 46
Métodos ....................................................................................................... 46
3
ECM - Webservices
ColleagueService ............................................................................. 49
Métodos ....................................................................................................... 49
ColleagueReplacementService ....................................................... 53
Métodos ....................................................................................................... 53
FolderService ................................................................................... 56
Métodos ....................................................................................................... 56
CardService ...................................................................................... 63
Métodos ....................................................................................................... 63
TokenService .................................................................................... 66
Métodos ....................................................................................................... 66
CustomFieldsService ....................................................................... 67
Métodos ....................................................................................................... 67
OutstandingService ......................................................................... 70
Método ......................................................................................................... 70
GlobalParamService ........................................................................ 71
Métodos ....................................................................................................... 71
DashBoardService ........................................................................... 74
Método ......................................................................................................... 74
DatasetService ................................................................................. 83
Métodos ....................................................................................................... 83
4
ECM - Webservices
BusinessPeriodService ................................................................... 85
Métodos ....................................................................................................... 85
AttributionMecanismService ........................................................... 86
Métodos ....................................................................................................... 86
CardIndexService ............................................................................. 87
Métodos ....................................................................................................... 87
5
ECM - Webservices
Objetivo
O objetivo deste documento é descrever a utilização de Webservices, mostrar
e explicar todos seus métodos, disponibilizar exemplos de classes que
utilizam esses Webservices e mostrar exemplos de geração de stubs que são
necessários para que os client’s possam se comunicar com o serviço.
Criar Stubs
Os stubs são necessários para que os client’s que utilizam os métodos dos
Webservices possam se comunicar com o serviço.
Para criar um stub é necessário que o serviço do ECM esteja inicializado.
Depois de iniciar o serviço, deve-se abrir o Prompt de comando e utilizar a
sintaxe: wsimport -d <output_directory> <wsdl_url>, onde output_directory é o
diretório onde o stub será criado e wsdl_url é a url de acesso ao serviço. Após
isso, basta apertar Enter e o resultado aparecerá conforme mostra a figura 1.
Figura 1: Exemplo de criação de stub
No quadro 1, é mostrado o comando necessário para criação de stubs de

cada serviço disponível no ECM.
Webservices Comando
WorkflowEngineService wsimport -d C:\Webservices\tmp
http://<SERVER>:<PORT>/webdesk/WorkflowEngineService?w
sdl
6
ECM - Webservices
ColleagueGroupService wsimport -d C:\Webservices\tmp

http://<SERVER>:<PORT>/webdesk/ColleagueGroupService?w
sdl
ColleagueReplacementService wsimport -d C:\Webservices\tmp
http://<SERVER>:<PORT>/webdesk/ColleagueReplacementSer
vice?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?ws
dl
AttributionMecanismService wsimport -d C:\Webservices\tmp
http://<SERVER>:<PORT>/webdesk/AttributionMecanismServic
e?wsdl
Quadro 1: Comandos para criação de stubs
7
ECM - Webservices
Considerações Métodos de
Update
Para os métodos de update que recebem objetos complexos (DocumentDto,
ColleagueDto, GroupDto, etc) é obrigatório passar todos os campos do objeto
alterado. Os campos não informados serão substituídos por branco, nulo ou
zero, dependendo do seu tipo.
Para evitar esta situação, sugerimos sempre utilizar os métodos get para
recuperar o objeto, efetuar as alterações nos campos necessários e enviá-lo
para o método update.
8
ECM - Webservices
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:
 colleagueId: matrícula do colaborador;
 documentVersao: número da versão do documento;
 nomeArquivo: nome do arquivo.
9
ECM - Webservices
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:
 version: número da versão do documento;
getDocumentByExternalId Retorna um documento pelo código externo.
Método:
getDocumentByExternalId(String user, String password, int
companyId, String externalDocumentId, String colleagueId)
Parâmetros:
 externalDocumentId: código externo do documento;
getSecurity Retorna a segurança de um documento.
Método:
getSecurity(String user, String password, int company, int
nrDocumentId, int version)
Parâmetros:
 version: número da versão do documento.
Retorno: DocumentSecurityConfigDto[].
getApprovers Retorna os aprovadores de um documento.
10
ECM - Webservices
Método:
getApprovers(String user, String password, int companyId, int
Parâmetros:
 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:
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:
 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.
11
ECM - Webservices
Retorno: WebServiceMessage[].
createDocumentWithApprove Cria um documento com nível de aprovação.
mentLevels
Método:
createDocumentWithApprovementLevels(String user, String
password, int companyId, DocumentDto[] docDtos,
Attachment[] attachs, DocumentSecurityConfigDto[]
docSecurity, ApproverWithLevelDto[] docApproversLevels,
ApprovalLevelDto[] levels, RelatedDocumentDto[] relDocs)
Parâmetros:
 docDtos: documento que será publicado;
 attachs: arquivo anexado na publicação;
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á;
que será publicado.
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:
 docDtos: documento que será alterado;
 attachs: arquivo anexado na alteração;
alterado;
 docApprovers: aprovadores do documento que será
alterado;
que será alterado.
12
ECM - Webservices
updateSimpleDocument Altera de forma simples um documento.
Método:
updateSimpleDocument(String username, String password,
int companyId, int documentId, String publisherId, String
documentDescription, Attachment[] attachments)
Parâmetros:
 username: login do usuário de integração;
 password: senha do usuário de integração;
 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.
updateDocumentWithApprov Altera um documento com nível de aprovação.
ementLevels
Métodos:
updateDocumentWithApprovementLevels(String user, String
password, int companyId, DocumentDto[] docDtos,
Attachment[] attach, DocumentSecurityConfigDto[]
docSecutiry, ApproverWithLevelDto[] docApprovers,
ApprovalLevelDto[] levels, RelatedDocumentDto[] relDocs)
Parâmetros:
 docDtos: documento que será alterado;
 attachs: arquivo anexado na alteração;
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á;
que será alterado.
validateIntegrationRequireme Verifica a integração do colaborador no ECM.
13
ECM - Webservices
nts
Método:
validateIntegrationRequirements (String user, String
password, int companyId)
Parâmetros:
 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:
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:
 documentId: número 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
Parâmetros:
14
ECM - Webservices

Retorno: Integer.
createSimpleDocument Cria um documento simples.
Método:
createSimpleDocument(String user, String password, int
company, int parentDocumentId, String publisherId, String
Parâmetros:
 parentDocumentId: número da pasta pai;
 publisherId: matrícula do colaborador que publicará o
documento;
 attachments: arquivo anexado na publicação.
createSimpleDocumentPrivat Cria um documento simples na pasta particular.
e
Método:
createSimpleDocumentPrivate(String colleagueId, String
password, int companyId, int parentDocumentId, String
Parâmetros:
 colleagueId: login do colaborador;
 parentDocumentId: número da pasta pai;
 attachments: arquivo anexado na publicação.
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:
15
ECM - Webservices

 nr_resultados: quantidade de documentos que serão
retornados.
findMostPopularDocumentsO Retorna os documentos mais acessados no ECM que o
nDemand 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:
 nr_resultados: quantidade de documentos que serão
retornados;
 limit: número de registros a serem retornados;
 lastRowId: última linha retornada.
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:
excluído;
destroyDocument Exclui um documento da lixeira.
Método:
destroyDocument(String user, String password, int
16
ECM - Webservices
companyId, int documentId, String colleagueId)
Parâmetros:
excluído;
findRecycledDocuments Retorna os documentos da lixeira.
Método:
findRecycledDocuments(String user, String password, int
companyId, String colleagueId)
Parâmetros:
restoreDocument Restaura um documento da lixeira.
Método:
restoreDocument(String user, String password, int
Parâmetros:
restaurado;
copyDocumentToUploadAre Copia os arquivos (principal e anexos) de um documento
a 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)
17
ECM - Webservices
Parâmetros:
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:
 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.
 documentId: código do documento.
18
ECM - Webservices
 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;

 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:
19
ECM - Webservices
getDocumentApprovalHistory(String user, String password,

int companyId, int documentId,
int version)
Parâmetros:
 user: código do usuário de integração;

 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[]
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.
20
ECM - Webservices
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
DocumentService.
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:
 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:
21
ECM - Webservices
 choosedState: número da atividade;

 colleagueIds: colaborador que receberá a tarefa;
 userId: matrícula do colaborador que vai iniciar a
solicitação;
 completeTask: indica se deve completar a tarefa
(true) ou somente salvar (false);
 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:
 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:
22
ECM - Webservices

 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:
 cancelText: comentários do cancelamento.
Retorno: String.
cancelInstanceByReplaceme Cancela uma solicitação utilizando colaborador substituto.
nt
Método:
cancelInstanceByReplacement(String user, String password,
int companyId, int processInstanceId, String userId, String
cancelText, String replacementId)
Parâmetros:
 cancelText: comentários do cancelamento;
 replacementId: matrícula do colaborador substituto.
Retorno: String.
getCardValue Retorna o valor de um campo da ficha.
23
ECM - Webservices
Método:
getCardValue(String user, String password, int companyId,
int processInstanceId, String userId, String cardFieldName)
Parâmetros:
 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:
 userId: matrícula do colaborador que vai executar a
tarefa;
 managerMode: indica se colaborador esta
executando a tarefa como gestor do processo;
existentes no processo.
24
ECM - Webservices
saveAndSendTaskByReplac Movimenta solicitação para próxima atividade utilizando
ement 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:
 userId: matrícula do colaborador que vai executar a
tarefa;
 managerMode: indica se colaborador esta
executando a tarefa como gestor do processo;
takeProcessTask Assume uma tarefa.
Método:
takeProcessTask(String user, String password, int
companyId, String userId, int processInstanceId, int
threadSequence)
Parâmetros:
25
ECM - Webservices

 userId: matrícula do colaborador;
Retorno: String.
takeProcessTaskByReplace Assume uma tarefa utilizando colaborador substituto.
ment
Método:
takeProcessTask(String user, String password, int
companyId, String userId, int processInstanceId, int
threadSequence, String replacementId)
Parâmetros:
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:
 processInstanceId: número da solicitação.
26
ECM - Webservices
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:
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:
 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:
27
ECM - Webservices
Retorno: Integer[].
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;
 state: número da atividade;
Retorno: String[].
getAvailableUsersOnDeman Retorna os colaboradores que podem executar a tarefa
d 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:
 initialUser: última linha retornada;
 userSearch: texto a ser buscado.
28
ECM - Webservices
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:
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:
 userId: matrícula do colaborador.
Retorno: ProcessDefinitionVersionDto[].
getAvailableProcessOnDema Retorna os processos que o colaborador pode iniciar uma
nd solicitação, paginados.
Método:
getAvailableProcessOnDemand(String username, String
password, int companyId, String userId, int limit, int
lastRowId)
Parâmetros:
29
ECM - Webservices
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:
 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:
Retorno: String[].
getAvailableUsersStartOnDe Retorna os colaboradores disponíveis na abertura de uma
mand 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)
30
ECM - Webservices
Parâmetros:
 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:
 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:
31
ECM - Webservices
 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:
 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.
Retorna o processo selecionado em uma String.

exportProcess Método:
exportProcess (String username, String password, int
companyId, String processId)
Parâmetros:
 processId - Código do processo
Retorno: String que contém a definição do processo
Retorna uma lista de processos disponíveis para serem

getAllProcessAvailableToImp importados.
ort
Método:
32
ECM - Webservices
getAllProcessAvailableToImport (String username, String

Parâmetros:
Retorno: ProcessDefinitionDto[]
Retorna uma lista de processos disponíveis para serem

getAllProcessAvailableToExp exportados.
ort
Método:
getAllProcessAvailableToExport (String username, String
Parâmetros:
Retorno: ProcessDefinitionDto[].
Retorna lista de históricos de um processo.

getHistories
Método:
getHistories (String username, String password, int
companyId)
Parâmetros:
 processInstanceId - número da solicitação workflow
Retorno: ProcessHistoryDto[].
Quadro 3: Métodos da WorkflowEngineService
Webservices\ExemplosWorkflowEngineService é disponibilizada a classe
WorkflowEngineServiceClient.java, esta exemplifica a utilização de todos os
métodos da classe WorkflowEngineService.
33
ECM - Webservices
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
GroupService.
getGroups Retorna todos os grupos cadastrados no ECM.
Método:
getGroups(String username, String password, int companyId)
Parâmetros:
Retorno: GroupDto[].
getGroup Retorna um grupo cadastrado no ECM.
Método:
getGroups(String username, String password, int companyId,
String groupId)
Parâmetros:
 groupId: código do grupo.
createGroup Cria um grupo no ECM.
Método:
createGroup(String username, String password, int
companyId, GroupDto[] grupos)
Parâmetros:
34
ECM - Webservices

 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:
 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:
 desc: descrição do grupo.
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:
 pIdiAtribuic: código da atribuição;
 pDesValAtribuic: valor da atribuição.
Retorno: boolean.
deleteGroup Exclui um grupo do ECM.
35
ECM - Webservices
Método:
deleteGroup(String username, String password, int
companyId, String groupId)
Parâmetros:
 GroupId: código do grupo.
Retorno: String.
Quadro 4: Métodos da GroupService
Webservices\ExemplosGroupService é disponibilizada a classe
GroupServiceClient.java, esta exemplifica a utilização de todos os métodos da
classe GroupService.
36
ECM - Webservices
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:
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:
 colleagueId : matrícula do colaborador;
findFavoritesProcess Retorna os processos favoritos do colaborador.
Método:
findFavoritesProcess (String user, String password, int
37
ECM - Webservices
Parâmetros:
Retorno: ProcessDefinitionVersionDto[] .
findFavoritesProcessOnDema Retorna os processos favoritos do colaborador, paginados.
nd
Método:
findFavoritesProcess (String user, String password, int
Parâmetros:
 colleagueId : matrícula do colaborador;
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:
 nrDocument: número do documento
 nrVersao: versão do documento
removeFavoriteDocument Remove um documento dos favoritos do colaborador

informado.
38
ECM - Webservices
Método:
removeFavoriteDocument (String username, String
password, int companyId, int nrDocument, String
colleagueId)
Parâmetros:
 nrDocument: número do documento
addProcessToFavorites Adiciona um processo aos favoritos do colaborador

informado.
Método:
addProcessToFavorites(String username, String password,

int companyId,String processId, String colleagueId)
Parâmetros:
 processId: código do processo
removeFavoriteProcess Remove um processo dos favoritos do colaborador

informado.
Método:
addProcessToFavorites(String username, String password,

int companyId,String processId, String colleagueId)
Parâmetros:
 processId: código do processo
39
ECM - Webservices
Quadro 5: Métodos da FavoritesService
Webservices\ExemplosFavoritesService é disponibilizada a classe
FavoritesServiceClient.java, esta exemplifica a utilização de todos os métodos
da classe FavoritesService.
40
ECM - Webservices
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
CompanyService.
getCompanies Retorna todas as empresas cadastradas no ECM.
Método:
getCompanies(String username, String password, String
companyId)
Parâmetros:
Retorno: CompanyDto[].
getCompany Retorna uma empresa cadastrada no ECM.
Método:
getCompany(int companyId)
Parâmetros:
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:
41
ECM - Webservices
 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:
 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:
 deleteFiles: indica se deve excluir o caminho físico.
Retorno: String.
Quadro 6: Métodos da CompanyService
Webservices\ExemplosCompanyService é disponibilizada a classe
42
ECM - Webservices
CompanyServiceClient.java, esta exemplifica a utilização de todos os

métodos da classe CompanyService.
43
ECM - Webservices
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
SearchDocumentService.
searchDocuments Utiliza busca simples.
Método:
searchDocuments(String user, String password, int
companyId, String colleagueId, String content)
Parâmetros:
 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:
 content: conteúdo da busca;
 findAllDocumentTypes: indica se deve buscar todos
os tipos de documentos;
44
ECM - Webservices
 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[].
Quadro 7: Métodos da SearchDocumentService
Webservices\ExemplosSearchDocumentService é disponibilizada a classe
SearchDocumentServiceClient.java, esta exemplifica a utilização de todos os
métodos da classe SearchDocumentService.
45
ECM - Webservices
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
ColleagueGroupService.
getColleagueGroupsByColle Retorna os grupos de usuários que um colaborador participa.

agueId
Método:
getColleagueGroupsByColleagueId(String username, String
password, int companyId, String colleagueId)
Parâmetros:
Retorno: ColleagueGroupDto[].
getColleagueGroupsByGrou Retorna os colaboradores que participam de um grupo de
pId usuários.
Método:
getColleagueGroupsByGroupId(String username, String
password, int companyId, String groupId)
Parâmetros:
 groupId: código do grupo.
getAllColleagueGroups Retorna todos os grupos de usuários que possuem
colaboradores relacionados.
Método:
46
ECM - Webservices
getAllColleagueGroups(String username, String password,

int companyId)
Parâmetros:
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:
 groupId: código do grupo;
createColleagueGroup Associa um colaborador a um grupo de usuários.
Método:
createColleagueGroup(String username, String password, int
companyId, ColleagueGroupDto[] grupo_colaborador)
Parâmetros:
 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:
47
ECM - Webservices

 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:
 groupId: código do grupo;
Retorno: String.
Quadro 8: Métodos da ColleagueGroupService
Webservices\ExemplosColleagueGroupService é disponibilizada a classe
ColleagueGroupServiceClient.java, esta exemplifica a utilização de todos os
métodos da classe ColleagueGroupService.
48
ECM - Webservices
ColleagueService
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.
Métodos
ColleagueService.
getColleagues Retorna todos os colaboradores ativos.
Método:
getColleagues(String username, String password, int
companyId)
Parâmetros:
Retorno: ColleagueDto[].
getColleague Retorna um colaborador.
Método:
getColleague(String username, String password, int
Parâmetros:
getGroups Retorna os grupos de usuários que o colaborador participa.
Método:
getGroups(String username, String password, int companyId,
String colleagueId)
Parâmetros:
49
ECM - Webservices

createColleague Cria um colaborador.
Método:
createColleague(String username, String password, int
companyId, ColleagueDto[] colegas)
Parâmetros:
 colegas: colaboradores.
Retorno: String.
createColleaguewithDepend Cria um colaborador com grupo de segurança e papéis
encies workflow.
Método:
createColleaguewithDependencies(String username, String
password, int companyId, ColleagueDto[] colegas,
GroupDto[] grupos, WorkflowRoleDto[] papeis)
Parâmetros:
 colegas: colaboradores;
 grupos: grupos de segurança;
 papeis: papéis workflow.
Retorno: String.
updateColleague Altera um colaborador.
Método:
updateColleague(String username, String password, int
companyId, ColleagueDto[] colegas)
Parâmetros:
50
ECM - Webservices
 colegas: colaboradores.
Retorno: String.
updateColleaguewithDepend Altera um colaborador com grupo de segurança e papéis
encies workflow.
Método:
updateColleaguewithDependencies(String username, String
password, int companyId, ColleagueDto[] colegas,
GroupDto[] grupos, WorkflowRoleDto[] papeis)
Parâmetros:
 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:
 colleagId: matrícula do colaborador.
Retorno: String.
getSummaryColleagues Retorna todos os colaboradores ativos.
Método:
getSummaryColleagues(int companyId)
Parâmetros:
validateColleagueLogin Valida o acesso de um colaborador no produto.
Método:
validateColleagueLogin(int companyId, String colleagueId,
51
ECM - Webservices
String password)
Parâmetros:
 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:
 mail: e-mail do colaborador.
getSimpleColleague Retorna o colaborador.
Método:
getSimpleColleague(String username, String password)
Parâmetros:
Retorno: ColleagueDto.
Quadro 9: Métodos da ColleagueService
Webservices\ExemplosColleagueService é disponibilizada a classe
ColleagueServiceClient.java, esta exemplifica a utilização de todos os
métodos da classe ColleagueService.
52
ECM - Webservices
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
ColleagueReplacementService.
getColleagueReplacement Retorna um substituto de um colaborador.
Método:
getColleagueReplacement(String username, String
password, int companyId, String colleagueId, String
replacementId)
Parâmetros:
 colleagueId: matrícula do colaborador origem;
Retorno: ColleagueReplacementDto.
getReplacementsOfUser Retorna todos os substitutos de um colaborador.
Método:
getReplacementsOfUser(String username, String password,
int companyId, String colleagueId)
Parâmetros:
 colleagueId: matrícula do colaborador origem.
Retorno: ColleagueReplacementDto[].
getValidReplacedUsers Retorna todos os colaboradores substituidos por um
substituto válido.
Método:
53
ECM - Webservices
getValidReplacedUsers(String username, String password,

int companyId, String replacementId)
Parâmetros:
getValidReplacement Retorna um substituto válido de um colaborador.
Método:
getValidReplacement(String username, String password, int
companyId, String colleagueId, String replacementId)
Parâmetros:
Retorno: ColleagueReplacementDto.
getValidReplacementsOfUse Retorna todos os substitutos válidos de um colaborador.
r
Método:
getValidReplacementsOfUser(String username, String
Parâmetros:
createColleagueReplacemen Cria um substituto.
t
Método:
createColleagueReplacement (String username, String
password, int companyId, ColleagueReplacementDto crDto)
Parâmetros:
54
ECM - Webservices

 crDto: cadastro do substituto.
Retorno: String.
updateColleagueReplaceme Altera o cadastro de um substituto.
nt
Método:
updateColleagueReplacement (String username, String
password, int companyId, ColleagueReplacementDto crDto)
Parâmetros:
 crDto: cadastro do substituto.
Retorno: String.
deleteColleagueReplacemen Exclui o cadastro de um substituto.
t
Método:
deleteColleagueReplacement(String username, String
password, int companyId, String colleagueId, String
replacementId)
Parâmetros:
Retorno: String.
Quadro 10: Métodos da ColleagueReplacementService
Webservices\ExemplosColleagueReplacementService é disponibilizada a
classe ColleagueReplacementServiceClient.java, esta exemplifica a utilização
de todos os métodos da classe ColleagueReplacementService.
55
ECM - Webservices
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
FolderService.
getFolder Retorna uma pasta.
Método:
getFolder(String user, String password, int companyId, int
nrDocumentId, String colleagueId )
Parâmetros:
 nrDocumentId: número da pasta;
getSecurity Retorna a segurança de uma pasta.
Método:
getSecurity(String user, String password, int companyId, int
nrDocumentId)
Parâmetros:
 nrDocumentId: número da pasta.
Retorno: DocumentSecurityConfigDto[].
getApprovers Retorna os aprovadores de uma pasta.
Método:
getApprovers(String user, String password, int companyId, int
nrDocumentId)
56
ECM - Webservices
Parâmetros:
 nrDocumentId: número da pasta.
Retorno: ApproverWithLevelDto[].
createFolder Cria uma pasta.
Método:
createFolder(String user, String password, int companyId,
DocumentDto[] docdtos, DocumentSecurityConfigDto[]
docsecurity, ApproverDto[] docapprovers )
Parâmetros:
 docdtos: pasta que será criada;
 docsecurity: segurança da pasta;
 docapprovers: aprovadores da pasta.
createFolderWithApproveme Cria uma pasta com nível de aprovação.
ntLevels
Método:
createFolderWithApprovementLevels(String user, String
password, int companyId, DocumentDto[] docdtos,
DocumentSecurityConfigDto[] docsecurity,
ApproverWithLevelDto[] docapprovers, ApprovalLevelDto[]
levels)
Parâmetros:
 docdtos: pasta que será criada;
 docapprovers: aprovadores em níveis;
 levels: níveis de aprovação da pasta.
updateFolder Altera uma pasta.
Método:
57
ECM - Webservices
updateFolder(String user, String password, int companyId,

DocumentDto[] docdtos, DocumentSecurityConfigDto[]
docsecurity, ApproverDto[] docapprovers)
Parâmetros:
 docdtos: pasta que será alterada;
 docapprovers: aprovadores da pasta.
updateFolderWithApproveme Altera uma pasta com nível de aprovação.
ntLevels
Método:
updateFolderWithApprovementLevels(String user, String
password, int companyId, DocumentDto[] docdtos,
DocumentSecurityConfigDto[] docsecurity,
ApproverWithLevelDto[] docapprovers, ApprovalLevelDto[]
levels)
Parâmetros:
 docdtos: pasta que será alterada;
 docapprovers: aprovadores em níveis;
 levels: níveis de aprovação da pasta.
getRootFolders Retorna as pastas root que um colaborador tem acesso,
exceto a pasta particular.
Método:
getRootFolders(String user, String password, int companyId,
String colleagueId)
Parâmetros:
58
ECM - Webservices
getChildren Retorna todos os documentos de uma pasta.
Método:
getChildren(String user, String password, int companyId, int
documentId, String colleagueId)
Parâmetros:
 documentId: número da pasta;
getPrivateChildren Retorna todos os documentos de uma pasta particular.
Método:
getPrivateChildren(String user, String password, int
companyId, int parentDocumentId)
Parâmetros:
getSubFolders Retorna todas as subpastas e arquivos de um pasta.
Método:
getSubFolders(String user, String password, int companyId,
Parâmetros:
getSubFoldersOnDemand Retorna todas as subpastas e arquivos de um pasta,
paginados.
Método:
59
ECM - Webservices
getSubFoldersOnDemand(String user, String password, int

companyId, int documentId, int limit , int lastRowId, String
colleagueId)
Parâmetros:
 lastRowId: última linha retornada;
getUserPermissions Retorna a permissão de um colaborador sobre uma pasta.
Método:
getUserPermissions(int companyId, String user, int
Parâmetros:
 user: matrícula do colaborador;
 nrDocumentId: número da pasta;
 version: versão da pasta.
Retorno: Integer.
createSimpleFolder Cria uma pasta simples.
Método:
createSimpleFolder(String user, String password, int
companyId, int parentDocumentId, String publisherId, String
documentDescription)
Parâmetros:
 parentDocumentId: número do documento pai;
 publisherId: matrícula do colaborador publicador;
 documentDescription: descrição da pasta.
getSubPrivateFolders Retorna todas as subpastas de uma pasta particular.
Método:
60
ECM - Webservices
getSubPrivateFolders(String colleagueId, String password,

int companyId, int documentId)
Parâmetros:
 documentId: número da pasta particular.
getSubFoldersPermission Retorna todas as subspastas em que o colaborador tenha a
permissão informada.
Método:
getSubFoldersPermission(String user, String password, int
companyId, int documentId, String colleagueId, int
permission)
Parâmetros:
 documentId: número da pasta particular;
 permission: permissão sobre a pasta.
deleteDocument Exclui uma pasta e envia para a lixeira.
Método:
deleteDocument(String user, String password, int companyId,
Parâmetros:
destroyDocument Exclui uma pasta da lixeira.
Método:
destroyDocument(String user, String password, int
61
ECM - Webservices
Parâmetros:
findRecycledDocuments Retorna todos os documentos da lixeira de um colaborador.
Método:
findRecycledDocuments(String user, String password, int
Parâmetros:
restoreDocument Restaura uma pasta da lixeira.
Método:
restoreDocument(String user, String password, int
Parâmetros:
Quadro 11: Métodos da FolderService
Webservices\ExemplosFolderService é disponibilizada a classe
FolderServiceClient.java, esta exemplifica a utilização de todos os métodos da
classe FolderService.
62
ECM - Webservices
CardService
Webservices responsável por realizar operações referentes a fichas no ECM.
Pode ser utilizado para criar, alterar, excluir e pesquisar fichas, entre outras
funcionalidades.
Métodos
CardService.
updateCardData Altera os campos de uma ficha.
Método:
updateCardData(int companyId, String user, String
password, int cardId, CardFieldDto[] cardData)
Parâmetros:
 cardId: número da ficha;
 cardData: campos da ficha que serão alterados.
create Cria uma ficha.
Método:
create(int companyId, String user, String password,
CardDto[] carddtos)
Parâmetros:
 carddtos: ficha que será criada.
deleteCard Exclui uma ficha e envia para a lixeira.
Método:
deleteCard(int companyId, String user, String password, int
cardId)
63
ECM - Webservices
Parâmetros:
 cardId: número da ficha.
updateCard Altera os metadados de uma ficha.
Método:
updateCard(int companyId, String user, String password,
CardDto[] cardDtos, Attachment[] attachs,
DocumentSecurityConfigDto[] docsecurity, ApproverDto[]
docapprovers, RelatedDocumentDto[] reldocs)
Parâmetros:
 cardDtos: ficha que será alterada;
 attachs: anexos da ficha;
 docsecurity: segurança da ficha;
 docapprovers: aprovadores da ficha;
 reldocs: documentos relacionados da ficha.
getCardVersion Retorna a versão de uma ficha.
Método:
getCardVersion(int companyId, String user, String password,
int nrDocumentId, int version, String colleagueId)
Método:
Parâmetros:
 nrDocumentId: número da ficha;
 version: versão da ficha;
Retorno: CardDto[].
Quadro 12: Métodos da CardService
64
ECM - Webservices
Webservices\ExemplosCardService é disponibilizada a classe
CardServiceClient.java, esta exemplifica a utilização de todos os métodos da
classe CardService.
65
ECM - Webservices
TokenService
Webservices responsável por interagir com os token’s do ECM. Pode ser
utilizado para pesquisar e validar os token’s existentes.
Métodos
TokenService.
getToken Retorna um token de segurança.
Método:
getToken(String login, String password)
Parâmetros:
 login: login do colaborador;
Retorno: String.
validateToken Valida o token de segurança e retorna o login do
colaborador.
Método:
validateToken(String token)
Parâmetro:
 token: token do colaborador.
Retorno: String.
Quadro 13: Métodos da TokenService
Webservices\ExemplosTokenService é disponibilizada a classe
TokenServiceClient.java, esta exemplifica a utilização de todos os métodos da
classe TokenService.
66
ECM - Webservices
CustomFieldsService
Webservices responsável por interagir com os campos customizados do ECM.
Pode ser utilizado para criar, alterar, excluir e pesquisar campos
customizados, entre outras funcionalidades.
Métodos
CustomFieldsService.
createCustomFields Cria um campo customizado.
Método:
createCustomFields(String user, String password, int
companyId, CustomFieldsDto[] customFieldsDto)
Parâmetros:
 customFieldsDto: campo customizado que será
criado.
Retorno: String.
updateCustomFields Altera um campo customizado.
Método:
updateCustomFields(String user, String password, int
companyId, CustomFieldsDto[] customFieldsDto)
Parâmetros:
 customFieldsDto: campo customizado que será
alterado.
Retorno: String.
removeCustomField Exclui um campo customizado.
Método:
removeCustomField(String user, String password, int
67
ECM - Webservices
companyId, String customFieldsId)
Parâmetros:
 customFieldsId: código do campo customizado.
Retorno: String.
getAllCustomField Retorna todos os campos customizados.
Método:
getAllCustomField(String user, String password, int
companyId)
Parâmetros:
Retorno: CustomFieldsDto[].
setDocumentCustomFields Cria ou altera um campo customizado em um documento.
Método:
setDocumentCustomFields(String user, String password, int
companyId, DocumentCustomFieldsDto[]
documentCustomFieldsDto)
Parâmetros:
 documentCustomFieldsDto: documento com campo
customizado.
Retorno: String.
removeDocumentCustomFiel Exclui um campo customizado de um documento.
d
Método:
removeDocumentCustomField(String user, String password,
int companyId, String customFieldsId, int documentId, int
version)
Parâmetros:
68
ECM - Webservices

 customFieldsId: código do campo customizado;
Retorno: String.
getAllDocumentCustomField Retorna todos os campos customizados de um documento.
Método:
getAllDocumentCustomField(String user, String password, int
companyId, int documentId, int version)
Parâmetros:
Retorno: DocumentCustomFieldsDto[].
Quadro 14: Métodos da CustomFieldsService
Webservices\ExemplosCustomFieldsService é disponibilizada a classe
CustomFieldsServiceClient.java, esta exemplifica a utilização de todos os
métodos da classe CustomFieldsService.
69
ECM - Webservices
OutstandingService
Webservices responsável por interagir com as transferências de pendências
do ECM. Pode ser utilizado para transferir pendências de um colaborador
para outro colaborador.
Método
No quadro 15, é mostrado o método disponível na classe OutstandingService.
transfer Transfere pendências de um colaborador para outro

colaborador.
Método:
transfer(String user, String password, int companyId, String
colleagueIdFrom, String colleagueIdTo, String[] parameters)
Parâmetros:
 colleagueIdFrom: matrícula do colaborador origem
(suas pendências serão tranferidas para o
colaborador destino);
 colleagueIdTo: matrícula do colaborador destino
(receberá as pendências do colaborador origem);
 parameters: array de pendências que serão
transferidas para o colaborador destino.
Retorno: String.
Quadro 15: Métodos da OutstandingService
Webservices\ExemplosOutstandingService é disponibilizada a classe
OutstandingServiceClient.java, esta exemplifica a utilização de todos os
métodos da classe OutstandingService.
70
ECM - Webservices
GlobalParamService
Webservices responsável por interagir com as configurações dos parâmetros
gerais do ECM. Pode ser utilizado para criar, alterar e pesquisar os
parâmetros gerais.
Métodos
GlobalParamService.
getGlobalParam Retorna os parâmetros gerais de uma empresa.
Método:
getGlobalParam(String username, String password, int
companyId)
Parâmetros:
Retorno: GlobalParamDto[].
createGlobalParam Cria parâmetros gerais para uma empresa.
Método:
createGlobalParam(String username, String password, int
companyId, GlobalParamDto[] global)
Parâmetros:
 global: parâmetros gerais da empresa.
Retorno: String.
updateGlobalParam Altera parâmetros gerais de uma empresa.
Método:
updateGlobalParam(String username, String password, int
companyId, GlobalParamDto[] global)
Parâmetros:
71
ECM - Webservices

 global: parâmetros gerais da empresa.
Retorno: String.
getVolumes Retorna os volumes da empresa.
Método:
getVolumes(String user, String password, int companyId)
Parâmetros:
Retorno: VolumeDto[].
getConfigurations Retorna as informações de configuração do sistema.
Método:
getConfigurations(String username, String password, int
companyId)
Parâmetros:
Retorno: SystemInfo.
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:
72
ECM - Webservices

 dbDriver: driver do banco de dados (MySql-
com.mysql.jdbc.Driver; SQLServer -
net.sourceforge.jtds.jdbc.Driver; Oracle -
oracle.jdbc.driver.OracleDriver)
 dbUser: username banco de dados;
 dbPassword: password banco de dados;
 dbServer: servidor de conexão do banco de dados;
 dbPort: porta servidor banco de dados;
 dbScheme: database;
 dbInstance: instância do banco, utilizada para
SQLServer, caso não seja o caso passar em branco
("");
 emailServer: nome do servidor SMTP;
 emailSender: e-mail do remetente padrão do
produto.
 emailPort: porta do servidor SMTP;
 emailDefaultSender:
 emailUser: usuário de email, somente se o servidor
necessitar de autenticação;
 emailPassword: password do email, somente se o
servidor necessitar de autenticação;
 emailTLS: servidor utilizará criptografia no envio de
email (true/false)
 paramsRMTPTPort: porta utilizada pelo Flex;
 lsType: tipo de licença utilizada, LM/LS;
 paramsLSHost: servidor de licenças;
 paramsLSPort: porta servidor de licenças;
 paramsOpenOfficeDir: diretório de instalação do
OpenOffice
 paramsOpenOfficePorts: porta utilizado pelo
OpenOffice
 portsSetName: porta utilizadas pelo sistema (ports-
default, ports-01, ports-02)
Retorno: String.
Quadro 16: Métodos da GlobalParamService
Webservices\ExemplosGlobalParamService é disponibilizada a classe
GlobalParamServiceClient.java, esta exemplifica a utilização de todos os
métodos da classe GlobalParamService.
73
ECM - Webservices
DashBoardService
Webservices responsável por interagir com a central de tarefas do ECM. Pode
ser utilizado para pesquisar as informações que estão disponíveis na central
de tarefas.
Método
DashBoardService.
findMyDocuments Retorna os documentos do colaborador que precisam ser

aprovados.
Método:
findMyDocuments(String user, String password, int
Parâmetros:
findMyDocumentsOnDemand Retorna os documentos do colaborador que precisam ser
aprovados, paginados.
Método:
findMyDocumentsOnDemand(String user, String password,
int companyId, String colleagueId, int limit, int lastRowId)
Parâmetros:
findDocumentsToApprove Retorna os documentos que o colaborador precisa aprovar.
74
ECM - Webservices
Método:
findDocumentsToApprove(String user, String password, int
Parâmetros:
findDocumentsToApproveOnD Retorna os documentos que o colaborador precisa aprovar,
emand paginados.
Método:
findDocumentsToApproveOnDemand(String user, String
password, int companyId, String colleagueId, int limit, int
lastRowId)
Parâmetros:
findAgreementDocuments Retorna os documentos do colaborador que estão em
consenso.
Método:
findAgreementDocuments(String user, String password, int
Parâmetros:
findCheckoutDocuments Retorna os documentos do colaborador que estão em
checkout.
Método:
75
ECM - Webservices
findCheckoutDocuments(String user, String password, int

Parâmetros:
findCancelledTasks Retorna as tarefas atribuidas ao colaborador que foram
canceladas.
Método:
findCancelledTasks(String user, String password, int
Parâmetros:
Retorno: WorkflowProcessDto[].
findCompletedTasks Retorna as tarefas atribuidas ao colaborador que foram
finalizadas.
Método:
findCompletedTasks(String user, String password, int
Parâmetros:
findConsensusTasks Retorna as tarefas atribuidas ao colaborador que estão em
consenso.
Método:
findConsensusTasks(String user, String password, int
Parâmetros:
76
ECM - Webservices

findTransferredTasks Retorna as tarefas atribuidas ao colaborador que foram
transferidas.
Método:
findTransferredTasks(String user, String password, int
Parâmetros:
findWorkflowTasks Retorna as tarefas do colaborador que estão abertas.
Método:
findWorkflowTasks(String user, String password, int
Parâmetros:
findWorkflowTasksOnDemand Retorna as tarefas do colaborador que estão abertas,
paginadas.
Método:
findWorkflowTasksOnDemand(String user, String
password, int companyId, String colleagueId, int limit, int
lastRowId)
Parâmetros:
77
ECM - Webservices

findMyRequests Retorna as solicitações abertas que foram inicializadas
pelo colaborador.
Método:
findMyRequests(String user, String password, int
Parâmetros:
findMyRequestsOnDemand Retorna as solicitações abertas que foram inicializadas
pelo colaborador, paginadas.
Método:
findMyRequestsOnDemand(String user, String password,
int companyId, String colleagueId, int limit, int lastRowId)
Parâmetros:
findMyManagerTasks Retorna as tarefas gerenciadas pelo colaborador.
Método:
findMyManagerTasks(String user, String password, int
Parâmetros:
78
ECM - Webservices
findExpiredWorkflowTasks Retorna as tarefas do colaborador que estão em atraso
Método: findExpiredWorkflowTasks(String user, String

Parâmetros:
fillStatusTask Retorna a quantidade de tarefas atrasadas, no prazo e sem

prazo de um colaborador.
Método:
fillStatusTask(String user, String password, int companyId,
String colleagueId)
Parâmetros:
Retorno: int[].
fillChronoTasks Retorna a quantidade de tarefas com prazo de conclusão
que foram atribuidas ao colaborador e não foram
finalizadas.
Método:
fillChronoTasks(String user, String password, int
companyId, String colleagueId, int yearIni, int yearFin, int
mounthIni, int mounthFin, int dayIni, int dayFin, int
kindTask)
Parâmetros:
79
ECM - Webservices

 yearIni: ano inicial;
 yearFin: ano final;
 mounthIni: mês inicial;
 mounthFin: mês final;
 dayIni: dia inicial;
 dayFin: dia final;
 kindTask: tipo da tarefa.
Retorno: int[].
fillTypeTasks Retorna os tipos de tarefas que o colaborador possui.
Método:
fillTypeTasks(String user, String password, int companyId,
String colleagueId)
Parâmetros:
Retorno: TaskVODto[].
fillTypeTasksOfReplacement Retorna os tipos de tarefas que o colaborador substituto
possui.
Método:
fillTypeTasksOfReplacement(String user, String password,
int companyId, String colleagueId, String replacementId)
Parâmetros:
Retorno: TaskVODto[].
getOpenTasksByColleagueGr Retorna as tarefas atribuidas a um grupo de usuários que o
oups colaborador participa.
Método:
getOpenTasksByColleagueGroups(String user, String
80
ECM - Webservices
Parâmetros:
Retorno: WorkflowTaskDto[].
getOpenTasksByColleagueGr Retorna as tarefas atribuidas a um grupo de usuários que o
oupsOnDemand colaborador participa, paginadas.
Método:
getOpenTasksByColleagueGroupsOnDemand(String user,
String password, int companyId, String colleagueId, int limit,
int lastRowId)
Parâmetros:
getOpenTasksByColleagueRol Retorna as tarefas atribuidas a um papel workflow que o
es colaborador participa.
Método:
getOpenTasksByColleagueRoles(String user, String
Parâmetros:
getOpenTasksByColleagueRol Retorna as tarefas atribuidas a um papel workflow que o
esOnDemand colaborador participa, paginadas.
Método:
getOpenTasksByColleagueRolesOnDemand(String user,
String password, int companyId, String colleagueId, int limit,
int lastRowId)
81
ECM - Webservices
Parâmetros:
getSummaryRequests Retorna os contadores de pendências da Home.
Método:
getSummaryRequests(int companyId, String user, String
password, String colleagueId)
Parâmetros:
Retorno: HomeRequestSummaryDto[].
Quadro 17: Métodos da DashBoardService
Webservices\ExemplosDashBoardService é disponibilizada a classe
DashBoardClient.java, esta exemplifica a utilização de todos os métodos da
classe DashBoardService.
82
ECM - Webservices
DatasetService
Webservices responsável por interagir com os datasets do ECM. Pode ser
utilizado para pesquisar os datasets existentes.
Métodos
DatasetService.
getAvailableDatasets Retorna todos os datasets disponíveis.
Método:
getAvailableDatasets(int companyId, String user, String
password)
Parâmetros:
Retorno: Object[].
getDataset Retorna as informações de um dataset.
Método:
getDataset(int companyId, String user, String password,
String name, String[] fields, SearchConstraintDto[]
constraintsDto, String[] order)
Parâmetros:
 name: nome do dataset;
 fields: campos que serão retornados do dataset;
 constraintsDto: filtro dos registros que irão compor o
dataset;
 order: campos utilizados para ordenar o dataset.
Retorno: DatasetDto.
Quadro 18: Métodos da DatasetService
83
ECM - Webservices
Webservices\ExemplosDatasetService é disponibilizada a classe
DatasetServiceClient.java, esta exemplifica a utilização de todos os métodos
da classe DatasetService.
84
ECM - Webservices
BusinessPeriodService
Webservices responsável por realizar operações referentes aos expedientes
cadastrados no ECM. Pode ser utilizado para pesquisar os expedientes de
uma determinada empresa.
Métodos
BusinessPeriodService.
getBusinessPeriods Retorna os expedientes da empresa.
Método:
getBusinessPeriods(String user, String password, int
companyId)
Parâmetros:
Retorno: BusinessPeriodDto[].
Quadro 19: Métodos da BusinessPeriodService
Webservices\ExemplosBusinessPeriodService é disponibilizada a classe
BusinessPeriodServiceClient.java, esta exemplifica a utilização de todos os
métodos da classe BusinessPeriodService.
85
ECM - Webservices
AttributionMecanismService
Webservices responsável por realizar operações referentes aos mecanismos
de atribuição cadastrados no ECM. Pode ser utilizado para pesquisar os
mecanismos de atribuição de uma determinada empresa.
Métodos
AttributionMecanismService.
getAttributionMecanism Retorna os mecanismos de atribuição da empresa.
Método:
getAttributionMecanism(String user, String password, int
companyId)
Parâmetros:
Retorno: AttributionMecanismDto[].
Quadro 20: Métodos da AttributionMecanismService
Webservices\ExemplosAttributionMecanismService é disponibilizada a classe
AttributionMecanismServiceClient.java, esta exemplifica a utilização de todos
os métodos da classe AttributionMecanismService.
86
ECM - Webservices
CardIndexService
Webservices responsável por realizar operações referentes aos fichários
cadastrados no ECM.
Métodos
CardIndexService.
getCardIndexesWithoutAppr Retorna os fichários sem aprovadores que o colaborador

over tenha permissão.
Método:
getCardIndexesWithoutApprover(String user, String
Parâmetros:
 colleagueId : matrícula do colaborador para a
verificação de permissão nos fichários.
getFormFields Retorna os campos do fichário.
Método:
getFormFields(String user, String password, int companyId,
int documentId)
Parâmetros:
 documentId : numero do fichário.
Retorno: String[].
Quadro 21: Métodos da CardIndexService
87
ECM - Webservices
Webservices\ExemplosCardIndexService é disponibilizada a classe
CardIndexServiceClient.java, esta exemplifica a utilização de todos os
métodos da classe CardIndexService.
88

Guia de ReferOncia Utilizatpo de Webservices PDF

Enviado por

Direitos autorais:

Formatos disponíveis

Guia de ReferOncia Utilizatpo de Webservices PDF

Enviado por

Dados do documento

Título original

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Guia de ReferOncia Utilizatpo de Webservices PDF

Enviado por

Direitos autorais:

Formatos disponíveis

ECM - Webservices

Guia de Referência Utilização

Copyright © 2009 TOTVS S.A. Todos os direitos reservados.

S.A não assume nenhuma responsabilidade pelas conseqüências de quaisquer erros ou

inexatidões que possam aparecer neste documento.

Av. Santos Dumont, 831, Joinville, SC, Brasil, CEP 89.222-900

Considerações Métodos de Update .................................................. 8

Exemplo de utilização .................................................................................. 84

Figura 1: Exemplo de criação de stub

No quadro 1, é mostrado o comando necessário para criação de stubs de

ColleagueGroupService wsimport -d C:\Webservices\tmp

getActiveDocument Retorna um documento ativo.

Retorno: Não há retorno.

 nrDocumentId: número do documento;

 user: login do colaborador;

companyId, int documentId, String colleagueId)

Retorno: String[] nome dos arquivos que foram

 version: versão do documento.

getDocumentApprovalStatus Retorna o status do documento com relação a aprovação. O

getDocumentApprovalStatus(String user, String password, int

 user: código do usuário de integração;

getDocumentApprovalHistory Retorna o histórico de aprovacoes do documento solicitado.

getDocumentApprovalHistory(String user, String password,

 user: código do usuário de integração;

Quadro 2: Métodos da DocumentService

simpleStartProcess Inicia uma solicitação simples.

 choosedState: número da atividade;

 password: senha do colaborador;

 user: login do colaborador;

 username - Usuário de Integração

Retorno: Objeto DeadLineDto que contem variáveis com a

calculateDeadLineTime Calcula um prazo a partir de uma data com base no

Retorno: Objeto DeadLineDto que contem variáveis com a

Retorna o processo selecionado em uma String.

Retorna uma lista de processos disponíveis para serem

getAllProcessAvailableToImport (String username, String

Retorna uma lista de processos disponíveis para serem

Retorna lista de históricos de um processo.

Quadro 3: Métodos da WorkflowEngineService

getGroups Retorna todos os grupos cadastrados no ECM.

 companyId: código da empresa;

findFavorites Retorna os documentos favoritos do colaborador.

companyId, String colleagueId)

addDocumentToFavorites Adiciona um documento aos favoritos do colaborador

removeFavoriteDocument Remove um documento dos favoritos do colaborador

addProcessToFavorites Adiciona um processo aos favoritos do colaborador

addProcessToFavorites(String username, String password,

removeFavoriteProcess Remove um processo dos favoritos do colaborador

addProcessToFavorites(String username, String password,

 colleagueId : matrícula do colaborador.

Quadro 5: Métodos da FavoritesService

getCompanies Retorna todas as empresas cadastradas no ECM.

 description: descrição da empresa;

CompanyServiceClient.java, esta exemplifica a utilização de todos os

searchDocuments Utiliza busca simples.

 findFolders: indica se deve buscar pastas;

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

getAllColleagueGroups(String username, String password,

 username: login do colaborador;