Integration batch
The integration batch is a plugin type used for customers' integrations. It can be periodic or non-periodic plugin. You can choose to pause a recurring plugin so that all the coming executions are canceled.
You can check plugins key concepts to understand the hierarchy between a plugin, the versions, the instances and the executions.
Imagine you want to create a script that imports data every night for a customer :
You declare a new integration batch plugin called
import-data-for-customer
You declare a first
1.0.0
version for this plugin with the code of the script and the declaration of the script parametersYour script is now available for usage
To execute the script, you can :
Create an integration batch instance that will use the code from the 1.0.0 version with specific input parameters
Either program the instance to automatically create executions at a specified cron, or manually create a new execution to start now or later.
How-to
Plugin creation
Use the plugin creation endpoints to create a new plugin with the plugin type as INTEGRATION_BATCH
. Everything else remains the same.
Example
Plugin version creation
Use the plugin version creation endpoints to create a new plugin version with all the properties. The call and format are the same than usual.
Example
Plugin instance creation
For the integration batch plugin, the instance is called integration_batch_instances
.
There are five properties that are used for this plugin type: cron
, cron_status
, ram_size
, cpu_size
and disk_size
.
The cron
and the cron_status
are not mandatory as you can create non-periodic jobs. If used, you should use them together.
The ram_size
, cpu_size
and disk_size
are mandatory and the default values are set to LOW
.
Example
You can perform the operations POST / PUT / GET and DELETE on the instances.
Integration batch execution creation
Executions can be created either automatically by the scheduler using the cron defined in the instance or manually using the API or the interface.
When creating an execution you have to set the execution_type
and expected_start_date
properties.
You can perform the operations POST / PUT / GET and DELETE on the executions.
The execution_type can be either MANUAL
when created using the interface or CRON
when created by the instance using the cron value set in the instance.
The expected_start_date is set by the timestamp chosen in the interface or by the cron set in the instance.
Last updated