Customização de Eventos

A customização de eventos é realizada pela criação de scripts na linguagem “JavaScript”. O código de implementação de cada script é armazenado em banco de dados e dispensa o uso de quaisquer outros arquivos, como por exemplo, “custom.p”. Os eventos de customização para o TOTVS | ECM são criados pelo administrador, na seção eventos, conforme a figura abaixo.

...

Abaixo um exemplo de uso do log em script:

Teríamos no console do servidor a mensagem “Testando o log info”.

...

AdddocumentConvertionExt

Este evento permite customizar a conversão de documento realizada pelo ECM. Mais informações sobre ele podem ser encontradas no “Guia de Referência Customização de Conversores”.

DizplayCentralTasks

Este evento é disparado sempre antes de ser exibida a central de tarefas. Através dele é possível inserir, alterar ou remover os links da central de tarefas. O evento recebe como parâmetro um LinkedHashMap com os links disponíveis na central de tarefas.
Exemplo adicionando um link customizado ao final dos itens da central de tarefas:

...

Exemplos alterando a ordem de exibição dos links padrões e adicionando três novos, um no início e dois ao final:

function displayCentralTasks (links){
var _links = new java.util.LinkedHashMap();
_links.put("Totvs","http://www.totvs.com");
var it = links.keySet().iterator();
while (it.hasNext()) {
            var key = it.next();
_links.put(key, links.get(key));
}
_links.put("Totvs ECM" ,"http://www.totvs.com/tecnologia/ecm");
_links.put("Google","http://www.google.com.br/search?sourceid=chrome&ie=UTF-8&q=" + getValue("WKUser"));


links.clear();
links.putAll(_links);
}

...

Disponibilizamos algumas informações sobre o usuário e a empresa, porem somente para consulta através do método getValue.

...

function displayCentralTasks (links){log.info("Usuário: “ + getValue("WKUser"));}

DisplayCustomMetadada

Este evento é disparado sempre antes de ser exibidos os campos customizados de um documento, tanto na publicação como edição. Através dele é possível sugerir valores iniciais para campos customizados dos metadados de um documento. O evento recebe como parâmetro uma referência aos campos customizados.

Exemplo:

function displayCustomMetadata(fields){}

...

Para consultar o valor de um campo customizado neste evento, utiliza-se o fields.getValue passando como parâmetro o código do campo desejado. Retornando “null”, casso o campo não esteja disponível para este documento.

Exemplo:

function displayCustomMetadata(fields){log.info("Valor do Campo 1: “ + fields.getValue("campo1"));}

...

Já pra a edição utiliza-se o fields.setValue, passando como parâmetro, primeiro o nome do campo, em seguida o valor.

Exemplo:

function displayCustomMetadata(fields){fields.setValue("campo1","Valor para o Campo 1");}

...

Alem dos valores dos campos customizados disponibilizamos algumas informações do documento que esta sendo criado ou editado, porem somente para consulta através do método getValue.

Exemplo:

function displayCustomMetadata(fields){log.info("Usuário: “ + getValue("WKUser "));}

ValidateCustomMetadada

Este evento é disparado sempre antes de salvar os valores dos campos customizados de um documento, tanto na publicação como edição. Através dele é possível alterar ou validar os valores dos campos customizados dos metadados de um documento. O evento recebe como parâmetro uma referência aos campos customizados.

Exemplo:

function validateCustomMetadata(fields){}

...

Para consultar o valor de um campo customizado neste evento, utiliza-se o fields.getValue passando como parâmetro o código do campo desejado. Retornando “null”, casso o campo não esteja disponível para este documento.

Exemplo:

function validateCustomMetadata (fields){log.info("Valor do Campo 1: “ + fields.getValue("campo1"));}

...

Já pra a edição utiliza-se o fields.setValue, passando como parâmetro, primeiro o nome do campo, em seguida o valor.

Exemplo:

function validateCustomMetadata (fields){fields.setValue("campo1","Valor para o Campo 1");}

...

Alem dos valores dos campos customizados disponibilizamos algumas informações do documento que esta sendo criado ou editado, porem somente para consulta através do método getValue.

Exemplo:

function validateCustomMetadata (fields){log.info("Usuário: “ + getValue("WKUser "));}

...

As exceções podem ser tratadas utilizando o comando throw. Este comando retornará uma mensagem ao usuário ao tentar salvar o documento.

Exemplo:

function validateCustomMetadata (fields){if( fields.getValue("campo1") == “Area 1”){throw "TRATAMENTO DA EXCEÇÃO";}}

BeforeDocumentPublisher

Utilizado quando é preciso fazer validação customizada nas propriedades da tela de publicação/edição de documentos antes de salva-lo no banco de dados. Dentre todas as propriedades da tela de publicação/edição de documentos não serão tratados os campos customizados, pois já existe um evento que trata esta situação.

Exemplo:

function beforeDocumentPublisher(){ }

...

São disponibilizadas algumas propriedades referentes ao documento que esta sendo criado ou editado, porem somente para consulta através do método getValue.

...

O produto retorna null quando for necessário pegar umas das propriedades do documento que não exista. Por exemplo: Nem todos os documentos publicados tem aprovador, então a variável WKListApprover só terá informações quando realmente existirem aprovadores na publicação.

Exemplo:

function beforeDocumentPublisher(){
       var doc = getValue("WKDocument");
       var subject = getValue("WKSubject");
       var listApprover = getValue("WKListApprover");
       var listSeg = getValue("WKListSecurity");
       var listRelated = getValue("WKListRelatedDocument");´
       var state = getValue("WKState");
       var user = getValue("WKUser");
       var company = getValue("WKCompany");
 
       log.info("Usuário Logado: " + user);
 
       log.info("Empresa: " + company);
 
       log.info("Número do documento: "+ doc.getDocumentId() + " - Versão: "+ 
doc.getVersion());
 
       if(listApprover!=null){
        for(j = 0; j < listApprover.size(); j++) {
          if (listApprover.get(j).getColleagueId().equals("adm")){
           throw "O usuário adm não pode ser aprovador de documentos";
        } 
    } 
} 
       if(listSeg != null){
        for(j = 0; j < listSeg.size(); j++) {
          if (listSeg.get(j).getAttributionValue().equals("cvd")){
           throw "O usuário cvd não pode estar na segurança de documentos"; 
    } 
  } 
}
        if( listRelated != null){
          log.info("Os seguintes documentos estão relacionados a este documentos: ");
            for(j = 0; j < listRelated.size(); j++) {
              log.info("Nr. documento: "+ listRelated.get(j).getRelatedDocumentId());
   } 
}
       log.info("Assunto: " + subject);
       log.info("Estado: " + state);
}

AfterDocumentPublisher

Utilizado quando é preciso fazer alguma manipulação customizada nas propriedades da tela de publicação/edição de documentos depois que ele foi salvo no banco de dados. Dentre todas as propriedades da tela de publicação/edição de documentos não serão tratados os campos customizados.

Exemplo:

function afterDocumentPublisher(){ }

As propriedades recuperadas através do método getValue() são as mesmas do eventos beforeDocumentPublisher e a forma de manipulação das propriedades pode ser vista no exemplo do evento beforeDocumentPublisher.

BeforeDocumentViewer

Utilizado quando é preciso fazer validação customizada antes da visualização de algum documento.

Exemplo:

function beforeDocumentViewer (){ }

...

São disponibilizadas algumas propriedades referentes ao documento que esta sendo visualizado, porem somente para consulta através do método getValue.

Exemplo:

function beforeDocumentViewer(){ 
         var doc = getValue("WKDocument"); 
         var company = getValue("WKCompany");
   var ds
   try {
         var c1 = DatasetFactory.createConstraint("allocatedDocumentPK.companyId", company, company, ConstraintType.MUST);
         var c2 = DatasetFactory.createConstraint("allocatedDocumentPK.sourceDocument", doc.getDocumentId(), doc.getDocumentId(), ConstraintType.MUST);
         var c3 = DatasetFactory.createConstraint("allocatedDocumentPK.sourceVersion", doc.getVersion(), doc.getVersion(), ConstraintType.MUST);
         var c4 = DatasetFactory.createConstraint("active", "true","true", ConstraintType.MUST);
         var constraints = new Array(c1, c2, c3, c4);
         ds = DatasetFactory.getDataset("allocatedDocument", null, constraints, null);
   }catch (e) {
         log.error("Erro ao tentar recuperar o documento em CheckOut: " + e.message);
         }
   if(ds!=null && ds.rowsCount>0){
        throw "Este documento está em Check Out e não pode ser visualizado. Foi gerado o documento " + ds.getValue(0,"allocatedDocumentPK.destinationDocument") + " que está sob responsabilidade do colaborador com matrícula "+ ds.getValue(0,"colleagueId");
        }
   }

AfterSaveCard

Utilizado quando ao criar/salvar os dados de uma ficha pelo GED ou por movimentações workflow se deseja salvar os dados da ficha em uma forma externa. Por exemplo, ao criar a ficha, enviar os dados da ficha para um Webservice de outro produto.

Exemplo:

function afterSaveCard(companyId, formId, cardId, versionId, cardData){}

Sendo os parâmetros:

Exemplo:

function afterSaveCard(companyId, formId, cardId, versionId, cardData){
  var custom = ServiceManager.getService("CustomCard");
  var serviceHelper = custom.getBean();
  var serviceLocator =
serviceHelper.instantiate("com.totvs.technology.webdesk.forms.service.custom.CustomCardServiceLocator");
  var service = serviceLocator.getCustomCardPort();
  var ar = new Array();
  var it = cardData.keySet().iterator();
  while (it.hasNext()) {
    var key = it.next();
    var field1 =
serviceHelper.instantiate("com.totvs.technology.webdesk.forms.service.custom.CardKeyValue");
 
    field1.setKey(key);
             field1.setValue( cardData.get(key));
    log.info('>' + key + ': ' + cardData.get(key));
 
    ar.push(field1);
}
   var resultArr =
serviceHelper.instantiate("com.totvs.technology.webdesk.forms.service.custom.CardKeyValueArray");
   resultArr.setItem(ar);
   service.create(companyId, formId, cardId, versionId, resultArr);
}

AfterDeleteCard

Utilizado como complemento do evento afterSaveCard. É chamado toda vez que um fichário ou uma ficha é eliminado da lixeira.

Exemplo:

function afterDeleteCard(companyId,cardId){
   var custom = ServiceManager.getService("CustomCard");
   var serviceHelper = custom.getBean();
   var serviceLocator =
serviceHelper.instantiate("com.totvs.technology.webdesk.forms.service.custom.CustomCardServiceLocator");
   var service = serviceLocator.getCustomCardPort();
   log.info("########## carregou serviço CustomCard");
   service.deleteCard(companyId, cardId);
}

Sendo os parâmetros:

...

Objetos Utilizados nos Eventos

Existem alguns objetos disponibilizados pelo produto que são utilizados nos eventos, nas próximas sessões eles serão explicados seus métodos e seus retornos.

...

var doc = getValue("WKDocument"); 
log.info("Número do documento: "+ doc.getDocumentId() + " - Versão: "+ doc.getVersion());

ApproverDto

Este objeto que representa os aprovadores e suas propriedades, na tabela abaixo consta mais informações sobre ele:

...

DocumentSegurityConfigDto

Este objeto que representa a segurança de um documento e suas propriedades, na tabela abaixo consta mais informações sobre ele:

...

var listSeg = getValue("WKListSecurity");
if(listSeg != null){
   for(j = 0; j < listSeg.size(); j++) {
       if (listSeg.get(j).getAttributionValue().equals("cvd")){
           throw "O usuário cvd não pode estar na segurança de documentos";
         }
    }
}

RelatedDocumentDto

...

Customização de Eventos JMS

O ECM tem customização de eventos JMS, permitindo criar procedimentos de auditoria com base nas informações fornecidas pelo produto. O JMS (Java Message Service) é uma API Java™ que provê uma conexão assíncrona entre aplicações por meio de troca de mensagens. O produto dispara dois tipos de mensagens JMS customizáveis, o wdkDocument e o wdkAbstract.

...

• userId (String): Usuário que efetuou a ação;
• entity (String): Entidade do objeto que está sendo manipulado, conforme a tabela de objeto que já foi apresentada acima.
• mapNewVersion (byte[ ]): Array de bytes de um HashMap<String, Object> com as propriedade do objeto.
• mapPreviousVersion (byte[ ]): Array de bytes de um HashMap<String, Object> com as propriedade do objeto antes da alteração.

...