Em Desenvolvimento
Esta documentação ainda está em desenvolvimento. Agradecemos sua paciência!
Pular para o conteúdo principal
Versão: 03.007.002

Draw Explorer

Interface Swagger UI com a referência completa dos nós e funções disponíveis nos scripts Ruby do ScanDesigner e do WFDesigner.

URL de acesso: https://{servidor}/draw-explorer/

Útil durante o desenvolvimento de fluxos: permite consultar os parâmetros de cada nó e as assinaturas das funções auxiliares disponíveis nos scripts.


ScanDesigner​

Nós do ScanDesigner​

NóDescrição
App.StartNó inicial do fluxo de captura
App.WorkflowInicia um workflow do WFDesigner
App.InputAguarda entrada manual do operador
App.SocialEntrada manual com validação de CPF/CNPJ
App.MenuApresenta menu de opções ao operador
App.FindBusca nós ou documentos no repositório
App.ServiceExecuta lógica customizada via script Ruby
App.MessageExibe mensagem ao operador
App.FileRealiza a captura/digitalização do documento

Funções do ScanDesigner​

Configuração e ambiente​

FunçãoDescrição
getiniRetorna valor de propriedade do alfresco-global.properties
REPO_HOSTRetorna a URL do Alfresco
PROCESS_HOSTRetorna a URL do Process
UserRetorna o usuário atual
SerialRetorna o serial do dispositivo atual

Criptografia​

FunçãoDescrição
aeseverywhere_encryptCriptografa valor com AES-256
aeseverywhere_decryptDescriptografa valor com AES-256

String e validações​

FunçãoDescrição
acntrimRemove acentos de uma string
check_cpfValida CPF
check_dateValida data
check_cnpjValida CNPJ
check_pisValida PIS
check_pasepValida PASEP
check_nisValida NIS

Data e hora​

FunçãoFormatoExemplo
Now%Y.%m.%d %H.%M.%S.%5N2025.05.20 14.30.00.00000
Time%H.%M.%S.%5N14.30.00.00000
Date%Y.%m.%d2025.05.20
Day%d20
Month%m05
Year%Y2025

Usuários​

FunçãoDescrição
getpeopleRetorna propriedades de um usuário

Tabelas​

FunçãoDescrição
gettabledefinitionVerifica se existe definição de tabela com o ID
insertintableInsere um registro na tabela
gettablevalRetorna o valor de um campo de um item da tabela
settablevalDefine o valor de um campo de um item da tabela
gettablebyvalRetorna registros da tabela onde campo contém valor
getalltableRetorna todos os registros de uma tabela
createtablefieldCria objeto JSON de campo de tabela

Integrador​

FunçãoDescrição
getintegratorExecuta e retorna valor via integrador por definição

WFDesigner​

Nós do WFDesigner​

NóDescrição
App.StartNó inicial do fluxo de trabalho
App.EndFinaliza o fluxo
App.TimerAguarda um intervalo de tempo antes de prosseguir
App.WorkflowExecuta um sub-fluxo
App.CaptureLinkInicia uma instância de captura vinculada ao workflow
App.UserTarefa atribuída a um usuário ou grupo
App.MessageEnvia mensagem dentro do fluxo
App.ServiceExecuta lógica customizada via script Ruby
App.SmartDocGeração de documento a partir de template
App.DocusignAssina documento via DocuSign
App.CertisignAssina documento via Certisign
App.SelbettiSSignAssina documento via Selbetti S-Sign
App.A1SignAssina documento com certificado A1 local
App.SafeIdAssina documento via SafeID

Funções do WFDesigner​

As funções de configuração (getini, REPO_HOST, PROCESS_HOST), criptografia (aeseverywhere_encrypt, aeseverywhere_decrypt), validações (acntrim, check_cpf, check_cnpj, check_pis, check_pasep, check_nis, check_date), tabelas (gettabledefinition, insertintable, gettableval, settableval, gettablebyval, getalltable, createtablefield) e integrador (getintegrator) são as mesmas disponíveis no ScanDesigner. Abaixo estão as funções exclusivas do WFDesigner:

Instância e tarefa​

FunçãoDescrição
instanceRetorna o ID da instância do workflow atual
taskRetorna o ID da tarefa no banco de dados
taskidRetorna o task-id completo da tarefa atual nas ações
getvalRetorna o valor de um campo da instância ou tarefa
setvalueDefine o valor de um campo da instância ou tarefa
setvaluesDefine múltiplos valores da instância ou tarefa
getchildrenvalRetorna valor de campo de um workflow filho
haschildrenRetorna instâncias filhas da instância atual
getinstanceprocessingVerifica se existe instância de Capture vinculada ao workflow

Usuários e tarefas​

FunçãoDescrição
getinitiatorRetorna o usuário que iniciou a tarefa
getownerRetorna o proprietário da tarefa
getcommentsRetorna comentários da tarefa
getpeopleRetorna propriedades de um usuário
linkRetorna link da tarefa quando o proprietário é um convidado

Mensagens​

FunçãoDescrição
setmessageDefine a mensagem da instância
getmessageRetorna a mensagem da instância

Anexos​

FunçãoDescrição
setattachmentsDefine os anexos da instância
addinattachmentsAdiciona um anexo à instância
removefromattachmentsRemove um anexo da instância
updateattachmentsAtualiza um anexo da instância
getattachmentsRetorna os anexos da instância

Documentos e repositório​

FunçãoDescrição
downloadDocumentNoderefRetorna arquivo pelo nodeRef
downloadDocumentRetorna arquivo pela URL
alfrescoaddaspectAdiciona um aspecto ao nó
alfrescoremoveaspectRemove um aspecto do nó
alfrescocheckaspectVerifica se o nó possui o aspecto
updateDocumentAtualiza documento com nova versão
uploadDocumentFaz upload de documento em uma pasta

Tempo​

FunçãoDescrição
seconds_to_daysFormata segundos como %d days, %d hours, %d minutes
seconds_to_hoursFormata segundos como %02d:%02d

SmartDoc​

FunçãoDescrição
getfieldvalRetorna valor de campo SmartDoc
FunçãoDescrição
getcapturelinkRetorna link da tarefa App.CaptureLink

Certificados​

FunçãoDescrição
getcertificatesRetorna perfis de certificado disponíveis para o usuário

Utilitários​

FunçãoDescrição
raisecustommsgLança mensagem de erro customizada
createoptionspairCria objeto JSON de campo de opções