Quick Start Guide

Job Scheduling is a robust Catalyst service that allows you to create and schedule tasks that can be executed with the quickest time interval of one minute. You can create and submit jobs to a Job Pool, and they will be executed automatically at the scheduled time period or interval. Using Job Scheduling, you can trigger Job Functions, AppSail services, Webhooks (any third-party URL), and Circuits.

Note: The Circuits component is currently not available to Catalyst users accessing from the EU, AU, IN, or CA data centers. Hence, users from these DCs will not be able to trigger Circuits using the Job Scheduling service.

In this section, we will be going over how to incorporate Catalyst Job Scheduling with your Catalyst project.

Create a Project

Use the Catalyst console to create a new project. After the project creation is complete, you will be able to access all components of Job Scheduling and other Catalyst services from the console.

Engineer Your Application

Access Job Scheduling Components

  • Navigate to Job Scheduling service in the console. You can first create a Job Pool for your project. Inside this Job Pool, you can create jobs, or you can submit jobs created from the Jobs component section to this Job Pool, that can be executed either immediately or scheduled using the Cron component. You also have a Dashboard that you can use to see the status of the Jobs that have been executed.

  • When you schedule jobs using Cron, you choose to configure them as Pre-defined Crons, or Dynamic Crons. Pre-defined Crons allow you to configure and schedule jobs using the console UI. Dynamic Crons can be configured using the Catalyst SDK (Java, Node.js, and Python) and be executed through code during runtime. Additionally, you can use regex-like expressions called Cron Expressions to configure the schedule of the cron.

  • You can go through the help documentation of each of these components to understand the optimal ways Job Scheduling helps you to build robust solutions and applications.

Configure Job Scheduling for Your Project

Depending on your requirement, the steps you need to employ the following steps to trigger the required target type:

  • You need to initialize the Job Function, or create it in the Serverless console.
  • Code your custom business logic and deploy it to the Catalyst console using the following CLI command:
copy
$
catalyst deploy –only functions
  • Navigate to the Job Scheduling section of the console, and create a Function Job Pool with a higher allocated memory then your Job Function.
  • Create your required job and point it to the Function Job Pool. You can then use a Pre-defined or Dynamic cron to schedule the submission of the created job to the job pool. When it is executed, it will trigger the Job Function, and your custom business logic will be executed.
  • Create a Webhook Job Pool.
  • When you create a job to submit to this job pool, you can configure it to trigger any third-party URL.
  • You can schedule the submission of this job to the job pool using a Pre-defined Cron or Dynamic Cron.
  • At the scheduled time, when the job is submitted to the job pool, it will be executed in the job pool, and the configured third-party URL will be triggered.
  • You need to create and configure a circuit using the Catalyst Serverless component Circuits.
  • You need to ensure the Basic I/O functions that are required to configure the circuit are all created, coded, deployed and available in the console.
  • Create a Circuit Job Pool using the Job Scheduling service, and configure it your requirement.
  • When you create a job to trigger the circuit, you need to select the created circuit as it’s target.
  • You can schedule the submission of this job to the job pool using a Pre-defined Cron or Dynamic Cron.
  • At the scheduled time, the job will be submitted to the job pool, and the required circuit will be triggered. This will invoke the configured workflow.
Note: The Circuits component is currently not available to Catalyst users accessing from the EU, AU, IN, or CA data centers. Hence, users from these DCs will not be able to trigger Circuits using the Job Scheduling service.
  • Once you have created your required microservice or application, you need to host it on Catalyst using AppSail.
  • Create an AppSail Job Pool using the Job Scheduling service, and configure it your requirement.
  • Create a job to submit to this job pool, and ensure you have selected the required AppSail service as the target.
  • You can schedule the submission of this job to the job pool using a Pre-defined Cron or Dynamic Cron.
  • At the scheduled time, the job will be submitted to the job pool. The job pool will then execute the job and the required AppSail service’s endpoint will be triggered.

Test the Application

You can test the client components of your application locally before deploying it to the remote console using the following CLI command:

copy
$
catalyst serve

Deploy the Application

You can now deploy your application from the CLI to your project in the remote console using the following CLI command:

copy
$
catalyst deploy

Post-Production & Monitoring the Application

You can deploy your project to production after you test and freeze it in the development environment. You can create a custom domain for your application using the Domain Mappings component, if needed. You can also monitor the performance of your application using Catalyst DevOps components like Application Performance Monitoring or Logs.

Note: The sequence of steps specified here might differ based on your business or application logic, or your specific use case. The flow mentioned in the deploying and testing phases of the application can be altered based on your requirements. This is a generic set of guidelines that is suitable for a typical small to mid-scale, client-based application, or microservice.

Last Updated 2025-05-30 16:54:59 +0530 +0530