Search
Search ONESOURCE Global Trade LatAm Help and Support.

How do I manage In Out input interface tables?

This functionality should be used to
register the structures of the input interface tables
. Structures are characteristics such as name, description, links between interfaces (header and item), processing properties, size, triggers, etc. Some operations, such as import priority, processing dependency, and script generation, can also be defined in this functionality.

Adding an input interface table

  1. Access the menu
    Interface > Interface Structure > Entrance Interfaces Tables
  2. On the Interface Table Filter screen, click
    Add
    .
  3. According to the definitions, complete the fields on the
    Create Interface Tables
    screen:
    * Required fields
    • Table:
      name of the table to be created. This name cannot contain spaces or restricted characters as it will generate a physical table in the Oracle database.
    • Description:
      Descriptive text with function, data source, and other information that identifies the table
    • Table Column Structure:
      • Sorting:
        Position of the column in the table structure. If you want to change the order of the records, clicking on the checkbox will allow you to drag it up or down, and you can change the order of the columns.
      • Column Name*:
        Name of the Column. This name cannot contain spaces or restricted characters as it will generate a physical column in the Oracle database table.
      • Type*:
        Column data type:
        • CHAR for alphanumeric data
        • EXTERNAL DATE for dates
        • EXTERNAL DECIMAL for numbers
        attention
        It is recommended that all columns in a Loader table be CHAR.
      • Size*:
        Number of characters in the field. In a Loader table, this value will be used to calculate field read spacing in the text file and also fix the physical field size in the CHAR type database.
      • AK:
        This column is to delete duplicate records. When you load a record in the table, the system deletes all previous records with the same value in the fields marked AK.
      • General
        • Loader or ODBC:
          indicates the type of table information search:
          • Loader is the loading of text files through Oracle SQL Loader
          • ODBC is the loading of information through the ODBC database connection to any source registered in Windows
        • Deletes Records During Run:
          When checked, this option indicates that the table records will be deleted shortly after they have been successfully executed (even if interface processing has not been completed).
        • Initial Extent (Kb):
          Number of kilobytes that must initially be allocated when creating the table.
        • Next Extent (Kb):
          Number of kilobytes that must be allocated to each growth of the table.
        • Index Tablespace:
          Name of the index allocation area that will be created by the table
      • Loader:
        • CTL name*:
          Name of the Loader control file (the same name as the table is usually used).
        • File Prefix*:
          Prefix that will be used to identify the files that should be uploaded to the table.
        • Extra Ldr Command:
          SQL Loader allows the use of a series of extra commands (command line), since these commands are often required in specific structures.
        • Generate CTL automatically:
          When checked, this option indicates that the system will automatically generate a control file based on specific structures (instead of using a
          fixed CTL
          ).
        • Field Separator:
          Character used to separate fields, for example, the semicolon (;).
          attention
          You can populate this field with a hexadecimal character and enter TAB (X'09').
        • Fixed CTL*:
          Loader control standard file.
    • Tabs:
      • ODBC:
        • ODBC Name*:
          Name of the ODBC Data Source declared in Windows.
        • Table Ref.*:
          Name of the source table of the information within the data source.
        • User:
          User name for connection to the data source.
        • Password:
          Password for connection to the data source.
        • Where Clause:
          Indicates a search condition in the ODBC table (uses any field from the original structure).
        • Specific Select:
          A fully specific select command (uses other ODBC structure tables). In this case it is important to highlight that the return labels (or column names) of the select must have the same column names as stated in
          In Out
          .
      • Header/Item:
        • Header Table (Associated Processing):
          Table that will be linked to the associated processing.
        • Mandatory existence of the item:
          In direct processing, checking this option indicates that the existence of the item will be validated by the system.
      • Direct Processing:
        important
        For base system version tables that require a specific mapping, use the
        User (CST)
        and
        Procedure. fields (CST)
        to indicate the object that will perform the processing. If the table is customized, enter the user and processing object details in the
        User
        and
        Procedure
        fields.
        • User:
          Bank user name for direct processing reference.
        • Procedure:
          Procedure responsible for processing the table.
        • User (CST):
          Bank user name for direct processing reference.
        • Procedure. (CST):
          Procedure responsible for processing the table.
      • Triggers:
        Fields that can contain the full database trigger codes.
      • Triggers (CST):
        Fields that can contain the complete trigger codes from the control file.
      • Reprocessing:
        Reprocessing is applicable to all input interfaces when there are error logs. To better understand, click on the links in the sections below:
        • Interface Tables to be Reprocessed
          : To define the tables to be reprocessed in this section, you must specify the child tables whose records must be reprocessed when correcting the parent table records
        • Relationship:
          In this section, it is critical to establish the connection between these tables, indicating the columns that connect them. For example, when reprocessing the items of an invoice along with the invoice header records, it is necessary to:
          1. Edit the note header table.
          2. Include the table of items in the
            Interface Tables to be Reprocessed
            section.
          3. Record the columns that establish the relationship (such as the parent table INVOICE_ID and the child table NF_ID).
            attention
            The
            Order
            field (from 1 to 5) influences the creation of indexes in the database when defining relationships between tables. This order is crucial to optimize search during reprocessing and improve overall application performance. For example, if the relationship between the BG_PRODUCT and BG_PRODUCT_NCM tables involves the PART_NUMBER and COD_ORGANIZATION fields, indicating the PART_NUMBER as order 1 and the COD_ORGANIZATION as order 2 can improve the efficiency of the search.
  4. Click
    Save.

Defining import priorities, configuring processing dependencies, and generating interface table scripts.

  1. Access the menu
    Interface > Interface Structure > Entrance Interfaces Tables
    .
  2. On the
    Interface Table Filter
    screen, click on the
    View
    button for the table you want to set import priorities for, configure processing dependencies, or script from an interface table.
  3. On the
    Interface Table Details
    screen, click on:
    • Define Import Priorities:
      On the
      Execution Priorities
      screen, click on referring to the table you want to reconfigure the prioritization for, and then click on
      Save
      . If you need to export the table information to an Excel file, select the desired tables and click
      Export
      .
      tip
      Table data can be organized using the
      Hide Filters
      ,
      Show Grouper
      and
      Show Grouper
      buttons.
    • Processing Dependencies:
      On the left side of the
      Processing Dependencies
      screen, select the dependencies you want to include in the table, click
      Add
      , and then
      Save
      .
    • Gerar Script da tabela selecionada:
      On the
      Scripts
      screen, click on
      Save SQL Scrip
      t. An SQL file will be generated with the table script.

Editing an input interface table

  1. Access the menu
    Interface > Interface Structure > Entrance Interfaces Tables
    .
  2. In the table on the
    Interface Table Filter
    screen, click the
    Edit
    Edit button button for the record whose information is updated.
    To view or delete a record, click the
    View
    View button and
    Delete
    Delete button buttons, respectively.
  3. On the
    Edit Interface Tables
    screen, change the required
    information
    .
  4. Click
    Save
    .
    Table data can be organized using the
    Hide Filters
    Show Grouper
    and
    Show/Hide Columns
    buttons.

Exporting input interface tables

  1. Access the menu
    Interface > Interface Structure > Entrance Interfaces Tables
    .
  2. On the
    Interface Table Filter
    screen, select the descriptions you want to export.
    To export data from all rows in the table, this marking is not required.
    Table data can be organized using the
    Hide Filters
    ,
    Show Grouper
    , and
    Show/Hide Columns
    buttons.
  3. Click
    Export
    .
An Excel file will be generated with the table descriptions, for example: