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 Fluig são criados pelo administrador, a partir do plugin Fluig Designer. No projeto Fluig, clique com o botão direito sobre a pasta events e em seguida Novo -> Evento Global Fluig conforme a figura abaixo.

Image Added

Figura 1 - Criação de evento - Fluig Designer.

Em seguida basta informar o Servidor e o Nome do Evento que será adicionado. Uma tela para edição do evento será aberta, conforme imagem a seguir:

Image Added

Figura 2 - Criação de evento - Fluig Designer.

É possível observar também que o arquivo .js foi adicionado a pasta events do projeto.

O Fluig permite utilizar o log de execução nos eventos de customização. Através da variável global “log” é possível obter o feedback da execução de cada evento. Existem quatro níveis de log, são eles:

ERROR: apresentação de erros.
DEBUG: depurar a execução.
WARN: informar possível problema de execução.
INFO: apresentação de mensagens.

A apresentação de cada um dos tipos de log está condicionada a configuração do servidor de aplicação. Por exemplo, no JBoss®, por padrão, as mensagens do tipo info e warn são apresentadas no console do servidor e as do tipo debug, error são apresentadas no arquivo de log. Abaixo um exemplo de uso do log em script:

Bloco de código

language	java

            log.info(“Testando o log info”);

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

A seguir serão detalhados os eventos disponíveis no Fluig.

AddDocumentConvertionExt

Este evento permite customizar a conversão de documento realizada pelo Fluig. Mais informações sobre ele podem ser encontradas no guia Conversores de Documentos.

DisplayCentralTasks

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:

Bloco de código

language	java

function displayCentralTasks (links){
links.put("Fluig","http://www.fluig.com");
}

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

Bloco de código

language	java

function displayCentralTasks (links){
	var _links = new java.util.LinkedHashMap();
	_links.put("Fluig","http://www.fluig.com");                                     
    var it = links.keySet().iterator();
    while (it.hasNext()) {           
       var key = it.next();
       _links.put(key, links.get(key));
	}             
	_links.put("Fluig - DEV" ,"http://dev.fluig.com");
	_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.

WKUser	Código do usuário
WKCompany	Número da empresa

Bloco de código

language	java
title	Exemplo

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

DisplayCustomMetadata

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.

Bloco de código

language	java
title	Exemplo

function displayCustomMetadata(fields){
}

No contexto deste evento a variável fields pode ser usada para consultar ou modificar os valores dos campos customizados de um documento. Não permitindo adicionar novos campos.

Para inserir novos campos em um documento existe varias maneiras disponíveis.

- Pela herança da pasta pai

- No cadastro de Campos Customizados, marcando a opção “Mostrar em todos documentos” ou da forma padrão

- Através do WebService CustomFieldsService

- Na edição dos metadados do documento, pelo usuário.

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.

WKUser	Código do usuário
WKCompany	Número da empresa
WKNumParentDocument	Número da pasta pai
WKDocumentType	Tipo do documento
WKPrivateDocument	Se o documento esta sendo publicado na pasta particular (true/false)

Exemplo:

function displayCustomMetadata(fields){

log.info("Usuário: “ + getValue("WKUser "));

}

ValidateCustomMetadata

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){

}

No contexto deste evento a variável fields pode ser usada para consultar ou modificar os valores dos campos customizados de um documento. Não permitindo adicionar novos campos.

Para inserir novos campos em um documento existe varias maneiras disponíveis.

- Pela herança da pasta pai

- No cadastro de Campos Customizados, marcando a opção “Mostrar em todos documentos” ou da forma padrão

- Através do WebService CustomFieldsService

- Na edição dos metadados do documento, pelo usuário.

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.

WKUser	Código do usuário
WKCompany	Número da empresa
WKNumParentDocument	Número da pasta pai
WKDocumentType	Tipo do documento
WKPrivateDocument	Se o documento esta sendo publicado na pasta particular (true/false)
WKNumAcess	Numero de acessos
WKComments	Comentários do documento
WKAuthor	Código do autor do documento
WKCreateDate	Data de criação do documento
WKDescription	Descrição do documento
WKNumDocument	Número do documento
WKNumVersion	Número da versão do documento
WKExpirationDate	Data de expiração do documento
WKExpires	Documento expira? (true/false)
WKFileSize	Tamanho do documento em bytes
WKKeyWord	Palavras chaves do documento
WKVolume	Volume do documento
WKSubject	Assunto relacionado ao documento

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.

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.

Propriedade	Descrição	Tipo
WKDocument	Objeto do Documento	DocumentDto
WKSubject	Descrição do Assunto do documento.	String
WKListApprover	Lista dos Aprovadores do documento.	List<ApproverDto>
WKListSecurity	Lista com a segurança do documento.	List <DocumentSecurityConfigDto>
WKListRelatedDocument	Lista com os documentos relacionados ao documento.	List< RelatedDocumentDto>
WKState	Estado da ação: PUBLISH ou MODIFY	String
WKUser	Usuário logado.	String
WKCompany	Código da Empresa	int

Obs.: Os objetos Dto’s serão explicados no capítulo “Objetos utilizados nos eventos”

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.

Propriedade	Descrição	Tipo
WKDocument	Objeto do Documento	DocumentDto
WKUser	Usuário logado.	String
WKCompany	Código da Empresa	int

Obs.: Os objetos Dto’s serão explicados no capítulo “Objetos utilizados nos eventos”

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");

}

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.

DocumentDto

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

Função	Descrição da Função	Tipo do Retorno
getDocumentId()	Retorna o número do documento.	int
getVersion()	Retorna o número da versão do documento.	int
getCompanyId()	Retorna o código da empresa em que o documento foi publicado.	Int
getUUID()	Retorna o UUID (identificador Único Global) do documento.	String
getDocumentTypeId()	Retorna o tipo do arquivo físico, se retornar branco ou nulo é porque esse tipo não é conhecido pelo ECM.	String
getLanguageId()	Retorna o código do Idioma do documento.	String
getIconId()	Retorna o código do Ícone do documento.	int
getTopicId()	Retorna o código do assunto do documento.	int
getColleagueId()	Retorna a matricula do colaborador que criou o documento.	String
getDocumentDescription()	Retorna a descrição do documento.	String
getAdditionalComments()	Retorna os comentários adicionais do documento.	String
getPhisicalFile()	Retorna o caminho físico onde o documento está armazenado.	String
getCreateDate()	Retorna a data de criação.	java.util.Date
getApprovedDate()	Retorna a data de Aprovação.	java.util.Date
getLastModifiedDate()	Retorna a Data da última modificação.	java.util.Date
getDocumentType()	Retorna o tipo do documento, onde: 0à Pasta raiz 1à Pasta 2à Documento normal 3à Documento externo 4à Fichário 5à Ficha 7à Anexo Workflow 8àNovo Conteúdo 9àAplicativo 10à Relatório portalàSite portalPageàPágina de Site	String
getExpirationDate()	Retorna a data de expiração.	java.util.Date
getParentDocumentId()	Retorna o número da Pasta/Fichário pai	int
getRelatedFiles()	String com o nome do arquivo físico principal e anexos.	String
getActiveVersion()	Retorna se a versão é ativa.	boolean
getVersionDescription()	Retorna a descrição da versão.	String
getDownloadEnabled()	Retorna se o documento permite Download	boolean
getApproved()	Retorna se o documento está em aprovação.	boolean
getValidationStartDate()	Retorna a partir de que data em que o documento poderá ser visualizado.	java.util.Date
getPublisherId()	Retorna a matricula do colaborador que publicou o documento.	String
getCardDescription()	Retorna a descrição da ficha, para documento do tipo 5.	String
getDocumentPropertyNumber()	Retorna o fichário que foi usado como base para criação da ficha, por isso só tem um valor quando o documento é do tipo 5 (ficha).	int
getDocumentPropertyVersion()	Retorna a versão do fichário em que a ficha foi criada.	int
getPrivateDocument()	Retorna se o documento/pasta está abaixo da pasta particular.	boolean
getPrivateColleagueId()	Se é um documento particular retorna a matricula do colaborador onde este documento está alocado.	String
getIndexed()	Retorna se o documento já foi indexado.	boolean
getPriority()	Retorna a prioridade do documento.	int
getUserNotify()	Retorna se notifica os usuários que tenham esse assunto de interesse.	boolean
getExpires()	Retorna se o documento está expirado.	boolean
getVolumeId()	Retorna o volume onde o documento foi publicado, se estiver em branco ele utiliza o volume do pai.	String
getInheritSecurity()	Retorna se herda segurança do pai.	boolean
getUpdateIsoProperties()	Retorna se atualiza as propriedades da cópia controlada.	boolean
getLastModifiedTime()	Retorna a hora da última modificação em milissegundos.	String
getDeleted()	Retorna se o documento está na lixeira.	boolean
getDatasetName()	Retorna o documento do dataset , se o documento é um fichário.	String
getKeyWord()	Retorna as palavras chaves do documento. Cada palavra é separada por vírgula.	String
getImutable()	Retorna se a versão/revisão é inalterável.	boolean
getDraft()	Retorna se o documento está em edição, para documento do tipo “Novo Conteúdo”.	boolean
getInternalVisualizer()	Retorna se utiliza visualizador interno.	boolean
getPhisicalFileSize()	Retorna o tamanho físico do documento principal e anexos.	float

Exemplo de utilização:

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:

Função	Descrição da Função	Tipo do Retorno
getDocumentId()	Retorna o número do documento.	int
getVersion()	Retorna o número da versão do documento.	int
getCompanyId()	Retorna o código da empresa em que o documento foi publicado.	Int
getColleagueId()	Retorna a matricula de um colaborador ou o código do grupo que está aprovando este documento. É possível saber se vai retornar um colaborador ou um grupo pelo tipo de aprovação.	String
getApproverType()	Retorna o tipo da aprovação, onde: 0 à Colaborador 1à Grupo	int
getLevelId()	Retorna o nível de aprovação, no caso de aprovação em níveis.	int

Exemplo de utilização:

var listApprover = getValue("WKListApprover");

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 aprovadores de documentos";

}

DocumentSecurityConfigDto

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

Função	Descrição da Função	Tipo do Retorno
getDocumentId()	Retorna o número do documento.	int
getVersion()	Retorna o número da versão do documento.	int
getCompanyId()	Retorna o código da empresa em que o documento foi publicado.	Int
getAttributionValue()	Retorna a matricula de um colaborador ou o código do grupo que está na segurança deste documento. É possível saber se vai retornar um colaborador ou um grupo pelo tipo da segurança. Obs.: Retorna em branco quando o tipo é todos os usuários.	String
getAttributionType()	Retorna o tipo da segurança, onde: 1 à Colaborador; 2à Grupo; 3à Todos os Usuários.	int
getPermission()	Retorna se é uma permissão. Obs.: Se não é uma permissão é uma restrição.	boolean
getShowContent()	Retorna se lista o conteúdo.	boolean
getSecurityLevel()	Retorna no nível de permissão/restrição, onde: -1à sem permissão/restrição (nega acesso); 0à Leitura; 1àGravação; 2à Modificação; 3à Total.	int
getSequence()	Retorna a sequência da permissão/restrição.	int
getSecurityVersion()	Retorna se ele utiliza a segurança deste versão nas demais.	boolean

Exemplo de utilização:

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

Função	Descrição da Função	Tipo do Retorno
getDocumentId()	Retorna o número do documento.	int
getVersion()	Retorna o número da versão do documento.	int
getCompanyId()	Retorna o código da empresa em que o documento foi publicado.	int
getRelatedDocumentId()	Retorna o número do documento que está relacionado ao documento publicado.	int

Exemplo de utilização:

var listRelated = getValue("WKListRelatedDocument");

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());

}

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 1

Nova versão 2

Chave

Customização de Eventos

AddDocumentConvertionExt

DisplayCentralTasks

DisplayCustomMetadata

ValidateCustomMetadata

BeforeDocumentPublisher

AfterDocumentPublisher

BeforeDocumentViewer

Objetos utilizados nos eventos

DocumentDto

ApproverDto

DocumentSecurityConfigDto

RelatedDocumentDto

Atalhos

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 1

Nova versão 2

Chave

Customização de Eventos

AddDocumentConvertionExt

DisplayCentralTasks

DisplayCustomMetadata

ValidateCustomMetadata

BeforeDocumentPublisher

AfterDocumentPublisher

BeforeDocumentViewer

Objetos utilizados nos eventos

DocumentDto

ApproverDto

DocumentSecurityConfigDto

RelatedDocumentDto