Create a Custom Job Step

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.
  1. Create a cartridge.
  2. 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.
  3. 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.
  4. Upload the cartridge, and include it in the cartridge path.
  5. 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.
X Privacy Update: We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used. By continuing to use this site you are giving us your consent to do this. Privacy Policy.