Gerador 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>

Os atributos com valores de REQUIRED são gerados como atributos necessários na DTD e XSD. No entanto, um atributo necessário existente não pode ser marcado como opcional.

Os valores de atributo também podem ser especificados para fornecer restrições adicionais. Uma lista de opções é separada por uma barra vertical (|). O valor do atributo deve ser uma das opções fornecidas Isto é suportado apenas para tipos de dados baseados nas sequências. Os valores são cortados do caractere de espaço em branco se o valor em si é totalmente espaços, nesse caso, a opção enumerada permanece inalterada.

Por exemplo, SomeAttr="A | B | C | |" resulta em opções válidas de "A", "B", "C", " " e "".

Os XMLs de entrada e de saída padrão que podem agir como uma base para seu XML customizado estão localizados no diretório <runtime_sandbox>/xapidocs/xmlstruct/ Observe também que os dados DTDOccurrence e REQUIRED fornecidos para as tabelas padrão são inferidos a partir do arquivo base no diretório xmlstruct e não precisam ser fornecidos. Se eles são fornecidos, as informações existentes são substituídas por quaisquer novas informações presentes nos XMLs customizados. Quaisquer informações necessárias do tipo de dados e relacionamento são obtidas a partir de XMLs de entidade.

Portanto, quando a ferramenta é executada, estes arquivos XML base servem como padrão para seus arquivos XML customizados, que precisam conter apenas as mudanças feitas por você, tais como os elementos estendidos e atributos. Isso permite que os upgrades futuros modifiquem de forma segura os arquivos XML no diretório xmlstruct. Executar novamente a ferramenta de geração de XSD seleciona automaticamente essas atualizações.

O arquivo XML apropriado no diretório xmlstruct associado ao seu XML customizado identificado pelo nome do arquivo. Seu XML customizado pode iniciar com um prefixo opcional seguido por um sublinhado e o nome do arquivo base. Por exemplo, um arquivo XML customizado denominado Custom_File_YFS_getOrderDetails_input.xml refere-se ao arquivo YFS_getOrderDetails_input.xml no diretório xmlstruct.

No entanto, a convenção de nomenclatura é opcional. Por exemplo, também é possível nomear seu XML customizado sampleCustomApi.xml, mas nenhum arquivo base é usado. Neste caso, a ferramenta envia uma mensagem informativa para indicar que nenhum XML base foi localizado.

O XSD gerado especifica o namespace de destino conforme mostrado abaixo:

<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">

Este namespace é selecionado a partir do atributo xmlns no elemento raiz do XML de entrada e padronizado como http://www.sterlingcommerce.com/documentation.

Os arquivos XSD e DTD contêm atributos de tipo de consulta usados nas APIs de lista quando QryTypeSupported="Y" é configurado no elemento raiz do XML de entrada. De modo semelhante, os tipos de consulta complexos definidos para as APIs getItemList() e getOrganizationList() são representados nos arquivos XSD e DTD quando ComplexQuerySupported="Y" é configurado.