File docCustomDefinitions.xml
Il file di configurazione delle proprietà del documento (
docCustomDefinitions.xml) definisce le proprietà utilizzate per la gestione dei documenti. Il processo di
installazione colloca un file di esempio all'interno di /aiw/aiw1/samples/config nei sistemi operativi basati su UNIX e in C:\aiw\aiw1\samples\config in Windows.
- Nota:
- Se si modifica il file
docCustomDefinitions.xmldopo aver installato Document Pool avanzato, Supporto AFP o Supporto Documenti PDF:- Eseguire l'utilità
docCustome installare o aggiornare la funzione Proprietà del documento personalizzato. - Per la funzione Supporto Documenti PDF, caricare le proprietà di documento in Plug-in ProcessDirector di RICOH per Adobe Acrobat.
- Per la funzione Supporto AFP, accedere a RICOH Visual Workbench dall'interfaccia utente di RICOH ProcessDirector. Le nuove proprietà di documento vengono caricate in RICOH Visual Workbench al momento dell'apertura sulla stazione di lavoro.
- Eseguire l'utilità
Proprietà database e proprietà limitate
È possibile definire due tipi di proprietà di documento:
- Proprietà del database
- Proprietà non consentite
È possibile memorizzare e modificare entrambi i tipi di proprietà in un file di proprietà del documento, ma solo le proprietà database vengono memorizzate nel database.
È possibile utilizzare entrambi i tipi di proprietà nei modi seguenti:
- Con le operazioni di un flusso di lavoro per raggruppare oppure ordinare i documenti (ad esempio con il modello di procedura SortDocuments).
- È possibile collegarle a tag di indice AFP tramite di RICOH Visual Workbench Document Property Designer .
- È possibile associarle ai dati dei documenti nei lavori PDF tramitePlug-in ProcessDirector di RICOH per Adobe Acrobat-
- Se si utilizza la funzione Archivia, è possibile memorizzarle in un contenitore. Dopo averle memorizzate, è possibile impiegarle per fare ricerche nel contenitore allo scopo di recuperare lavori, documenti e informazioni cronologiche. I valori delle proprietà vengono visualizzati nella scheda Proprietà quando si fa clic su Mostra dettagli nella tabella dei risultati.
- Se si utilizza la funzione Gestione preferenza, è possibile utilizzare un file di preferenze esterno per impostare i valori delle proprietà.
È possibile utilizzare le proprietà database, ma non le proprietà limitate, nei modi seguenti:
- È possibile utilizzarle per ricercare documenti nel portlet Documenti della pagina Principale dell'interfaccia utente.
- Quando si seleziona un documento nel portlet Documenti, vengono visualizzati i valori delle proprietà database.
- È possibile utilizzarle per ricercare documenti da mostrare nel visualizzatore.
- È possibile determinare i loro valori in un lavoro, aggiornare i valori in un altro lavoro e utilizzare i valori aggiornati nel lavoro originale.
- Se si utilizza Verifica automatizzata o la funzione insertore, è possibile utilizzare le proprietà del database per ricercare documenti da riconciliare o ristampare.
- Con la funzione estesa Document Pool avanzato, è possibile utilizzare i selettori per gestire i documenti in base ai loro valori di proprietà.
Le proprietà limitate offrono i seguenti vantaggi:
- È possibile utilizzarle per evitare che nell'interfaccia utente vengano visualizzati valori di proprietà sensibili come i codici della previdenza sociale o gli importi degli assegni.
- Massimizzano le prestazioni del sistema. La gestione delle proprietà database può compromettere le prestazioni quando si elabora un notevole numero di documenti.
Consultarsi con il rappresentante dell'assistenza per stabilire i requisiti per le proprietà database e le proprietà limitate.
Sezioni del file di esempio
Il file docCustomDefinitions.xml di esempio contiene diverse sezioni. La tabella che segue riporta un riepilogo di queste sezioni.
Sezioni del file docCustomDefinitions.xml
| Sezione | Scopo |
|---|---|
| Schema | La sezione dello schema identifica lo schema e la stringa di caratteri univoca delle proprietà personalizzate del documento. Solo il rappresentante dell'assistenza può modificare questa sezione. |
| Proprietà del database | Questa sezione definisce le proprietà database dei documenti. |
| Proprietà non consentite | Questa sezione definisce le proprietà limitate dei documenti. |
| Proprietà di autorizzazione utente | Questo passo è facoltativo. Le proprietà di autorizzazione utente specificano i gruppi di autorizzazioni personalizzati per accedere alle proprietà del database. |
Sezione dello schema
La sezione Schema contiene un elemento docCustomDefinitions e un elemento schema. Solo i rappresentanti dell'assistenza possono modificare la sezione dello schema.
Sezione delle proprietà del database
La sezione Proprietà del database contiene l'elemento docProperty.
- Nota:
- Non definire una proprietà sia come proprietà database che come proprietà limitata. Non è possibile prevedere le conseguenze.
- Evitare di definire una proprietà di documento assegnandole lo stesso nome di una proprietà che RICOH ProcessDirector definisce automaticamente. Per un elenco, vedere Proprietà del documento definite automaticamente.
- <docProperty>
- Definisce le proprietà del documento contenute nel database.
Attributi per l'elemento docProperty
Attributo docProperty Obbligatorio? Note nome Sì Il nome di database (nome interno) della proprietà. È il nome utilizzato dai programmi che leggono o scrivono le proprietà. Si consiglia di utilizzare una convenzione di denominazione coerente per i nomi delle proprietà personalizzate, in modo che essi siano univoci all'interno del sistema. Ad esempio, il file docCustomDefinitions.xml utilizza il prefisso Doc.Custom che rende le sue proprietà univoche rispetto a quelle del prodotto di base. Non utilizzare spazi o caratteri speciali (come @, #, $, % o - (trattino)) nel nome della proprietà. È possibile utilizzare punti e caratteri di sottolineatura.
Non utilizzare un numero subito dopo il punto (.) nel nome del database delle proprietà. Ad esempio, la proprietà Doc.3rdLineAddress non è valida.
access No Il livello di accesso utente per la proprietà. É possibile utilizzare un livello di accesso già definito nel prodotto oppure creare un livello di accesso personalizzato, nel caso in cui quello esistente non soddisfi le proprie esigenze. Per ulteriori informazioni, vedere la sezione Accesso. datatype Sì Il tipo di dati da utilizzare per la proprietà. Vedere la tabella successiva. dbType No Un parametro di database che specifica il tipo di dati. - Nota:
- La proprietà dbtype è ormai obsoleta e non più utilizzata. Utilizzare al suo posto la proprietà datatype.
caption Sì Il nome della proprietà (la didascalia predefinita) visualizzato nell'interfaccia utente. Se le didascalie sono impostate in una sola lingua, definirle in questo file. Se si impostano nomi per l'interfaccia utente in più lingue, creare altri file di nomi delle proprietà del documento (docCustomDefinitions_lingua.properties) per le altre lingue. shortCaption Sì La didascalia breve predefinita visualizzata per questa proprietà ove richiesto, ad esempio nelle intestazioni delle colonne di una tabella. Se le didascalie brevi sono impostate in una sola lingua, definirle in questo file. Se si impostano didascalie brevi in più lingue, creare altri file di proprietà del documento (docCustomDefinitions_lingua.properties) per le altre lingue. descrizione Sì La descrizione predefinita della proprietà del documento, che viene visualizzata nell'interfaccia utente come testo della guida. Se le descrizioni sono impostate in una sola lingua, definirle in questo file. Se si impostano descrizioni in più lingue, creare altri file di proprietà del documento (docCustomDefinitions_lingua.properties) per le altre lingue. Nelle definizioni di proprietà è opportuno utilizzare questi tipi dati e database. Ricordare che la definizione del database potrebbe limitare ulteriormente i valori che possono essere memorizzati, in aggiunta alle regole di convalida visualizzate in questa tabella. Ad esempio, un valore SMALLINT può archiviare numeri interi da 0 a 32.767. I valori dei tipi di database non fanno distinzione tra maiuscole e minuscole.
Tipi dati e database consigliati per le definizioni di proprietà
Tipo dati Tipo database (utilizzato in SQL) Convalida per il tipo dati Stringa VARCHAR(128) VARCHAR:lunghezza variabile, 1-128 caratteri IntegerNonNeg SMALLINTBIGINTINTEGER SMALLINT 2 bytesBIGINT: 4 bytesINTEGER: 8 bytesMinimum=0 Data/ora TIMESTAMP TIMESTAMP: Deve contenere i valori per giorno (G), mese (M) e anno (A).Questi componenti possono essere visualizzati in uno dei seguenti formati:MM GG AAAAGG MM AAAAAAAA MM GGGiorno e mese devono essere rappresentati da un numero a due cifre.È possibile aggiungere l'ora in questo formato:hh:mm:ss XdkString10 VARCHAR(10) VARCHAR:lunghezza variabile, 1-10 caratteri - Nota:
- Questi valori sono variazioni di tipo di dati String che possono essere utilizzate al posto di String per ridurre la quantità di spazio riservato nel database ai valori di proprietà.
XdkString20 VARCHAR(20) VARCHAR:lunghezza variabile, 1-20 caratteri - Nota:
- Questi valori sono variazioni di tipo di dati String che possono essere utilizzate al posto di String per ridurre la quantità di spazio riservato nel database ai valori di proprietà.
XdkString30 VARCHAR(30) VARCHAR:lunghezza variabile, 1-30 caratteri - Nota:
- Questi valori sono variazioni di tipo di dati String che possono essere utilizzate al posto di String per ridurre la quantità di spazio riservato nel database ai valori di proprietà.
XdkString40 VARCHAR(40) VARCHAR:lunghezza variabile, 1-40 caratteri - Nota:
- Questi valori sono variazioni di tipo di dati String che possono essere utilizzate al posto di String per ridurre la quantità di spazio riservato nel database ai valori di proprietà.
XdkString50 VARCHAR(50) VARCHAR:lunghezza variabile, 1-50 caratteri - Nota:
- Questi valori sono variazioni di tipo di dati String che possono essere utilizzate al posto di String per ridurre la quantità di spazio riservato nel database ai valori di proprietà.
XdkString128 VARCHAR(128) VARCHAR:lunghezza variabile, 1-128 caratteri - Nota:
- Questi valori sono variazioni di tipo di dati String che possono essere utilizzate al posto di String per ridurre la quantità di spazio riservato nel database ai valori di proprietà.
Sezione delle proprietà limitate
La sezione Proprietà limitate contiene uno o più elementi docProperty.
- Nota:
- Non definire una proprietà sia come proprietà database che come proprietà limitata. Non è possibile prevedere le conseguenze.
- Evitare di definire una proprietà di documento assegnandole lo stesso nome di una proprietà che RICOH ProcessDirector definisce automaticamente. Per un elenco, vedere Proprietà del documento definite automaticamente.
- <docProperty>
- Identifica le proprietà del documento o del lavoro situate nel file di proprietà ma
non nel database.
Attributi per l'elemento docProperty
Attributo docProperty Obbligatorio? Note nome Sì Si consiglia di utilizzare una convenzione di denominazione coerente per i nomi delle proprietà personalizzate, in modo che essi siano univoci all'interno del sistema. Ad esempio, il file docCustomDefinitions.xml utilizza il prefisso Doc.Custom che rende le sue proprietà univoche rispetto a quelle del prodotto di base. Non utilizzare spazi o caratteri speciali (come @, #, $, % o - (trattino)) nel nome della proprietà. È possibile utilizzare punti e caratteri di sottolineatura.
Non utilizzare un numero subito dopo il punto (.) nel nome del database delle proprietà. Ad esempio, la proprietà Doc.3rdLineAddress non è valida.
datatype No Vedere la tabella successiva. caption No La didascalia visualizzata negli elenchi nell'interfaccia utente per questa proprietà. Se le didascalie sono impostate in una sola lingua, definirle in questo file. Se si impostano didascalie in più lingue, creare un file di proprietà del documento (docCustomDefinitions_lingua.properties) per le altre lingue. Per i dettagli, vedere l'argomento del centro informazioni correlato. È possibile utilizzare questi tipi di dati nelle definizioni docProperty:
Attributi per l'elemento docProperty
Tipo dati Convalida per il tipo dati Stringa Nessuno
IntegerNonNeg Intero da 0 a 2147483647
Data/ora TIMESTAMP: Deve contenere i valori per giorno (G), mese (M) e anno (A).Questi componenti possono essere visualizzati in uno dei seguenti formati:MM GG AAAAGG MM AAAAAAAA MM GGGiorno e mese devono essere rappresentati da un numero a due cifre.È possibile aggiungere l'ora in questo formato:hh:mm:ss
Sezione Proprietà di autorizzazione utente
La sezione Proprietà di autorizzazione utente è facoltativa. Le proprietà di autorizzazione utente specificano i gruppi di autorizzazioni personalizzati per accedere alle proprietà del database. Questa sezione contiene uno o più elementi di accesso.
- <access>
- Consente di definire la capacità di leggere o modificare le proprietà personalizzate.
Utilizzare questi livelli di accesso nell'elemento docProperty. È possibile utilizzare
uno dei gruppi di sicurezza predefiniti forniti da RICOH ProcessDirector, o definirne uno. Di seguito sono riportati gli attributi:Sono i livelli di accesso predefiniti e le autorizzazioni fornite da RICOH ProcessDirector:
Attributi per l'elemento access
attributo access Note nome Nome del livello di accesso. groupAttributeAccess Capacità del gruppo utenti di leggere o modificare l'attributo. Autorizzazioni e livelli di accesso predefiniti
Nome accesso Nome gruppo Livello di accesso generico AnyAuthenticated Accesso attributo: lettura Operatore Accesso attributo: lettura Supervisore Accesso attributo: lettura Amministratore Accesso attributo: scrittura attrWriteAdmin Operatore Accesso attributo: lettura Supervisore Accesso attributo: lettura Amministratore Accesso attributo: scrittura Tutti Accesso attributo: lettura Controllo Accesso attributo: lettura attrWriteAdminSuper Operatore Accesso attributo: lettura Supervisore Accesso attributo: scrittura Amministratore Accesso attributo: scrittura Tutti Accesso attributo: lettura Controllo Accesso attributo: lettura attrWriteAdminSuperOper Operatore Accesso attributo: scrittura Supervisore Accesso attributo: scrittura Amministratore Accesso attributo: scrittura Tutti Accesso attributo: lettura Controllo Accesso attributo: lettura actionAdmin Operatore Accesso azione: false Supervisore Accesso azione: false Amministratore Accesso azione: true Tutti Accesso azione: false Controllo Accesso azione: false actionAdminSuper Operatore Accesso azione: false Supervisore Accesso azione: true Amministratore Accesso azione: true Tutti Accesso azione: false Controllo Accesso azione: false actionAdminSuperOper Operatore Accesso azione: true Supervisore Accesso azione: true Amministratore Accesso azione: true Tutti Accesso azione: false Controllo Accesso azione: false
Proprietà del documento definite automaticamente
Questa tabella elenca le proprietà di documenti che RICOH ProcessDirector definisce automaticamente durante l'installazione. Non definire queste proprietà nel file docCustomDefinitions.xml.
Proprietà del documento definite automaticamente
| Nome database proprietà | Nello stesso pacchetto di... | Note |
|---|---|---|
| Doc.Address.1 | Postal Enablement | Specifica la prima riga del blocco di indirizzi nel documento. |
| Doc.Address.Company | Postal Enablement | Specifica il nome dell'azienda nel documento. |
| Doc.Address.PostalCode | Postal Enablement | Specifica il codice postale nel documento. |
| Doc.Address.ZipCode | Postal Enablement | Specifica il codice postale nel documento. |
| Doc.AV.ScanCount | Verifica automatizzata | Mostra il numero di scansioni effettuate sul codice a barre in un documento. |
| Doc.ChildJobID | Tutte le funzioni di elaborazione dei documenti | Un identificativo di raggruppamento per i lavori secondari. Sebbene il valore venga inizialmente definito in IdentifyDocuments e IdentifyPDFDocuments, può essere comunque aggiornato attraverso qualsiasi procedura che modifichi il file di proprietà documento, ad esempio SortDocuments o CreateJobsFromDocuments. |
| Doc.CurrentFirstPage | Tutte le funzioni di elaborazione dei documenti | Il numero della prima pagina del documento nel file di stampa corrente. |
| Doc.CurrentJobID | Tutte le funzioni di elaborazione dei documenti | Il numero del lavoro associato. |
| Doc.CurrentPages | Tutte le funzioni di elaborazione dei documenti | Il numero di pagine del documento nel lavoro corrente. |
| Doc.CurrentSequence | Tutte le funzioni di elaborazione dei documenti | La sequenza del documento nel lavoro corrente. |
| Doc.CurrentSheets | Tutte le funzioni di elaborazione dei documenti | Il numero di fogli del documento nel lavoro corrente. |
| Doc.Custom.MemberLevel | Electronic Presentment | Il livello di appartenenza del cliente al momento in cui viene creato il rendiconto. |
| Doc.Custom.PURL | Electronic Presentment | Un URL personalizzato che rimandi alla posizione in cui il cliente può recuperare il rendiconto. |
| Doc.Custom.StatementDate | Electronic Presentment | La data in cui è stato effettuato il rendiconto. |
| Doc.DataLen | Tutte le funzioni di elaborazione dei documenti | La lunghezza (in byte) del documento nel file di stampa. |
| Doc.DataOffset | Tutte le funzioni di elaborazione dei documenti | L'offset in byte del documento nel file di stampa del lavoro originale. Questo valore viene utilizzato da BuildAFPFromDocuments e CreateAFPJobsFromDocuments per individuare l'AFP da estrarre dal lavoro originale. |
| Doc.DocSize.PieceThickness | Postal Enablement | Specifica lo spessore del messaggio di posta quando i messaggi di posta di un lavoro presentano spessori diversi. |
| Doc.DocSize.PieceWeight | Postal Enablement | Specifica il peso del messaggio di posta quando i messaggi di posta di un lavoro presentano pesi diversi. |
| Doc.Email.Sent | Tutte le funzioni di elaborazione dei documenti | Indica se un messaggio e-mail con un documento allegato è stato creato e consegnato al server SMTP dall'operazione EmailDocuments di un flusso di lavoro. |
| Doc.EmailAddress | Tutte le funzioni di elaborazione dei documenti | L'indirizzo e-mail associato al documento. |
| Doc.ID | Tutte le funzioni di elaborazione dei documenti | Un identificativo univoco del documento. |
| Doc.Insert.BinTriggers | Imbustatrice | I contenitori dell'insertore che devono distribuire gli inserimenti per il documento. |
| Doc.Insert.DivertBin | Imbustatrice | Il numero del contenitore di output dell'insertore a cui il documento viene deviato dopo l'inserimento. |
| Doc.Insert.OriginalBarCode | Imbustatrice | I dati presenti nel codice a barre che controlla l'inserimento del documento. |
| Doc.Insert.RecipientName | Imbustatrice | Il nome della persona a cui viene inviato questo documento. |
| Doc.Insert.ReprintJobId | Imbustatrice | Per un lavoro di ristampa dell'insertore, l'ID del lavoro principale che ha creato il lavoro. |
| Doc.Member.Number | Archivia | Specifica il numero membro del documento. Il flusso di lavoro RepositorySample fornito fa uso di questa proprietà. |
| Doc.OriginalFirstPage | Tutte le funzioni di elaborazione dei documenti | Il numero della prima pagina del documento. |
| Doc.OriginalJobID | Tutte le funzioni di elaborazione dei documenti | L'ID lavoro del lavoro originale. |
| Doc.OriginalPages | Tutte le funzioni di elaborazione dei documenti | Il numero di pagine nel documento. |
| Doc.OriginalSequence | Tutte le funzioni di elaborazione dei documenti | La sequenza del documento nel lavoro originale. Il sistema assegna al primo documento il valore di sequenza 1, al documento successivo il valore di sequenza 2 e così via. |
| Doc.OriginalSheets | Tutte le funzioni di elaborazione dei documenti | Il numero di fogli necessari per stampare il documento. |
| Doc.Postal.AddressProcessingRC | Postal Enablement | Un valore restituito dal software postale che indica se la modifica di un indirizzo è disponibile per il documento. |
| Doc.Postal.Category | Postal Enablement | Specifica il punto di interruzione nel pallet per il documento. |
| Doc.Postal.ChangeAddressRC | Postal Enablement | Specifica il numero di pallet per il documento. |
| Doc.Postal.ContainerBreakMark | Postal Enablement | Specifica il segno di interruzione del contenitore per il documento. |
| Doc.Postal.ContainerNumber | Postal Enablement | Specifica il numero di contenitori per il documento. |
| Doc.Postal.HandlingUnitBreakMark | Postal Enablement | Specifica il segno di interruzione della confezione per il documento. |
| Doc.Postal.HandlingUnitNumber | Postal Enablement | Specifica il numero di confezioni per il documento. |
| Doc.Postal.PackageBreakMark | Postal Enablement | Specifica la tariffa postale per il documento. |
| Doc.Postal.PackageNumber | Postal Enablement | Specifica il codice della tariffa postale per il documento. |
| Doc.Postal.PostageRate | Postal Enablement | Specifica il numero sequenza di preordinamento per il documento. |
| Doc.Postal.PostageRateCode | Postal Enablement | Un valore restituito dal software di ordinamento postale che indica il risultato dell'elaborazione. |
| Doc.Postal.SequenceNumber | Postal Enablement | La sequenza del documento nel lavoro secondario. |
| Doc.Postal.SequencingProcessingRC | Postal Enablement | Lo stato del documento. |
| Doc.Pref.Member | Gestione preferenza | Da utilizzare con un oggetto associazione di proprietà per identificare i documenti di un lavoro. L'oggetto associazione DelimitedSample e il flusso di lavoro PreferencesSample forniti utilizzano questa proprietà. |
| Doc.Pref.Output | Gestione preferenza | Da utilizzare con un oggetto associazione di proprietà per indicare il tipo di output (come e-mail, stampa o soppressione) di un documento. L'oggetto associazione DelimitedSample e il flusso di lavoro PreferencesSample forniti utilizzano questa proprietà. |
| Doc.Pull | Tutte le funzioni di elaborazione dei documenti | Da utilizzare con il modello di operazione SetDocPropsFromList per indicare che bisogna rimuovere un documento da un lavoro. I flussi di lavoro PullPDFSample e PullAFPSample forniti utilizzano questa proprietà. |
| Doc.PullProp | Tutte le funzioni di elaborazione dei documenti | Da utilizzare con l'operazione SetDocPropsFromList per identificare la proprietà di documento che indica i documenti da rimuovere dal lavoro. I flussi di lavoro PullPDFSample e PullAFPSample forniti utilizzano questa proprietà. |
| Doc.SequenceInChild | Tutte le funzioni di elaborazione dei documenti | La sequenza di un documento in un lavoro secondario. Sebbene il valore sia inizialmente definito in IdentifyDocuments, può essere comunque aggiornato da qualsiasi procedura che modifichi il file di proprietà del documento, ad esempio SortDocuments o CreateJobsFromDocuments. |
| Doc.SourceFileName | Tutte le funzioni di elaborazione dei documenti | Il nome del file di input contenente il documento. |
| Doc.State | Tutte le funzioni di elaborazione dei documenti | Lo stato corrente del documento. |
| Doc.TT.BarcodeStatus1 | Verifica automatizzata | Mostra se il codice a barre su un documento è stato letto correttamente dalla fotocamera o dallo scanner associati a un'operazione ReadBarcodeData. |
| Doc.TT.BarcodeStatus2 | Verifica automatizzata | Mostra se il codice a barre su un documento è stato letto correttamente dalla fotocamera o dallo scanner associati a un'operazione ReadBarcodeData. |
| Doc.TT.BarcodeStatus3 | Verifica automatizzata | Mostra se il codice a barre su un documento è stato letto correttamente dalla fotocamera o dallo scanner associati a un'operazione ReadBarcodeData. |
| Doc.TT.BarcodeStatus4 | Verifica automatizzata | Mostra se il codice a barre su un documento è stato letto correttamente dalla fotocamera o dallo scanner associati a un'operazione ReadBarcodeData. |
| Doc.TT.BarcodeStatus5 | Verifica automatizzata | Mostra se il codice a barre su un documento è stato letto correttamente dalla fotocamera o dallo scanner associati a un'operazione ReadBarcodeData. |
| Doc.Verification.Recipient | Verifica automatizzata | Specifica le informazioni, ad esempio il nome account, che consentono di identificare un documento. |