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 to configure and manage FTP/SFTP tasks in In Out?

File Transfer Protocol (FTP) and Secure File Transfer Protocol (SFTP)
 are connection types that allow you to conveniently transmit files between servers and systems connected to the Internet. In this context, use the
FTP/SFTP task
screen to
parameterize these connections
, enabling the retrieval/sending of files from/to a remote server and the association of these tasks with the interfaces registered in
In Out
.

Adding an FTP/SFTP Task

  1. Access the menu
    Interface > Interface Structure > FTP/SFTP Tasks
    .
  2. On the
    FTP/SFTP Task Filter
     screen, click
    Add
     .
  3. According to the definitions, complete the fields on the
    Create FTP/SFTP Task
     screen:
    * Required fields
    • General Data
      • Name:
        FTP or SFTP job name.
      • Order*:
        Position of the task in the execution order, if there is more than one task associated with the interface.
    • Connection:
      • Protocol*:
         Connection Protocol: File Transfer Protocol (FTP) or Secure File Transfer Protocol (SFTP)
      • Operation*:
         GET (input) or PUT (output), where:
        • GET = moves defined extensions from
          Remote Folder
           to
          Local Folder
        • PUT = moves defined extensions from
          Local Folder
           to
          Remote Folder
      • Server*:
         In Out Path.
        Example: #INOUT#\TXTFiles
      • Port*:
         Port number for connection (default: 22)
      • User:
        User for connection.
      • Password:
        Password for connection.
      • Key Type*:
        Password or host key file.
      • Key Value:
        Server/Protocol Information used for authentication.
      • Registration Level*:
         Level of detail in the log file:
        • -1=Reduced
        • 0=Normal (default)
        • 1=Debug 1
        • 2=Debug 2
      • Maximum file size* (in MB):
         Size limit of the files being transferred via the FTP/SFTP task. The value is expressed in megabytes (MB) and serves to ensure that transferred files do not compromise network performance or exceed the storage capacity of the target server. When exceeding the established limit, the
        Save
        button is disabled.
      • Maximum file count*:
        Maximum number of files that can be transferred via the FTP/SFTP task. Restricting the amount of files helps manage the use of server resources and avoid system overload during transfer processing. When exceeding the established limit, the
        Save
        button is disabled.
      • Use Proxy:
         When checked, this option indicates that proxy settings will be used
      • Deletes Source files:
         When checked, this option indicates that the source files should be deleted on the transfer.
      • Files:
        Click
        Add
        and enter:
        • Local Folder:
           Local folder where transmitted files will be stored
        • Remote Folder:
           Remote folder (FTP/SFTP server) where files can be retrieved.
          important
          In this case, the bar indicating the path to the folder should not be reversed, i.e., use "/".
        • File Mask:
           Using wildcards, represent the names of the files that should be transmitted by the task. Generally, wildcards used in masks are
          *
          and
          ?
          , where * equals any number of characters and
          ?
          symbolizes any character. For example, in the case of the
          *.txt
           mask, only text files (whose names may have any number of characters) will be sent or received.
          tip
          You can export the table information to an Excel file. To do so, mark the desired files and click
          Export
          . To export data from all rows in the table, this marking is not required.
  4. Click
    Save
    If this functionality is used to move files from an FTP/SFTP that does not belong to Thomson Reuters, the FTP/SFTP address must be public so that the connection data can be registered in the task.
    Table data can be organized using the buttons . To learn how to use them, see the
    Tables
     article.

Editing an FTP/SFTP Task

  1. Access the menu
    Interfaces > Estruturas de Interfaces > Tarefas FTP/SFTP
    .
  2. In the table on the
    FTP/SFTP Task Filter
     screen, click the
    Edit
    button of the record whose information will be updated.
    To view or delete a record, click the
    View
     and
    Delete
     buttons, respectively.
  3. On the
    Edit FTP/SFTP Task
     screen, change the required
    information
    .
  4. Click
    Save
    .
    Table data can be organized using the
    Hide Filters
    Show Grouper
    and
    Show/Hide Columns
    buttons.

Generating a SQL script from an FTP/SFTP task

  1. Access the menu
    Interfaces > Estruturas de Interfaces > Tarefas FTP/SFTP
    .
  2. On the
    FTP/SFTP Task Filter
     screen, fill in the filter fields with the task data you want to generate a script and/or click
    Filter
    .
    Table data can be organized using the
    Hide Filters
     ,
    Show Grouper
     , and
    Show/Hide Columns
    buttons.
  3. In the table, click the
    View
     button for the record whose script is generated.
  4. On the
    FTP/SFTP Task Details
     screen, click
    Generate a SQL Script
     .
  5. On the
    Scripts
     screen, click
    Save SQL Script
    .
A SQL file will be generated with the task script.

Exporting FTP/SFTP Tasks

  1. Access the menu
    Interfaces > Estruturas de Interfaces > Tarefas FTP/SFTP
    .
  2. On the
    FTP/SFTP Task Filter
     screen, select the tasks 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 task information, for example:

Related Content