Inclusión de entidades personalizadas y descolgadas en la plantilla de API

La API estándar puede ampliarse para que proporcione información de las tablas personalizadas o descolgadas. Una herramienta proporcionada específicamente para generar los XML de plantilla, templateXmlGen.xml se encuentra en el directorio <runtime_sandbox>/bin .

1. Ejecute la herramienta de generación de XML de plantilla desde el directorio <runtime_sandbox> utilizando el mandato siguiente:

   sci_ant.sh -Dtable=TABLE_NAME -f bin/templateXmlGen.xml

2. Una vez ejecutado el mandato, los archivos XML de ejemplo se colocan en el directorio <runtime_sandbox>/extn/sampleXML como TABLE_NAME_sample.xml.

   Por ejemplo, supongamos que HF_Order_Header es un elemento descolgado de la tabla YFS_Order_Header. El archivo HF_Order_Header_sample.xml generado es el siguiente:

   <HFOrderHeader Createprogid=" " Description=" " DocumentType=" " EnterpriseKey=" " OrderHeaderKey=" " OrderName=" " OrderNo=" " .... > </HFOrderHeader>

3. Se puede generar un XML de ejemplo para incluir los atributos anteriores en una API estándar pasando la tabla YFS que tiene una relación con la tabla descolgada que le interesa.

   Por ejemplo, supongamos que HF_Order_Header es una tabla descolgada con una relación con la tabla YFS_Order_Header. La plantilla XML generada por la herramienta cuando se le pasa NOMBRE_TABLA=YFS_Order_Header es:

   <Order>
     <OrderLines>
        <OrderLine ........>
          <Extn extended attributes >
            <HFOrderHeaderList>
              <HFOrderHeader Createprogid=" " Description=" " .........>
              </HFOrderHeader>
            </HFOrderHeaderList>
          </Extn>
        </OrderLine>
     </OrderLines> 
   </Order>

   Nota: Puede modificar los atributos sólo dentro del elemento personalizado o descolgado.

   Puede borrar este XML de ejemplo para incluir los atributos personalizados en una plantilla de API, como la plantilla de salida getOrderDetails. Sin embargo, no puede cualquiera los elementos o atributos de YFS.

   Nota: Los XML de ejemplo también se generan automáticamente al crear el archivo jar de extensión de base de datos y se publican en el directorio <runtime_sandbox>/xapidocs/sampleXML . Sin embargo, si necesita crear un ejemplo de plantilla, debe ejecutar la herramienta de generación de XML de plantilla por separado, especificando el nombre de tabla YFS correspondiente.
4. Se puede suprimir una tabla descolgada pasando un atributo Operation en las API de cambio o modificación. Por ejemplo, el elemento HF_Order_Header se puede suprimir en una API changeOrder de la siguiente forma:

   <Order>
     <OrderLines>
       <OrderLine ........>
           <Extn extended attributes >
              <HFOrderHeaderList>
                <HFOrderHeader Operation="Delete" Createprogid=" " ....... >
                </HFOrderHeader>
              </HFOrderHeaderList>
           </Extn>
        </OrderLine>
     </OrderLines> 
   </Order>

   Las operaciones como Crear y Modificar se ejecutan de forma predeterminada. Si existe una entrada para ese elemento, la API modifica las entradas con el valor más reciente. En caso de que ese elemento no exista, la API crea una nueva entrada.

5. Los registros de una tabla descolgada se puede restablecer asignando el valor de "true" para el atributo Reset en el elemento list level del XML. Cuando los registros se restablecen, se suprimen todos los registros existentes de esa tabla descolgada correspondientes a la tabla padre y se insertan todos los elementos incluidos en el elemento list. Por ejemplo, los registros descolgados del elemento HF_Order_Header_list pueden restablecerse utilizando lo siguiente:

   <Order>
      <OrderLines>
        <OrderLine ........>
            <Extn extended attributes >
               <HFOrderHeaderList Reset="true">
                  <HFOrderHeader>
                  </HFOrderHeader>
               </HFOrderHeaderList>
            </Extn>
        </OrderLine>
      </OrderLines> 
    </Order>

6. Compile y despliegue las ampliaciones.