...

Os eventos de customização para o Fluig são criados pelo administrador, a partir do Fluig Studio. No projeto Fluig, clique com o botão direito sobre a pasta events pasta events e em seguida seguida Novo -> Evento Global Fluig conforme conforme a figura abaixo.

Image RemovedImage Added

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

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 Studio.

É possível observar também que o arquivo .js foi adicionado a pasta pasta events do 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 apresentação de erros.
DEBUG: depurar depurar a execução.
WARN: informar informar possível problema de execução.
INFO: apresentação 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.

...

Pela herança da pasta pai.
No cadastro de Campos Customizados, marcando a opção opção Mostrar em todos documentos ou ou da forma padrão.
Através do WebService CustomFieldsService.
Na edição dos metadados do documento, pelo usuário.

...

Bloco de código

language	java
title	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.

Bloco de código

language	java
title	Exemplo

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

...

Bloco de código

language	java
title	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 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.

...

WKUser	Código do usuário
WKCompany	Número da empresa
WKNumParentDocument	Número da pasta pai
WKDocumentType	Tipo do documento
WKDocumentTypeId	ID do tipo de documento
WKPrivateDocument	Se o documento esta sendo publicado na pasta particular (true/false)
WKNumAcess	Número 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

...

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

Informações

title	Nota

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

O produto retorna retorna null quando 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 variável WKListApprover só só terá informações quando realmente existirem aprovadores na publicação.

Bloco de código

language	java
title	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.

Bloco de código

language	java
title	Exemplo

function afterDocumentPublisher(){
}

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

BeforeDocumentViewer

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

...

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

Informações

title	Nota

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

Bloco de código

language	java
title	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 usuário com matrícula "+ ds.getValue(0,"colleagueId");
                }
}

...

Propriedade	Descrição	Tipo
companyId	Código da Empresa	int
formId	Código do Formulário	int
cardId	Código do Registro de Formulário	int
versionId	Versão do Registro de Formulário	int
cardData	Dados do Registro de Formulário	Hashmap <String, String>

...

Bloco de código

language	java
title	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); 
}

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 Fluig.	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 usuário 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 usuário 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 usuário 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

Bloco de código

language	java
title	Exemplo

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

ApproverDto

BeforeWatchContent

Utilizado quando ao acompanhar algum conteúdo se deseja recuperar informações do registro e usar antes da ação de "acompanhar". Por exemplo, ao acompanhar um documento, é possível recuperar suas informações e usá-las em um dataset.

Bloco de código

language	java
title	Exemplo

function beforeWatchContent(companyId, watchDTO){
}

Sendo os parâmetros:

Propriedade	Descrição	Tipo
companyId	Código da Empresa	int
watchDTO	Dados do registro	WatchDTO

Bloco de código

language	java
title	Exemplo

function beforeWatchContent(companyId, watchDTO){
	if(watchDTO.getSocialWatchType() == "DOCUMENT"){
		var objClass = "com.totvs.technology.social.document.6";
		var objClass = watchDTO.getObjectClass();
		var patt = new RegExp( /\d+/) ; 
		var documentId = patt.exec(objClass) ;
		var documentVersion = watchDTO.getObjectId();
		var doc = getValue("WKDocument"); 
		var company = companyId; 
		var ds ;
		try { 
			var c1 = DatasetFactory.createConstraint( "allocatedDocumentPK.companyId", company, company, ConstraintType.MUST); 
			var c2 = DatasetFactory.createConstraint("allocatedDocumentPK.sourceDocument",documentId,documentId, ConstraintType.MUST); 
			var c3 = DatasetFactory.createConstraint("allocatedDocumentPK.sourceVersion", documentVersion,documentVersion, 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  "Sua solicita&ccedil;&atilde;o de notifica&ccedil;&atilde;o foi negada, pois o documento est&aacute; em checkout." ; 
		}
	}
}

AfterWatchContent

Utilizado quando ao acompanhar algum conteúdo se deseja recuperar informações do registro e usar após a ação de "acompanhar". Por exemplo, ao acompanhar um post, é possível recuperar suas informações e usá-las para informar o usuário sobre o autor do post.

Bloco de código

language	java
title	Exemplo

function afterWatchContent(companyId, watchDTO){	
}

Sendo os parâmetros:

Propriedade	Descrição	Tipo
companyId	Código da Empresa	int
watchDTO	Dados do registro	WatchDTO

Bloco de código

language	java
title	Exemplo

function afterWatchContent(companyId, watchDTO){
	if(watchDTO.getSocialWatchType() == "POST"){
		throw "O usu&aacute;rio "+watchDTO.getUserAlias()+" vai ser notificado sobre o post " + watchDTO.getText() + " do autor " + watchDTO.getPostAuthor() ;
	}
}

BeforeUnwatchContent

Utilizado quando ao deixar de acompanhar algum conteúdo se deseja recuperar informações do registro e usar antes da ação de "deixar de acompanhar". Por exemplo, ao tentar deixar de acompanhar uma comunidade, é possível decidir se o usuário pode deixar de acompanhá-la.

Bloco de código

language	java
title	Exemplo

function beforeUnwatchContent(companyId, watchDTO){
}

Sendo os parâmetros:

Propriedade	Descrição	Tipo
companyId	Código da Empresa	int
watchDTO	Dados do registro	WatchDTO

Bloco de código

language	java
title	Exemplo

function beforeUnwatchContent(companyId, watchDTO){
	if(watchDTO.getSocialWatchType() == "COMMUNITY"){
		
		throw "Voc&ecirc; n&atilde;o pode deixar de ser notificado sobre a comunidade " + watchDTO.getDescription() ;
	}
}

AfterUnwatchContent

Utilizado quando ao deixar de acompanhar algum conteúdo se deseja recuperar informações do registro e usar após a ação de "deixar de acompanhar". Por exemplo, ao deixar de acompanhar um post, é possível recuperar suas informações e informar o usuário que aquele post possui muitos seguidores.

Bloco de código

language	java
title	Exemplo

function afterUnwatchContent(companyId, watchDTO){
}

Sendo os parâmetros:

Propriedade	Descrição	Tipo
companyId	Código da Empresa	int
watchDTO	Dados do registro	WatchDTO

Bloco de código

language	java
title	Exemplo

function afterUnwatchContent(companyId, watchDTO){
	if(watchDTO.getSocialWatchType() == "POST" && watchDTO.getNumberWatchers() < 3 ){
		log.erro("O post   \"" + watchDTO.getText() + "\" do autor " + watchDTO.getPostAuthor() + " deixou de ser polemico" )
	}
}

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 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 Fluig.	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 usuário 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 usuário 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 usuário 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

Bloco de código

language	java
title	Exemplo

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

ApproverDto

Este objeto 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 usuário ou o código do grupo que está aprovando este documento. É possível saber se vai retornar um usuário ou um grupo pelo tipo de aprovação.	String
getApproverType()	Retorna o tipo da aprovação, onde: 0 à Usuário 1 à Grupo	int
getLevelId()	Retorna o nível de aprovação, no caso de aprovação em níveis.	int

Bloco de código

language	java
title	Exemplo

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 representa a segurança de um documento 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
getColleagueIdgetAttributionValue()	Retorna a matricula de um usuário ou o código do grupo que está aprovando este na segurança deste documento. É possível saber se vai retornar um usuário ou um grupo pelo tipo de aprovaçãoda segurança.	String
getApproverType()	Retorna o tipo da aprovação, onde: 0 à Usuário 1 à Grupo	int
getLevelId()	Retorna o nível de aprovação, no caso de aprovação em níveis.	int

Bloco de código

language	java
title	Exemplo

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 usuário ou o código do grupo que está na segurança deste documento. É possível saber se vai retornar um usuário 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 à Usuário; 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

Obs.: Retorna em branco quando o tipo é todos os usuários.	String
getAttributionType()	Retorna o tipo da segurança, onde: 1 à Usuário; 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

Bloco de código

language	java
title	Exemplo

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

Este objeto representa os documentos relacionados 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
getRelatedDocumentId()	Retorna o número do documento que está relacionado ao documento publicado.	int

Bloco de código

language	java
title	Exemplo

var listRelated = getValue("WKListRelatedDocument");
	if( listRelated != null){
   	 log.info("Os seguintes documentos estão relacionados a este documentos: ");

Bloco de código

language	java
title	Exemplo

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

...

WatchDTO

Este objeto representa as notificações de acompanhamento de comentários e suas propriedades, na tabela abaixo consta mais informações sobre ele:

getDocumentId do documentointgetVersion da versão do documentointgetCompanyId código da empresa em que o documento foi publicadointgetRelatedDocumentId do documento que está relacionado ao documento publicadoint

Função	Descrição da Função	Tipo do Retorno		Descrição da Função	Tipo do Retorno
getEntityId()	Retorna o código do Conteúdo.	String
getUserId()	Retorna o código do usuário.	String
getUserAlias()	Retorna o alias do usuário.	String
getSociableId()	Retorna ocódigo sociable.	String
getCreationDate()	Retorna a data de criação.	String
getLastUpdateDate()	Retorna a data da última atualizaçã.	String
getNumberComments	()	Retorna o número	de comentários.	String
getNumberLikes()	Retorna o número	de apoios.	String
getNumberShares()	Retorna o	número de compartilhamentos.	String
getNumberWatchers()	Retorna o número	de acompanhamentos.	String

Bloco de código

language	java
title	Exemplo

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

...

getNumberDenouncements()	Retorna o número de denúncias.	String
getSocialWatchType()	Retorna o tipo (social)	String
getPostAuthor()	Retorna o autor do conteúdo.	String
getTags()	Retorna as tags.	String
getText()	Retorna o texto.	String
getDescription()	Retorna a descrição.	String
getObjectClass()	Retorna a classe do objeto.	String
getObjectId()	Retorna o objectId.	String
getThumbURL()	Retorna a url do thumb	String

Customização de Eventos JMS

...

O produto dispara dois tipos de mensagens JMS customizáveis, o o wdkDocument e o e o wdkAbstract.

O O wdkDocument será será disparado quando houver manipulação nos documentos do Fluig, para a aplicação receber a mensagem com as informações do documento a classe tem que estender o MessageListener e ter a seguinte linha:

...

O objeto de retorno será um MapMessage que conterá os seguintes parâmetros:

event (String): Informa Informa qual o tipo de evento que foi efetuado com o documento, conforme a tabela abaixo:

Evento	Descrição
PUBLISH	Um novo documento publicado.
MODIFY	Documento é modificado
DELETE	Documento é excluído da base de dados.
SENDRECYCLE	Documento é enviado para lixeira.
DELETEFOLDER	Uma pasta é excluída da base de dados.
EXTERNALCONVERTION	Documento com conversão customizada.
CONVERTIONLONGTERM	Documento convertido para longo prazo.
MOVE	Um ou mais documento ou pastas foram movidos de uma pasta para outra.
RESTORERECYCLE	Restaura documentos e pastas da Lixeira.

companyId (Integer): Código Código da empresa em que o documento foi manipulado.
colleagueId (String): Usuário Usuário que efetuou a ação.
documentId (Integer): Código Código do documento que sofreu a ação.
version (Integer): Número Número da versão do documento.
lhasCreatedDocument (Boolean): Informa Informa se criou o documento.
IhasIncreasedVersion (Boolean): Informa Informa se foi incrementada a versão.
changedApproval (Boolean): Informa Informa se o aprovador foi modificado.
documento (byte[ ]): Array Array de bytes com o documento e suas propriedades.

...

Bloco de código

language	java
title	Exemplo

import java.util.Enumeration;
import javax.ejb.ActivationConfigProperty;
import javax.ejb.MessageDriven;
import javax.jms.MapMessage;
import javax.jms.Message;
import javax.jms.MessageListener;


@MessageDriven(mappedName = "custom/DocumentListener", activationConfig = {
@ActivationConfigProperty(propertyName = "destinationType", propertyValue = "javax.jms.Topic"),
@ActivationConfigProperty(propertyName = "destination", propertyValue = "topic/wdkDocument")
})


public class DocumentListenerMessageBean implements MessageListener {


    @Override
    public void onMessage(Message message) {
        try {
            System.out.println("========Document Listener========");
            System.out.println("Message received: " + message.getJMSMessageID());
            if (message instanceof MapMessage) {
                MapMessage mm = (MapMessage) message;
                @SuppressWarnings("unchecked")
                Enumeration<String> es = mm.getMapNames();
                while (es.hasMoreElements()) {
                    String prop = es.nextElement();
                    System.out.println(prop + ": " + mm.getObject(prop));
                }
            }
            System.out.println("========Fim Document Listener========");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

O O wdkAbstract será será disparado quando houver manipulação em alguns objetos no Fluig, conforme tabela abaixo:

Objeto	Descrição	Tabela no BD
Icon	Ícone	ICONE
Topic	Assunto	ASSUNTO
Shortcut	Segurança de Menu	MENU_ICONE
LogAccess	Log de Acesso	LOG_ACCESS
ColleagueReplacement	Substituto	COLAB_SUBSTTO
Application	Aplicativo	APLICATIVO
ProgressLib	Ambiente Progress	AMBIEN_PROGRESS
GlobalCalendar	Feriado	CALEND_GLOBAL
Term	Termo	TERMO
Synonym	Sinônimo	SINONIMO
DocumentType	Tipo do Documento	TIPO_DOCUMENTO
Volume	Volume	VOL_FISIC
AttributionMecanism	Mecanismo de Atribuição	MECAN_ATRIBUIC
EmailTemplate	Template de Email	TEMPLATE_EMAIL
CustomizedDatasetBuilder	Dataset	SERV_DATASET
DataService	Serviços	SERV_DADOS
CustomFields	Campos Customizados	CAMPO_CUSTOM
UserGraphicSetings	DashBoard	CONFIGUR_GRAF_USUAR
Watermark	Marca D’água	MARCA_DAGUA
WebLayout	Layout	WEBLAYOUT
Adapter	Adaptadores	ADAPTER

...

O objeto de retorno será um MapMessage que conterá os seguintes parâmetros:

event (String): Informa Informa qual o tipo de evento que foi efetuado com o objeto, conforme a tabela abaixo:

Evento	Descrição
CREATE	Um novo objeto foi criado.
UPDATE	Um objeto foi modificado
DELETE	Um objeto foi excluído da base de dados.

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

...

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 23

Nova versão 24

Chave

AfterDocumentPublisher

BeforeDocumentViewer

Objetos utilizados nos eventos

DocumentDto

ApproverDto

BeforeWatchContent

AfterWatchContent

BeforeUnwatchContent

AfterUnwatchContent

Objetos utilizados nos eventos

DocumentDto

ApproverDto

DocumentSecurityConfigDto

DocumentSecurityConfigDto

RelatedDocumentDto

WatchDTO

Customização de Eventos JMS

Atalhos

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 23

Nova versão 24

Chave

AfterDocumentPublisher

BeforeDocumentViewer

Objetos utilizados nos eventos

DocumentDto

ApproverDto

BeforeWatchContent

AfterWatchContent

BeforeUnwatchContent

AfterUnwatchContent

Objetos utilizados nos eventos

DocumentDto

ApproverDto

DocumentSecurityConfigDto

DocumentSecurityConfigDto

RelatedDocumentDto

WatchDTO

Customização de Eventos JMS