Histórico da Página
Índice
Índice | ||||||||
---|---|---|---|---|---|---|---|---|
|
Desenvolvimento de Eventos
...
Abaixo se encontra um exemplo de como implementar esse evento:
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
function onNotify(subject, receivers, template, params) { if (template.match("TPLDOCUMENT_APPROVAL_PENDING") != null) { receivers.add("[email protected]"); } } |
...
Nota | ||
---|---|---|
| ||
|
afterReleaseProcessVersion
Evento disparado após a criação ou modificação nas configurações de um determinado processo.
Nota | ||
---|---|---|
| ||
Caso o processo possua o evento "afterReleaseVersion" implementado, este evento global será desconsiderado na liberação de novas versões do processo em questão. |
Abaixo segue um exemplo de como implementar esse evento:
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
function afterReleaseProcessVersion(processXML){ var pdv = getValue("ProcessDefinitionVersionDto"); var processInfo = "\n### Nova versão de processo liberada: ###"; processInfo += "\n User: " + getValue("WKUser"); processInfo += "\n processDescription: " + pdv.getProcessDescription(); processInfo += "\n processId: " + pdv.getProcessId(); processInfo += "\n version: " + pdv.getVersion(); log.info(processInfo + "\n"); } |
São disponibilizadas algumas propriedades referentes ao processo que esta sendo liberado, porém somente para consulta através do método getValue.
Propriedade | Descrição | Tipo |
WKCompany | Código da empresa | long |
WKUser | Usuário logado | String |
ProcessDefinitionVersion | Objeto com propriedades da versão do processo alterada | ProcessDefinitionVersionDto |
beforeSendNotification
Evento disparado antes do envio de uma notificação ao usuário. Pode ser utilizado quando for necessário adicionar alguma informação à nota ou alterar a prioridade de uma notificação, possibilitando o cancelamento do envio da notificação caso seja definida uma prioridade através do evento.
Informações | ||
---|---|---|
| ||
Por questões de segurança, somente os campos priority e note podem ser alterados. Outras alterações não serão consideradas. |
Nota | ||
---|---|---|
| ||
Caso seja lançada uma exceção através do evento a notificação não será enviada, mas esse não é o modo correto de cancelar o envio. Definir o campo priority como "NONE" impede que a notificação seja enviada sem a necessidade de lançar exceção. |
Abaixo segue um exemplo de como implementar esse evento:
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
function beforeSendNotification(notification) { if (notification.eventType == "DENOUNCED_CONTENT") { notification.priority = "NONE"; } if (notification.eventType == "DOCUMENT_APPROVED") { notification.priority = "NORMAL"; } if (notification.eventType == "DOCUMENT_REPROVED") { notification.priority = "HIGH"; } if (notification.eventType == "LIKE") { notification.priority = "LOW"; } } |
São disponibilizadas algumas propriedades referentes à notificação que está sendo enviada.
Propriedade | Descrição | Tipo |
aliasSender | Alias de quem enviou a notificação. Pode vir nulo nos casos em que a notificação é enviada pelo sistema. | String |
aliasReceiver | Alias de quem vai receber a notificação. | String |
place | Lugar onde foi feita a ação que gerou a notificação. Pode vir nulo quando não for um lugar socializavel. | |
object | Objeto sobre o qual foi feita a ação que gerou o alerta. | |
eventType | Tipo do evento que gerou a notificação. | String |
metadata | Metadados da notificação. | Hashmap <String, String> |
priority | Prioridade da notificação. Valores válidos: NONE, LOW, NORMAL, HIGH. | String |
note | Nota enviada junto à notificação. | String |
afterSendNotification
Evento disparado após o envio de uma notificação ao usuário. Pode ser utilizado quando for necessário registrar alguma informação, para auditoria, por exemplo.
Abaixo segue um exemplo de como implementar esse evento:
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
function afterSendNotification(notification){ log.info("notification as send for " + notification.aliasReceiver); } |
São disponibilizadas algumas propriedades referentes à notificação que foi enviada.
Propriedade | Descrição | Tipo |
aliasSender | Alias de quem enviou a notificação. Pode vir nulo nos casos em que a notificação é enviada pelo sistema. | String |
aliasReceiver | Alias de quem vai receber a notificação. | String |
place | Lugar onde foi feita a ação que gerou a notificação. Pode vir nulo quando não for um lugar socializavel. | |
object | Objeto sobre o qual foi feita a ação que gerou o alerta. | |
eventType | Tipo do evento que gerou a notificação. | String |
metadata | Metadados da notificação. | Hashmap <String, String> |
priority | Prioridade da notificação. | String |
note | Nota enviada junto à notificação. | String |
onDisplayTasks
Este evento é disparado antes de serem exibidas as tarefas das aba "Tarefas a concluir" , "Minhas solicitações", "Tarefas em pool", "Tarefas em consenso" e "Minhas tarefas sob gerência" na central de tarefas. Através dele é possível inserir, alterar ou remover itens da central de tarefas. O evento recebe como parâmetro uma lista de WorkflowTasksVO das tarefas existentes.
Exemplo adicionando uma tarefa personalizada ao final da lista de tarefas:
Bloco de código | ||
---|---|---|
| ||
function onDisplayTasks(tasks) { var newTask = new WorkflowTasksVO(); newTask.description = "TOTVS 001"; newTask.url = "http://www.totvs.com"; tasks.add(newTask); } |
Disponibilizamos algumas informações para consulta através do método getValue.
Propriedade | Descrição | Tipo |
---|---|---|
WKUser | Código do usuário logado. | String |
WKUserLocale | Idioma do usuário logado. | String |
WKCompany | Número da empresa. | Int |
taskUserId | Código do usuário substituído, em caso de visualização da central como substituto. Nos demais casos retorna o usuário logado. | String |
taskType | Indicador do tipo de tarefas que estão sendo exibidas, “open” tarefas a concluir e “requests” para minhas solicitações. | String |
filter | Filtros utilizados. | Map<String, Object> |
order | Ordenação aplicada. | String |
maxResult | Número de resultados por página. | Int |
page | Número da página atual. | Int |
taskId | Em caso de pool, quando o taskType for pool, o taskId trará uma string contendo o tipo no caso ‘Role’ para papel ou ‘Group‘ para grupo e seu código. Exemplo: ‘Pool:Role:admin’ para um pool do papel ‘admin’. | String |
Bloco de código | ||||
---|---|---|---|---|
| ||||
function onDisplayTasks(links){ log.info("Usuário: " + getValue("WKUser")); } |
onDisplayTasksSummary
Este evento é disparado antes de serem exibidos os contadores das abas e gráficos da central de tarefas e widgets de BPM. Através dele é possível alterar números de tarefas pendentes de cada tipo.
Exemplo alterando o número de tarefas abertas e no prazo:
Bloco de código | ||
---|---|---|
| ||
function onDisplayTasksSummary(resumeTasks) { resumeTasks.openTasks=20; } |
O objeto recebido como parâmetro contém:
Propriedade | Descrição | Tipo |
---|---|---|
expiredTasks
| Solicitações atrasadas. | Int |
openTasks | Solicitações no prazo. | Int |
myRequests | Minhas solicitações. | Int |
toApprover | Aprovação de documentos pendentes. | Int |
myDocuments | Documentos aguardando aprovação. | Int |
checkout | Documento em checkout. | Int |
learningTasks | Atividades de Aprendizado. | Int |
Bloco de código | ||
---|---|---|
| ||
function onDisplayTasksSummary(resumeTasks) { resumeTasks.expiredTasks=10; resumeTasks.openTasks=20; resumeTasks.myRequests=30; resumeTasks.toApprover=40; resumeTasks.myDocuments=50; resumeTasks.checkout=60; resumeTasks.learningTasks=70; } |
Disponibilizamos algumas informações para consulta através do método getValue.
Propriedade | Descrição | Tipo |
---|---|---|
WKUser | Código do usuário logado. | String |
WKUserLocale | Idioma do usuário logado. | String |
WKCompany | Número da empresa. | Int |
taskUserId | Código do usuário substituído, em caso de visualização da central como substituto. Nos demais casos retorna o usuário logado. | String |
Bloco de código | ||||
---|---|---|---|---|
| ||||
function onDisplayTasks(links){ log.info("Usuário: " + getValue("WKUser")); } |
...
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árioFormulário 5 à FichaRegistro de formulário 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 Formulá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 fichado registro de formulário, para documento do tipo 5. | String |
getDocumentPropertyNumber() | Retorna o fichário formulário que foi usado como base para criação da fichado registro de formulário, por isso só tem um valor quando o documento é do tipo 5 (ficharegistro de formulário). | int |
getDocumentPropertyVersion() | Retorna a versão do fichário formulário em que a ficha foi criadao registro de formulário foi criado. | 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árioformulá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 |
getVersionOption() | Retorna a condição de versionamento do documento: 0 = Será mantida a versão 1 = Será criado nova revisão 2 = Será criado nova versão Importante lembrar que no momento da criação de um novo documento o valor sempre será 0. | int |
...