Explore Preconfigured Job Steps
Learning Objectives
- List some preconfigured system job steps.
- Describe how to configure replication processes to use in job steps.
- Explain why you might want to use the IncludeStepsFromJob system step.
Introduction
Linda learns fast that jobs are nothing without job steps. Job steps are where the work of the jobs happen. They let her control what the job actually does. There are two kinds of job steps: system and custom. When she can’t find a system step that does what she wants, she asks a developer to create a custom step.
In this unit, she focuses on system job steps.
System Job Steps
These are the out-of-the-box system job steps available to Linda when she creates a job.
| System Step | Purpose |
|---|---|
| CreateSiteMap | Creates a site map. |
| ExecutePipeline (Deprecated) | Executes a legacy pipeline. This job step is deprecated. We recommend that you re-create pipelines using job steps. |
| ExecutePreconfiguredCodeReplicationProcess | Executes a code replication process. |
| ExecutePreconfiguredDataReplicationProcesss | Executes a data replication process. |
| ExecuteScriptModule (Deprecated) | Executes a function exported by a script module. This job step is deprecated. We recommend that you create a custom job step to execute a script. |
| ExportCatalog | Exports catalog data. |
| ExportOrders | Exports order data. |
| ExportPriceBook | Exports price data. |
| ExportTaxTable | Exports tax data. |
| ImportCatalog | Imports catalog data. |
| ImportPriceBook | Imports price data. |
| ImportSiteArchive | Imports a site archive file into the current instance. |
| IncludeStepsFromJob | Includes steps from another job. |
| SearchReindex | Rebuilds or updates search indexes. |
| SiteExport | Exports site data. |
| UndoPreconfiguredCodeReplicationProcess | Undoes a preconfigured code replication process that has already completed. |
| UndoPreconfiguredDataReplicationProcess | Undoes a preconfigured data replication process that has already completed. |
| UpdateStorefrontURLs | Updates the storefront URLs for objects like categories, products, folders, and content assets. |
If she uses system steps in her job, she doesn’t have to do any coding. However, she does have to enter parameters. Each job step has its own parameters, applicable to the task that Salesforce B2C Commerce performs in that step. For example, when she adds the step ImportSiteArchive to a job, she must specify a parameter for the name of the file to be imported. Job steps typically have both required and optional parameters.
Now she delves into the details of system steps.
Execute or Undo Code or Data Replication Processes
A common reason to create jobs is to manage data or code replication processes. B2C Commerce provides these four system steps for that purpose.
- ExecutePreconfiguredCodeReplicationProcess
- ExecutePreconfiguredDataReplicationProcess
- UndoPreconfiguredCodeReplicationProcess
- UndoPreconfiguredDataReplicationProcess
To use these replication system steps, Linda must first use Business Manager to create a code or data replication process. When she configures the code or data replication process for the job step, she sets the replication process parameters like this.
- Process ID: Enter a meaningful name, because this is the value you use to configure the job step.
- Type: For data replication processes, select Transfer and Publication. For code replication processes, select Code Transfer and Activation.
- Activation: Select Job Step.
You can execute an undo replication process only if the preceding replication process was successful.
Include Steps from Another Job
Linda can use the IncludeStepsFromJob system step to include steps from another job. When she adds the IncludeStepsFromJob system step to a job, she must configure the JobID parameter to specify the other job’s ID. This makes it easy to create sets of standard steps that she can run anytime she wants.
