Stampa ID pratica
La Stampa ID pratica aggiunge automaticamente sui documenti PDF della pratica un timbro testuale con l'identificativo della pratica (es. Sign ID 12345), utile per riconciliare i documenti stampati o archiviati con la pratica di origine.
La funzionalità va abilitata a livello di installazione o di organizzazione (vedi Abilitazione); una volta abilitata, la modalità di stampa si può impostare sulla singola pratica, anche via API, oppure ereditare dalla Tipologia di processo.
Modalità di stampa
| Valore | Significato |
|---|---|
N | Nessuna stampa |
A | Solo sui PDF allegati |
L | Su tutti i PDF |
Uso tramite API
La modalità si indica nella creazione della pratica:
POST /files/send
con il campo opzionale practiceIdPrintMode nel corpo della richiesta.
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
practiceIdPrintMode | string | No | Modalità di stampa dell'ID pratica: N, A o L. |
Come viene decisa la modalità
- Se la funzionalità non è abilitata per l'organizzazione, vale sempre
N, qualunque sia il valore inviato. - Se la richiesta contiene un valore valido (
N,AoL), vale quello. AncheNè una scelta esplicita e non viene sostituita dalla Tipologia. - Se il campo manca o contiene un valore non riconosciuto, si usa la modalità della Tipologia indicata con
idWorkflowTypeoworkflowTypeCode. - Se non c'è una Tipologia, oppure la Tipologia non ha una modalità valida, vale
N.
Il campo è opzionale: le integrazioni esistenti, che non lo inviano, continuano a funzionare come prima. Senza Tipologia non viene stampato nulla; con una Tipologia si eredita la sua impostazione.
Esempi
Timbro su tutti i PDF, indipendentemente dalla Tipologia:
{
"name": "Contratto di fornitura",
"workflowTypeCode": "CONTRATTI",
"practiceIdPrintMode": "L"
}
Nessun campo: si eredita la modalità configurata sulla Tipologia CONTRATTI:
{
"name": "Contratto di fornitura",
"workflowTypeCode": "CONTRATTI"
}
Negli esempi compaiono solo i campi che riguardano la stampa dell'ID; gli altri campi della richiesta restano quelli abituali.
Verificare la modalità applicata
La modalità effettivamente applicata viene restituita nel campo practiceIdPrintMode:
- nei dati della pratica (
GET /files/{idFile}ed elenco pratiche); - nei dati della Tipologia di processo.
Abilitazione
La funzionalità è disattivata di default e si abilita con la chiave di configurazione documents.practiceIdPrint.enabled:
application:
documents:
practiceIdPrint:
enabled: true
Come per le altre configurazioni, è possibile abilitarla per una singola organizzazione con la chiave documents.practiceIdPrint.enabled.<codice organizzazione>.
Personalizzare il testo stampato
Il testo del timbro si imposta con la chiave di configurazione documents.idFileStampTextTemplate:
application:
documents:
idFileStampTextTemplate: Sign ID {{idFile}} # default
- Il segnaposto
{{idFile}}viene sostituito con l'ID numerico della pratica. - Si può impostare un testo diverso per una singola organizzazione con la chiave
documents.idFileStampTextTemplate.<codice organizzazione>. - Il testo non si modifica dall'interfaccia: va impostato nella configurazione dell'installazione.
- Lo stesso testo viene usato per l'anteprima nell'editor.
Consigli:
- tenere il testo breve: viene scritto su una sola riga, in corpo 8, e un testo lungo può uscire dal bordo destro delle pagine strette;
- usare caratteri dell'alfabeto latino (lettere accentate comprese). Simboli o alfabeti non latini potrebbero non essere rappresentati correttamente, perché il timbro usa il carattere standard Helvetica.
Esempi: Pratica n. {{idFile}}, Rif. pratica {{idFile}}, ID {{idFile}}.