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 create and manage interface schedules?

Schedules
are simply the programming of the execution of interfaces. That is, in this functionality it is possible to program when and under which conditions each interface should be executed by
In Out
.

Adding an interface schedule

  1. Access the menu
    Interfaces > Schedules
    .
  2. Click
    Add
     .
  3. According to the definitions, complete the fields on the
    Schedule Registration
     screen:
    * Required fields
    • Interface*:
       Name of the interface to be scheduled to run.
    • Active:
      When checked, this option indicates that the schedule is valid.
    • Type:
      Periodicity of interface execution.
      • Time (min.):
         The interface will run according to a number of minutes. For example, if the schedule is of this type, with a
        start time
         of 2 PM and an
        increment
         of 30 minutes, this means that, starting at 2 PM, the interface will run every 30 minutes.
      • Monthly:
        The interface will run once a month, on the registered
        day
        and start time.
      • Annual:
        The interface will run once a year, in the
        month, day
         and
        start time
         registered.
      • Daily:
        The interface will run every day at the registered
        start time
        .
      • Weekly:
        The interface will run once a week, at the
        start time
         and on
        day of the week
        registered.
      • Occasional:
        The interface will only run once, on the registered
        day, month
        , year and
        start time
        .
    • Schedule extra: Last day of the month
       when checked, this option indicates that an extra run will be scheduled for the last day of the month of the original schedule, which can be
      weekly, monthly
      , or
      annual
      . For example, if the interface is scheduled to run on the 15th of every month and this option is selected, the interface will run twice a month: once on the 15th and again on the 28th, 30th, or 31st (depending on the month).
    • Day:
      Day on which the interface will be executed, in the case of
      monthly, annual
       or
      occasional
       scheduling.
    • Month:
      Month in which the interface will run, in case of
      annual
      or
      occasional
       scheduling.
    • Year:
      Year in which the interface will run, in the event of
      an occasional
       schedule.
    • Day of week:
      Day of the week on which the interface will run, in case of
      weekly
       scheduling.
    • Start Time:
      Time at which the interface execution schedule will start.
    • End Time:
      Time at which the interface execution schedule will end.
    • Number of Minutes for Additional Time:
      Number of minutes that determines the periodicity of the interface execution, in the case of
      scheduling time (min.).
    • Date Schedule:
      Date when the schedule was registered in the system.
    • Responsible User:
      Identification of the user who registered the schedule.
  4. Click
    Save
    .
To confirm the schedule registration, go to the
Data Imports/Exports
 screen and search for the interface scheduled to run.

Editing an interface schedule

  1. Access the menu
    Interfaces > Schedules
    .
  2. On the
    Schedules
     screen, fill in the filter fields with the schedule data you want to change and/or click
    Filter
    .
    For occasional schedules to be included in the search, check the
    Occasional List
     option.
  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
    Schedule Registration
     screen, change the required information.
  5. Click
    Save
    .
    Table data can be organized using the
    Hide Filters
     ,
    Show Grouper
     , and
    Show/Hide Columns
     buttons.

Viewing an interface schedule

  1. Access the menu
    Interfaces > Interface Registration
    .
  2. On the
    Schedules
     screen, fill in the filter fields with the schedule data you want to view and/or click
    Filter
    .
    Important: For occasional schedules to be included in the search, check the
    Occasional List
     option.
  3. In the table, click the
    View
    button for the record to be queried.
The schedule details will be displayed.
attention
To edit, view change log, and delete the schedule, 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.

Querying interface schedule change log

  1. Access the menu
    Interfaces > Interface Registration
    .
  2. On the
    Schedules
     screen, fill in the filter fields with the schedule data for which you want to view the logs and/or click
    Filter
    .
  3. In the table, click the
    View
     button for the record to be queried for log.
  4. On the
    Schedule Registration
     screen, click
    Change Log
     .
  5. On the
    Change Log
     screen, complete the filter fields and click
    Filter
    .
Records of all activities performed by users are displayed in the table.
tip
Table data can be organized using the
Hide Filters
 ,
Show Grouper
 , and
Show/Hide Columns
 buttons.
Exporting logs
You can export the table information to an Excel file. To do this, check the desired records and click
Export
, for example:
attention
To export data from all rows in the table, this marking is not required.

Exporting an interface schedule

  1. Access the menu
    Interfaces > Schedules
    .
  2. On the
    Schedules
     screen, select the interfaces whose
    schedules
    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
scheduling data
for the desired interfaces, for example:

Related Content