guia de referência utilização de webservices.pdf
TRANSCRIPT
-
ECM - Webservices
Guia de Referncia Utilizao de Webservices
-
2
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 eletrnico ou mecnico, na sua totalidade ou em parte, sem a prvia autorizao
escrita da TOTVS S.A., que reserva-se o direito de efetuar alteraes sem aviso prvio. A TOTVS
S.A no assume nenhuma responsabilidade pelas conseqncias de quaisquer erros ou
inexatides que possam aparecer neste documento.
TOTVS S.A.
Av. Santos Dumont, 831, Joinville, SC, Brasil, CEP 89.222-900
-
3
ECM - Webservices
ndice
Objetivo............................................................................................... 6
Criar Stubs .......................................................................................... 6
Consideraes Mtodos de Update .................................................. 8
DocumentService ............................................................................... 9
Mtodos ......................................................................................................... 9
Exemplo de utilizao .................................................................................. 22
WorkflowEngineService .................................................................. 23
Mtodos ....................................................................................................... 23
Exemplo de utilizao .................................................................................. 38
GroupService.................................................................................... 39
Mtodos ....................................................................................................... 39
Exemplo de utilizao .................................................................................. 41
FavoritesService .............................................................................. 42
Mtodo ......................................................................................................... 42
Exemplo de utilizao .................................................................................. 45
CompanyService .............................................................................. 46
Mtodos ....................................................................................................... 46
Exemplo de utilizao .................................................................................. 47
SearchDocumentService ................................................................. 49
Mtodos ....................................................................................................... 49
Exemplo de utilizao .................................................................................. 50
ColleagueGroupService ................................................................... 51
Mtodos ....................................................................................................... 51
Exemplo de utilizao .................................................................................. 53
-
4
ECM - Webservices
ColleagueService ............................................................................. 54
Mtodos ....................................................................................................... 54
Exemplo de utilizao .................................................................................. 57
ColleagueReplacementService ....................................................... 59
Mtodos ....................................................................................................... 59
Exemplo de utilizao .................................................................................. 61
FolderService ................................................................................... 62
Mtodos ....................................................................................................... 62
Exemplo de utilizao .................................................................................. 69
CardService ...................................................................................... 70
Mtodos ....................................................................................................... 70
Exemplo de utilizao .................................................................................. 72
TokenService .................................................................................... 73
Mtodos ....................................................................................................... 73
Exemplo de utilizao .................................................................................. 73
CustomFieldsService ....................................................................... 74
Mtodos ....................................................................................................... 74
Exemplo de utilizao .................................................................................. 76
OutstandingService ......................................................................... 77
Mtodo ......................................................................................................... 77
Exemplo de utilizao .................................................................................. 77
GlobalParamService ........................................................................ 78
Mtodos ....................................................................................................... 78
Exemplo de utilizao .................................................................................. 80
DashBoardService ........................................................................... 81
Mtodo ......................................................................................................... 81
Exemplo de utilizao .................................................................................. 89
DatasetService ................................................................................. 90
Mtodos ....................................................................................................... 90
-
5
ECM - Webservices
Exemplo de utilizao .................................................................................. 91
BusinessPeriodService ................................................................... 92
Mtodos ....................................................................................................... 92
Exemplo de utilizao .................................................................................. 92
AttributionMecanismService ........................................................... 93
Mtodos ....................................................................................................... 93
Exemplo de utilizao .................................................................................. 93
CardIndexService ............................................................................. 94
Mtodos ....................................................................................................... 94
Exemplo de utilizao .................................................................................. 95
-
6
ECM - Webservices
Objetivo
O objetivo deste documento descrever a utilizao de Webservices, mostrar
e explicar todos seus mtodos, disponibilizar exemplos de classes que
utilizam esses Webservices e mostrar exemplos de gerao de stubs que so
necessrios para que os clients possam se comunicar com o servio.
Criar Stubs
Os stubs so necessrios para que os clients que utilizam os mtodos dos
Webservices possam se comunicar com o servio.
Para criar um stub necessrio que o servio do ECM esteja inicializado.
Depois de iniciar o servio, deve-se abrir o Prompt de comando e utilizar a
sintaxe: wsimport -d , onde output_directory o
diretrio onde o stub ser criado e wsdl_url a url de acesso ao servio. Aps
isso, basta apertar Enter e o resultado aparecer conforme mostra a figura 1.
Figura 1: Exemplo de criao de stub
No quadro 1, mostrado o comando necessrio para criao de stubs de
cada servio disponvel no ECM.
Webservices Comando
WorkflowEngineService wsimport -d C:\Webservices\tmp
http://:/webdesk/WorkflowEngineService?w
sdl
-
7
ECM - Webservices
ColleagueGroupService wsimport -d C:\Webservices\tmp
http://:/webdesk/ColleagueGroupService?w
sdl
ColleagueReplacementService wsimport -d C:\Webservices\tmp
http://:/webdesk/ColleagueReplacementSer
vice?wsdl
ColleagueService wsimport -d C:\Webservices\tmp
http://:/webdesk/ColleagueService?wsdl
CompanyService wsimport -d C:\Webservices\tmp
http://:/webdesk/CompanyService?wsdl
GlobalParamService wsimport -d C:\Webservices\tmp
http://:/webdesk/GlobalParamService?wsdl
GroupService wsimport -d C:\Webservices\tmp
http://:/webdesk/GroupService?wsdl
CardService wsimport -d C:\Webservices\tmp
http://:/webdesk/CardService?wsdl
CustomFieldsService wsimport -d C:\Webservices\tmp
http://:/webdesk/CustomFieldsService?wsdl
DashBoardService wsimport -d C:\Webservices\tmp
http://:/webdesk/DashBoardService?wsdl
DocumentService wsimport -d C:\Webservices\tmp
http://:/webdesk/DocumentService?wsdl
FavoritesService wsimport -d C:\Webservices\tmp
http://:/webdesk/FavoritesService?wsdl
FolderService wsimport -d C:\Webservices\tmp
http://:/webdesk/FolderService?wsdl
SearchDocumentService wsimport -d C:\Webservices\tmp
http://:/webdesk/SearchDocumentService?
wsdl
TokenService wsimport -d C:\Webservices\tmp
http://:/webdesk/TokenService?wsdl
DatasetService wsimport -d C:\Webservices\tmp
http://:/webdesk/DatasetService?wsdl
OutstandingService wsimport -d C:\Webservices\tmp
http://:/webdesk/OutstandingService?wsdl
BusinessPeriodService wsimport -d C:\Webservices\tmp
http://:/webdesk/BusinessPeriodService?ws
dl
AttributionMecanismService wsimport -d C:\Webservices\tmp
http://:/webdesk/AttributionMecanismServic
e?wsdl
Quadro 1: Comandos para criao de stubs
-
8
ECM - Webservices
Consideraes Mtodos de Update
Para os mtodos de update que recebem objetos complexos (DocumentDto,
ColleagueDto, GroupDto, etc) obrigatrio passar todos os campos do objeto
alterado. Os campos no informados sero substitudos por branco, nulo ou
zero, dependendo do seu tipo.
Para evitar esta situao, sugerimos sempre utilizar os mtodos get para
recuperar o objeto, efetuar as alteraes nos campos necessrios e envi-lo
para o mtodo update.
-
9
ECM - Webservices
DocumentService
Webservices responsvel por realizar operaes referentes a documentos do
ECM. Pode ser utilizado para criar, alterar, excluir e procurar documentos,
entre outras funcionalidades.
Mtodos
No quadro 2, mostrado todos os mtodos disponveis na classe
DocumentService.
getActiveDocument Retorna um documento ativo.
Mtodo:
getActiveDocument(String user, String password, int
companyId, int nrDocumentId, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
nrDocumentId: nmero do documento;
colleagueId: matrcula do colaborador.
Retorno: DocumentDto[].
getDocumentContent Retorna o byte do arquivo fsico de um documento, caso o
usurio tenha permisso para acess-lo.
Mtodo:
getDocumentContent(String user, String password, int
companyId, int nrDocumentId, String colleagueId, int
documentoVersao, String nomeArquivo)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
nrDocumentId: nmero do documento;
colleagueId: matrcula do colaborador;
documentVersao: nmero da verso do documento;
nomeArquivo: nome do arquivo.
-
10
ECM - Webservices
Retorno: byte[].
getDocumentVersion Retorna a verso de um documento.
Mtodo:
getDocumentVersion(String user, String password, int
companyId, int nrDocumentId, int version, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
nrDocumentId: nmero do documento;
version: nmero da verso do documento;
colleagueId: matrcula do colaborador.
Retorno: DocumentDto[].
getDocumentByExternalId Retorna um documento pelo cdigo externo.
Mtodo:
getDocumentByExternalId(String user, String password, int
companyId, String externalDocumentId, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
externalDocumentId: cdigo externo do documento;
colleagueId: matrcula do colaborador.
Retorno: DocumentDto[].
getSecurity Retorna a segurana de um documento.
Mtodo:
getSecurity(String user, String password, int company, int
nrDocumentId, int version)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
nrDocumentId: nmero do documento;
version: nmero da verso do documento.
Retorno: DocumentSecurityConfigDto[].
getApprovers Retorna os aprovadores de um documento.
-
11
ECM - Webservices
Mtodo:
getApprovers(String user, String password, int companyId, int
nrDocumentId, int version)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
nrDocumentId: nmero do documento.
Retorno: ApproverWithLevelDto[].
getRelatedDocuments Retorna todos os documentos relacionados de um
documento.
Mtodo:
getRelatedDocuments(String user, String password, int
companyId, int nrDocumentId, int version)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
nrDocumentId: nmero do documento;
version: nmero da verso do documento.
Retorno: RelatedDocumentDto[].
createDocument Cria um documento.
Mtodo:
createDocument(String user, String password, int
companyId, DocumentDto[] docDtos, Attachment[] attachs,
DocumentSecurityConfigDto[] docSecurity, ApproverDto[]
docApprovers, RelatedDocumentDto[] relDocs)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
docDtos: documento que ser publicado;
attachs: arquivo anexado na publicao;
docSecurity: segurana do documento que ser
publicado;
docApprovers: aprovadores do documento que ser
publicado;
relDocs: documentos relacionados ao documento
que ser publicado.
-
12
ECM - Webservices
Retorno: WebServiceMessage[].
createDocumentWithApprove
mentLevels
Cria um documento com nvel de aprovao.
Mtodo:
createDocumentWithApprovementLevels(String user, String
password, int companyId, DocumentDto[] docDtos,
Attachment[] attachs, DocumentSecurityConfigDto[]
docSecurity, ApproverWithLevelDto[] docApproversLevels,
ApprovalLevelDto[] levels, RelatedDocumentDto[] relDocs)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
docDtos: documento que ser publicado;
attachs: arquivo anexado na publicao;
docSecurity: segurana do documento que ser
publicado;
docApproversLevel: nvel de aprovao que os
aprovadores do documento esto inseridos;
levels: nveis de aprovao que o documento ter;
relDocs: documentos relacionados ao documento
que ser publicado.
Retorno: WebServiceMessage[].
updateDocument Altera um documento.
Mtodo:
updateDocument(String user, String password, int
companyId, DocumentDto[] docDtos, Attachment[] attach,
DocumentSecurityConfigDto[] docSecurity, ApproverDto[]
docApprovers, RelatedDocumentDto[] relDocs)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
docDtos: documento que ser alterado;
attachs: arquivo anexado na alterao;
docSecurity: segurana do documento que ser
alterado;
docApprovers: aprovadores do documento que ser
alterado;
relDocs: documentos relacionados ao documento
que ser alterado.
-
13
ECM - Webservices
Retorno: WebServiceMessage[].
updateSimpleDocument Altera de forma simples um documento.
Mtodo:
updateSimpleDocument(String username, String password,
int companyId, int documentId, String publisherId, String
documentDescription, Attachment[] attachments)
Parmetros:
username: login do usurio de integrao;
password: senha do usurio de integrao;
companyId: cdigo da empresa;
documentId: nmero do documento que ser
alterado;
publisherId: matrcula do colaborador que realizar a
alterao do documento;
documentDescription: descrio do documento;
attachments: arquivos anexados na alterao.
Retorno: WebServiceMessage[].
updateDocumentWithApprov
ementLevels
Altera um documento com nvel de aprovao.
Mtodos:
updateDocumentWithApprovementLevels(String user, String
password, int companyId, DocumentDto[] docDtos,
Attachment[] attach, DocumentSecurityConfigDto[]
docSecutiry, ApproverWithLevelDto[] docApprovers,
ApprovalLevelDto[] levels, RelatedDocumentDto[] relDocs)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
docDtos: documento que ser alterado;
attachs: arquivo anexado na alterao;
docSecurity: segurana do documento que ser
alterado;
docApprovers: nvel de aprovao que os
aprovadores do documento esto inseridos;
levels: nveis de aprovao que o documento ter;
relDocs: documentos relacionados ao documento
que ser alterado.
Retorno: WebServiceMessage[].
validateIntegrationRequireme Verifica a integrao do colaborador no ECM.
-
14
ECM - Webservices
nts
Mtodo:
validateIntegrationRequirements (String user, String
password, int companyId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa.
Retorno: String.
getReportSubjectId Retorna o cdigo do assunto relatrios dentro do ECM.
Mtodo:
getReportSubjectId(String user, String password, int
companyId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa.
Retorno: int.
removeSecurity Remove a segurana de um documento.
Mtodo:
removeSecurity(String user, String password, int companyId,
int documentId, int version)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
documentId: nmero do documento;
version: nmero da verso do documento.
Retorno: No h retorno.
getUserPermissions Retorna as permisses do colaborador sobre um documento.
Mtodo:
getUserPermissions(int companyId, String user, int
nrDocumentId, int version)
Parmetros:
companyId: cdigo da empresa;
user: login do colaborador;
-
15
ECM - Webservices
nrDocumentId: nmero do documento;
version: nmero da verso do documento.
Retorno: Integer.
createSimpleDocument Cria um documento simples.
Mtodo:
createSimpleDocument(String user, String password, int
company, int parentDocumentId, String publisherId, String
documentDescription, Attachment[] attachments)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
parentDocumentId: nmero da pasta pai;
publisherId: matrcula do colaborador que publicar o
documento;
documentDescription: descrio do documento;
attachments: arquivo anexado na publicao.
Retorno: WebServiceMessage[].
createSimpleDocumentPrivat
e
Cria um documento simples na pasta particular.
Mtodo:
createSimpleDocumentPrivate(String colleagueId, String
password, int companyId, int parentDocumentId, String
documentDescription, Attachment[] attachments)
Parmetros:
colleagueId: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
parentDocumentId: nmero da pasta pai;
documentDescription: descrio do documento;
attachments: arquivo anexado na publicao.
Retorno: WebServiceMessage[].
findMostPopularDocuments Retorna os documentos mais acessados no ECM que o
colaborador tenha permisso de acesso.
Mtodo:
findMostPopularDocuments(String user, String password, int
companyId, String colleagueId, int nr_resultados)
Parmetros:
-
16
ECM - Webservices
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador;
nr_resultados: quantidade de documentos que sero
retornados.
Retorno: DocumentDto[].
findMostPopularDocumentsO
nDemand
Retorna os documentos mais acessados no ECM que o
colaborador tenha permisso de acesso, paginados.
Mtodo:
findMostPopularDocuments(String user, String password, int
companyId, String colleagueId, int nr_resultados, int limit, int
lastRowId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador;
nr_resultados: quantidade de documentos que sero
retornados;
limit: nmero de registros a serem retornados;
lastRowId: ltima linha retornada.
Retorno: DocumentDto[].
deleteDocument Exclui um documento e o envia para a lixeira.
Mtodo:
deleteDocument(String user, String password, int companyId,
int documentId, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
documentId: nmero do documento que ser
excludo;
colleagueId: matrcula do colaborador.
Retorno: WebServiceMessage[].
destroyDocument Exclui um documento da lixeira.
Mtodo:
destroyDocument(String user, String password, int
-
17
ECM - Webservices
companyId, int documentId, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
documentId: nmero do documento que ser
excludo;
colleagueId: matrcula do colaborador.
Retorno: WebServiceMessage[].
findRecycledDocuments Retorna os documentos da lixeira.
Mtodo:
findRecycledDocuments(String user, String password, int
companyId, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador.
Retorno: DocumentDto[].
restoreDocument Restaura um documento da lixeira.
Mtodo:
restoreDocument(String user, String password, int
companyId, int documentId, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
documentId: nmero do documento que ser
restaurado;
colleagueId: matrcula do colaborador.
Retorno: WebServiceMessage[].
copyDocumentToUploadAre
a
Copia os arquivos (principal e anexos) de um documento
para a area de upload do usurio. Isto permite que os
documentos tornem-se acessveis via FTP.
Mtodo:
copyDocumentToUploadArea(String user, String password,
int companyId, int documentId, int version, String
colleagueId)
-
18
ECM - Webservices
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
documentId: nmero do documento que ser
copiado;
version: verso do documento
colleagueId: matrcula 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.
Mtodo:
moveDocument(String user, String password, int companyId,
int[] documentIds, String colleagueId, int destfolder)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
documentIds: lista com os nmeros dos documentos
que sero movidos;
colleagueId: matrcula do colaborador com
permisso para mover o documento
destFolder: nmero da pasta de destino.
Retorno: String[]
updateGroupSecurityType Modifica a tipo da segurana dos grupos na permisso e na
restrio. Existem duas opes que so representadas por
um inteiro:
0 - TODOS os colaboradores dos Grupos.
1 - SOMENTE colaboradores comuns dos grupos;
Mtodo:
updateGroupSecurityType(String user, String password, int
companyId, int documentId, int version, int permissionType,
int restrictionType, String colleagueId)
Parmetros:
user: cdigo do usurio de integrao.
password: senha do usurio de integrao.
companyId: cdigo da empresa.
documentId: cdigo do documento.
-
19
ECM - Webservices
version: verso do documento.
permissionType: tipo da permisso (0 - TODOS os
colaboradores dos Grupos / 1 - SOMENTE
colaboradores comuns dos grupos)
restrictionType: tipo da restrio (0 - TODOS os
colaboradores dos Grupos / 1 - SOMENTE
colaboradores comuns dos grupos)
colleagueId: matrcula do colaborador
Retorno: WebServiceMessage[]
getDocumentApprovalStatus Retorna o status do documento com relao a aprovao. O
status do documento pode ser:
0 Aprovado;
1 - Rejeitado;
2- Em aprovao.
Mtodo:
getDocumentApprovalStatus(String user, String password, int
companyId, int documentId, int version)
Parmetros:
user: cdigo do usurio de integrao;
password: senha do usurio de integrao;
companyId: cdigo da empresa;
documentId: cdigo do documento que se deseja
visualizar o status;
version: verso do documento (caso seja informada
a verso 0 sera solicitada a ultima verso do
documento).
Retorno: DocumentApprovalStatusDto[]
getDocumentApprovalHistory Retorna o histrico de aprovacoes do documento solicitado.
Metodo:
-
20
ECM - Webservices
getDocumentApprovalHistory(String user, String password,
int companyId, int documentId,
int version)
Parmetros:
user: cdigo do usurio de integrao;
password: senha do usurio de integrao;
companyId: cdigo da empresa;
documentId: cdigo do documento que se deseja
visualizar o status;
version: verso do documento (caso seja informada
a verso 0 sera solicitada a ultima verso do
documento).
Retorno: DocumentApprovementHistoryDto[]
approveDocument Aprova ou reprova documento pendente de aprovao.
Metodo:
approveDocument(int companyId, String userId, String
password, int documentId, int version, String approverId,
boolean approved, String observation)
Parmetros:
user: cdigo do usurio de integrao;
password: senha do usurio de integrao;
companyId: cdigo da empresa;
documentId: cdigo do documento a ser aprovado;
version: verso do documento a ser aprovado.
approverId: cdigo do aprovador
approved: true se aprova o documento e false caso o
documento sera reprovado.
observation: observao da aprovao ou rejeio.
Retorno: WebServiceMessage[]
-
21
ECM - Webservices
destroyDocumentApproval Exclui documento pendente de aprovao.
Metodo:
destroyDocumentApproval(String userId, String password, int
companyId, int documentId, String publisherId)
Parmetros:
user: cdigo do usurio de integrao;
password: senha do usurio de integrao;
companyId: cdigo da empresa;
documentId: cdigo do documento a excluido;
publisherId: cdigo do publicador.
Retorno: WebServiceMessage[]
copyDocuments Realiza a cpia de vrios documentos e pastas em uma
nica requisio.
Metodo:
copyDocuments(int companyId, String login, String
password, String userId, Integer[] origins, Integer destination)
Parmetros:
companyId: cdigo da empresa;
login: login ou cdigo do usurio de integrao;
password: senha do usurio de integrao;
userId: cdigo do usurio;
origins: lista de documentos a serem copiados;
destination: pasta destino das cpias.
Retorno: CopyDocumentDto[]
Quadro 2: Mtodos da DocumentService
-
22
ECM - Webservices
Exemplo de utilizao
No diretrio de documentao do ECM na pasta Documentos de
Customizao\Arquivos Adicionais\Exemplos
Webservices\ExemplosDocumentService disponibilizada a classe
DocumentServiceClient.java, esta exemplifica a utilizao de todos os
mtodos da classe DocumentService.
-
23
ECM - Webservices
WorkflowEngineService
Webservices responsvel por realizar operaes referentes a workflow no
ECM. Pode ser utilizado para movimentar solicitaes, entre outras
funcionalidades.
Mtodos
No quadro 3, mostrado todos os mtodos disponveis na classe
WorkflowEngineService.
simpleStartProcess Inicia uma solicitao simples.
Mtodo:
simpleStartProcess(String user, String password, int
companyId, String processId, String comments,
ProcessAttachmentDto[] attachments, String cardData[][])
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processId: cdigo do processo;
comments: comentrios;
attachments: anexos da solicitao;
cardData: dados da ficha.
Retorno: String[].
startProcess Inicia uma solicitao.
Mtodo:
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)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processId: cdigo do processo;
-
24
ECM - Webservices
choosedState: nmero da atividade;
colleagueIds: colaborador que receber a tarefa;
comments: comentrios;
userId: matrcula do colaborador que vai iniciar a
solicitao;
completeTask: indica se deve completar a tarefa
(true) ou somente salvar (false);
attachments: anexos da solicitao;
cardData: dados da ficha;
appointment: apontamentos da tarefa;
managerMode: indica se colaborador esta iniciando
a solicitao como gestor do processo.
Retorno: String[][].
startProcessClassic Inicia uma solicitao e retorna um array de objeto com
chave e valor.
Mtodo:
startProcessClassic(String user, String password, int
companyId, String processId, int choosedState, String[]
colleagueIds, String comments, String userId, boolean
completeTask, ProcessAttachmentDto[] attachments,
KeyValueDto[] cardData, ProcessTaskAppointmentDto[]
appointment, boolean managerMode)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processId: cdigo do processo;
choosedState: nmero da atividade;
colleagueIds: colaborador que receber a tarefa;
comments: comentrios;
userId: matrcula do colaborador que vai iniciar a
solicitao;
completeTask: indica se deve completar a tarefa
(true) ou somente salvar (false);
attachments: anexos da solicitao;
cardData: dados da ficha;
appointment: apontamentos da tarefa;
managerMode: indica se colaborador esta iniciando
a solicitao como gestor do processo.
Retorno: String[][].
setDueDate Altera a data de prazo da tarefa.
-
25
ECM - Webservices
Mtodo:
setDueDate(String user, String password, int companyId, int
processInstanceId, String userId, int threadSequence, String
newDueDate, int timeInSeconds)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processInstanceId: nmero da solicitao;
userId: mtricula do colaborador;
threadSequence: Indica se existe atividade paralela
no processo. Se no 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 aps a
meia noite.
Retorno: String.
setTasksComments Altera os comentrios da tarefa.
Mtodo:
setTasksComments(String user, String password, int
companyId, int processInstanceId, String userId, int
threadSequence, String comments)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processInstanceId: nmero da solicitao;
userId: mtricula do colaborador;
threadSequence: Indica se existe atividade paralela
no processo. Se no 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: comentrios.
Retorno: String.
cancelInstance Cancela uma solicitao.
Mtodo:
cancelInstance(String user, String password, int companyId,
-
26
ECM - Webservices
int processInstanceId, String userId, String cancelText)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processInstanceId: nmero da solicitao;
userId: mtricula do colaborador;
cancelText: comentrios do cancelamento.
Retorno: String.
cancelInstanceByReplaceme
nt
Cancela uma solicitao utilizando colaborador substituto.
Mtodo:
cancelInstanceByReplacement(String user, String password,
int companyId, int processInstanceId, String userId, String
cancelText, String replacementId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processInstanceId: nmero da solicitao;
userId: mtricula do colaborador;
cancelText: comentrios do cancelamento;
replacementId: matrcula do colaborador substituto.
Retorno: String.
getCardValue Retorna o valor de um campo da ficha.
Mtodo:
getCardValue(String user, String password, int companyId,
int processInstanceId, String userId, String cardFieldName)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processInstanceId: nmero da solicitao;
userId: mtricula do colaborador;
cardFieldName: nome do campo da ficha.
Retorno: String.
saveAndSendTask Movimenta solicitao para prxima atividade.
Mtodo:
-
27
ECM - Webservices
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)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processInstanceId: nmero da solicitao;
choosedState: nmero da atividade;
colleagueIds: colaborador que receber a tarefa;
comments: comentrios;
userId: matrcula do colaborador que vai executar a
tarefa;
completeTask: indica se deve completar a tarefa
(true) ou somente salvar (false);
attachments: anexos da solicitao;
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 no 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 solicitao para prxima atividade e retorna um
array de objeto com chave e valor.
Mtodo:
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)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
-
28
ECM - Webservices
processInstanceId: nmero da solicitao;
choosedState: nmero da atividade;
colleagueIds: colaborador que receber a tarefa;
comments: comentrios;
userId: matrcula do colaborador que vai executar a
tarefa;
completeTask: indica se deve completar a tarefa
(true) ou somente salvar (false);
attachments: anexos da solicitao;
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 no 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[].
saveAndSendTaskByReplac
ement
Movimenta solicitao para prxima atividade utilizando
colaborador substituto.
Mtodo:
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)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processInstanceId: nmero da solicitao;
choosedState: nmero da atividade;
colleagueIds: colaborador que receber a tarefa;
comments: comentrios;
userId: matrcula do colaborador que vai executar a
tarefa;
completeTask: indica se deve completar a tarefa
(true) ou somente salvar (false);
attachments: anexos da solicitao;
cardData: dados da ficha;
-
29
ECM - Webservices
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 no 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: matrcula do colaborador substituto.
Retorno: String[][].
setAutomaticDecisionClassic Seleciona usurio(s) e avana atividade automtica.
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)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processInstanceId: nmero da solicitao;
iTaskAutom: nmero da atividade automtica;
iTask: numero da atividade atual;
condition: numero da condio da atividade
automtica;
colleagueIds: colaborador que receber a tarefa;
comments: comentrios;
userId: matrcula 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 no 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.
Mtodo:
-
30
ECM - Webservices
takeProcessTask(String user, String password, int
companyId, String userId, int processInstanceId, int
threadSequence)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
userId: matrcula do colaborador;
processInstanceId: nmero da solicitao;
threadSequence: Indica se existe atividade paralela
no processo. Se no 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.
takeProcessTaskByReplace
ment
Assume uma tarefa utilizando colaborador substituto.
Mtodo:
takeProcessTask(String user, String password, int
companyId, String userId, int processInstanceId, int
threadSequence, String replacementId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
userId: matrcula do colaborador;
processInstanceId: nmero da solicitao;
threadSequence: Indica se existe atividade paralela
no processo. Se no 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: matrcula do colaborador substituto.
Retorno: String.
getAttachments Retorna os anexos de uma solicitao.
Mtodo:
getAttachments(String user, String password, int companyId,
String userId, int processInstanceId)
Parmetros:
user: login do colaborador;
-
31
ECM - Webservices
password: senha do colaborador;
companyId: cdigo da empresa;
userId: matrcula do colaborador;
processInstanceId: nmero da solicitao.
Retorno: ProcessAttachmentDto[].
getAllActiveStates Retorna o nmero da atividade em que uma solicitao esta.
Mtodo:
getAllActiveStates(String user, String password, int
companyId, String userId, int processInstanceId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
userId: matrcula do colaborador;
processInstanceId: nmero da solicitao.
Retorno: Integer[].
getActualThread Retorna a sequncia da thread de uma solicitao.
Mtodo:
getActualThread(String user, String password, int
companyId, int processInstanceId, int stateSequence)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
userId: matrcula do colaborador;
stateSequence: sequncia do estado.
Retorno: int.
getAvailableStates Retorna o nmero da prxima atividade de uma solicitao.
Mtodo:
getAvailableStates(String user, String password, int
companyId, String processId, int processInstanceId, int
threadSequence)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processId: cdigo do processo;
-
32
ECM - Webservices
processInstanceId: nmero da solicitao;
threadSequence: Indica se existe atividade paralela
no processo. Se no 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 disponveis para seleo..
Mtodo:
getAvailableStatesDetail(String user, String password, int
companyId, String processId, int processInstanceId, int
threadSequence)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processId: cdigo do processo;
processInstanceId: nmero da solicitao;
threadSequence: Indica se existe atividade paralela
no processo. Se no 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 solicitao.
Mtodo:
getAvailableUsers(String username, String password, int
companyId, int processInstanceId, int state, int
threadSequence)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processInstanceId: nmero da solicitao;
state: nmero da atividade;
threadSequence: Indica se existe atividade paralela
no processo. Se no existir o valor 0 (zero), caso
exista, este valor pode ser de 1 a infinito
dependendo da quantidade de atividade paralelas
-
33
ECM - Webservices
existentes no processo.
Retorno: String[].
getAvailableUsersOnDeman
d
Retorna os colaboradores que podem executar a tarefa
corrente de uma solicitao, paginados e com busca.
Mtodo:
getAvailableUsersOnDemand(String username, String
password, int companyId, int processInstanceId, int state, int
threadSequence, int limit, int initialUser, String userSearch)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processInstanceId: nmero da solicitao;
state: nmero da atividade;
threadSequence: Indica se existe atividade paralela
no processo. Se no 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: nmero 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 solicitao.
Mtodo:
getInstanceCardData(String user, String password, int
companyId, String userId, int processInstanceId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
userId: matrcula do colaborador;
processInstanceId: nmero da solicitao.
Retorno: String[][].
getAvailableProcess Retorna os processos que o colaborador pode iniciar uma
solicitao.
Mtodo:
getAvailableProcess(String username, String password, int
-
34
ECM - Webservices
companyId, String userId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
userId: matrcula do colaborador.
Retorno: ProcessDefinitionVersionDto[].
getAvailableProcessOnDema
nd
Retorna os processos que o colaborador pode iniciar uma
solicitao, paginados.
Mtodo:
getAvailableProcessOnDemand(String username, String
password, int companyId, String userId, int limit, int
lastRowId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
userId: matrcula do colaborador;
limit: nmero de registros a serem retornados;
lastRowId: ltima linha retornada.
Retorno: ProcessDefinitionVersionDto[].
updateWorkflowAttachment Atualiza um documento do tipo 7.
Retorna uma string contendo a descrio de sucesso ou
falha da operao.
Mtodo:
updateWorkflowAttachment(String username, String
password, int companyId, int processInstanceId, String
usuario, DocumentDto[] docdtos, Attachment[] attach)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processInstanceId: nmero da solicitao workflow
usuario: usurio responsvel pela edio do
documento;
docDtos: documento ou documentos que sero
publicados;
attachs: arquivo(s) anexado(s) na publicao;
getAvailableUsersStart Retorna os colaboradores disponveis na abertura de uma
solicitao.
-
35
ECM - Webservices
Mtodo:
getAvailableUsersStart (String username, String password,
int companyId, String processId, int state, int
threadSequence)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processId: cdigo do processo;
state: nmero da atividade;
threadSequence: Indica se existe atividade paralela
no processo. Se no 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[].
getAvailableUsersStartOnDe
mand
Retorna os colaboradores disponveis na abertura de uma
solicitao, paginados e com busca.
Mtodo:
getAvailableUsersStart (String username, String password,
int companyId, String processId, int state, int
threadSequence, int limit, int initialUser, String userSearch)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processId: cdigo do processo;
state: nmero da atividade;
threadSequence: Indica se existe atividade paralela
no processo. Se no 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: nmero de registros a serem retornados;
initialUser: ltima linha retornada;
userSearch: texto a ser buscado.
Retorno: AvailableUsersDto.
importProcess Importa processos workflow.
Mtodo:
importProcess(String user, String password, int companyId,
-
36
ECM - Webservices
String processId, Attachment file, boolean newProcess,
boolean overWrite, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processId: cdigo 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 : matrcula 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. Mtodo: calculateDeadLineHours(String username, String password, int companyId, String userId, String data, int segundos, int prazo, String periodId) Parmetros:
username - Usurio de Integrao
password - Senha de Integrao
companyId - Cdigo da empresa
userId - Matrcula do usurio
data - data (Tipo String no formato "yyyy-MM-dd").
segundos - Quantidade de segundos aps a meia noite
prazo - Prazo que ser aplicado em horas (Varivel int).
periodId - Cdigo de Expediente Retorno: Objeto DeadLineDto que contem variveis 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. Mtodo: calculateDeadLineHours(String username, String password, int companyId, String userId, String data, int segundos, int prazo, String periodId) Parmetros:
-
37
ECM - Webservices
username - Usurio de Integrao
password - Senha de Integrao
companyId - Cdigo da empresa
userId - Matrcula do usurio
data - data (Tipo String no formato "yyyy-MM-dd").
segundos - Quantidade de segundos aps a meia noite
prazo - Prazo que ser aplicado em minutos (Varivel int).
periodId - Cdigo de Expediente Retorno: Objeto DeadLineDto que contem variveis com a data e hora.
exportProcess Retorna o processo selecionado em uma String. Mtodo: exportProcess (String username, String password, int companyId, String processId) Parmetros:
username - Usurio de Integrao
password - Senha de Integrao
companyId - Cdigo da empresa
processId - Cdigo do processo Retorno: String que contm a definio do processo
getAllProcessAvailableToImp
ort
Retorna uma lista de processos disponveis para serem importados. Mtodo: getAllProcessAvailableToImport (String username, String password, int companyId) Parmetros:
username - Usurio de Integrao
password - Senha de Integrao
companyId - Cdigo da empresa Retorno: ProcessDefinitionDto[]
getAllProcessAvailableToExp
ort
Retorna uma lista de processos disponveis para serem exportados. Mtodo: getAllProcessAvailableToExport (String username, String password, int companyId) Parmetros:
username - Usurio de Integrao
password - Senha de Integrao
companyId - Cdigo da empresa Retorno: ProcessDefinitionDto[].
-
38
ECM - Webservices
getHistories Retorna lista de histricos de um processo. Mtodo: getHistories (String username, String password, int companyId) Parmetros:
username - Usurio de Integrao
password - Senha de Integrao
companyId - Cdigo da empresa
userId - Matrcula do usurio
processInstanceId - nmero da solicitao workflow Retorno: ProcessHistoryDto[].
searchProcess Busca processo disponveis para inicializao. Metodo: searchProcess(String user, String Password, int companyId, String colleagueId, String content, boolean favorite) Parametros
user - Usurio de Integrao
password - Senha de Integrao
companyId - Cdigo da empresa
colleagueId - Matrcula do usurio
content nome do processo a ser pesquisado
favorite busca da lista de processos favoritos ou da listagem padro.
Retorno: ProcessDefinitionVersionDto[]
Quadro 3: Mtodos da WorkflowEngineService
Exemplo de utilizao
No diretrio de documentao do ECM na pasta Documentos de
Customizao\Arquivos Adicionais\Exemplos
Webservices\ExemplosWorkflowEngineService disponibilizada a classe
WorkflowEngineServiceClient.java, esta exemplifica a utilizao de todos os
mtodos da classe WorkflowEngineService.
-
39
ECM - Webservices
GroupService
Webservices responsvel por realizar operaes referentes a grupos no ECM.
Pode ser utilizado para criar, alterar, excluir e procurar grupos, entre outras
funcionalidades.
Mtodos
No quadro 4, mostrado todos os mtodos disponveis na classe
GroupService.
getGroups Retorna todos os grupos cadastrados no ECM.
Mtodo:
getGroups(String username, String password, int companyId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa.
Retorno: GroupDto[].
getGroup Retorna um grupo cadastrado no ECM.
Mtodo:
getGroups(String username, String password, int companyId,
String groupId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
groupId: cdigo do grupo.
Retorno: GroupDto[].
createGroup Cria um grupo no ECM.
Mtodo:
createGroup(String username, String password, int
companyId, GroupDto[] grupos)
Parmetros:
username: login do colaborador;
-
40
ECM - Webservices
password: senha do colaborador;
companyId: cdigo da empresa;
grupos: grupo que ser criado.
Retorno: String.
updateGroup Altera um grupo no ECM.
Mtodo:
updateGroup(String username, String password, int
companyId, GroupDto[] grupos)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
grupos: grupo que ser alterado.
Retorno: String.
getGroupsByDescription Retorna um grupo pela descrio.
Mtodo:
getGroupsByDescription(String username, String password,
int companyId, String desc)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
desc: descrio do grupo.
Retorno: GroupDto[].
getOcurrenceByKey Retorna se existe configurao de segurana para atribuio
e valor da atribuio.
Mtodo:
getOcurrenceByKey(String username, String password, int
companyId, int pIdiAtribuic, String pDesValAtribuic)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
pIdiAtribuic: cdigo da atribuio;
pDesValAtribuic: valor da atribuio.
Retorno: boolean.
-
41
ECM - Webservices
deleteGroup Exclui um grupo do ECM.
Mtodo:
deleteGroup(String username, String password, int
companyId, String groupId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
GroupId: cdigo do grupo.
Retorno: String.
Quadro 4: Mtodos da GroupService
Exemplo de utilizao
No diretrio de documentao do ECM na pasta Documentos de
Customizao\Arquivos Adicionais\Exemplos
Webservices\ExemplosGroupService disponibilizada a classe
GroupServiceClient.java, esta exemplifica a utilizao de todos os mtodos da
classe GroupService.
-
42
ECM - Webservices
FavoritesService
Webservices responsvel por interagir com os documentos e processos
favoritos do ECM. Pode ser utilizado para pesquisar os documentos e
processos favoritos de cada colaborador.
Mtodo
No quadro 5, mostrado os mtodos disponveis na classe FavoritesService.
findFavorites Retorna os documentos favoritos do colaborador.
Mtodo:
findFavorites(String user, String password, int companyId,
String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId : matrcula do colaborador.
Retorno: DocumentDto[].
findFavoritesOnDemand Retorna os documentos favoritos do colaborador,
paginados.
Mtodo:
findFavoritesOnDemand(String user, String password, int
companyId, String colleagueId, int limit, int lastRowId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId : matrcula do colaborador;
limit: nmero de registros a serem retornados;
lastRowId: ltima linha retornada.
Retorno: DocumentDto[].
findFavoritesProcess Retorna os processos favoritos do colaborador.
Mtodo:
findFavoritesProcess (String user, String password, int
-
43
ECM - Webservices
companyId, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId : matrcula do colaborador.
Retorno: ProcessDefinitionVersionDto[] .
findFavoritesProcessOnDema
nd
Retorna os processos favoritos do colaborador, paginados.
Mtodo:
findFavoritesProcess (String user, String password, int
companyId, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId : matrcula do colaborador;
limit: nmero de registros a serem retornados;
lastRowId: ltima linha retornada.
Retorno: ProcessDefinitionVersionDto[] .
addDocumentToFavorites Adiciona um documento aos favoritos do colaborador
informado.
Mtodo:
addDocumentToFavorites(String username, String password, int companyId, int nrDocument, int nrVersao, String colleagueId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
nrDocument: nmero do documento
nrVersao: verso do documento
colleagueId : matrcula do colaborador.
removeFavoriteDocument Remove um documento dos favoritos do colaborador
informado.
-
44
ECM - Webservices
Mtodo:
removeFavoriteDocument (String username, String password, int companyId, int nrDocument, String colleagueId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
nrDocument: nmero do documento
colleagueId : matrcula do colaborador.
addProcessToFavorites Adiciona um processo aos favoritos do colaborador
informado.
Mtodo:
addProcessToFavorites(String username, String password,
int companyId,String processId, String colleagueId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processId: cdigo do processo
colleagueId : matrcula do colaborador.
removeFavoriteProcess Remove um processo dos favoritos do colaborador
informado.
Mtodo:
addProcessToFavorites(String username, String password,
int companyId,String processId, String colleagueId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processId: cdigo do processo.
-
45
ECM - Webservices
colleagueId : matrcula do colaborador.
isFavoriteDocument Verifica se documento favorito.
Metodo:
isFavoriteDocument(String username, String password, int
companyId, int nrDocument, String colleagueId)
Parmetros:
username: login do usurio de integrao;
password: senha do colaborador;
companyId: cdigo da empresa;
nrDocument: cdigo do documento;
colleagueId: matricula do colaborador.
Retorno: Boolean
Quadro 5: Mtodos da FavoritesService
Exemplo de utilizao
No diretrio de documentao do ECM na pasta Documentos de
Customizao\Arquivos Adicionais\Exemplos
Webservices\ExemplosFavoritesService disponibilizada a classe
FavoritesServiceClient.java, esta exemplifica a utilizao de todos os mtodos
da classe FavoritesService.
-
46
ECM - Webservices
CompanyService
Webservices responsvel por realizar operaes referentes empresa no
ECM. Pode ser utilizado para criar, alterar, excluir e pesquisar empresas,
entre outras funcionalidades.
Mtodos
No quadro 6, mostrado todos os mtodos disponveis na classe
CompanyService.
getCompanies Retorna todas as empresas cadastradas no ECM.
Mtodo:
getCompanies(String username, String password, String
companyId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa.
Retorno: CompanyDto[].
getCompany Retorna uma empresa cadastrada no ECM.
Mtodo:
getCompany(int companyId)
Parmetros:
companyId: cdigo da empresa.
Retorno: CompanyDto.
createCompany Cria uma empresa no ECM.
Mtodo:
createCompany(String username, String password, String
companyId, String description, String urlAccessName, String
phisicalPath, String webdeskServer, String webPort)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
-
47
ECM - Webservices
description: descrio da empresa;
urlAccessName: URL de acesso;
phisicalPath: caminho fsico;
webdeskServer: servidor;
webPort: porta.
Retorno: String.
updateCompany Altera uma empresa no ECM.
Mtodo:
updateCompany(String username, String password, String
companyId, String description, String urlAccessName, String
phisicalPath, String webdeskServer, String webPort)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
description: descrio da empresa;
urlAccessName: URL de acesso;
phisicalPath: caminho fsico;
webdeskServer: servidor;
webPort: porta.
Retorno: String.
delete Exclui uma empresa do ECM.
Mtodo:
delete(String username, String password, String companyId,
Boolean deleteFiles)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
deleteFiles: indica se deve excluir o caminho fsico.
Retorno: String.
Quadro 6: Mtodos da CompanyService
Exemplo de utilizao
No diretrio de documentao do ECM na pasta Documentos de
Customizao\Arquivos Adicionais\Exemplos
Webservices\ExemplosCompanyService disponibilizada a classe
-
48
ECM - Webservices
CompanyServiceClient.java, esta exemplifica a utilizao de todos os
mtodos da classe CompanyService.
-
49
ECM - Webservices
SearchDocumentService
Webservices responsvel por realizar operaes referentes s buscas no
ECM. Pode ser utilizado para buscar documentos utilizando a busca simples e
avanada.
Mtodos
No quadro 7, mostrado todos os mtodos disponveis na classe
SearchDocumentService.
searchDocuments Utiliza busca simples.
Mtodo:
searchDocuments(String user, String password, int
companyId, String colleagueId, String content)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador;
content: contedo da busca.
Retorno: SearchResultDto[].
advancedSearchDocuments Utiliza busca avanada.
Mtodo:
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)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador;
content: contedo da busca;
findAllDocumentTypes: indica se deve buscar todos
os tipos de documentos;
-
50
ECM - Webservices
findFolders: indica se deve buscar pastas;
findDocuments: indica se deve buscar documentos;
findCardIndex: indica se deve buscar fichrios;
findCards: indica se deve buscar fichas;
findExternalDocument: indica se deve buscar
documentos externos;
documentParentId: nmero 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: cdigo da empresa;
colleagueId: matrcula do colaborador;
contente: contedo a ser buscado
Retorno: SearchResultDto[]
Quadro 7: Mtodos da SearchDocumentService
Exemplo de utilizao
No diretrio de documentao do ECM na pasta Documentos de
Customizao\Arquivos Adicionais\Exemplos
Webservices\ExemplosSearchDocumentService disponibilizada a classe
SearchDocumentServiceClient.java, esta exemplifica a utilizao de todos os
mtodos da classe SearchDocumentService.
-
51
ECM - Webservices
ColleagueGroupService
Webservices responsvel por realizar operaes referentes aos grupos de
usurios no ECM. Pode ser utilizado para relacionar um colaborador a um
grupo de usurios e serve tambm para alterar, excluir e pesquisar esses
relacionamentos criados.
Mtodos
No quadro 8, mostrado todos os mtodos disponveis na classe
ColleagueGroupService.
getColleagueGroupsByColle
agueId
Retorna os grupos de usurios que um colaborador participa.
Mtodo:
getColleagueGroupsByColleagueId(String username, String
password, int companyId, String colleagueId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador.
Retorno: ColleagueGroupDto[].
getColleagueGroupsByGrou
pId
Retorna os colaboradores que participam de um grupo de
usurios.
Mtodo:
getColleagueGroupsByGroupId(String username, String
password, int companyId, String groupId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
groupId: cdigo do grupo.
Retorno: ColleagueGroupDto[].
getAllColleagueGroups Retorna todos os grupos de usurios que possuem
colaboradores relacionados.
Mtodo:
-
52
ECM - Webservices
getAllColleagueGroups(String username, String password,
int companyId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa.
Retorno: ColleagueGroupDto[].
getColleagueGroup Retorna somente um grupo de usurios que um colaborador
participa.
Mtodo:
getColleagueGroup(String username, String password, int
companyId, String groupId, String colleagueId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
groupId: cdigo do grupo;
colleagueId: matrcula do colaborador.
Retorno: ColleagueGroupDto[].
createColleagueGroup Associa um colaborador a um grupo de usurios.
Mtodo:
createColleagueGroup(String username, String password, int
companyId, ColleagueGroupDto[] grupo_colaborador)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
grupo_colaborador: grupo de usurios que estar
associado a um colaborador.
Retorno: String.
updateColleagueGroup Altera a associao de um colaborador a um grupo de
usurios.
Mtodo:
updateColleagueGroup(String username, String password,
int companyId, ColleagueGroupDto[] grupo_colaborador)
Parmetros:
-
53
ECM - Webservices
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
grupo_colaborador: grupo de usurios que ser
alterado.
Retorno: String.
deleteColleagueGroup Exclui um colaborador de um grupo de usurios.
Mtodo:
deleteColleagueGroup(String username, String password, int
companyId, String groupId, String colleagueId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
groupId: cdigo do grupo;
colleagueId: matrcula do colaborador.
Retorno: String.
Quadro 8: Mtodos da ColleagueGroupService
Exemplo de utilizao
No diretrio de documentao do ECM na pasta Documentos de
Customizao\Arquivos Adicionais\Exemplos
Webservices\ExemplosColleagueGroupService disponibilizada a classe
ColleagueGroupServiceClient.java, esta exemplifica a utilizao de todos os
mtodos da classe ColleagueGroupService.
-
54
ECM - Webservices
ColleagueService
Webservices responsvel por realizar operaes referentes a colaboradores
no ECM. Pode ser utilizado para criar, alterar, excluir e pesquisar
colaboradores, entre outras funcionalidades.
Os mtodos 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.
Mtodos
No quadro 9, mostrado todos os mtodos disponveis na classe
ColleagueService.
getColleagues Retorna todos os colaboradores ativos.
Mtodo:
getColleagues(String username, String password, int
companyId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa.
Retorno: ColleagueDto[].
getColleague Retorna um colaborador.
Mtodo:
getColleague(String username, String password, int
companyId, String colleagueId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador.
Retorno: ColleagueDto[].
getGroups Retorna os grupos de usurios que o colaborador participa.
-
55
ECM - Webservices
Mtodo:
getGroups(String username, String password, int companyId,
String colleagueId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador.
Retorno: GroupDto[].
createColleague Cria um colaborador.
Mtodo:
createColleague(String username, String password, int
companyId, ColleagueDto[] colegas)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colegas: colaboradores.
Retorno: String.
createColleaguewithDepend
encies
Cria um colaborador com grupo de segurana e papis
workflow.
Mtodo:
createColleaguewithDependencies(String username, String
password, int companyId, ColleagueDto[] colegas,
GroupDto[] grupos, WorkflowRoleDto[] papeis)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colegas: colaboradores;
grupos: grupos de segurana;
papeis: papis workflow.
Retorno: String.
updateColleague Altera um colaborador.
Mtodo:
updateColleague(String username, String password, int
-
56
ECM - Webservices
companyId, ColleagueDto[] colegas)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colegas: colaboradores.
Retorno: String.
updateColleaguewithDepend
encies
Altera um colaborador com grupo de segurana e papis
workflow.
Mtodo:
updateColleaguewithDependencies(String username, String
password, int companyId, ColleagueDto[] colegas,
GroupDto[] grupos, WorkflowRoleDto[] papeis)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colegas: colaboradores;
grupos: grupos de segurana;
papeis: papis workflow.
Retorno: String.
removeColleague Exclui um colaborador.
Mtodo:
removeColleague(String username, String password, int
companyId, String colleagId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagId: matrcula do colaborador.
Retorno: String.
getSummaryColleagues Retorna todos os colaboradores ativos.
Mtodo:
getSummaryColleagues(int companyId)
Parmetros:
companyId: cdigo da empresa.
-
57
ECM - Webservices
Retorno: ColleagueDto[].
validateColleagueLogin Valida o acesso de um colaborador no produto.
Mtodo:
validateColleagueLogin(int companyId, String colleagueId,
String password)
Parmetros:
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador;
password: senha do colaborador.
Retorno: String.
getColleaguesMail Retorna um colaborador utilizando um e-mail.
Mtodo:
getColleaguesMail(String username, String password, int
companyId, String mail)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
mail: e-mail do colaborador.
Retorno: ColleagueDto[].
getSimpleColleague Retorna o colaborador.
Mtodo:
getSimpleColleague(String username, String password)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
Retorno: ColleagueDto.
Quadro 9: Mtodos da ColleagueService
Exemplo de utilizao
No diretrio de documentao do ECM na pasta Documentos de
Customizao\Arquivos Adicionais\Exemplos
Webservices\ExemplosColleagueService disponibilizada a classe
ColleagueServiceClient.java, esta exemplifica a utilizao de todos os
-
58
ECM - Webservices
mtodos da classe ColleagueService.
-
59
ECM - Webservices
ColleagueReplacementService
Webservices responsvel por realizar operaes referentes a colaboradores
substitutos no ECM. Pode ser utilizado para criar, alterar, excluir e pesquisar
colaboradores substitutos, entre outras funcionalidades.
Mtodos
No quadro 10, mostrado todos os mtodos disponveis na classe
ColleagueReplacementService.
getColleagueReplacement Retorna um substituto de um colaborador.
Mtodo:
getColleagueReplacement(String username, String
password, int companyId, String colleagueId, String
replacementId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador origem;
replacementId: matrcula do colaborador substituto.
Retorno: ColleagueReplacementDto.
getReplacementsOfUser Retorna todos os substitutos de um colaborador.
Mtodo:
getReplacementsOfUser(String username, String password,
int companyId, String colleagueId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador origem.
Retorno: ColleagueReplacementDto[].
getValidReplacedUsers Retorna todos os colaboradores substituidos por um
substituto vlido.
Mtodo:
-
60
ECM - Webservices
getValidReplacedUsers(String username, String password,
int companyId, String replacementId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
replacementId: matrcula do colaborador substituto.
Retorno: ColleagueReplacementDto[].
getValidReplacement Retorna um substituto vlido de um colaborador.
Mtodo:
getValidReplacement(String username, String password, int
companyId, String colleagueId, String replacementId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador origem;
replacementId: matrcula do colaborador substituto.
Retorno: ColleagueReplacementDto.
getValidReplacementsOfUse
r
Retorna todos os substitutos vlidos de um colaborador.
Mtodo:
getValidReplacementsOfUser(String username, String
password, int companyId, String colleagueId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador origem.
Retorno: ColleagueReplacementDto[].
createColleagueReplacemen
t
Cria um substituto.
Mtodo:
createColleagueReplacement (String username, String
password, int companyId, ColleagueReplacementDto crDto)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
-
61
ECM - Webservices
companyId: cdigo da empresa;
crDto: cadastro do substituto.
Retorno: String.
updateColleagueReplaceme
nt
Altera o cadastro de um substituto.
Mtodo:
updateColleagueReplacement (String username, String
password, int companyId, ColleagueReplacementDto crDto)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
crDto: cadastro do substituto.
Retorno: String.
deleteColleagueReplacemen
t
Exclui o cadastro de um substituto.
Mtodo:
deleteColleagueReplacement(String username, String
password, int companyId, String colleagueId, String
replacementId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador origem;
replacementId: matrcula do colaborador substituto.
Retorno: String.
Quadro 10: Mtodos da ColleagueReplacementService
Exemplo de utilizao
No diretrio de documentao do ECM na pasta Documentos de
Customizao\Arquivos Adicionais\Exemplos
Webservices\ExemplosColleagueReplacementService disponibilizada a
classe ColleagueReplacementServiceClient.java, esta exemplifica a utilizao
de todos os mtodos da classe ColleagueReplacementService.
-
62
ECM - Webservices
FolderService
Webservices responsvel por realizar operaes referentes a pastas no ECM.
Pode ser utilizado para criar, alterar, excluir e pesquisar pastas, entre outras
funcionalidades.
Mtodos
No quadro 11, mostrado todos os mtodos disponveis na classe
FolderService.
getFolder Retorna uma pasta.
Mtodo:
getFolder(String user, String password, int companyId, int
nrDocumentId, String colleagueId )
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
nrDocumentId: nmero da pasta;
colleagueId: matrcula do colaborador origem.
Retorno: DocumentDto[].
getSecurity Retorna a segurana de uma pasta.
Mtodo:
getSecurity(String user, String password, int companyId, int
nrDocumentId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
nrDocumentId: nmero da pasta.
Retorno: DocumentSecurityConfigDto[].
getApprovers Retorna os aprovadores de uma pasta.
Mtodo:
getApprovers(String user, String password, int companyId, int
nrDocumentId)
-
63
ECM - Webservices
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
nrDocumentId: nmero da pasta.
Retorno: ApproverWithLevelDto[].
createFolder Cria uma pasta.
Mtodo:
createFolder(String user, String password, int companyId,
DocumentDto[] docdtos, DocumentSecurityConfigDto[]
docsecurity, ApproverDto[] docapprovers )
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
docdtos: pasta que ser criada;
docsecurity: segurana da pasta;
docapprovers: aprovadores da pasta.
Retorno: WebServiceMessage[].
createFolderWithApproveme
ntLevels
Cria uma pasta com nvel de aprovao.
Mtodo:
createFolderWithApprovementLevels(String user, String