Cert++
Close

Deploying and registering a custom job step cartridge

Key Takeaway

For a custom step type to be registered and listed in Business Manager, its definition file must be named steptypes.json and sit in the root folder of the cartridge. The file goes next to the cartridge folder (my_cartridge/steptypes.json), not inside it.

A custom job step is a step you write yourself when none of the built-in system steps does what a job needs. One example is a step that imports catalog data from an external PIM system and processes it before saving. You package a CommonJS script module and a steptypes.json definition file in a cartridge, upload the cartridge, and add it to the cartridge path. After B2C Commerce loads that definition, administrators can add the step to jobs in Business Manager.

How to create a custom step type

A cartridge packages and deploys B2C Commerce program code and data, so it is the delivery vehicle for a custom job step. The step's script and its definition file travel together in one cartridge.

Creating a custom step type takes four developer tasks:

  1. Create a cartridge.
  2. Write a task-oriented or chunk-oriented CommonJS script module that does the work.
  3. Create a steptypes.json file that describes the step.
  4. Upload the cartridge and include it in the cartridge path.
B2C Commerce Developer Study Guide

Checklist progress

0/237Learned

Prepare for the Exam

Play Today's Certle

Study Community

Ask questions and get the latest info from other B2C Commerce Developer studiers. 796 members and growing.