TOTVS Fluig

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 4

changes.mady.by.user Leticia de Liz Engelke

Gravado em

comparado com

Nova versão 5

changes.mady.by.user Leticia de Liz Engelke

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

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
titleNota

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.

Bloco de código
languagejava
titleExemplo

...

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

...


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

...


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

...


                            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
languagejava
titleExemplo

...

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.

Bloco de código
languagejava
titleExemplo

...

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

 

...

Informações
titleNota

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

...

.

Bloco de código
languagejava
title

...

Exemplo

...

function beforeDocumentViewer(){

...

 

...




                var doc = getValue("WKDocument");

...


                var company = getValue("WKCompany");

...

                var ds

               

                try {

...


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

...


                                var constraints = new Array(c1, c2, c3, c4);
                               ds = DatasetFactory.getDataset("allocatedDocument", null, constraints, null

...

 

                }catch (e) {

...

);


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

...

                }

}


                }
}

 

BeforeStatyEntry ?

 

           

...

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

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 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à 0 à Pasta raiz

1à 1 à Pasta

2à 2 à Documento normal

3à 3 à Documento externo

4à 4 à Fichário

5à 5 à Ficha

7à 7 à Anexo Workflow

8àNovo 8 à Novo Conteúdo

9àAplicativo

10à Relatório

portalàSite

9 à Aplicativo

10 à Relatório

portal à Site

portalPage à Página 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 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 colaborador 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
languagejava
titleExemplo

...

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 usuário ou o código do grupo que está aprovando este documento. É possível saber se vai retornar um colaborador usuário ou um grupo pelo tipo de aprovação.
String
getApproverType()
Retorna o tipo da aprovação, onde:
0 à ColaboradorUsuário
1à 1 à Grupo
int
getLevelId()
Retorna o nível de aprovação, no caso de aprovação em níveis.
int
...
 Bloco de código
languagejava
titleExemplo
...
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 usuário ou o código do grupo que está na segurança deste documento. É possível saber se vai retornar um colaborador 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 à ColaboradorUsuário;
2à 2 à Grupo;
3à 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à 1 à sem permissão/restrição (nega acesso);
0à 0 à Leitura;
1àGravação1 à Gravação;
2à 2 à Modificação;
3à 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
languagejava
titleExemplo
...
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:
 Bloco de código
languagejava
titleExemplo
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());
...
        }
}
...

     }
}