Skip to main content
In Out
Search
Search ONESOURCE Global Trade LatAm Help and Support.

This article applies to:

  • Product: ONESOURCE Global Trade
  • Sub-Product: in-out

How do I register and configure interfaces in In Out?

The
interface registry
 contains the data for all interfaces used in
In Out
. Thus, this functionality allows to both add and change the main information of the interfaces.

Adding an interface

  1. Access the menu
    Interface > Interface Registration
    .
  2. Click
    Add
  3. According to the definitions, complete the fields on the
    Create Interface Registration
    screen:
    * Required fields
    • Id Interface*
      : Alphanumeric code that uniquely identifies the interface.
    • Description
      : Descriptive text that identifies the interface.
    • Active:
       When checked, this option indicates that the interface can be used.
    • Interface Type:
       Interface category: input, output, or other (e.g., backup, maintenance, etc.).
    • Interface Group:
       Set of interfaces to which the interface belongs, for example, import, export, etc. This information makes it easier to search for interfaces.
    • Executable*:
       Name of the executable file (EXE or BAT file) that will process the interface.
    • Sequencing:
       Name of the sequencing group to which the interface belongs.
    • Machines:
       Machines on which the interface will run.
      tip
      You can export the table data to an Excel file. To do this, mark the desired machines and click
      Export
      .
    • FTP Tasks:
       FTP tasks that will be associated with the interface.
      tip
      You can export the table data to an Excel file. To do this, mark the desired tasks and click
      Export
      .
    • Responsible User:
       Identification of the user who registered the interface.
    • Average time (minutes):
       Average interface run time (recalculated with each run)
    • Input Interface:
       Corresponds to the import of data (data input, originating from integration with external systems, for a given functionality of a system).
      • Input Table Association:
         Input tables whose data will be imported into the interface. This association is required when the information to be imported should be separated into different tables, such as with the purchase order interfaces (order and item information)
      • Specific Systems:
         systems (such as Import, Broker, and Export) that will be associated with the interface. The
        Priority
        column determines the execution order of the specific systems.
        attention
        If no system is checked, the imported data is made available to all systems. In addition, if interface preprocessing fails, the run will be stopped completely, but if the error occurs in postprocessing, that error will be indicated and the processing will be maintained
      • Interferes with Direct Processing:
         When checked, this option indicates that the direct processing tables will use the system owner associated with the interface (and not the owner of the table record).
    • Output Interface:
       Corresponds to the export of data (output of data, originating from a certain functionality of a system, to external integrated systems).
      • Use structure for log reprocessing:
         When checked, this option allows the use of interface resending control.
      • System*:
         System that will use interface resending control.
      • Reprocessing Procedure*:
         Name of the database procedure that will be triggered when resending is requested.
      • Key Description (1-5)*:
         Parameters that will be passed to the
        reprocessing procedure
        .
    • Other:
       Corresponds to different input and output scenarios. There are no specific rules for this type of interface.
  4. Click
    Save
    .

Viewing an interface registration

  1. Access the menu
    Interface > Interface Registration
    .
  2. On the
    Interface Filter
     screen, fill in the filter fields with the interface data you want to view and/or click
    Filter
    .
    To further narrow the search results, click
    Advanced Filters
     .
  3. In the table, click the
    View
     button for the record to be queried.
The interface registration details will be displayed.
attention
To edit, generate SQL scripts, define access groups, define access groups and delete the record, use the buttons located in the screen header.
tip
Table data can be organized using the
Hide Filters
 ,
Show Grouper
 , and
Show/Hide Columns
 buttons.

Generating a SQL script from an interface

  1. Access the menu
    Interface > Interface Registration
    .
  2. On the
    Interface Filter
     screen, fill in the filter fields with the interface data you want to generate a script and/or click
    Filter
    .
    To further narrow the search results, click
    Advanced Filters
     .
  3. In the table, click the
    View
     button for the record whose script is generated.
  4. On the
    Interface Registration Details
     screen, click
    Generate a SQL Script
     .
  5. On the
    Scripts
     screen, click
    Save SQL Script
    .
A SQL file will be generated with the interface script.

Defining access groups for an interface

  1. Access the menu
    Interface > Interface Registration
    .
  2. On the
    Interface Filter
     screen, fill in the filter fields with the data for the interface you want to define the access groups for and/or click
    Filter
    .
    To further narrow the search results, click
    Advanced Filters
     .
  3. In the table, click the
    View
     button for the record whose access groups you want to define.
  4. On the
    Interface Registration Details
     screen, click
    Set Access Groups
     .
  5. On the
    Access Group Association
     screen, select the available groups to which you want to associate the interface and click
    Add
    .
    If the interface is not associated with any access groups, all users authorized to handle import errors have access to the errors of that interface.
  6. When all desired groups are added, click
    OK
    .
The interface information will be made available according to the access groups defined.

Editing an interface registration

  1. Access the menu
    Interface > Interface Registration
    .
  2. On the
    Interface Filter
     screen, fill in the filter fields with the interface data you want to change and/or click
    Filter
    .
    To further narrow the search results, click
    Advanced Filters
     .
  3. In the table, click the
    Edit
     button of the record whose information will be updated.
    To delete a record, click the
    Delete
     button.
  4. On the
    Edit Interface Registration
     screen, change the required information.
    You cannot edit the
    ID
    ,
    Responsible User
    , and
    Average Time (minutes)
     fields.
  5. Click
    Save
    .
    Table data can be organized using the
    Hide Filters
     ,
    Show Grouper
     , and
    Show/Hide Columns
     buttons.

Exporting an interface registration

  1. Access the menu
    Interface > Interface Registration
    .
  2. On the
    Interface Filter
     screen, select the interfaces whose
    data
    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
data
 of the desired interfaces, for example:

Related Content