...
Este evento permite personalizar a conversão de documento realizada pelo TOTVS Fluig Plataforma. Mais informações sobre ele podem ser encontradas no guia Conversores de Documentos.
ValidateUpload
Nota |
---|
A partir da versão: 1.8. |
...
...
Este evento sempre é disparado antes de realizar upload de arquivo para a plataforma, seja por API Rest, Soap/Webservices ou FTP. Através dele é possível validar o MIMEType ou Extensão do arquivo que está sendo feito upload e poder bloquear. O evento não recebe parâmetros, porém temos acesso à função getValue.
Exemplo:
Bloco de código |
---|
language | js |
---|
linenumbers | true |
---|
|
function validateUpload() {
// Exemplo de implementação
// CompanyId da empresa
var companyId = getValue("WKCompany");
// Nome do arquivo com extensão
var fileName = getValue("WKFileName");
// Tamanho do arquivo em bytes
var fileSize = getValue("WKFileSize");
// Caminho absoluto do arquivo
var filePath = getValue("WKFilePath");
// MimeType dos bytes do arquivo, ou seja, independente da extensão
var fileMimeType = getValue("WKFileMimeType");
// UserId do usuário que está realizando o upload
var userId = getValue("WKUser");
// A maioria dos mimetypes executáveis começam com "application/x-"
if (fileMimeType.indexOf("application/x-") !== -1) {
// Porém alguns tipos começam também com "application/x-", como por exemplo: .rar ou .7zip. Então caso deseja permití-los, pode ser feito assim:
if (fileMimeType.indexOf("application/x-rar-compressed") !== -1 || fileMimeType.indexOf("application/x-7z-compressed") !== -1) {
return;
}
throwsIfBlocked();
}
// Podemos bloquear qualquer outro mimetype, por exemplo:
if (fileMimeType.indexOf("application/octet-stream") !== -1 || fileMimeType.indexOf("application/exe") !== -1) {
throwsIfBlocked();
}
// Podemos bloquear também pela extensão do arquivo
if (fileName.match(/.*\.(sh|exe|msi|bat|app)/i)){
throwsIfBlocked();
}
// Função usada para logar uma mensagem no log do servidor e retornar o erro na tela
function throwsIfBlocked() {
log.warn("Usuário: '" + userId + "' da Empresa: '" + companyId + "' tentou realizar o upload "
+ "do Arquivo '" + fileName + "' com o Mimetype: '" + fileMimeType + "' e foi impedido!");
throw "Este formato de documento não está de acordo com as políticas de segurança e portanto não será permitida sua publicação na plataforma.";
}
} |
...
São disponibilizadas algumas propriedades referentes ao arquivo que está sendo feito upload através do método getValue.
Propriedade | Descrição | Tipo |
---|
WKCompany | Código da Empresa | int |
WKFileName | Nome do arquivo com extensão | String |
WKFileSize | Tamanho do arquivo em bytes | long |
WKFilePath | Caminho absoluto do arquivo | String |
WKFileMimeType | MimeType dos bytes do arquivo, ou seja, independente da extensão | String |
WKUser | Usuário logado | String |
ValidateCustomMetadata
Este evento sempre é disparado 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.
...
Deck of Cards |
---|
history | false |
---|
id | Exemplos beforeDcoumentPublisher |
---|
|
Card |
---|
label | 1- Validar informações do documento |
---|
| É possível usar vários objetos e fazer validações e é muito comum validar permissões específicas ao negócio do cliente e não permitir a inclusão do documento. No exemplo abaixo, o trecho de código está mostrando todos os possíveis atributos, declara os possíveis objetos, exibe no log algumas informações desses objetos, depois verifica os aprovadores, validando que não pode conter um usuário administrador como aprovador e exibe todos documentos relacionados. Bloco de código |
---|
language | js |
---|
linenumbers | true |
---|
| 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);
} |
|
Card |
---|
label | 2- Impedir publicação com descrição repetida |
---|
| Exemplo de evento que impede o usuário de publicar um documento com descrição repetida em uma determinada pasta. Bloco de código |
---|
language | js |
---|
linenumbers | true |
---|
| function beforeDocumentPublisher() {
// Exemplo de evento que impede o usuário de publicar um documento com descrição
// repetida em uma determinada pasta levando em consideração também se o documento esta na lixeira.
// caso não queira considerar a lixeira é só remover a validação da mesma, porem o documento poderá
// ser restaurando da lixeira para pasta duplicando assim o nome do arquivo.
var state = getValue("WKState");
if (state == "PUBLISH") {
var doc = getValue("WKDocument");
// Faz validações apenas se o documento estiver sendo publicado na pasta selecionada (trocar o "6" pelo numero da pasta desejada)
// Valida também se o documento esta sendo publicado como novo opção (getVersionOption), caso seja somente alteração ou seja, nova revisão ou versão passa
if (doc.getParentDocumentId() == 6 && doc.getVersionOption() == 0) {
//###############################################################################################
//documentos ativos
// Reduz o retorno de registros para reduzir impacto em performance.
var constraintDocument1 = DatasetFactory.createConstraint(
'sqlLimit', '0', '1', ConstraintType.MUST);
// Passando código da pasta pai para o Dataset
var constraintDocument2 = DatasetFactory.createConstraint(
'parentDocumentId', doc.getParentDocumentId(), doc
.getParentDocumentId(), ConstraintType.MUST);
// Consultando apenas registros de documentos ativos.
var constraintDocument3 = DatasetFactory.createConstraint(
'activeVersion', 'true', 'true', ConstraintType.MUST);
// Consultando apenas nos documentos que não foram removidos.
var constraintDocument4 = DatasetFactory.createConstraint(
'deleted', 'false', 'false', ConstraintType.MUST);
// Consultando documentos que tenham a mesma descrição informada na
// publicação
var constraintDocument5 = DatasetFactory.createConstraint(
'documentDescription', doc.getDocumentDescription(), doc
.getDocumentDescription(), ConstraintType.MUST);
var datasetDocumentActive = DatasetFactory.getDataset('document', null,
new Array(constraintDocument1, constraintDocument2,
constraintDocument3, constraintDocument4,
constraintDocument5), null);
//###############################################################################################
//Considera o documento que esta na lixeira
// Consultando apenas registros de documentos inativos.
constraintDocument3 = DatasetFactory.createConstraint(
'activeVersion', 'false', 'false', ConstraintType.MUST);
// Consultando apenas nos documentos que foram removidos.
constraintDocument4 = DatasetFactory.createConstraint(
'deleted', 'true', 'true', ConstraintType.MUST);
var datasetDocumentDeleted = DatasetFactory.getDataset('document', null,
new Array(constraintDocument1, constraintDocument2,
constraintDocument3, constraintDocument4,
constraintDocument5), null);
var isExistDoc = datasetDocumentActive != null && datasetDocumentActive.rowsCount > 0
&& (datasetDocumentActive.getValue(0, "documentDescription") == doc.getDocumentDescription());
var isExistDocDeleted = datasetDocumentDeleted != null && datasetDocumentDeleted.rowsCount > 0
&& (datasetDocumentDeleted.getValue(0, "documentDescription") == doc.getDocumentDescription());
if (isExistDoc || isExistDocDeleted) {
throw "Já existe um documento com a mesma descrição informada";
}
}
}
}
|
|
Card |
---|
label | 3- Tornar campo descrição/versão/revisão obrigatório |
---|
| Exemplo de como tornar o campo 'Descrição/Versão/Revisão' de preenchimento obrigatório, apresentado no momento do check-in do documento. Bloco de código |
---|
language | js |
---|
linenumbers | true |
---|
| function beforeDocumentPublisher() {
var doc = getValue("WKDocument");
// Verifica se a descrição da versão não está preenchida
if (doc.getVersionDescription() == "") {
log.info("### Documento: " + doc.getDocumentId() + " - Versão: " + doc.getVersion() + " não está com a Descrição da Versão preenchida!");
// Informa somente o numero do documento de origem, para o caso de checkin com nova versao/revisao
var constraintDocument1 = DatasetFactory.createConstraint('allocatedDocumentPK.sourceDocument', doc.getDocumentId(), doc .getDocumentId(), ConstraintType.MUST);
// Instanciando o dataset
var datasetDocument = DatasetFactory.getDataset('allocatedDocument', null, new Array(constraintDocument1), null);
// Verifica se o documento esta em checkout/checkin e exibe a mensagem
if (datasetDocument.rowsCount > 0) {
throw "Para efetuar o checkin é necessário informar a Descrição da Versão!";
}
}
} |
|
Card |
---|
label | 4- Parametrizar keyword do documento |
---|
| Exemplo de uso do parâmetro WKDocumentEdit no evento, para que seja possível atualizar o campo keyWord do documento. Bloco de código |
---|
language | js |
---|
linenumbers | true |
---|
| function beforeDocumentPublisher() {
var doc = getValue("WKDocument");
log.info("KeyWord Atual: " + doc.getKeyWord());
var docEdit = getValue("WKDocumentEdit");
docEdit.setKeyWord("Novo");
log.info("KeyWord Novo: " + docEdit.getKeyWord());
} |
|
Card |
---|
label | 5- Impedir publicação pela extensão do arquivo físico |
---|
| Exemplo de como impedir a publicação pela extensão do arquivo físico. Bloco de código |
---|
language | js |
---|
linenumbers | true |
---|
| function beforeDocumentPublisher(){
var doc = getValue("WKDocument");
var ext = [".exe",".reg"];
for (var i = 0; i < ext.length; i++) {
if (doc.getPhisicalFile().endsWith(ext[i])) {
throw "Desculpe, este tipo de arquivo não é permitido por razões de segurança";
}
}
} |
|
Card |
---|
label | 6- Controlando a versão manualmente em novos documentos |
---|
| Exemplo de uso do parâmetro WKDocumentEdit no evento para que seja possível controlar as propriedades version, validationStartDate e expirationDate do documento. Bloco de código |
---|
language | js |
---|
linenumbers | true |
---|
| function beforeDocumentPublisher() {
var doc = getValue("WKDocument");
log.info("DocumentId Atual: " + doc.getDocumentId());
log.info("Version Atual: " + doc.getVersion());
log.info("DocumentType Atual: " + doc.getDocumentType());
log.info("ValidationStartDate Atual: " + doc.getValidationStartDate());
log.info("ExpirationDate Atual: " + doc.getExpirationDate());
// Quando documento é novo e o tipo de documento é Documento normal.
if (doc.getDocumentId() == 0 && doc.getDocumentType() == "2") {
var docEdit = getValue("WKDocumentEdit");
docEdit.setVersion(3);
log.info("Version Novo: " + docEdit.getVersion());
docEdit.setValidationStartDate(stringToDate("26/05/2023 00:00:00"));
log.info("ValidationStartDate Novo: " + docEdit.getValidationStartDate());
docEdit.setExpirationDate(stringToDate("27/05/2023 16:50:30"));
log.info("ExpirationDate Novo: " + docEdit.getExpirationDate());
}
function stringToDate(dateString){
var format = new java.text.SimpleDateFormat("dd/MM/yyyy HH:mm:ss");
return format.parse(dateString);
}
} |
|
|
AfterDocumentPublisher
...