Skip to content

Develop a Scheduled Integration

Choreo iPaaS is a versatile integration platform that allows you to create various types of integrations depending on your requirement.

If you have a requirement to automatically run a specific integration at regular intervals, you can use Choreo iPaaS to develop a scheduled integration. This type of integration can automate the synchronization of data between different systems at specified intervals, reducing errors and improving productivity by eliminating the need for manual intervention.

This guide walks you through the steps to develop, deploy, test, and observe a scheduled integration using Choreo iPaaS.

In this guide, you will:

  • Develop a scheduled integration to fetch the weather forecast for a specified location for the next 24 hours from the OpenWeatherMap API.
  • Process the weather data to a specific format.
  • Send the formatted data to a specified email address at a specific time every day.

Prerequisites

Before you try out the steps in this guide, complete the following:

  • If you are signing in to the Choreo Console for the first time, create an organization as follows:

    1. Go to https://console.choreo.dev/, and sign in using your Google, GitHub, or Microsoft account.
    2. Enter a unique organization name. For example, Stark Industries.
    3. Read and accept the privacy policy and terms of use.
    4. Click Create. This creates the organization and opens the Project Home page of the default project created for you.

  • Fork the Choreo examples repository, which contains the sample integration for this guide.

    Repository file structure

    To work with the sample repository, it is important to familiarize yourself with the repository file structure. The sample code for this guide is in the <sample-repository-dir>/ipaas/ballerina/weather-to-email-integration directory. To understand how the functionality is implemented, you must read the code comments. The following table describes what you will find in each file in the repository:

    File path File content
    Ballerina.toml Contains metadata about the project
    Dependencies.toml Lists the dependencies required for the project
    main.bal Contains the entry point of the project, including the main function
    types.bal Contains custom data types used in the project
    utils.bal Contains utility functions and helper functions used in the project

  • Go to OpenWeatherMap and sign up to obtain an API key. For details on how to obtain an API key, see the OpenWeatherMap documentation.

Step 1: Create a scheduled integration component

  1. Sign in to Choreo iPaaS. This opens the Project Home page in the Choreo Console.
  2. If you already have one or more components in your project, click + Create. Otherwise, proceed to the next step.
  3. Go to the Scheduled Integration card and click Create.

  4. Enter a unique name and a description for the component. You can use the name and description given below:

    Field Value
    Name WeatherToEmail
    Description My first scheduled integration

  5. To allow Choreo to connect to your GitHub account, click Authorize with GitHub.

  6. If you have not already connected your GitHub repository to Choreo, enter your GitHub credentials, and select the repository you created by forking https://github.com/wso2/choreo-examples to install the Choreo GitHub App.

    Info

    The Choreo GitHub App requires the following permissions:

    - Read and write access to code and pull requests.

    - Read access to issues and metadata.

    You can revoke access if you do not want Choreo to have access to your GitHub account. However, write access is only used to send pull requests to a user repository. Choreo will not directly push any changes to a repository.

  7. In the Connect Repository pane, enter the following information:

    Field Description
    GitHub Account Your account
    GitHub Repository choreo-examples
    Branch main
    Build Preset Ballerina
    Project Path ipaas/ballerina/weather-to-email-integration

    Tip

    • Build Preset specifies the type of build to run depending on the implementation of the component. It converts the integration code into a Docker image that can run on Choreo cloud. If an integration is developed using WSO2 Integration Studio, select Micro Integrator as the build preset. If an integration is developed using the Ballerina language, select Ballerina as the build preset.

    • Project Path specifies the location of the project to build the component.

  8. Click Create. Choreo initializes the component with the sample implementation and opens the Overview page of the component.

Step 2: Deploy the integration

To deploy the integration, follow the steps given below:

  1. In the Choreo Console left navigation menu, click Deploy.
  2. In the Build Area card, click Configure & Deploy.

  3. In the Configure & Deploy pane, specify values as follows for the configurable variables:

    Tip

    The configurable variables populated here are defined in the sample Ballerina project used in this guide. To learn how to declare configurable variables in Ballerina, see the Ballerina documentation on declaring configurable variables. If configurable variables are detected in a connected Ballerina project, Choreo prompts for the respective values during component deployment.

    Field Value
    apiKey The API key you obtained in the prerequisites section
    latitude Latitude of the location to get the weather forecast
    longitude Longitude of the location to get the weather forecast
    email the email address to receive the formatted weather forecast information

  4. Click Next.

  5. In this step, you must define a schedule for the integration. In this guide, let's say you want to receive the weather information daily at 8.00 AM UTC. Enter values as follows to configure the schedule:

    Field Value
    Select Range Day
    Every 1
    At 08:00

    Tip

    • Choreo scheduling is based on Coordinated Universal Time (UTC). Therefore, when you define a schedule, it is important to convert the required time to UTC to ensure accurate scheduling.
    • When you develop a scheduled integration, you can define a schedule depending on your requirement. If you want to test and verify the integration immediately, you can schedule the deployment to run in just a few minutes after you create it. However, to avoid unnecessary expenses, make sure you reschedule or stop the deployment once you test and verify.

  6. Click Deploy. This deploys the scheduled integration to the development environment and indicates the Scheduled Status as Active in the Development card.

You can test the integration when it runs at the scheduled time.

Step 3: Test the integration

When the integration runs at the scheduled time, an email with the subject [WSO2 Choreo Demo] Next 24H Weather Forecast is sent from [email protected] to the email address specified as the email configurable variable value in Step 2.

If the integration ran successfully, you should receive an email similar to the following to the email address you specified:

Received email

Step 4: Observe the integration

The observability view in Choreo displays graphs that depict details such as throughput, latency, diagnostic data, and logs to identify and troubleshoot anomalies in components you deploy.

To visualize and monitor the performance of the scheduled integration component you deployed, click Observe in the left navigation menu. You can observe the following:

  • The throughput and latencies of requests served over a given period.
  • The logs that are generated over a given period.
  • The flame graph (Diagnostics View) that is generated over a given period.
  • The low-code diagram.

To learn more about the observability details you can view via Choreo observability, see Observability Overview.