To create a custom job step, you must develop a task-oriented or chunk-oriented
CommonJS script module or legacy pipeline to define what the step does. You must also create
a JSON or XML steptypes file that describes the step, and then include
the module or pipeline along with the steptypes file in a cartridge
uploaded to the site.
To create a custom job step, you must be familiar with
creating and uploading a cartridge.
-
Create a cartridge.
-
Create a task-oriented or chunk-oriented CommonJS module to describe what the
step does.
A best practice is to put the CommonJS module in the
cartridge/scripts directory or subdirectory, for
example, my_cartridge/cartridge/scripts/steps.
Instead of using a CommonJS module, you can use the UX Studio plug-in to the
Eclipse IDE to create a pipeline. However, we recommend using CommonJS modules
for jobs in the new framework.
-
Create a steptypes.json or
steptypes.xml file that describes the job step and put
the file in the root directory of the cartridge.
You can describe more than one custom job step in the same file. Each
cartridge can have only one steptypes.json or
steptypes.xml file.
-
Upload the cartridge, and include it in the cartridge path.
-
For a production system, replicate the code to production, and activate the
code version that includes your cartridge.
When an administrator creates a job in Business Manager,
custom steps defined in the steptypes.json or
steptypes.xml file are listed as steps available to add to the
job.