@salesforce/b2c-tooling-sdk 1.15.1 → 1.17.0

package/data/job-steps/ImportSourceCodeGroups.md

@@ -0,0 +1,34 @@
+<!-- prettier-ignore-start -->
+# Job Step: ImportSourceCodeGroups
+
+**Type ID:** `ImportSourceCodeGroups`  
+**Scope:** Site (add to a site-level job flow)  
+**Category:** Standard / system job step (Import)
+
+Imports source code groups in the specified mode.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `AfterImportFileHandling` | Yes | `Archive` | `Keep`, `Delete`, `Archive`, `Archive Zipped`, `Archive In Subfolders`, `Archive Overwrite Existing` | What to do with the import file after successful or failed import. The handling is not performed if there was a locking problem, or if ImportFailedHandling is ERROR and the file failed to validate. |
+| `ArchiveFolder` | No | `archive` | — | Folder to store archived import files. Used when 'AfterImportFileHandling' is 'Archive' or 'Archive Zipped'. Folder location relative to 'IMPEX/' folder. If not defined 'IMPEX/archive/' is used. |
+| `FileNamePattern` | No | — | — | Regular expression pattern to select import files, e.g. 'import_.*\.xml'. Matching files are imported in alphanumerical order. If not defined all files in working folder are imported. |
+| `ImportFailedHandling` | Yes | `WARN` | `ERROR`, `WARN` | The step exit status that will be used when the import process failed. |
+| `ImportMode` | Yes | `Merge` | `Merge`, `Delete`, `Replace`, `Update` | The import mode. |
+| `NoFilesFoundHandling` | Yes | `NO_FILES_FOUND` | `OK`, `ERROR`, `WARN`, `NO_FILES_FOUND` | The step exit status that will be used when no matching files were found. |
+| `WorkingFolder` | No | — | — | The folder that contains the import files, relative to the 'IMPEX/src/' folder. If not defined 'IMPEX/src/' is used as working folder. |
+
+## Working With IMPEX Files
+
+This step reads files from the instance IMPEX area. `WorkingFolder` is resolved relative to `IMPEX/src/` (and defaults to `IMPEX/src/`); use `FileNamePattern` to select which file(s) to import. A prior step — custom or standard — that writes a file under `IMPEX/src/...` can hand off directly to this step. See the chaining example in the `b2c:b2c-custom-job-steps` skill.
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/ImportStores.md

@@ -0,0 +1,34 @@
+<!-- prettier-ignore-start -->
+# Job Step: ImportStores
+
+**Type ID:** `ImportStores`  
+**Scope:** Site (add to a site-level job flow)  
+**Category:** Standard / system job step (Import)
+
+Imports Stores based on store.xsd
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `AfterImportFileHandling` | Yes | `Archive` | `Keep`, `Delete`, `Archive`, `Archive Zipped`, `Archive In Subfolders`, `Archive Overwrite Existing` | What to do with the import file after successful or failed import. |
+| `ArchiveFolder` | No | `archive` | — | Folder to store archived import files. Used when 'AfterImportFileHandling' is 'Archive' or 'Archive Zipped'. Folder location relative to 'IMPEX/' folder. If not defined 'IMPEX/archive/' is used. |
+| `FileNamePattern` | No | `.*\.xml` | — | Regular expression pattern to select import files, e.g. 'import_.*\.xml'. Matching files are imported in alphanumerical order. If not defined, all files in the working folder are imported. |
+| `ImportFailedHandling` | Yes | `WARN` | `ERROR`, `WARN` | The step exit status that will be used when the import process failed. |
+| `ImportMode` | Yes | `Merge` | `Merge`, `Delete`, `Replace`, `Update` | The import mode. |
+| `NoFilesFoundHandling` | Yes | `NO_FILES_FOUND` | `OK`, `ERROR`, `WARN`, `NO_FILES_FOUND` | The step exit status that will be used when no matching files were found. |
+| `WorkingFolder` | No | — | — | The folder that contains the import files, relative to the 'IMPEX/src/' folder. If not defined 'IMPEX/src/' is used as working folder. |
+
+## Working With IMPEX Files
+
+This step reads files from the instance IMPEX area. `WorkingFolder` is resolved relative to `IMPEX/src/` (and defaults to `IMPEX/src/`); use `FileNamePattern` to select which file(s) to import. A prior step — custom or standard — that writes a file under `IMPEX/src/...` can hand off directly to this step. See the chaining example in the `b2c:b2c-custom-job-steps` skill.
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/ImportTaxTable.md

@@ -0,0 +1,34 @@
+<!-- prettier-ignore-start -->
+# Job Step: ImportTaxTable
+
+**Type ID:** `ImportTaxTable`  
+**Scope:** Site (add to a site-level job flow)  
+**Category:** Standard / system job step (Import)
+
+Imports Tax Classes, Tax Jurisdictions and Tax Rates from the given ImportFile in the specified mode.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `AfterImportFileHandling` | Yes | `Archive` | `Keep`, `Delete`, `Archive`, `Archive Zipped`, `Archive In Subfolders`, `Archive Overwrite Existing` | What to do with the import file after successful or failed import. The handling is not performed if there was a locking problem, or if ImportFailedHandling is ERROR and the file failed to validate. |
+| `ArchiveFolder` | No | `archive` | — | Folder to store archived import files. Used when 'AfterImportFileHandling' is 'Archive' or 'Archive Zipped'. Folder location relative to 'IMPEX/' folder. If not defined 'IMPEX/archive/' is used. |
+| `FileNamePattern` | No | — | — | Regular expression pattern to select import files, e.g. 'import_.*\.xml'. Matching files are imported in alphanumerical order. If not defined all files in working folder are imported. |
+| `ImportFailedHandling` | Yes | `WARN` | `ERROR`, `WARN` | The step exit status that will be used when the import process failed. |
+| `ImportMode` | Yes | `Merge` | `Merge`, `Delete`, `Replace`, `Update` | The import mode. |
+| `NoFilesFoundHandling` | Yes | `NO_FILES_FOUND` | `OK`, `ERROR`, `WARN`, `NO_FILES_FOUND` | The step exit status that will be used when no matching files were found. |
+| `WorkingFolder` | No | — | — | The folder that contains the import files, relative to the 'IMPEX/src/' folder. If not defined 'IMPEX/src/' is used as working folder. |
+
+## Working With IMPEX Files
+
+This step reads files from the instance IMPEX area. `WorkingFolder` is resolved relative to `IMPEX/src/` (and defaults to `IMPEX/src/`); use `FileNamePattern` to select which file(s) to import. A prior step — custom or standard — that writes a file under `IMPEX/src/...` can hand off directly to this step. See the chaining example in the `b2c:b2c-custom-job-steps` skill.
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/IncludeStepsFromJob.md

@@ -0,0 +1,24 @@
+<!-- prettier-ignore-start -->
+# Job Step: IncludeStepsFromJob
+
+**Type ID:** `IncludeStepsFromJob`  
+**Scope:** Organization & Sites (add to an organization- or site-level job flow)  
+**Category:** Standard / system job step (Processing)
+
+Includes steps from another job. This step makes it easy to create a set of standard steps that you can execute in multiple jobs. It is recommended to use the IncludeStepsFromJob step in single execution scope flows only (Organization or one specific Storefront Site). If the IncludeStepsFromJob step is used in multi-site execution scope flows (more than one specific Storefront Site, All Storefront Sites) inclusion of the steps is done multiple times.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `JobID` | Yes | — | — | The ID of the job to import steps from. |
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/InvalidateCache.md

@@ -0,0 +1,26 @@
+<!-- prettier-ignore-start -->
+# Job Step: InvalidateCache
+
+**Type ID:** `InvalidateCache`  
+**Scope:** Site (add to a site-level job flow)  
+**Category:** Standard / system job step (Processing)
+
+Invalidate Page and Static Content Cache Invalidates the page cache and/or static content cache (images, styles, etc.) of the sites specified for the job flow. Portions of the page cache may be invalidated by specifying a set of page cache partition IDs, which will invalidate only the page cache that matches the controllers/pipelines specified with these partitions.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `InvalidatePageCache` | Yes | `true` | — | If selected, then pages in the page cache are deleted. If the PageCachePartitionIDs parameters is specified, only those partitions are invalidated, otherwise the entire page cache. |
+| `InvalidateStaticCache` | Yes | `true` | — | If selected, then all files in the static content cache are invalidated. Page cache should be invalidated at the same time to refresh static content URLs. |
+| `PageCachePartitionIDs` | No | — | — | A comma separated list of page cache partition IDs to invalidate in the page cache. If specified, only the portion of the page cache specified by the partitions is invalidated, as opposed to the entire page cache. |
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/LibraryDeltaExport.md

@@ -0,0 +1,30 @@
+<!-- prettier-ignore-start -->
+# Job Step: LibraryDeltaExport
+
+**Type ID:** `LibraryDeltaExport`  
+**Scope:** Organization (add to an organization-level job flow)  
+**Category:** Standard / system job step (Export)
+
+Creates Delta Export for Libraries. Support must be contacted to enable delta exports.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `Consumers` | Yes | — | — | Comma Separated List of consumers. Limit of 1000 characters |
+| `ExportFile` | Yes | — | — | Delta Export name and Export file name and path relative to 'IMPEX/src'. |
+| `LibraryIDs` | Yes | — | — | Comma Separated list of Library Content Ids to be exported. Limit of 1000 characters |
+
+## Working With IMPEX Files
+
+This step writes a file into the instance IMPEX area (typically under `IMPEX/src/...`). The produced file can be consumed by a later step in the same flow (for example a replication or a custom processing step) or downloaded via WebDAV. See the `b2c:b2c-custom-job-steps` skill for IMPEX hand-off patterns.
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/SearchReindex.md

@@ -0,0 +1,27 @@
+<!-- prettier-ignore-start -->
+# Job Step: SearchReindex
+
+**Type ID:** `SearchReindex`  
+**Scope:** Site (add to a site-level job flow)  
+**Category:** Standard / system job step (Processing)
+
+Rebuilds or updates search indexes. The number of search indexes that can be rebuilt or updated in parallel is globally limited. If the limit is exceeded, any rebuild or update action will be queued and executed once resources are available again.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `Active data search index` | No | `false` | — | Reindex active data search indexes. |
+| `Content search index` | No | `false` | — | Reindex content search indexes. |
+| `Indexer Type` | Yes | `Full Index Rebuild` | `Full Index Rebuild`, `Incremental Index Update` | Determines whether to rebuild or update incrementally. |
+| `Product related search indexes` | No | `false` | — | Reindex product related search indexes which contain 'Product', 'Suggest' and 'Synonym' search indexes. |
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/SiteExport.md

@@ -0,0 +1,32 @@
+<!-- prettier-ignore-start -->
+# Job Step: SiteExport
+
+**Type ID:** `SiteExport`  
+**Scope:** Organization (add to an organization-level job flow)  
+**Category:** Standard / system job step (Export)
+
+Exports site data. The DataUnits parameter defines which objects are included in the export. Its function is similar to the Data Units to Export field on the Business Manager Site Import & Export page. The parameter requires a string in JSON format that describes the data to be exported. Units not included in the JSON are not included in the export.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `DataUnits` | Yes | — | — | String in JSON format that describes the data to be exported. |
+| `ExportFile` | No | — | — | Export file name and path relative to 'IMPEX/src/instance'. Required if not using FileNamePrefix. |
+| `FileNamePrefix` | No | — | — | Prefix for the export file. Can include a path relative to 'IMPEX/src/instance'. The timestamp is appended. To order the files chronologically, sort alphabetically. Required if not using ExportFile. |
+| `OverwriteExportFile` | Yes | `true` | — | If selected, the option overwrites an existing file. If not selected and a file exists, the job exits and reports an error. |
+| `SaveOnRealm` | Yes | `false` | — | If selected, the export file will be saved in the global realm directory. |
+
+## Working With IMPEX Files
+
+This step writes a file into the instance IMPEX area (typically under `IMPEX/src/...`). The produced file can be consumed by a later step in the same flow (for example a replication or a custom processing step) or downloaded via WebDAV. See the `b2c:b2c-custom-job-steps` skill for IMPEX hand-off patterns.
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/UndoPreconfiguredCodeReplicationProcess.md

@@ -0,0 +1,24 @@
+<!-- prettier-ignore-start -->
+# Job Step: UndoPreconfiguredCodeReplicationProcess
+
+**Type ID:** `UndoPreconfiguredCodeReplicationProcess`  
+**Scope:** Organization (add to an organization-level job flow)  
+**Category:** Standard / system job step (Processing)
+
+Undo the preconfigured code replication process with the ID defined at parameter 'ReplicationProcessID'. The given code replication process must have been executed using a step of type 'ExecutePreconfiguredCodeReplicationProcess' by this job.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `ReplicationProcessID` | Yes | — | — | The ID of the preconfigured replication process. |
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/UndoPreconfiguredDataReplicationProcess.md

@@ -0,0 +1,24 @@
+<!-- prettier-ignore-start -->
+# Job Step: UndoPreconfiguredDataReplicationProcess
+
+**Type ID:** `UndoPreconfiguredDataReplicationProcess`  
+**Scope:** Organization (add to an organization-level job flow)  
+**Category:** Standard / system job step (Processing)
+
+Undo the preconfigured data replication process with the ID defined at parameter 'ReplicationProcessID'. The given data replication process must have been executed using a step of type 'ExecutePreconfiguredDataReplicationProcess' by the same job.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `ReplicationProcessID` | Yes | — | — | The ID of the preconfigured replication process. |
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/UpdateStorefrontURLs.md

@@ -0,0 +1,22 @@
+<!-- prettier-ignore-start -->
+# Job Step: UpdateStorefrontURLs
+
+**Type ID:** `UpdateStorefrontURLs`  
+**Scope:** Site (add to a site-level job flow)  
+**Category:** Standard / system job step (Processing)
+
+Updates the Storefront URLs for objects like categories, products, folders and content assets. This will update the URLs for all sites assigned under 'Scope'. This job step will not work in production instances and the storefront URLs are to be replicated from STG.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+This step takes no configuration parameters.
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/UploadActiveDataBackupToStorage.md

@@ -0,0 +1,22 @@
+<!-- prettier-ignore-start -->
+# Job Step: UploadActiveDataBackupToStorage
+
+**Type ID:** `UploadActiveDataBackupToStorage`  
+**Scope:** Site (add to a site-level job flow)  
+**Category:** Standard / system job step (Processing)
+
+Upload current site's active data to storage system (as a backup). This step uploads active data as a backup to storage system during a site move if active data is required to migrate to the new site.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+This step takes no configuration parameters.
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/UploadActiveDataToStorage.md

@@ -0,0 +1,24 @@
+<!-- prettier-ignore-start -->
+# Job Step: UploadActiveDataToStorage
+
+**Type ID:** `UploadActiveDataToStorage`  
+**Scope:** Site (add to a site-level job flow)  
+**Category:** Standard / system job step (Processing)
+
+Upload current site's active data to storage system. This step uploads active data from an old site to storage system during a site move if active data is required to migrate to the new site. Before this step can run, put the old site in 'Maintenance' mode for at least 90 minutes. This lets the old site fully process active data before the migration happens. When the job finishes, copy the storage folder name from the job log.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `TargetRealm` | Yes | — | — | The 4-letter target realm where the Active Data is intended to be downloaded by the DownoadActiveDataFromStorage step. |
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->