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.Start | Nó inicial do fluxo de captura |
App.Workflow | Inicia um workflow do WFDesigner |
App.Input | Aguarda entrada manual do operador |
App.Social | Entrada manual com validação de CPF/CNPJ |
App.Menu | Apresenta menu de opções ao operador |
App.Find | Busca nós ou documentos no repositório |
App.Service | Executa lógica customizada via script Ruby |
App.Message | Exibe mensagem ao operador |
App.File | Realiza a captura/digitalização do documento |
Funções do ScanDesigner
Configuração e ambiente
| Função | Descrição |
|---|
getini | Retorna valor de propriedade do alfresco-global.properties |
REPO_HOST | Retorna a URL do Alfresco |
PROCESS_HOST | Retorna a URL do Process |
User | Retorna o usuário atual |
Serial | Retorna o serial do dispositivo atual |
Criptografia
| Função | Descrição |
|---|
aeseverywhere_encrypt | Criptografa valor com AES-256 |
aeseverywhere_decrypt | Descriptografa valor com AES-256 |
String e validações
| Função | Descrição |
|---|
acntrim | Remove acentos de uma string |
check_cpf | Valida CPF |
check_date | Valida data |
check_cnpj | Valida CNPJ |
check_pis | Valida PIS |
check_pasep | Valida PASEP |
check_nis | Valida NIS |
Data e hora
| Função | Formato | Exemplo |
|---|
Now | %Y.%m.%d %H.%M.%S.%5N | 2025.05.20 14.30.00.00000 |
Time | %H.%M.%S.%5N | 14.30.00.00000 |
Date | %Y.%m.%d | 2025.05.20 |
Day | %d | 20 |
Month | %m | 05 |
Year | %Y | 2025 |
Usuários
| Função | Descrição |
|---|
getpeople | Retorna propriedades de um usuário |
Tabelas
| Função | Descrição |
|---|
gettabledefinition | Verifica se existe definição de tabela com o ID |
insertintable | Insere um registro na tabela |
gettableval | Retorna o valor de um campo de um item da tabela |
settableval | Define o valor de um campo de um item da tabela |
gettablebyval | Retorna registros da tabela onde campo contém valor |
getalltable | Retorna todos os registros de uma tabela |
createtablefield | Cria objeto JSON de campo de tabela |
Integrador
| Função | Descrição |
|---|
getintegrator | Executa e retorna valor via integrador por definição |
WFDesigner
Nós do WFDesigner
| Nó | Descrição |
|---|
App.Start | Nó inicial do fluxo de trabalho |
App.End | Finaliza o fluxo |
App.Timer | Aguarda um intervalo de tempo antes de prosseguir |
App.Workflow | Executa um sub-fluxo |
App.CaptureLink | Inicia uma instância de captura vinculada ao workflow |
App.User | Tarefa atribuída a um usuário ou grupo |
App.Message | Envia mensagem dentro do fluxo |
App.Service | Executa lógica customizada via script Ruby |
App.SmartDoc | Geração de documento a partir de template |
App.Docusign | Assina documento via DocuSign |
App.Certisign | Assina documento via Certisign |
App.SelbettiSSign | Assina documento via Selbetti S-Sign |
App.A1Sign | Assina documento com certificado A1 local |
App.SafeId | Assina 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ção | Descrição |
|---|
instance | Retorna o ID da instância do workflow atual |
task | Retorna o ID da tarefa no banco de dados |
taskid | Retorna o task-id completo da tarefa atual nas ações |
getval | Retorna o valor de um campo da instância ou tarefa |
setvalue | Define o valor de um campo da instância ou tarefa |
setvalues | Define múltiplos valores da instância ou tarefa |
getchildrenval | Retorna valor de campo de um workflow filho |
haschildren | Retorna instâncias filhas da instância atual |
getinstanceprocessing | Verifica se existe instância de Capture vinculada ao workflow |
Usuários e tarefas
| Função | Descrição |
|---|
getinitiator | Retorna o usuário que iniciou a tarefa |
getowner | Retorna o proprietário da tarefa |
getcomments | Retorna comentários da tarefa |
getpeople | Retorna propriedades de um usuário |
link | Retorna link da tarefa quando o proprietário é um convidado |
Mensagens
| Função | Descrição |
|---|
setmessage | Define a mensagem da instância |
getmessage | Retorna a mensagem da instância |
Anexos
| Função | Descrição |
|---|
setattachments | Define os anexos da instância |
addinattachments | Adiciona um anexo à instância |
removefromattachments | Remove um anexo da instância |
updateattachments | Atualiza um anexo da instância |
getattachments | Retorna os anexos da instância |
Documentos e repositório
| Função | Descrição |
|---|
downloadDocumentNoderef | Retorna arquivo pelo nodeRef |
downloadDocument | Retorna arquivo pela URL |
alfrescoaddaspect | Adiciona um aspecto ao nó |
alfrescoremoveaspect | Remove um aspecto do nó |
alfrescocheckaspect | Verifica se o nó possui o aspecto |
updateDocument | Atualiza documento com nova versão |
uploadDocument | Faz upload de documento em uma pasta |
Tempo
| Função | Descrição |
|---|
seconds_to_days | Formata segundos como %d days, %d hours, %d minutes |
seconds_to_hours | Formata segundos como %02d:%02d |
SmartDoc
| Função | Descrição |
|---|
getfieldval | Retorna valor de campo SmartDoc |
CaptureLink
| Função | Descrição |
|---|
getcapturelink | Retorna link da tarefa App.CaptureLink |
Certificados
| Função | Descrição |
|---|
getcertificates | Retorna perfis de certificado disponíveis para o usuário |
Utilitários
| Função | Descrição |
|---|
raisecustommsg | Lança mensagem de erro customizada |
createoptionspair | Cria objeto JSON de campo de opções |