Вы находитесь на странице: 1из 88
ECM - Webservices Guia de Referência Utilização de Webservices

ECM - Webservices

Guia de Referência Utilização de Webservices

ECM - Webservices Copyright © 2009 TOTVS S.A. Todos os direitos reservados. Nenhuma parte deste

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

2

ECM - Webservices Índice Objetivo 6 Criar Stubs 6 Considerações Métodos de Update 8

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

Exemplo de utilização

33

GroupService

34

Métodos

34

Exemplo de utilização

36

FavoritesService

37

Método

37

Exemplo de utilização

40

CompanyService

41

Métodos

41

Exemplo de utilização

42

SearchDocumentService

44

Métodos

44

Exemplo de utilização

45

ColleagueGroupService

46

Métodos

46

Exemplo de utilização

48

3

ECM - Webservices ColleagueService 49 Métodos 49 Exemplo de utilização 52 ColleagueReplacementService 53

ECM - Webservices

ColleagueService

49

Métodos

49

Exemplo de utilização

52

ColleagueReplacementService

53

Métodos

53

Exemplo de utilização

55

FolderService

56

Métodos

56

Exemplo de utilização

62

CardService

63

Métodos

63

Exemplo de utilização

65

TokenService

66

Métodos

66

Exemplo de utilização

66

CustomFieldsService

67

Métodos

67

Exemplo de utilização

69

OutstandingService

70

Método

70

Exemplo de utilização

70

GlobalParamService

71

Métodos

71

Exemplo de utilização

73

DashBoardService

74

Método

74

Exemplo de utilização

82

DatasetService

83

Métodos

83

4

ECM - Webservices Exemplo de utilização BusinessPeriodService 84 85 Métodos 85 Exemplo de utilização 85

ECM - Webservices

Exemplo de utilização

BusinessPeriodService

84

85

Métodos

85

Exemplo de utilização

85

AttributionMecanismService

86

Métodos

86

Exemplo de utilização

86

CardIndexService

87

Métodos

87

Exemplo de utilização

88

5

ECM - Webservices Objetivo O objetivo deste documento é descrever a utilização de Webservices, mostrar

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.

Enter e o resultado aparecerá conforme mostra a figura 1. Figura 1: Exemplo de criação de

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

sdl

6

ECM - Webservices ColleagueGroupService wsimport -d C:\Webservices\tmp

ECM - Webservices

ColleagueGroupService

wsimport

-d

C:\Webservices\tmp

sdl

ColleagueReplacementService

wsimport

-d

C:\Webservices\tmp

ColleagueService

wsimport

-d

C:\Webservices\tmp

CompanyService

wsimport

-d

C:\Webservices\tmp

GlobalParamService

wsimport

-d

C:\Webservices\tmp

GroupService

wsimport

-d

C:\Webservices\tmp

CardService

wsimport

-d

C:\Webservices\tmp

CustomFieldsService

wsimport

-d

C:\Webservices\tmp

DashBoardService

wsimport

-d

C:\Webservices\tmp

DocumentService

wsimport

-d

C:\Webservices\tmp

FavoritesService

wsimport

-d

C:\Webservices\tmp

FolderService

wsimport

-d

C:\Webservices\tmp

SearchDocumentService

wsimport

-d

C:\Webservices\tmp

TokenService

wsimport

-d

C:\Webservices\tmp

DatasetService

wsimport

-d

C:\Webservices\tmp

OutstandingService

wsimport

-d

C:\Webservices\tmp

BusinessPeriodService

wsimport

-d

C:\Webservices\tmp

dl

AttributionMecanismService

wsimport

-d

C:\Webservices\tmp

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

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

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

DocumentService.

quadro

2,

é

mostrado

todos

os

métodos

disponíveis

na

classe

getActiveDocument

Retorna um documento ativo.

Método:

getActiveDocument(String user, String password, int companyId, int nrDocumentId, String colleagueId)

Parâmetros:

user: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

nrDocumentId: número do documento;

colleagueId: matrícula do colaborador.

Retorno: DocumentDto[].

getDocumentContent

Retorna o byte do arquivo físico de um documento, caso o usuário tenha permissão para acessá-lo.

Método:

getDocumentContent(String user, String password, int companyId, int nrDocumentId, String colleagueId, int documentoVersao, String nomeArquivo)

Parâmetros:

user: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

nrDocumentId: número do documento;

colleagueId: matrícula do colaborador;

documentVersao: número da versão do documento;

nomeArquivo: nome do arquivo.

 

9

ECM - Webservices   Retorno: byte[]. getDocumentVersion Retorna a versão de um documento. Método:

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:

user: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

nrDocumentId: número do documento;

version: número da versão do documento;

colleagueId: matrícula do colaborador.

Retorno: DocumentDto[].

getDocumentByExternalId

Retorna um documento pelo código externo.

Método:

getDocumentByExternalId(String user, String password, int companyId, String externalDocumentId, String colleagueId)

Parâmetros:

user: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

externalDocumentId: código externo do documento;

colleagueId: matrícula do colaborador.

Retorno: DocumentDto[].

getSecurity

Retorna a segurança de um documento.

Método:

getSecurity(String user, String password, int company, int nrDocumentId, int version)

Parâmetros:

user: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

nrDocumentId: número do documento;

version: número da versão do documento.

Retorno: DocumentSecurityConfigDto[].

getApprovers

Retorna os aprovadores de um documento.

10

ECM - Webservices   Método: getApprovers(String user, String password, int companyId, int nrDocumentId, int

ECM - Webservices

 

Método:

getApprovers(String user, String password, int companyId, int nrDocumentId, int version)

Parâmetros:

 

user: login do colaborador;

 

password: senha do colaborador;

 

companyId: código da empresa;

nrDocumentId: número do documento.

Retorno: ApproverWithLevelDto[].

 

getRelatedDocuments

Retorna

todos

os

documentos

relacionados

de

um

documento.

 

Método:

getRelatedDocuments(String user, String password, int companyId, int nrDocumentId, int version)

Parâmetros:

 

user: login do colaborador;

 

password: senha do colaborador;

 

companyId: código da empresa;

nrDocumentId: número do documento;

version: número da versão do documento.

Retorno: RelatedDocumentDto[].

 

createDocument

Cria um documento.

 

Método:

createDocument(String user, String password, int companyId, DocumentDto[] docDtos, Attachment[] attachs, DocumentSecurityConfigDto[] docSecurity, ApproverDto[] docApprovers, RelatedDocumentDto[] relDocs)

Parâmetros:

 

user: login do colaborador;

 

password: senha do colaborador;

 

companyId: código da empresa;

docDtos: documento que será publicado;

attachs: arquivo anexado na publicação;

docSecurity: segurança do documento que será publicado;

docApprovers: aprovadores do documento que será publicado;

relDocs: documentos relacionados ao documento que será publicado.

 

11

ECM - Webservices   Retorno: WebServiceMessage[]. createDocumentWithApprove Cria um documento com nível de

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:

user: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

docDtos: documento que será publicado;

attachs: arquivo anexado na publicação;

docSecurity: segurança do documento que será publicado;

docApproversLevel: nível de aprovação que os aprovadores do documento estão inseridos;

levels: níveis de aprovação que o documento terá;

relDocs: documentos relacionados ao documento que será publicado.

Retorno: WebServiceMessage[].

updateDocument

Altera um documento.

Método:

updateDocument(String user, String password, int companyId, DocumentDto[] docDtos, Attachment[] attach, DocumentSecurityConfigDto[] docSecurity, ApproverDto[] docApprovers, RelatedDocumentDto[] relDocs)

Parâmetros:

user: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

docDtos: documento que será alterado;

attachs: arquivo anexado na alteração;

docSecurity: segurança do documento que será alterado;

docApprovers: aprovadores do documento que será alterado;

relDocs: documentos relacionados ao documento que será alterado.

 

12

ECM - Webservices   Retorno: WebServiceMessage[]. updateSimpleDocument Altera de forma simples um documento.

ECM - Webservices

 

Retorno: WebServiceMessage[].

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;

companyId: código da empresa;

documentId: número do documento que será alterado;

publisherId: matrícula do colaborador que realizará a alteração do documento;

documentDescription: descrição do documento;

attachments: arquivos anexados na alteração.

Retorno: WebServiceMessage[].

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:

user: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

docDtos: documento que será alterado;

attachs: arquivo anexado na alteração;

docSecurity: segurança do documento que será alterado;

docApprovers: nível de aprovação que os aprovadores do documento estão inseridos;

levels: níveis de aprovação que o documento terá;

relDocs: documentos relacionados ao documento que será alterado.

Retorno: WebServiceMessage[].

validateIntegrationRequireme

Verifica a integração do colaborador no ECM.

13

ECM - Webservices nts Método: validateIntegrationRequirements (String user, String password, int companyId)

ECM - Webservices

nts

Método:

validateIntegrationRequirements (String user, String password, int companyId)

Parâmetros:

 

user: login do colaborador;

password: senha do colaborador;

 

companyId: código da empresa.

Retorno: String.

 

getReportSubjectId

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

 

Método:

getReportSubjectId(String

user,

String

password,

int

companyId)

 

Parâmetros:

user: login do colaborador;

password: senha do colaborador;

 

companyId: código da empresa.

Retorno: int.

 

removeSecurity

Remove a segurança de um documento.

 

Método:

removeSecurity(String user, String password, int companyId, int documentId, int version)

Parâmetros:

 

user: login do colaborador;

password: senha do colaborador;

 

companyId: código da empresa;

documentId: número do documento;

version: número da versão do documento.

 

Retorno: Não há retorno.

 

getUserPermissions

Retorna as permissões do colaborador sobre um documento.

Método:

getUserPermissions(int companyId, String user, int nrDocumentId, int version)

Parâmetros:

 

companyId: código da empresa;

 

user: login do colaborador;

 

14

ECM - Webservices    nrDocumentId: número do documento;  version: número da versão do

ECM - Webservices

 

nrDocumentId: número do documento;

version: número da versão do documento.

Retorno: Integer.

createSimpleDocument

Cria um documento simples.

Método:

createSimpleDocument(String user, String password, int company, int parentDocumentId, String publisherId, String documentDescription, Attachment[] attachments)

Parâmetros:

user: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

parentDocumentId: número da pasta pai;

publisherId: matrícula do colaborador que publicará o documento;

documentDescription: descrição do documento;

attachments: arquivo anexado na publicação.

Retorno: WebServiceMessage[].

createSimpleDocumentPrivat

Cria um documento simples na pasta particular.

e

Método:

createSimpleDocumentPrivate(String colleagueId, String password, int companyId, int parentDocumentId, String documentDescription, Attachment[] attachments)

Parâmetros:

colleagueId: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

parentDocumentId: número da pasta pai;

documentDescription: descrição do documento;

attachments: arquivo anexado na publicação.

Retorno: WebServiceMessage[].

findMostPopularDocuments

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

Método:

findMostPopularDocuments(String user, String password, int companyId, String colleagueId, int nr_resultados)

Parâmetros:

15

ECM - Webservices    user: login do colaborador;    password: senha do colaborador;

ECM - Webservices

 

user: login do colaborador;

 

password: senha do colaborador;

 

companyId: código da empresa;

colleagueId: matrícula do colaborador;

nr_resultados: quantidade de documentos que serão retornados.

Retorno: DocumentDto[].

findMostPopularDocumentsO

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

nDemand

Método:

findMostPopularDocuments(String user, String password, int companyId, String colleagueId, int nr_resultados, int limit, int lastRowId)

Parâmetros:

user: login do colaborador;

 

password: senha do colaborador;

 

companyId: código da empresa;

colleagueId: matrícula do colaborador;

nr_resultados: quantidade de documentos que serão retornados;

limit: número de registros a serem retornados;

 

lastRowId: última linha retornada.

 

Retorno: DocumentDto[].

deleteDocument

Exclui um documento e o envia para a lixeira.

 

Método:

deleteDocument(String user, String password, int companyId, int documentId, String colleagueId)

Parâmetros:

user: login do colaborador;

 

password: senha do colaborador;

 

companyId: código da empresa;

documentId: número do documento que será excluído;

colleagueId: matrícula do colaborador.

 

Retorno: WebServiceMessage[].

 

destroyDocument

Exclui um documento da lixeira.

 

Método:

destroyDocument(String

user,

String

password,

int

16

ECM - Webservices   companyId, int documentId, String colleagueId) Parâmetros:  user: login do

ECM - Webservices

 

companyId, int documentId, String colleagueId)

Parâmetros:

user: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

documentId: número do documento que será excluído;

colleagueId: matrícula do colaborador.

Retorno: WebServiceMessage[].

findRecycledDocuments

Retorna os documentos da lixeira.

Método:

findRecycledDocuments(String user, String password, int companyId, String colleagueId)

Parâmetros:

user: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

colleagueId: matrícula do colaborador.

Retorno: DocumentDto[].

restoreDocument

Restaura um documento da lixeira.

Método:

restoreDocument(String user, String password, int companyId, int documentId, String colleagueId)

Parâmetros:

user: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

documentId: número do documento que será restaurado;

colleagueId: matrícula do colaborador.

Retorno: WebServiceMessage[].

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:  user: login do colaborador;  password: senha do colaborador;

ECM - Webservices

 

Parâmetros:

user: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

documentId: número do documento que será copiado;

version: versão do documento

colleagueId: matrícula do colaborador cuja área de upload será utilizada

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

moveDocument

Move documentos para pasta destino. Método:

moveDocument(String user, String password, int companyId, int[] documentIds, String colleagueId, int destfolder) Parâmetros:

user: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

documentIds: lista com os números dos documentos que serão movidos;

colleagueId: matrícula do colaborador com permissão para mover o documento

destFolder: número da pasta de destino. Retorno: String[]

updateGroupSecurityType

Modifica a tipo da segurança dos grupos na permissão e na

restrição. Existem duas opções que são representadas por

um inteiro:

 

0 - TODOS os colaboradores dos Grupos.

1 - SOMENTE colaboradores comuns dos grupos;

Método:

updateGroupSecurityType(String user, String password, int

companyId, int documentId, int version, int permissionType,

int restrictionType, String colleagueId)

Parâmetros:

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

password: senha do usuário de integração.

companyId: código da empresa.

documentId: código do documento.

 

18

ECM - Webservices    version: versão do documento.  permissionType: tipo da permissão (0

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;

password: senha do usuário de integração;

companyId: código da empresa;

documentId: código do documento que se deseja visualizar o status;

version: versão do documento (caso seja informada a versão 0 sera solicitada a ultima versão do documento).

Retorno: DocumentApprovalStatusDto[]

getDocumentApprovalHistory

Retorna o histórico de aprovacoes do documento solicitado.

Metodo:

19

ECM - Webservices getDocumentApprovalHistory(String user, String password, int companyId, int documentId, int

ECM - Webservices

getDocumentApprovalHistory(String user, String password,

int companyId, int documentId,

int version)

Parâmetros:

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

password: senha do usuário de integração;

companyId: código da empresa;

documentId: código do documento que se deseja

visualizar o status;

version: versão do documento (caso seja informada

a versão 0 sera solicitada a ultima versão do

documento).

Retorno: DocumentApprovementHistoryDto[]

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.

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

No

DocumentService.

quadro

3,

é

mostrado

todos

os

métodos

disponíveis

na

classe

simpleStartProcess

Inicia uma solicitação simples.

Método:

simpleStartProcess(String user, String password, int companyId, String processId, String comments, ProcessAttachmentDto[] attachments, String cardData[][])

Parâmetros:

user: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

processId: código do processo;

comments: comentários;

attachments: anexos da solicitação;

cardData: dados da ficha.

Retorno: String[].

startProcess

Inicia uma solicitação.

Método:

startProcess(String user, String password, int companyId, String processId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, String[][] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode)

Parâmetros:

user: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

processId: código do processo;

 

21

ECM - Webservices    choosedState: número da atividade;  colleagueIds: colaborador que receberá a

ECM - Webservices

 

choosedState: número da atividade;

colleagueIds: colaborador que receberá a tarefa;

comments: comentários;

userId: matrícula do colaborador que vai iniciar a solicitação;

completeTask: indica se deve completar a tarefa (true) ou somente salvar (false);

attachments: anexos da solicitação;

cardData: dados da ficha;

appointment: apontamentos da tarefa;

managerMode: indica se colaborador esta iniciando a solicitação como gestor do processo.

Retorno: String[][].

setDueDate

Altera a data de prazo da tarefa.

Método:

setDueDate(String user, String password, int companyId, int processInstanceId, String userId, int threadSequence, String newDueDate, int timeInSeconds)

Parâmetros:

user: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

processInstanceId: número da solicitação;

userId: mátricula do colaborador;

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

newDueDate: nova data de prazo da tarefa;

timeInSeconds: quantidade de segundos após a meia noite.

Retorno: String.

setTasksComments

Altera os comentários da tarefa.

Método:

setTasksComments(String user, String password, int companyId, int processInstanceId, String userId, int threadSequence, String comments)

Parâmetros:

user: login do colaborador;

 

22

ECM - Webservices    password: senha do colaborador;  companyId: código da empresa; 

ECM - Webservices

 

password: senha do colaborador;

companyId: código da empresa;

processInstanceId: número da solicitação;

userId: mátricula do colaborador;

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

comments: comentários.

Retorno: String.

cancelInstance

Cancela uma solicitação.

Método:

cancelInstance(String user, String password, int companyId, int processInstanceId, String userId, String cancelText)

Parâmetros:

user: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

processInstanceId: número da solicitação;

userId: mátricula do colaborador;

cancelText: comentários do cancelamento.

Retorno: String.

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:

user: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

processInstanceId: número da solicitação;

userId: mátricula do colaborador;

cancelText: comentários do cancelamento;

replacementId: matrícula do colaborador substituto.

Retorno: String.

getCardValue

Retorna o valor de um campo da ficha.

23

ECM - Webservices   Método: getCardValue(String user, String password, int companyId, int processInstanceId,

ECM - Webservices

 

Método:

getCardValue(String user, String password, int companyId, int processInstanceId, String userId, String cardFieldName)

Parâmetros:

user: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

processInstanceId: número da solicitação;

userId: mátricula do colaborador;

cardFieldName: nome do campo da ficha.

Retorno: String.

saveAndSendTask

Movimenta solicitação para próxima atividade.

Método:

saveAndSendTask(String user, String password, int companyId, int processInstanceId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, String[][] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode, int threadSequence)

Parâmetros:

user: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

processInstanceId: número da solicitação;

choosedState: número da atividade;

colleagueIds: colaborador que receberá a tarefa;

comments: comentários;

userId: matrícula do colaborador que vai executar a tarefa;

completeTask: indica se deve completar a tarefa (true) ou somente salvar (false);

attachments: anexos da solicitação;

cardData: dados da ficha;

appointment: apontamentos da tarefa;

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

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

 

24

ECM - Webservices   Retorno: String[][].   saveAndSendTaskByReplac Movimenta solicitação para

ECM - Webservices

 

Retorno: String[][].

 

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:

user: login do colaborador;

 

password: senha do colaborador;

companyId: código da empresa;

processInstanceId: número da solicitação;

 

choosedState: número da atividade;

colleagueIds: colaborador que receberá a tarefa;

comments: comentários;

 

userId: matrícula do colaborador que vai executar a tarefa;

completeTask: indica se deve completar a tarefa (true) ou somente salvar (false);

attachments: anexos da solicitação;

 

cardData: dados da ficha;

 

appointment: apontamentos da tarefa;

 

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

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

replacementId: matrícula do colaborador substituto.

Retorno: String[][].

 

takeProcessTask

Assume uma tarefa.

 

Método:

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

Parâmetros:

25

ECM - Webservices    user: login do colaborador;  password: senha do colaborador; 

ECM - Webservices

 

user: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

userId: matrícula do colaborador;

processInstanceId: número da solicitação;

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

Retorno: String.

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:

user: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

userId: matrícula do colaborador;

processInstanceId: número da solicitação;

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

replacementId: matrícula do colaborador substituto.

Retorno: String.

getAttachments

Retorna os anexos de uma solicitação.

Método:

getAttachments(String user, String password, int companyId, String userId, int processInstanceId)

Parâmetros:

user: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

userId: matrícula do colaborador;

processInstanceId: número da solicitação.

 

26

ECM - Webservices   Retorno: ProcessAttachmentDto[]. getAllActiveStates Retorna o número da atividade em que

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:

user: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

userId: matrícula do colaborador;

processInstanceId: número da solicitação.

Retorno: Integer[].

getActualThread

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

Método:

getActualThread(String user, String password, int companyId, int processInstanceId, int stateSequence)

Parâmetros:

user: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

userId: matrícula do colaborador;

stateSequence: sequência do estado.

Retorno: int.

getAvailableStates

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

Método:

getAvailableStates(String user, String password, int companyId, String processId, int processInstanceId, int threadSequence)

Parâmetros:

user: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

processId: código do processo;

processInstanceId: número da solicitação;

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

 

27

ECM - Webservices     existentes no processo. Retorno: Integer[]. getAvailableUsers Retorna os

ECM - Webservices

   

existentes no processo.

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;

password: senha do colaborador;

companyId: código da empresa;

processInstanceId: número da solicitação;

state: número da atividade;

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

Retorno: String[].

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:

username: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

processInstanceId: número da solicitação;

state: número da atividade;

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

limit: número de registros a serem retornados;

initialUser: última linha retornada;

userSearch: texto a ser buscado.

 

28

ECM - Webservices   Retorno: AvailableUsersDto. getInstanceCardData Retorna o valor dos campos da ficha de

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:

user: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

userId: matrícula do colaborador;

processInstanceId: número da solicitação.

Retorno: String[][].

getAvailableProcess

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

Método:

getAvailableProcess(String username, String password, int companyId, String userId)

Parâmetros:

username: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

userId: matrícula do colaborador.

Retorno: ProcessDefinitionVersionDto[].

getAvailableProcessOnDema

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

nd

Método:

getAvailableProcessOnDemand(String username, String password, int companyId, String userId, int limit, int lastRowId)

Parâmetros:

username: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

userId: matrícula do colaborador;

limit: número de registros a serem retornados;

lastRowId: última linha retornada.

 

29

ECM - Webservices   Retorno: ProcessDefinitionVersionDto[].   updateWorkflowAttachment Atualiza um

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:

username: login do colaborador;

 

password: senha do colaborador;

companyId: código da empresa;

processInstanceId: número da solicitação workflow

usuario:

usuário responsável pela edição do

documento;

 

docDtos:

documento ou documentos que serão

publicados;

 

attachs: arquivo(s) anexado(s) na publicação;

 

getAvailableUsersStart

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

Método:

getAvailableUsersStart (String username, String password, int companyId, String processId, int state, int threadSequence)

Parâmetros:

username: login do colaborador;

 

password: senha do colaborador;

companyId: código da empresa;

processId: código do processo;

state: número da atividade;

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

Retorno: String[].

 

getAvailableUsersStartOnDe

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

mand

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

ECM - Webservices

 

Parâmetros:

username: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

processId: código do processo;

state: número da atividade;

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

limit: número de registros a serem retornados;

initialUser: última linha retornada;

userSearch: texto a ser buscado.

Retorno: AvailableUsersDto.

importProcess

Importa processos workflow.

Método:

importProcess(String user, String password, int companyId, String processId, Attachment file, boolean newProcess, boolean overWrite, String colleagueId)

Parâmetros:

user: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

processId: código do processo;

file: arquivo a ser importado;

newProcess: indica se deve ser criado um processo ou atualizado o existente;

overWrite: indica se as atividade e fluxos do processo existente dever ser sobrescritas.

colleagueId : matrícula do colaborador.

Retorno: String.

calculateDeadLineHours

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

Método:

calculateDeadLineHours(String username, String password, int companyId, String userId, String data, int segundos, int prazo, String periodId)

Parâmetros:

31

ECM - Webservices    username - Usuário de Integração  password - Senha de

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:

username - Usuário de Integração

password - Senha de Integração

companyId - Código da empresa

userId - Matrícula do usuário

data - data (Tipo String no formato "yyyy-MM-dd").

segundos - Quantidade de segundos após a meia noite

prazo - Prazo que será aplicado em minutos (Variável int).

periodId - Código de Expediente

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

exportProcess

Retorna o processo selecionado em uma String. Método:

exportProcess (String username, String password, int companyId, String processId) Parâmetros:

username - Usuário de Integração

password - Senha de Integração

companyId - Código da empresa

processId - Código do processo

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

getAllProcessAvailableToImp

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

ort

Método:

32

ECM - Webservices   getAllProcessAvailableToImport (String username, String password, int companyId) Parâmetros:

ECM - Webservices

 

getAllProcessAvailableToImport (String username, String password, int companyId)

Parâmetros:

username - Usuário de Integração

password - Senha de Integração

companyId - Código da empresa

Retorno: ProcessDefinitionDto[]

getAllProcessAvailableToExp

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

ort

Método:

getAllProcessAvailableToExport (String username, String password, int companyId)

Parâmetros:

username - Usuário de Integração

password - Senha de Integração

companyId - Código da empresa

Retorno: ProcessDefinitionDto[].

getHistories

Retorna lista de históricos de um processo.

Método:

 

getHistories (String username, String password, int companyId)

Parâmetros:

username - Usuário de Integração

password - Senha de Integração

companyId - Código da empresa

userId - Matrícula do usuário

processInstanceId - número da solicitação workflow

Retorno: ProcessHistoryDto[].

Quadro 3: Métodos da WorkflowEngineService

Exemplo de utilização

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

33

ECM - Webservices GroupService Webservices responsável por realizar operações referentes a grupos no ECM. Pode

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

No

GroupService.

quadro

4,

é

mostrado

todos

os

métodos

disponíveis

na

classe

getGroups

Retorna todos os grupos cadastrados no ECM.

Método:

getGroups(String username, String password, int companyId)

Parâmetros:

username: login do colaborador;

password: senha do colaborador;

companyId: código da empresa.

Retorno: GroupDto[].

getGroup

Retorna um grupo cadastrado no ECM.

Método:

getGroups(String username, String password, int companyId, String groupId)

Parâmetros:

username: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

groupId: código do grupo.

Retorno: GroupDto[].

createGroup

Cria um grupo no ECM.

Método:

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

Parâmetros:

username: login do colaborador;

password: senha do colaborador;

 

34

ECM - Webservices    companyId: código da empresa;  grupos: grupo que será criado.

ECM - Webservices

 

companyId: código da empresa;

grupos: grupo que será criado.

Retorno: String.

updateGroup

Altera um grupo no ECM.

Método:

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

Parâmetros:

username: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

grupos: grupo que será alterado.

Retorno: String.

getGroupsByDescription

Retorna um grupo pela descrição.

Método:

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

Parâmetros:

username: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

desc: descrição do grupo.

Retorno: GroupDto[].

getOcurrenceByKey

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

Método:

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

Parâmetros:

username: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

pIdiAtribuic: código da atribuição;

pDesValAtribuic: valor da atribuição.

Retorno: boolean.

deleteGroup

Exclui um grupo do ECM.

35

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

ECM - Webservices

Método:

deleteGroup(String username, String password, int companyId, String groupId)

Parâmetros:

username: login do colaborador;

password: senha do colaborador;

companyId: código da empresa;

GroupId: código do grupo.

Retorno: String.

Quadro 4: Métodos da GroupService

Exemplo de utilização

No diretório de documentação do ECM na pasta Documentos de

Customização\Arquivos

Webservices\ExemplosGroupService é disponibilizada a classe GroupServiceClient.java, esta exemplifica a utilização de todos os métodos da classe GroupService.

Adicionais\Exemplos

36

ECM - Webservices FavoritesService Webservices responsável por interagir com os documentos e processos favoritos do

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:

 

user: login do colaborador;

 

password: senha do colaborador;

companyId: código da empresa;

colleagueId : matrícula do colaborador.

 

Retorno: DocumentDto[].

 

findFavoritesOnDemand

Retorna

os

documentos

favoritos

do

colaborador,

paginados.

 

Método:

findFavoritesOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)

Parâmetros:

 

user: login do colaborador;

 

password: senha do colaborador;

companyId: código da empresa;

colleagueId : matrícula do colaborador;

 

limit: número de registros a serem retornados;

 

lastRowId: última linha retornada.

 

Retorno: DocumentDto[].

 

findFavoritesProcess

Retorna os processos favoritos do colaborador.

 

Método:

findFavoritesProcess

(String

user,

String

password,

int

37

ECM - Webservices   companyId, String colleagueId)   Parâmetros:    user: login do

ECM - Webservices

 

companyId, String colleagueId)

 

Parâmetros:

 

user: login do colaborador;

 

password: senha do colaborador;

companyId: código da empresa;

colleagueId : matrícula do colaborador.

 

Retorno: ProcessDefinitionVersionDto[] .

 

findFavoritesProcessOnDema

Retorna os processos favoritos do colaborador, paginados.

nd

Método:

findFavoritesProcess (String user, String password, int companyId, String colleagueId)

Parâmetros:

 

user: login do colaborador;

 

password: senha do colaborador;

companyId: código da empresa;

colleagueId : matrícula do colaborador;

 

limit: número de registros a serem retornados;

lastRowId: última linha retornada.

 

Retorno: ProcessDefinitionVersionDto[] .

addDocumentToFavorites

Adiciona

um

documento

aos

favoritos

do

colaborador

informado.

 

Método:

addDocumentToFavorites(String username, String password, int companyId, int nrDocument, int nrVersao, String colleagueId)

Parâmetros:

 

username: login do colaborador;

 

password: senha do colaborador;

companyId: código da empresa;

nrDocument: número do documento

nrVersao: versão do documento

colleagueId : matrícula do colaborador.

 

removeFavoriteDocument

Remove

um

documento

dos

favoritos

do

colaborador

informado.

 

38

ECM - Webservices   Método: removeFavoriteDocument (String username, String password, int companyId, int

ECM - Webservices

 

Método:

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

Parâmetros:

 

username: login do colaborador;

 

password: senha do colaborador;

companyId: código da empresa;

nrDocument: número do documento

 

colleagueId : matrícula do colaborador.

addProcessToFavorites

Adiciona

um

processo

aos

favoritos

do

colaborador

informado.

 

Método:

addProcessToFavorites(String username, String password,

int companyId,String processId, String colleagueId)

Parâmetros:

 

username: login do colaborador;

 

password: senha do colaborador;

companyId: código da empresa;

processId: código do processo

colleagueId : matrícula do colaborador.

 

removeFavoriteProcess

Remove

um

processo

dos

favoritos

do

colaborador

informado.

 

Método:

addProcessToFavorites(String username, String password,

int companyId,String processId, String colleagueId)

Parâmetros:

 

username: login do colaborador;

 

password: senha do colaborador;

companyId: código da empresa;

processId: código do processo

 

39

ECM - Webservices  colleagueId : matrícula do colaborador. Quadro 5: Métodos da FavoritesService Exemplo

ECM - Webservices

 colleagueId : matrícula do colaborador.

colleagueId : matrícula do colaborador.

Quadro 5: Métodos da FavoritesService

Exemplo de utilização

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

40

ECM - Webservices CompanyService Webservices responsável por realizar operações referentes à empresa no ECM. Pode

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

No

CompanyService.

quadro

6,

é

mostrado

todos

os

métodos

disponíveis

na

classe

getCompanies

Retorna todas as empresas cadastradas no ECM.

 

Método:

getCompanies(String

username,

String

password,

String

companyId)

 

Parâmetros:

username: login do colaborador;

 

password: senha do colaborador;

companyId: código da empresa.

Retorno: CompanyDto[].

 

getCompany

Retorna uma empresa cadastrada no ECM.

 

Método:

getCompany(int companyId)

 

Parâmetros:

companyId: código da empresa.

 

Retorno: CompanyDto.

 

createCompany

Cria uma empresa no ECM.

 

Método:

createCompany(String username, String password, String companyId, String description, String urlAccessName, String phisicalPath, String webdeskServer, String webPort)

Parâmetros:

 

username: login do colaborador;

 

password: senha do colaborador;

companyId: código da empresa;

 

41

ECM - Webservices    description: descrição da empresa;  urlAccessName: URL de acesso; 

ECM - Webservices

 

description: descrição da empresa;

urlAccessName: URL de acesso;

phisicalPath: caminho físico;