Creating a table field

Some document types contain data that is formatted in a table. Create a table field to enable extraction of data that is displayed in a table.

About this task

This task assumes that you are adding a field as part of teaching your data extraction model. You have a sample document open that contains the table you want to use to create the table field.

Tables can provide a number of corresponding data points. You might need only a small subset of that data for your extraction process. When you define the fields to capture, you need to create a definition for the values of fields that are relevant to your processing goals.

Tables with well-defined borders (clear gridlines), multi-line headers, and multi-line rows are supported. Table extraction has some limitations in the table summary and for complex tables. For more information about Document Processing table support, see Best practices on table extraction IBM® Automation Document Processing limitations.

Procedure

To create a table field:

  1. From the Add fields tab, click Add table.
  2. Enter a value for the Table field display name. You can set this field in any language, using any Unicode character.
  3. Enter a value for the Table field symbolic name. This name is used to reference this project in the code, and cannot be changed. It cannot have spaces or special characters.
  4. Specify whether this table field is required or sensitive, or both.
  5. In Table creation options, select one of the following options:
    • Local table: Start a new table.
    • Global (existing) table: Select an existing table type, which automatically populates the rest of the table fields with the attributes of your existing table.
  6. Click Next.
  7. For a local table, in Table headers, define the table columns that you want to capture in your application. You should capture only the columns that are important for your runtime applications, so it might not be necessary to capture all columns in the table. Some columns might not appear in all sample documents, or some might not be needed by runtime applications. For each table header that you need, enter the following information:
    1. Enter a display name and a symbolic name for the column. This name does not have to be the same as the actual text of the column header in your samples.
    2. Enter the field type for the column, for example String, Date, Numeric, Decimal, and so on.
    3. Specify whether the value is required or sensitive, or both.

    If you decide that you do not need a table header that you created, you can use the trash can icon to delete it. To create more table headers, click Add table header.

  8. If your table contains summary information that applies only to a single column, add fields under Summary data. This is for items like Sub-total, Sales tax, Shipping, or Grand total that often appear at the end of a table, but only apply to the rightmost column of the table. If you do have summary table rows, then for each one enter the following information:
    1. Enter a display name and a symbolic name for the summary field.
    2. Enter the field type for the summary field, for example String, Date, Numeric, Decimal, and so on.
    3. Specify whether the value is required or sensitive, or both.
  9. If your table contains additional, non-summary information in a table cell, add fields under Additional data. If you do have additional cells, then for each one enter the following information:
    1. Enter a display name and a symbolic name for the additional field.
    2. Enter the field type for the additional field, for example String, Date, Numeric, Decimal, and so on.
    3. Specify whether the value is required or sensitive, or both.
    Note: For a global table, all table headers, summary data, and additional data are pre-populated by using the data from your existing table. You can edit the display name, or remove a header, but you cannot add new headers or optional data. If you want to restore headers that you removed, click Restore all table data.

    Summary data and additional data are added by default in the Summary data section. Use the double arrows icon at the end of each row to move data from one section to the other.

  10. Click Next.
  11. Enter alternative names, or aliases for your field. In a document, the same field can be identified by different names, case, or phrasing, for example Purchase order number, PO number, and PO#. In the Alias section, you can add any alternative name that might come up for your field.
  12. Click Done.

Results

After you enter all of the table information and save your table, you see the table and all of its headers appear in a hierarchical form in the Add fields tab. The table rows can be collapsed or expanded.

What to do next

After you add your table field, rerun the sample document so that the model can learn the field details from your updated field. When you open the sample after you rerun the document, you can check the values that are extracted from the table field that you created.