Automazione

L'automazione è un aspetto pervasivo della piattaforma LogicalDOC e rappresenta il modo che hai di programmare cose utilizzando un semplice linguaggio di scripting. A volte si desidera che LogicalDOC esegua la tua propria logica quando accade qualcosa di speciale durante un flusso di lavoro o in reazione ad eventi specifici che si verificano all'interno del repositorio: con l'automazione è possibile iniettare il proprio algoritmo per eseguire automaticamente le azioni corrette. Molti oggetti supportano l'automazione e consentono di definire script di automazione personalizzati (cartelle, flussi di lavoro, e-mail, ecc.)

Per cortesia leggi la guida Sintassi dell'Automatione per familiarizzare con la sintassi. Puoi anche consultare gli Esempi di Automazione.

Nel tuo script di automazione, puoi referenziare le seguenti variabili(alcune di esse sono disponibili solo in certi contesti):

CONTESTO DI AUTOMAZIONE: GENERALE
VariabileClasse JavaDescrizione
nlrappresenta la nuova linea
productnome del prodotto
localelocale corrente
CURRENT_DATEdata corrente
tenantIdidentificatore del tenant corrente
dictionarymappa con tutte le variabili (nome_variabile > valore)
keysset di tutte le chiavi nel dizionario
parametersmappa con tutti i parametri di invocazione della routine (nome_parametro > valore)
parametersnamesset di tutti i nomi dei parametri di invocazione della routine
systemDictionaryUna mappa transitoria e a livello di sistema utile per archiviare i dati tra le esecuzioni di automazione
logLogTooldà accesso al registro di sistema
I18NI18NToolgestisce le traduzioni
DateToolAutomationDateToolmanipolazione e formattazione delle date
NumberToolAutomationNumberToolformatta un numero usando il formato dato
CollectionToolCollectionToolmetodi di utilità per lavorare con le collezioni
RegexToolDocToolfunzioni per manipolare le espressioni regolari
DocToolFolderToolgestisce documenti e risorse correlate
FolderToolClassToolgestisce le cartelle e le risorse correlate
ClassToolClassToolcrea nuove istanze di una determinata classe
SystemToolSystemToolfunzioni per l'interazione con il sistema operativo
MailToolMailToolfunzioni per inviare e-mail
BarcodeToolBarcodeToolclasse per estrarre il contenuto del codice a barre dai documenti
StampToolStampToolapplica timbri ai documenti
SignToolSignToolfirma digitalmente un documento con il certificato digitale dell'utente
AutomationToolAutomationToolesegue una routine di automazione nello stesso thread di esecuzione o in uno nuovo
ContextToolContextToolmetodi per accedere al contesto dell'applicazione
SplitToolSplitToolconsente la suddivisione di un PDF in segmenti utilizzando criteri diversi
SecurityToolSecurityToolgestisce alcune operazioni relative alla sicurezza
WorkflowToolWorkflowToolmetodi per gestire i flussi di lavoro e interagire con essi
WebsocketToolWebsocketToolfunzioni di utilità per interagire con l'interfaccia utente
UserToolUserToolmetodi di utilità per gestire alcune operazioni relative all'utente
SearchToolSearchToolmetodi di utilità per eseguire ricerche
FormToolFormToolmetodi di utilità per operare con i moduli
ReportToolReportToolmetodi di utilità per eseguire rapporti personalizzati
CalendarToolCalendarToolstrumento per interagire col calendario

CONTESTO DI AUTOMAZIONE: EVENTI
VariabileClasse JavaDescrizione
eventHistoryl'evento corrente
documentDocumentil documento associato all'evento corrente (se presente)
folderFolderla cartella associata all'evento corrente (se presente)

CONTESTO DI AUTOMAZIONE: WORKFLOW
VariabileClasse JavaDescrizione
candidatesUserelenco degli utenti candidati dell'attività corrente
documentsDocumentelenco dei documenti allegati
documentDocumentprimo elemento della lista documents
taskl'attività corrente
taskNamenome dell'attività corrente
initiatorUserl'utente che ha lanciato il workflow
workflownome del workflow
processIdidentificatore del processo corrente
definitionIdidentificatore della definizione del processo
actionslista di possibili azioni(transazioni) dichiarate per l'attività corrente
actionnome dell'azione(transizione) corrente, disponibile solo all'interno della transizione
assigneeutente assegnato all'attività corrente

CONTESTO DI AUTOMAZIONE: PROTOCOLLO / DENOMINAZIONE AUTOMATICA / CARTELLA AUTOMATICA
VariabileClasse JavaDescrizione
documentDocumentil documento in corso di salvataggio

CONTESTO DI AUTOMAZIONE: MESSAGGIO DI BENVENUTO
VariabileClasse JavaDescrizione
userUserl'utente correntemente collegato
sessionSessionla sessione corrente

CONTESTO DI AUTOMAZIONE: DASHLET
VariabileClasse JavaDescrizione
userUserl'utente correntemente collegato
sessionSessionla sessione corrente
dashletDashletl'oggetto dashlet

CONTESTO DI AUTOMAZIONE: AZIONI PERSONALIZZATE
VariabileClasse JavaDescrizione
userUserl'utente correntemente collegato
sessionSessionla sessione corrente
documentDocumentil documento selezionato
documentsDocumenti documenti selezionati
folderFolderla cartella selezionata

CONTESTO DI AUTOMAZIONE: IMPORTAZIONE E-MAIL
VariabileClasse JavaDescrizione
emailEMaill'email che viene importata
accountEmailAccountl'account da cui viene importata l'e-mail
messagela rappresentazione del messaggio restituita dal server di posta
documentDocumentil documento che verrà utilizzato per salvare l'e-mail nel repository
documentsDocumentelenco di documenti che verranno utilizzati per salvare l'e-mail e i suoi allegati nel repository

CONTESTO DI AUTOMAZIONE: OCR ZONALE
VariabileClasse JavaDescrizione
documentDocumentil documento in elaborazione
sampleil testo estratto dalla zona
valuel'oggetto valore (String, Date, Decimal ...) convertito dal campione
zoneZonela zona in elaborazione, utilizzare zone.value se si desidera modificare il valore che verrà salvato nel documento

CONTESTO DI AUTOMAZIONE: AUTENTICAZIONE ESTERNA
VariabileClasse JavaDescrizione
ldapUserLDAPUserl'utente che viene autenticato

CONTESTO DI AUTOMAZIONE: NUOVO DISPOSITIVO
VariabileClasse JavaDescrizione
userUserl'utente correntemente collegato
deviceDevicethe device used to login
clientClientil client remoto connesso alla piattaforma
eventHistoryl'evento di accesso

CONTESTO DI AUTOMAZIONE: MODULI
VariabileClasse JavaDescrizione
formFormil modulo in elaborazione
documentDocumentil documento che contiene i metadati

CONTESTO DI AUTOMAZIONE: MODULI WEB
VariabileClasse JavaDescrizione
formFormil modulo in elaborazione
templateTemplatela classe documentale associata al modulo
senderUserl'utente mittente
responderindirizzo e-mail del rispondente
titleil titolo del modulo web
descriptiondescrizione del modulo web
footeril piè di pagina del modulo web
messagecorpo del messaggio di posta elettronica
prefilledMapuna mappa contenente risposte precompilate (usata quando si invitano persone)

CONTESTO DI AUTOMAZIONE: TIMBRI
VariabileClasse JavaDescrizione
stampStampil timbro che viene applicato
userUserl'utente che applica il timbro
documentDocumentil documento da timbrare
parametersmappa con tutti i parametri inseriti dall'utente (nome parametro > valore)
parametersnamesinsieme di tutti i nomi dei parametri di input
pageIntegernumero di pagina corrente
DATEdata corrente formattata utilizzando le impostazioni locali dell'utente
TIMESTAMPtimestamp corrente formattato utilizzando le impostazioni locali dell'utente

CONTESTO DI AUTOMAZIONE: BRANDING
VariabileClasse JavaDescrizione
brandingBrandingl'oggetto che rappresenta il branding
requestla richiesta HTTP che viene processata
requestPathil percorso invocato dal client
userUserl'utente correntemente collegato
sessionSessionla sessione corrente

CONTESTO DI AUTOMAZIONE: SPLITTING
VariabileClasse JavaDescrizione
segmentintero che rappresenta il segmento corrente
documentDocumentil documento attualmente suddiviso
eventHistoryl'evento di splitting
policyla politica di frazionamento prescelta
expressionl'espressione usata per dividere

CONTESTO DI AUTOMAZIONE: FIRMA DIGITALE
VariabileClasse JavaDescrizione
documentDocumentil documento da firmare
reasonil motivo specificato per la firma
userUserl'utente che firma

CONTESTO DI AUTOMAZIONE: CALENDARIO
VariabileClasse JavaDescrizione
eventEventl'evento nel calendario
reminderReminderil promemoria corrente

AUTOMATION CONTEXT: VALIDAZIONE
VariabileClasse JavaDescrizione
objectExtensibleObjectl'oggetto in validazione, ad esempio un Document o un Folder
eventHistoryl'evento corrente
errorsmappa delle stringhe. Chiave è il nome dell'attributo, Valore è la descrizione dell'errore
attributeNamenome dell'attributo corrente in fase di convalida (disponibile solo nel validatore di attributo)
attributeAttributel'attributo corrente in fase di convalida (disponibile solo nel validatore di attributi)
valuevalore dell'attributo corrente in fase di convalida (disponibile solo nel validatore di attributo)
errorValidationErrormantiene la descrizione dell'errore dell'attributo corrente in fase di convalida (disponibile solo nel validatore di attributo)

CONTESTO DI AUTOMAZIONE: INVIO MAIL
VariabileClasse JavaDescrizione
senderUserl'utente che invia il messaggio di posta elettronica
documentDocumentprimo documento allegato
documentsDocumentraccolta dei documenti allegati