Scheduling Integration Runs

You can schedule the running of integrations. For example, you can create an orchestrated integration that is triggered by a schedule or create a basic map data integration in which a trigger FTP Adapter reads a file and an invoke FTP Adapter writes the file. You can schedule this integration run to copy files at a date and time of your choosing. You can also define the frequency of the integration. When you create either of these types of integrations, a schedule icon is displayed with the integration entry on the Integrations page.

See Getting Started with the FTP Adapter.

Creating an Integration Schedule

You can create a schedule for running orchestrated integrations.

To create an integration schedule:
  1. Go to the Integration page.
  2. Find the integration in which trigger and invoke FTP adapter connections have been defined.
    These integrations are identified by a Schedule icon that depicts a calendar. There are several ways in which to create an integration.
  3. If you want to first activate the integration and then create the schedule:
    1. Click the Activate icon.
    2. Click Activate and Schedule.
  4. If you want to first create a schedule for an integration that you activate later:
    1. Select Add Schedule from the dropdown menu at the far right.
  5. In the Schedule Name field, accept the default name or click the Edit icon to enter a new name. When complete, enter an optional description and click the green checkmark. This action does not save the changes.

    Note:

    Assume you create a schedule and generate several integration runs, then deactivate and delete the integration. If you then create and activate a new integration with the same name as the deleted integration, and go to the Past Runs page, the past runs of the deleted integration are displayed. This is by design.
  6. If you want to schedule integration runs with an iCal expression, click Advanced.
    1. Enter an iCal expression, and click Validate Expression. For example:
      • The following expression indicates that this integration runs each month on the 1st, 10th, and 15th days of the month at 5:15 AM, 10:15 AM, 3:15 PM, and 8:15 PM.


        Description of sched_ical_expr.png follows
        Description of the illustration sched_ical_expr.png
      • You can also define multiple schedule frequencies. The following schedule runs every day between the hours of 5:30 PM – 7:30 PM, and during these hours it executes every 10 minutes. This configuration requires three schedules separated by the & sign:
        FREQ=DAILY;BYHOUR=17;BYMINUTE=30,40,50;BYSECOND=0;
        FREQ=DAILY;BYHOUR=18;BYMINUTE=0,10,20,30,40,50;BYSECOND=0;
        FREQ=DAILY;BYHOUR=19;BYMINUTE=0,10,20,30;BYSECOND=0;

        Description of ics_calendar_sched.png follows
        Description of the illustration ics_calendar_sched.png

      If validation is successful, the following message is displayed at the top:

      iCal expression is valid.

      Note:

      There is a three minute limitation on how frequently you can run scheduled integrations with an iCal expression. Anything below this limit is not supported.
  7. In the Frequency section, click the icon to display a dropdown list for selecting the frequency with which to run the integration. As you define one frequency, you can specify additional values by clicking the icon to the right of the Frequency section.
    • Only Once: This is the default selection. This selection clears all settings except for the From field.

      If you select this option, you cannot select When schedule starts as the start date. This option is disabled.

    • Hours and Minutes: Specify the hours and minutes at which to run the integration.

    • Days: Specify the days on which to run the integration.

    • Weeks: Specify the weeks during which to run the integration.

    • Months: Specify the months during which to run the integration.

  8. Click the green checkmark icon for each frequency type that you specify.
  9. Click Save to validate your frequency settings.
    Your selections are validated. If there are any errors, a validation message is displayed in the upper left corner that describes how to resolve the errors.
  10. In the This schedule is effective section, click the link to the right of From.
    A menu is displayed for defining the start date of the schedule.
  11. If you want to start the integration run when the schedule is activated:
    1. Click When schedule starts.
  12. If you want to explicitly set an integration run start date:
    1. Select Modify start date.
    2. Click the Calendar icon to select the month, year, and day and the hour, minute, and second at which to start the integration run.
    3. Click OK.
  13. In the Until section, click the link to the right.
    A menu is displayed for defining the expiration date.
  14. If you want the schedule run to never expire:
    1. Select Never (repeat indefinitely).
  15. If you want the integration run to have a fixed expiration date:
    1. Select Choose expiry date.
    2. Click the Calendar icon to select the month, year, and day and the hour, minute, and second at which to end the integration run.
    3. Click OK.
  16. Click Save.
    If successful, a message is displayed in the upper left corner.
    Schedule Run name saved successfully
  17. Click Exit Scheduler.
    The Schedule and Future Runs page is displayed and the Monitoring tab is highlighted in the upper right corner.

    Details about the integration run schedule are displayed. You can click the Edit icon to update the schedule definition.

  18. If you have already activated the integration, click Submit Now to run the integration or Start Schedule to activate the integration schedule.

    Note:

    • If you place a file in an input directory and run an integration for the first time, the file is copied to the output directory. If you then run the integration a second time, the same file is not copied again to the output directory, even if you deleted the file from the output directory before rerunning the integration. This is by design. Second integration runs do not copy the same file. However, if a new file is placed in the input folder or the previously-copied file is updated with a newer version in the input directory, both are copied to the output directory.

    • If you create a new schedule to repeat every minute and launch the calendar to specify a start time, it shows the current time (for example, 12:41:16). If you update the start time to several minutes later (for example, 12:43:55), save, and start the scheduled integration run, the integration starts running at 12:43:16 instead of  12:43:55. The scheduler does not care about the seconds entered and runs the schedule every minute.

  19. If you have not yet started the integration, return to the Integrations page and click Activate.
  20. Run the schedule in either of two ways:
    1. From the menu at the far right on the Integrations page, select Submit Now.
    or
    1. Select Schedule from the dropdown menu at the far right to return to the Schedule and Future Runs page.
    2. Click Submit Now to run the integration or Start Schedule to activate the integration schedule.

Creating Parameters in Scheduled Integrations

You can create and update scalar type parameters in scheduled integrations that determine how to batch and read data received from a source location. You then use these parameter values downstream in the integration. You create and assign values to these parameters in the Schedule Parameters page that is available in scheduled orchestrated integrations. You can also assign values to these parameters in assign actions. Up to five parameters are supported in the Schedule Parameters page.

  1. On the Integrations page, click Create.
  2. Select the Orchestration pattern.
  3. For the What triggers this integration option, select Schedule.
  4. Complete the remaining fields, and click Create.
    The integration canvas is displayed.
  5. Click the Schedule icon, then select Edit.
  6. In the Parameter Name column, click the plus icon.
  7. Enter a name, an optional description, and a default value in the Value column. For this example, a parameter of position and a value of 20 are entered.
  8. Click the plus icon, and enter a name (for this example, region is entered) and optional description, but leave the Value column empty.
  9. Click Close to save your changes and exit the page.
    A red warning icon is displayed on the Schedule icon. If you place your cursor over the icon, a message indicates that one or more parameters are missing a value.
    Description of sched_icon.png follows
    Description of the illustration sched_icon.png
  10. From the Actions section, drag an Assign icon into the integration, enter a name, and then click OK.
  11. In the Name column, click the plus icon, then select the parameter from the dropdown list that you created without a value in the Schedule Parameters page.
  12. Click the Edit icon to invoke the Expression Builder.
  13. Create an expression, then click Close.
  14. In the Assign page, click Close.
    You are returned to the integration canvas.
  15. Place your cursor over the Schedule icon, and note that the message about the missing parameter value is gone.

Note:

If you create a for-each action without selecting the Process items in parallel option and then add an assign action within the for-each loop, parameters defined in scheduled integrations are visible for selection in the assign action. If you later edit the for-each action and select the Process items in parallel option, a red fault icon is displayed on the impacted assign action indicating that a scheduled parameter is being used. You must correct this error for your integration to be valid. You can disable the Process items in parallel option or use the Reposition button to move the assign action outside of the for-each loop.

Starting and Pausing an Integration Schedule

After you define a schedule, you must activate it. You can also pause (deactivate) a schedule, as needed.

To start and pause an integration schedule:
  1. Go to the Integration page.
  2. Find the integration on which the scheduled run is defined.
  3. Select Schedule from the menu at the right.
    The Schedule and Future Runs page is displayed.
  4. Click the Start Schedule box.
    The following message is displayed at the top of the page: Schedule is now active.
    Details about the schedule including the frequency and any expiration date are displayed. The Start Schedule button is changed to Stop Schedule.
  5. If you want to pause the schedule run, click Pause Schedule at the far right.
  6. If you want to resume the schedule run, click Resume Schedule. This toggles the button name to Pause Schedule.

    Note:

    You can also pause a schedule from the Integrations page available under the Monitoring tab. See Monitoring Integration Runs.

Viewing Past and Present Integration Runs

You can view the status of past and present scheduled integration runs.

To view past and present integration runs:
  1. Go to the Integration page.
  2. Find the integration on which the scheduled run is defined.
  3. Select Schedule from the menu at the right.
    The Schedule and Future Runs page is displayed.
  4. Click View Past Runs.
    The Past Runs page is displayed. By default, all integration runs are displayed.
  5. Filter the display of integrations:
    1. Click In Progress to display all integration runs currently in progress.
    2. Click Completed to display all completed integration runs.
    3. Click the dropdown list to filter the display of runs by 1 hour, 6 hours, 1 day, 2 days, or 3 days.
  6. If a schedule run has failed (for example, the target FTP server did not have the correct write permissions), click the Resubmit icon at the far right to resubmit the schedule run.
    If you selected the Delete Files After Successful Retrieval checkbox on the Configure File Read page when configuring the inbound FTP Adapter, the file is deleted from the source directory if the file transfer is successful or unsuccessful this time.
    This action creates a RESUBMITTED RUN ID: number message to the right of the schedule name and original run ID. If you resubmit again, you end up with the following messages to the right of the schedule name:
    • RUN ID: number: The run ID for the first resubmission, which failed.

    • RESUBMITTED RUN ID: number: The run ID for the latest submission.

    • ORIGINAL RUN ID: number: The run ID for the initial submission.

  7. Click the RESUBMITTED RUN ID: number message link to go to the Tracking page.
  8. Click the file name of the instance.
    A graphical view of the integration flow is displayed.
    For example, if the resubmission resulted in a failure, details are displayed. For this example, the write portion of the integration failed because of a permissions issue.
    Description of scheduler_int_flow.png follows
    Description of the illustration scheduler_int_flow.png
  9. Select Actions > Audit Trail to view specific details about the error, such as the target directory not being defined with write permissions.

Viewing Future Runs

You can view the status of future scheduled integration runs.

To view future runs:
  1. Go to the Integration page.
  2. Find the integration on which the scheduled run is defined.
  3. Select Schedule from the menu at the right.
    The Schedule and Future Runs page is displayed.
  4. Click the hamburger menu menu to display tasks you can perform.
    1. Click View Past Runs.
    2. Click View Schedule.

    Details about the future runs are displayed. You can filter to display all runs, only automatically scheduled runs, or only manually submitted runs. The page only displays manually submitted runs that have a state of blocked, wait, ready, paused, or cancelling.
    Description of sched_future_runs.png follows
    Description of the illustration sched_future_runs.png

    A link is included that shows a dialog describing the reason why a run is in a blocked, wait, ready, paused, or cancelling state, along with a request ID.
    Description of sched_future_runs2.png follows
    Description of the illustration sched_future_runs2.png
See Running the File Transfer Sample for a sample of a scheduled orchestrated integration.

Editing an Integration Schedule

You can edit a schedule for an integration run.

To edit an integration schedule:
  1. Go to the Integration page.
  2. Find the integration on which the scheduled run is defined.
  3. Select Schedule from the menu at the right.
    The Schedule and Future Runs page is displayed.
  4. On the far right, click the Edit icon.
    Description of scheduler_delete.png follows
    Description of the illustration scheduler_delete.png
  5. Edit the schedule. See Creating an Integration Schedule.
  6. Click Save.

Deleting an Integration Schedule

You can delete a schedule for an integration run.

To delete an integration schedule:
  1. Go to the Integration page.
  2. Find the integration on which the scheduler run is defined.
  3. Select Schedule from the menu at the right.
    The Schedule and Future Runs page is displayed.
  4. Find the schedule in the list that you want to delete.
  5. On the far right, click the Delete icon.
    Description of scheduler_delete.png follows
    Description of the illustration scheduler_delete.png
  6. Click Yes when prompted to confirm.

Monitoring Integration Runs

You can pause and resume scheduled runs for an integration from the Monitoring page.

To monitor integration runs:
  1. On the Oracle Integration Cloud Service home page, click the Monitoring diagram.
  2. In the navigator, click Integrations.
    For integrations that include source and target FTP adapter connections, the calendar icon is displayed. This page shows only active integrations. Integrations can be of any type (that is, with or without the FTP Adapter).
  3. If you want to resubmit a run of an integration, click Submit Now. This button is available only for integrations that have an FTP Adapter as a trigger.
    Description of sched_submit_now.png follows
    Description of the illustration sched_submit_now.png
  4. If you click Push Integrations under Integrations in the navigator, all integrations that cannot be scheduled are displayed (that is, integrations that do not have an FTP Adapter as a trigger).
  5. If you click Scheduled under Integrations in the navigator, only scheduled integrations are displayed (that is, integrations that have an FTP Adapter as a trigger).
  6. If you want to pause the scheduled runs, click the Pause Schedule button.
    Description of sched_pause_int.png follows
    Description of the illustration sched_pause_int.png

Creating Ad-Hoc Integration Runs Using the REST API

You can create ad-hoc runs on integrations on which a schedule has been defined from the REST API. This is useful for when you want to test a scheduled integration.

To create ad-hoc integration runs:
  1. On the Oracle Integration Cloud Service home page, click the Integrations diagram.
  2. Find an integration on which a schedule is defined (indicated by the calendar icon).
  3. Click the Integration Details icon at the far right.
  4. Copy the URL from the Submit Now Link into a tool (such as SOAP UI) to test REST APIs. You can also use CURL commands from a terminal window to invoke the REST APIs.
    Description of sched_submit_now_url.png follows
    Description of the illustration sched_submit_now_url.png
  5. Invoke the integration run.
  6. Return to the Integrations page, and select Schedule from the list at the far right.
    The Schedule and Future Runs page is displayed.
  7. Click the View Past Runs link in the upper right corner.
    Details about the ah-hoc integration run are displayed.