Para ter acesso a funções relacionadas a documentos é possível utilizar nos eventos a variável global docAPI. Os métodos disponíveis através da docAPI são:
Informações |
---|
|
Utilizamos padrões de desenvolvimento de mercado portanto, ao utilizar os métodos e classes abaixo, atente-se às boas práticas de desenvolvimento JAVA. |
| |
---|
copyDocumentToUploadArea(documentId, version) | Copia os arquivos físicos de um documento existente para a área de upload do usuário logado, onde: - documentId: id do documento a ser copiado;
- version: versão do documento a ser copiado;
Retorno: Array de Strings contendo os nomes dos arquivos que foram disponibilizados na área de upload. |
createDocument(document, attachments, securityConfig, approvers, relatedDocs) | Cria um novo documento no GED de acordo com os parâmetros informados, onde: - document: documento a ser criado;
- attachments: lista de anexos do documento;
- securityConfig: lista de configurações de segurança do documento;
- approvers: lista de aprovadores do documento;
- relatedDocs: lista de documentos relacionados ao documento;
Retorno: DocumentDto do documento criado. Exemplo de utilização desta função em conjunto com a função copyDocumentToUploadArea: |
1234
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
function
beforeStateEntry(sequenceId) |
|
{
if
(sequenceId == 5) {
var
attachments = {
if (sequenceId == 5) {
var attachments = hAPI.listAttachments(); |
|
for
(
var
i = 0; i <
for ( var i = 0; i < attachments.size(); i++) |
|
{
var
docDto = {
var docDto = attachments.get(i); |
|
if
if (docDto.getDocumentType() == |
|
{
{
docAPI.copyDocumentToUploadArea(docDto.getDocumentId(), docDto.getVersion()); |
|
// Criar uma pasta para armazenar os anexos como documentos, concedendo à mesma as permissões de segurança e aprovação necessárias
docDto.setParentDocumentId(20); |
|
var
attachArray =
new
var attachArray = new java.util.ArrayList(); |
|
var
mainAttach =
var mainAttach = docAPI.newAttachment(); |
|
mainAttach.setFileName(docDto.getPhisicalFile()); |
|
mainAttach.setPrincipal(true); |
|
mainAttach.setAttach(false); |
|
attachArray.add(mainAttach);
try
{
var
doc =
attachArray.add(mainAttach);
// Adicionando aprovadores
docDto.setActiveVersion(true);
docDto.setColleagueId(getValue("WKUser")); // Informar o usuário logado.
docDto.setPublisherId(getValue("WKUser")); // Informar o publicador.
var aprovador = docAPI.newApproverDto();
aprovador.setCompanyId(getValue("WKCompany"));
aprovador.setColleagueId(getValue("WKUser")); // Informar o aprovador
aprovador.setDocumentId(documentoId);
aprovador.setVersion(1); // Versão do documento
aprovador.setLevelId(1); // Nível de aprovação
aprovador.setApproverType(0); //Tipo de aprovadores (0 = Colaboradores, 1 = Grupo)
var aprovadoresArray = new java.util.ArrayList();
aprovadoresArray.add(aprovador);
try {
var doc = docAPI.createDocument(docDto, attachArray, |
|
null
log.info("DOCUMENTO CRIADO COM O ID: " |
|
}
catch
{
{
log.error("Problemas na criação do documento:\n" |
|
}
}
}
}
|
createFolder(document, securityConfig, approvers) | Cria uma nova pasta no GED de acordo com os parâmetros informados, onde: - document: pasta a ser criada;
- securityConfig: lista de configurações de segurança da pasta;
- approvers: lista de aprovadores da pasta;
Retorno: DocumentDto da pasta criada. Exemplo de utilização desta função: |
123
4
5
6
7
8
9
10
11
12
13
14
function
afterProcessFinish(processId) |
|
{
try
{
var
dto = {
try {
var dto = docAPI.newDocumentDto(); |
|
dto.setDocumentDescription("Planilhas"); |
|
dto.setDocumentType("1"); |
|
dto.setParentDocumentId(20); |
|
dto.setDocumentTypeId(""); |
|
var
folder =
var folder = docAPI.createFolder(dto, |
|
log.info("PASTA CRIADA COM O ID :" |
|
+ folder.getDocumentId()); |
|
}
catch
{
{
log.error("Problemas na criação da pasta:\n" |
|
}
Informações |
---|
O parâmetro publisherId do objeto DocumentDTO não será considerado quando a publicação for realizada via script em um evento de processo. Esse parâmetro só pode ser definido na criação do objeto via WebService. |
Confira um exemplo de como criar pastas definindo sua segurança por grupos e usuários clicando aqui. |
getDocumentVersion(documentId, version) | Retorna o DocumentDto de um documento com base no seu id e sua versão, onde: - documentId: id do documento a ser retornado;
- version: versão do documento a ser retornado;
|
getUserPermissions(documentId, version) | Retorna o nível de permissão do usuário logado no documento informado, onde: - documentId: id do documento;
- version: versão do documento;
|
isUserInGroup(group) | Retorna se o usuário logado faz parte do grupo informado, onde: - group: código do grupo a ser verificado;
|
newAttachment() | Retorna uma nova instância de Attachment. |
newRelatedDocumentDto() | Retorna uma nova instância de RelatedDocumentDto. |
newDocumentSecurityConfigDto() | Retorna uma nova instancia de DocumentSecurityConfigDto. |
newApproverDto() | Retorna uma nova instância de ApproverDto. |
newDocumentDto() | Retorna uma nova instância de DocumentDto, com o tipo 2 (Documento) como padrão. |
Informações |
---|
Veja o exempo (create-advanced-folder) em nosso repositório aqui. |