Elemento TemplateTag di un file di definizione maschera
L'elemento TemplateTag viene utilizzato, insieme all'elemento TemplateDocument,
nel file di definizione maschera. E' possibile definire diversi elementi TemplateTag per ciascun messaggio XML in entrata. Tuttavia, ciascun elemento TemplateTag deve essere collegato ad un elemento TemplateDocument utilizzando l'attributoname. Il valore associato all'attributo name
deve corrispondere al valore nell'elemento secondario TemplateTagName
di un elemento TemplateDocument, definito con il file di
definizione maschera.
Ciascun elemento TemplateTag contiene un elenco di definizioni tag nell'elemento secondario Tag. L'elemento Tag può contenere i seguenti cinque attributi:
- XPath: Il percorso dell'elemento XML, relativo a StartElement indicato in TemplateDocument. L'elemento
XPath è la chiave per la ricerca del nome del campo
della coppia nome-valore. Esempi di XPath sono:
- E1/E2: Elemento E2, inserito all'interno dell'elemento E1. Di seguito è riportato
un esempio di questo tipo di percorso:
XPath='Address/ZipCode'
E1/E2/E3: Elemento E3, inserito all'interno dell'elemento E2,
che si trova a sua volta all'interno dell'elemento E1. Di seguito è riportato
un esempio di questo tipo di percorso:
XPath='ContactInfo/Address/ZipCode'
- E3@a1 : L'attributo a1 nell'elemento E3. Di seguito è riportato
un esempio di questo tipo di percorso:
XPath='InvoiceInfo@InvoiceType'
In questo caso, l'attributo InvoiceType
può essere utilizzato per indicare a quale fattura si fa
riferimento, tra una vasta gamma di tipi di fattura.
- E4[1] : La prima istanza dell'elemento E4. Possono esistere più
istanze di E4. Ad esempio, è possibile utilizzare questo formato
laddove ci siano più righe di un indirizzo. Ciascuna riga
dell'indirizzo è contenuta in un elemento Tag a parte.
- E5[@a2="value 2"] : Un'istanza dell'elemento E5, in cui l'attributo a2 di E5
corrisponde a "value 2". Ad esempio, è
possibile utilizzare il formato seguente:
XPath='InvoiceInfo[@InvoiceType="ShippingInvoice"]
E5[@a1="value1"][@a2="value 2"] : L'istanza dell'elemento E5, in cui l'attributo a1 di E5 corrisponde a '"value1" e l'attributo a2 di E5 corrisponde a "value 2".
- XPathType: Il tipo di elemento indicato nel XPath. Questo
attributo indica in che modo eseguire l'elemento XML con il parser
XML. I tipi supportati sono:
- PCDATA: L'elemento o l'attributo
dell'elemento contiene dati grezzi in entrata che verranno
elaborati e restituiti in una coppia nome-valore. Costituisce il valore predefinito per XPathType.
- EMPTY: L'elemento è vuoto o contiene dati che
è possibile ignorare. Non viene restituita alcuna coppia nome-valore
per questo elemento.
- REPEAT: L'elemento può avere più istanze. Ogni elemento PCDATA viene restituito in una coppia nome-valore.
- ATTRIBUTE: Se il nome del campo dell'elemento è
determinato dal valore di un attributo, questo attributo dovrebbe
essere di tipo ATTRIBUTE.
- VECTOR: Una nuova tabella hash verrà accodata
al vettore e tutte le coppie nome-valore generate per gli elementi
secondari verranno inserite nella nuova tabella hash.
- USERDATA: Indica un elemento definito
dall'utente. Questo elemento ha un attributo definito
name il cui valore è il nome del campo. I dati dell'elemento
vengono restituiti in una coppia nome-valore.
- Field: Il nome del campo di una coppia
nome-valore che verrà inserita in TypedProperty.
Dovrebbe
corrispondere al nome di un parametro utilizzato dal comando
richiamato.
- FieldType: Il tipo del campo di dati. Il tipo di campo può essere String
o Date (formato data ISO 8601). String è il valore predefinito.
- FieldInfo: Indica TypedProperty in cui inserire la coppia nome-valore. Data è il valore predefinito. Se si desidera inserire la
coppia nome-valore in più di un TypedProperty, è
necessario specificare più di uno tra i valori elencati di seguito,
separati da una virgola:
- Data: La coppia nome-valore verrà inserita
nell'oggetto commandProperty che contiene gli argomenti per
il comando.
- Control: La coppia nome-valore verrà
inserita nell'oggetto messageProperty che contiene le
informazioni di controllo per il comando, ad esempio USERID o PASSWORD
- Command: La coppia nome-valore utilizzata
per stabilire il comando da richiamare.
Le coppie nome-valore generate vengono utilizzate nell'elemento CommandMapping diTemplateDocument.
Se l'elemento XPath non viene rilevato nella maschera delle tag,
verrà utilizzato XPath nel messaggio XML come nome del campo e
XPathType sarà PCDATA, creando una coppia nome-valore che utilizza
XPath come nome del campo.
Per un esempio dell'utilizzo dell'elemento TemplateTag,
fare riferimento al file sys_template.xml.