Generatore DTD e XSD

<Item yfc:DTDOccurrence="REQUIRED" ItemKey="" ItemID="REQUIRED"
OrganizationCode="REQUIRED" UnitOfMeasure=""> 
   <PrimaryInformation Description="" ItemType="" /> 
   <AdditionalAttributeList> 
        <AdditionalAttribute Name="" Value=""/> 
    </AdditionalAttributeList> 
    <Extn ExtnAttr1="" ExtnRefId=""> 
       <CSTItemDataList yfc:DTDOccurrence="ZeroOrOne"> 
         <CSTItemData yfc:DTDOccurrence="ZeroOrMany" ItemDataKey="" 
Description=""> 
            <CSTItemExtraData yfc:DTDOccurrence="ZeroOrOne" CodeType="" 
DataType="" /> 
            <YFSCommonCode yfc:DTDOccurrence="REQUIRED" CodeName="" 
CodeType="" CodeValue="" />  
         </CSTItemData> 
       </CSTItemDataList> 
    </Extn> 
</Item>

Gli attributi con valori di REQUIRED vengono generati come attributi richiesti in DTD e XSD. Tuttavia, un attributo obbligatorio esistente non può essere contrassegnato come facoltativo.

I valori attributo possono essere specificati anche per fornire ulteriori vincoli. Un elenco di opzioni è separato da una barra verticale (|). Il valore dell'attributo deve essere una delle opzioni fornite. Ciò è supportato solo per i tipi di dati basati sulle stringhe. I valori vengono ritagliati del carattere spazio se il valore stesso è costituito interamente da spazi, nel qual caso l'opzione enumerata rimane invariata.

Ad esempio, SomeAttr="A | B | C | |" risulta in opzioni valide di "A", "B", "C", " "e" ".

Gli XML di input e output predefiniti che possono agire come base per l'XML personalizzato si trovano nella directory <runtime_sandbox>/xapidocs/xmlstruct/ . Notare inoltre che i dati DTDOccurrence e REQUIRED forniti per le tabelle standard vengono dedotti dal file di base nella directory xmlstruct e non è necessario fornirlo. Se vengono fornite, le informazioni esistenti vengono sovrascritte da tutte le nuove informazioni presenti negli XML personalizzati. I tipi di dati e le informazioni di relazione richiesti vengono ottenuti dagli XML di entità.

Di conseguenza, quando lo strumento viene eseguito, questi file XML di base vengono utilizzati come valori predefiniti per i file XML personalizzati, che devono contenere solo le modifiche apportate dall'utente, ad esempio gli elementi e attributi estesi. Ciò consente futuri aggiornamenti per modificare in modo sicuro i file XML nella directory xmlstruct. Rieseguendo lo strumento di creazione XSD, si selezionano automaticamente questi aggiornamenti.

Il file XML appropriato nella directory xmlstruct associata all'XML personalizzato viene identificato dal nome file. L'XML personalizzato può iniziare con un prefisso facoltativo seguito da un carattere di sottolineatura e dal nome file di base. Ad esempio, un file XML personalizzato chiamato Custom_File_YFS_getOrderDetails_input.xml fa riferimento al file YFS_getOrderDetails_input.xml nella directory xmlstruct.

Tuttavia, la convenzione di denominazione è facoltativa. Ad esempio, si può anche nominare l'XML personalizzato sampleCustomApi.xml, ma non viene utilizzato alcun file di base. In tal caso, lo strumento emette un messaggio informativo per indicare che non viene trovato alcun XML di base.

L'XSD generato specifica lo spazio dei nomi di destinazione come mostrato di seguito:

<xsd:schema attributeFormDefault="unqualified" 
elementFormDefault="qualified"
targetNamespace="http://www.sterlingcommerce.com/documentation" 
xmlns:xsd=http://www.w3.org/2001/XMLSchema
xmlns:yfc="http://www.sterlingcommerce.com/documentation">

Questo spazio dei nomi viene prelevato dall'attributo xmlns sull'elemento root dell'XML di input e viene impostato sul valore predefinito http://www.sterlingcommerce.com/documentation.

I file XSD e DTD contengono attributi del tipo di query utilizzati nelle API di elenco quando QryTypeSupported="Y" viene impostato nell'elemento root dell'XML di input. Allo stesso modo, i tipi di query complesse definite per le API getItemList( ) e getOrganizationList( ) sono rappresentate nei file XSD e DTD quando è impostato ComplexQuerySupported="Y".