##########################
Import Additional Data
##########################


Tetra4D Automate provides the ability to import additional data into the PDF document to complement
the CAD data:

    - Meta-data,

    - Text information to populate text fields,

    - Part list.


XML file to import meta-data
===========================

XML schema of files that enable the import of meta-data.

.. code-block:: xml

   <?xml version="1.0"?>
   <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <xsd:element name="attributes">
     <xsd:complexType>
      <xsd:sequence>
       <xsd:element name="NAME">
        <xsd:complexType>
         <xsd:sequence>
          <xsd:element name="NEW_ATTRIB">
           <xsd:complexType>
            <xsd:attribute name="name" type="xsd:string" use="required" />
            <xsd:attribute name="value" type="xsd:string" use="required" />
           </xsd:complexType>
          </xsd:element>
         </xsd:sequence>
         <xsd:attribute name="key" type="xsd:string" use="required" />
        </xsd:complexType>
       </xsd:element>
      </xsd:sequence>
     </xsd:complexType>
    </xsd:element>
   </xsd:schema>



Multiple attributes & values can be specified for every key

Sample of an XML file where several attributes (SUPPLIER, PRICE, SUPPLIER_REFERENCE) are imported and
mapped to the 3D parts, using in that case the name of the part as mapping key.

.. code-block:: xml

   <attributes>
    <NAME key="HEAD_TUBE">
     <NEW_ATTRIB name="SUPPLIER" value="Sup_1" />
     <NEW_ATTRIB name="PRICE" value="111,93 €" />
     <NEW_ATTRIB name="SUPPLIER_REFERENCE" value="9397608" />
    </NAME>
   </attributes>


XML file to define values to populate text fields
================================================

The following is XML schema of data field XML file.

.. code-block:: xml

   <?xml version="1.0"?>
   <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <xsd:element name="Fields">
     <xsd:complexType>
      <xsd:sequence>
       <xsd:field name="name" value="value" />
       <xsd:field name="name" value="value" />
      </xsd:sequence>
     </xsd:complexType>
    </xsd:element>
   </xsd:schema>

Each field has one value.

Sample of an XML file where several values to populate text fields are defined.

The mapping key are project, description, revision, and must be defined in the template using the Tetra4D Enrich feature “Set populate method for text fields).

.. code-block:: xml

   <?xml version="1.0"?>
   <Fields>
    <Field key="project" value="Micro Engine" />
    <Field key="description" value="Spare Parts catalog" />
    <Field key="revision" value="2016/02/29" />
   </Fields>


XML file to define a table
========================

Sample of an XML file that enable to import a part list in a template.

The information are:

- | Coldefs: Definition of the names of the columns of the table.
  | Remark:
  | The Coldefs values enable to map the table with the parts from the 3D annotation.
  | In such a case, the selection of a row in the table will highlight the mapped part in the 3D
  | annotation and conversely, the selection of a part in the 3D annotation will highlights the
  | mapped row in the table.

- | Tr Is-header=true: Definition of the titles of the columns.
  | Remark:
  | This option enables to replace the attributes names defined by the Coldefs by a text labels.

- | Tr: Definition of the values for the rows of the table.


.. code-block:: xml

   <TS3DFullXml CurrentVersionFormat="401">
    <TS3DBoms>
     <BOMTable>
      <coldefs>
          <col attributename="ItemNumber" is-key="true" is-visible="true"/>
          <col attributename="SUPPLIER"/>
          <col attributename="SUPPLIER_REFERENCE"/>
      </coldefs>
      <tr is-header="true">
          <td>Item</td>
          <td>Supplier</td>
          <td>Reference</td>
      </tr>
      <tr>
          <td>A4123589</td>
          <td>Supplier A</td>
          <td>RefA01</td>
      </tr>
     </BOMTable>
    </TS3DBoms>
   </TS3DFullXml>


Mapping an imported table with 3D parts
--------------------------------------

The mapping of the imported table with the 3D parts is based on the values of one specified CAD attribute.
To enable the mapping, the table must contain a column that lists the values of the attribute used as the
mapping key.

The definition of the column used to map the table with the components of the 3D annotation is done by the
is-key value.

In addition to the mapping key definition, the is-visible value makes it possible to hide one column
(usually the one used for the mapping) if it is not relevant to show these values in the table.

Example:

.. code-block:: xml

   <coldefs>
      <col attributename="ItemNumber" is-key="true" is-visible="true"/>
      <col attributename="SUPPLIER"/>
      <col attributename="SUPPLIER_REFERENCE"/>
   </coldefs>


- Above, the attribute ItemNumber is the mapping key (``is-key="true"``)

- The corresponding column will be visible (``is-visible="true"``)