steptypes.json definition for a custom job step type
Key Takeaway
The steptypes.json file in the cartridge root registers custom job step types. A chunk-oriented step must set chunk-size to a number greater than zero, because without it the file is invalid and its step types aren't registered.
A custom job step type adds your own step to the list of steps an administrator can pick when building a job in Business Manager. The step's logic lives in a CommonJS script module or a legacy pipeline. The steptypes.json file registers that logic: it gives the step an ID, points to the code, sets which scopes the step can run in, and declares its parameters and status codes.
The two parts of a custom job step type
A custom job step type has two parts, and both live in the same cartridge. The first part is the code that does the work: a task-oriented or chunk-oriented CommonJS script module, or a legacy pipeline. The second part is a steptypes.json file that describes that code.
After you upload the cartridge and add it to the cartridge path, the custom steps appear in Business Manager as steps an administrator can add when creating a job.