À propos des fichiers XML d'entrée pour des API

Les API extraient des données à l'aide de fichiers XML d'entrée qui déterminent les enregistrements qui doivent être sélectionnés ou utilisés. Lors d'une extension de la base de données destinée à inclure des zones supplémentaires, vous devez également étendre le code XML d'entrée pour renseigner ces zones.

ATTENTION :

Ne transmettez pas d'élément vide (un élément dont la valeur de tous les attributs est vide) à une API. De la même manière, ne transmettez pas d'attributs ayant des espaces de début et de fin de chaîne. Dans l'une ou l'autre de ces situations, vous obtenez un résultat imprévisible.

L'exemple suivant illustre une modification du code XML d'entrée.

Exemple de modification du code XML d'entrée

L'exemple suivant modifie le fichier XML d'entrée pour l'API YFS_createOrder() :

<Orders AuthenticationKey="">
   <Order EnterpriseCode="DEFAULT" OrderNo="DB04"
OrderName="DB04" OrderDate="20010803" OrderType="Phone" PriorityCode="1"
PriorityNumber="1" ReqDeliveryDate="20010810" ReqCancelDate="" 
ReqShipDate="20010810" SCAC="FEDEX" CarrierServiceCode="Express Saver Pak" 
CarrierAccountNo="112255" NotifyAfterShipmentFlag="N" 
NotificationType="FAX" NotificationReference="" ShipCompleteFlag="N"
EnteredBy="Iain " ChargeActualFreightFlag="Y" AORFlag="Y" 
SearchCriteria1="Search" SearchCriteria2="Search Again" >
      <OrderLines>
         <OrderLine PrimeLineNo="1" SubLineNo="1"
OrderedQty="1" ReqDeliveryDate="20010810" ReqCancelDate="20010810"
ReqShipDate="20010810" SCAC="FEDEX" CarrierServiceCode="Express
Saver Pak" PickableFlag="Y" HoldFlag="N" CustomerPONo="11" >
            <Extn ExtnAcmeLineType="Type1"/>
            <Item ItemID="ITEM1" ProductClass="A" ItemWeight="1" 
ItemDesc="paintball gun" ItemShortDesc="pball gun"
UnitOfMeasure="EACH" CustomerItem="Spectra Flex" CustomerItemDesc="GEGRG"
SupplierItem="Spectra Flex @ supplier" SupplierItemDesc="Spectra
Flex Desc @ supplier" UnitCost="15.99"  CountryOfOrigin="CA"/>
            <PersonInfoShipTo Title="Mr" FirstName="Quigley"
MiddleName="Al" LastName="Johns" Company="Company" JobTitle="Project
Clert" AddressLine1="Address Line 1 -3 Main Street" AddressLine2="ShipTo
Address line 2" AddressLine3="ShipTo Address line 3" AddressLine4="ShipTo
Address line 4" AddressLine5="ShipTo Address line 5" AddressLine6="ShipTo
Address line 6" City="Acton" State="MA" ZipCode="01720" Country="US"
DayPhone="978-635-9242" EveningPhone="978-635-9252" MobilePhone="978-888-8888"
Beeper="" OtherPhone="other555-5555" DayFaxNo="" EveningFaxNo=""
EMailID="jquigley@maine.com" AlternateEmailID="hfournier@ontario.com"
ShipToID=""/>
         </OrderLine>
         <NumberOfOrderLines/>
      </OrderLines>
      <PersonInfoShipTo Title="MR" FirstName="s"
MiddleName="X" LastName="T" Suffix="T" Department="T" Company="SD"
JobTitle="SS" AddressLine1="SS" AddressLine2="SS" AddressLine3="SS"
AddressLine4="SS" AddressLine5="SS" AddressLine6="SS" City="REDWOOD"
State="CA" ZipCode="01852" Country="USA" DayPhone="3456789234" 
EveningPhone="3456789234" MobilePhone=""  EveningFaxNo="SS" />
       <PersonInfoBillTo Title="mj" FirstName="m"
MiddleName="JJ" LastName="KK" Suffix="lll" Department="l" Company="kj"
JobTitle="k" AddressLine1="HJHKK" AddressLine2="HJKHK" AddressLine3="HKHJ" 
AddressLine4="" AddressLine5="" AddressLine6="" City="UUU" State="IUI" 
ZipCode="78787" Country="USA"  />
  </Order>
  <NumberOfOrders/> 
</Orders>

Important: Pour que les scripts de configuration de fabrique fonctionnent correctement, lorsque vous ajoutez une colonne à une table de base de données, assurez-vous que la colonne n'est pas null et qu'elle possède une valeur par défaut. Si vous devez rendre la valeur de la colonne à NULL, la valeur par défaut ne doit pas être présente.

De la même manière, si vous indiquez un nom XML et un groupe XML, gardez à l'esprit que les valeurs doivent être des chaînes DOM (Document Object Model) valides. (Les valeurs ne doivent pas contenir d'espaces ni de caractères spéciaux qui ne sont pas pris en charge par la spécification DOM.)

L'exemple de fichier XML suivant illustre l'ajout d'une colonne à la table YFS_ORDER_LINE :

<?xml version="1.0" encoding="UTF-8" ?> 
<DBSchema>
 <Entities>
  <Entity TableName="YFS_ORDER_LINE">
   <Attributes> 
    <Attribute ColumnName="EXTN_ACME_LINE_TYPE" DecimalDigits="" 
Default Value="' '" Size="10" Type="CHAR" XMLGroup="Extn" 
XMLName="ExtnAcmeLineType"/> 
   </Attributes> 
  </Entity> 
 </Entities> 
</DBSchema>