@salesforce/b2c-tooling-sdk 1.15.1 → 1.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (168) hide show
  1. package/data/content-schemas/regiondefinition.json +1 -0
  2. package/data/job-steps/CatalogDeltaExport.md +31 -0
  3. package/data/job-steps/CreateSitemap.md +22 -0
  4. package/data/job-steps/CustomerListsDeltaExport.md +30 -0
  5. package/data/job-steps/DownloadActiveDataFromStorage.md +24 -0
  6. package/data/job-steps/ExecuteCategorizationRules.md +25 -0
  7. package/data/job-steps/ExecuteDataReplication.md +24 -0
  8. package/data/job-steps/ExecutePipeline.md +24 -0
  9. package/data/job-steps/ExecutePreconfiguredCodeReplicationProcess.md +24 -0
  10. package/data/job-steps/ExecutePreconfiguredDataReplicationProcess.md +24 -0
  11. package/data/job-steps/ExecuteScriptModule.md +27 -0
  12. package/data/job-steps/ExportABTests.md +30 -0
  13. package/data/job-steps/ExportAssignments.md +30 -0
  14. package/data/job-steps/ExportCatalog.md +37 -0
  15. package/data/job-steps/ExportContent.md +31 -0
  16. package/data/job-steps/ExportContentSlots.md +30 -0
  17. package/data/job-steps/ExportCouponCodes.md +33 -0
  18. package/data/job-steps/ExportCoupons.md +30 -0
  19. package/data/job-steps/ExportCustomObjects.md +31 -0
  20. package/data/job-steps/ExportCustomerGroups.md +30 -0
  21. package/data/job-steps/ExportCustomerList.md +31 -0
  22. package/data/job-steps/ExportCustomers.md +30 -0
  23. package/data/job-steps/ExportFacebookFeed.md +26 -0
  24. package/data/job-steps/ExportGiftCertificates.md +30 -0
  25. package/data/job-steps/ExportInventoryLists.md +31 -0
  26. package/data/job-steps/ExportMetaData.md +32 -0
  27. package/data/job-steps/ExportOrders.md +42 -0
  28. package/data/job-steps/ExportPageLocalization.md +34 -0
  29. package/data/job-steps/ExportPriceBook.md +31 -0
  30. package/data/job-steps/ExportProductLists.md +34 -0
  31. package/data/job-steps/ExportPromotions.md +30 -0
  32. package/data/job-steps/ExportShippingMethods.md +30 -0
  33. package/data/job-steps/ExportSourceCodeGroups.md +30 -0
  34. package/data/job-steps/ExportStores.md +31 -0
  35. package/data/job-steps/ExportTaxTable.md +30 -0
  36. package/data/job-steps/ImportABTests.md +34 -0
  37. package/data/job-steps/ImportActiveData.md +33 -0
  38. package/data/job-steps/ImportAssignments.md +34 -0
  39. package/data/job-steps/ImportCatalog.md +34 -0
  40. package/data/job-steps/ImportContent.md +34 -0
  41. package/data/job-steps/ImportContentSlots.md +34 -0
  42. package/data/job-steps/ImportCouponCodeRedemptions.md +34 -0
  43. package/data/job-steps/ImportCoupons.md +34 -0
  44. package/data/job-steps/ImportCustomObjects.md +34 -0
  45. package/data/job-steps/ImportCustomerGroups.md +34 -0
  46. package/data/job-steps/ImportCustomerList.md +34 -0
  47. package/data/job-steps/ImportCustomerLists.md +34 -0
  48. package/data/job-steps/ImportCustomers.md +34 -0
  49. package/data/job-steps/ImportGiftCertificates.md +34 -0
  50. package/data/job-steps/ImportInventoryLists.md +35 -0
  51. package/data/job-steps/ImportKeyValueMapping.md +35 -0
  52. package/data/job-steps/ImportPageLocalization.md +34 -0
  53. package/data/job-steps/ImportPriceBook.md +34 -0
  54. package/data/job-steps/ImportProductLists.md +34 -0
  55. package/data/job-steps/ImportPromotions.md +34 -0
  56. package/data/job-steps/ImportShippingMethods.md +34 -0
  57. package/data/job-steps/ImportSiteArchive.md +30 -0
  58. package/data/job-steps/ImportSourceCodeGroups.md +34 -0
  59. package/data/job-steps/ImportStores.md +34 -0
  60. package/data/job-steps/ImportTaxTable.md +34 -0
  61. package/data/job-steps/IncludeStepsFromJob.md +24 -0
  62. package/data/job-steps/InvalidateCache.md +26 -0
  63. package/data/job-steps/LibraryDeltaExport.md +30 -0
  64. package/data/job-steps/SearchReindex.md +27 -0
  65. package/data/job-steps/SiteExport.md +32 -0
  66. package/data/job-steps/UndoPreconfiguredCodeReplicationProcess.md +24 -0
  67. package/data/job-steps/UndoPreconfiguredDataReplicationProcess.md +24 -0
  68. package/data/job-steps/UpdateStorefrontURLs.md +22 -0
  69. package/data/job-steps/UploadActiveDataBackupToStorage.md +22 -0
  70. package/data/job-steps/UploadActiveDataToStorage.md +24 -0
  71. package/data/job-steps/index.json +426 -0
  72. package/data/job-steps/job-steps.json +2910 -0
  73. package/data/job-steps/job-steps.md +96 -0
  74. package/data/script-api/TopLevel.APIException.md +1 -1
  75. package/data/script-api/dw.catalog.CatalogMgr.md +8 -2
  76. package/data/script-api/dw.crypto.Cipher.md +5 -1
  77. package/data/script-api/dw.customer.Profile.md +45 -0
  78. package/data/script-api/dw.customer.consent.ConsentStatusEntry.md +92 -0
  79. package/data/script-api/dw.customer.consent.MarketingConsentSubscription.md +247 -0
  80. package/data/script-api/dw.customer.consent.ShopperConsentErrorCodes.md +74 -0
  81. package/data/script-api/dw.customer.consent.ShopperConsentException.md +63 -0
  82. package/data/script-api/dw.customer.consent.ShopperConsentMgr.md +152 -0
  83. package/data/script-api/dw.customer.consent.md +10 -0
  84. package/data/script-api/dw.extensions.payments.SalesforcePaymentsHooks.md +24 -0
  85. package/data/script-api/dw.extensions.payments.SalesforcePaymentsSiteConfiguration.md +76 -0
  86. package/data/script-api/dw.object.CustomAttributes.md +72 -29
  87. package/data/script-api/dw.object.md +1 -1
  88. package/data/script-api/dw.order.Basket.md +3 -2
  89. package/data/script-api/dw.order.GiftCertificateLineItem.md +1 -1
  90. package/data/script-api/dw.order.LineItem.md +88 -0
  91. package/data/script-api/dw.order.LineItemCtnr.md +41 -11
  92. package/data/script-api/dw.order.LineItemTax.md +142 -0
  93. package/data/script-api/dw.order.OrderMgr.md +8 -0
  94. package/data/script-api/dw.order.PriceAdjustment.md +1 -1
  95. package/data/script-api/dw.order.ProductLineItem.md +1 -1
  96. package/data/script-api/dw.order.ProductShippingLineItem.md +1 -1
  97. package/data/script-api/dw.order.Shipment.md +12 -4
  98. package/data/script-api/dw.order.ShippingLineItem.md +1 -1
  99. package/data/script-api/dw.order.TaxMgr.md +54 -0
  100. package/data/script-api/dw.order.hooks.TaxHooks.md +495 -0
  101. package/data/script-api/dw.order.hooks.md +1 -0
  102. package/data/script-api/dw.order.md +1 -0
  103. package/data/script-api/dw.sitemap.SitemapFile.md +1 -1
  104. package/data/script-api/dw.sitemap.SitemapMgr.md +23 -0
  105. package/data/script-api/dw.system.Request.md +0 -1
  106. package/data/script-api/dw.util.Assert.md +29 -0
  107. package/data/script-api/dw.util.Locale.md +5 -2
  108. package/data/script-api/dw.web.Cookie.md +0 -6
  109. package/data/script-api/dw.web.PageMetaTag.md +25 -1
  110. package/data/script-api/dw.ws.WSUtil.md +2 -2
  111. package/data/script-api/index.json +49 -2
  112. package/data/script-api/index.md +2 -1
  113. package/data/xsd/commercefeaturestate.xsd +1 -0
  114. package/data/xsd/customer.xsd +11 -0
  115. package/data/xsd/eventrouting.xsd +257 -0
  116. package/data/xsd/index.json +6 -2
  117. package/data/xsd/order.xsd +53 -0
  118. package/data/xsd/store.xsd +8 -0
  119. package/data/xsd/storefronts.xsd +57 -1
  120. package/dist/esm/auth/dispatch-fetch.js +9 -2
  121. package/dist/esm/auth/dispatch-fetch.js.map +1 -1
  122. package/dist/esm/auth/oauth-jwt.js +9 -1
  123. package/dist/esm/auth/oauth-jwt.js.map +1 -1
  124. package/dist/esm/auth/oauth.js +9 -1
  125. package/dist/esm/auth/oauth.js.map +1 -1
  126. package/dist/esm/auth/stateful-oauth-strategy.js +26 -3
  127. package/dist/esm/auth/stateful-oauth-strategy.js.map +1 -1
  128. package/dist/esm/clients/am-api.js +9 -1
  129. package/dist/esm/clients/am-api.js.map +1 -1
  130. package/dist/esm/clients/middleware.js +9 -1
  131. package/dist/esm/clients/middleware.js.map +1 -1
  132. package/dist/esm/clients/webdav.js +14 -6
  133. package/dist/esm/clients/webdav.js.map +1 -1
  134. package/dist/esm/docs/search.d.ts +6 -3
  135. package/dist/esm/docs/search.js +39 -8
  136. package/dist/esm/docs/search.js.map +1 -1
  137. package/dist/esm/docs/types.d.ts +1 -0
  138. package/dist/esm/docs/types.js +1 -0
  139. package/dist/esm/docs/types.js.map +1 -1
  140. package/dist/esm/errors/index.d.ts +1 -0
  141. package/dist/esm/errors/index.js +1 -0
  142. package/dist/esm/errors/index.js.map +1 -1
  143. package/dist/esm/errors/network-error.d.ts +104 -0
  144. package/dist/esm/errors/network-error.js +301 -0
  145. package/dist/esm/errors/network-error.js.map +1 -0
  146. package/dist/esm/operations/cap/pull.js +4 -1
  147. package/dist/esm/operations/cap/pull.js.map +1 -1
  148. package/dist/esm/operations/code/constants.d.ts +17 -0
  149. package/dist/esm/operations/code/constants.js +23 -0
  150. package/dist/esm/operations/code/constants.js.map +1 -0
  151. package/dist/esm/operations/code/deploy.js +31 -2
  152. package/dist/esm/operations/code/deploy.js.map +1 -1
  153. package/dist/esm/operations/code/download.js +1 -2
  154. package/dist/esm/operations/code/download.js.map +1 -1
  155. package/dist/esm/operations/debug/dap-adapter.d.ts +9 -0
  156. package/dist/esm/operations/debug/dap-adapter.js +17 -0
  157. package/dist/esm/operations/debug/dap-adapter.js.map +1 -1
  158. package/dist/esm/operations/debug/debug-session.d.ts +8 -0
  159. package/dist/esm/operations/debug/debug-session.js +18 -0
  160. package/dist/esm/operations/debug/debug-session.js.map +1 -1
  161. package/dist/esm/operations/debug/sdapi-client.d.ts +30 -0
  162. package/dist/esm/operations/debug/sdapi-client.js +80 -6
  163. package/dist/esm/operations/debug/sdapi-client.js.map +1 -1
  164. package/dist/esm/skills/github.js +77 -24
  165. package/dist/esm/skills/github.js.map +1 -1
  166. package/dist/esm/slas/token.js +9 -1
  167. package/dist/esm/slas/token.js.map +1 -1
  168. package/package.json +4 -2
@@ -0,0 +1,26 @@
1
+ <!-- prettier-ignore-start -->
2
+ # Job Step: ExportFacebookFeed
3
+
4
+ **Type ID:** `ExportFacebookFeed`
5
+ **Scope:** Site (add to a site-level job flow)
6
+ **Category:** Standard / system job step (Export)
7
+
8
+ Exports Catalog Feed for Facebook.
9
+
10
+ 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.
11
+
12
+ ## Configuration Parameters
13
+
14
+ This step takes no configuration parameters.
15
+
16
+ ## Working With IMPEX Files
17
+
18
+ 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.
19
+
20
+ ## Related
21
+
22
+ - Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
23
+ - Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
24
+ - Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
25
+
26
+ <!-- prettier-ignore-end -->
@@ -0,0 +1,30 @@
1
+ <!-- prettier-ignore-start -->
2
+ # Job Step: ExportGiftCertificates
3
+
4
+ **Type ID:** `ExportGiftCertificates`
5
+ **Scope:** Site (add to a site-level job flow)
6
+ **Category:** Standard / system job step (Export)
7
+
8
+ Exports Gift Certificates.
9
+
10
+ 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.
11
+
12
+ ## Configuration Parameters
13
+
14
+ | Parameter | Required | Default | Allowed Values | Description |
15
+ | --- | --- | --- | --- | --- |
16
+ | `ExportFile` | No | — | — | Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix. |
17
+ | `FileNamePrefix` | No | — | — | Prefix for the export file. A timestamp is appended and site information as applicable. To order the files chronologically, sort alphanumerically. Path is relative to 'IMPEX/src' and can include a subdirectory. Required if not using ExportFile. |
18
+ | `OverwriteExportFile` | No | `true` | — | If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error. |
19
+
20
+ ## Working With IMPEX Files
21
+
22
+ 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.
23
+
24
+ ## Related
25
+
26
+ - Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
27
+ - Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
28
+ - Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
29
+
30
+ <!-- prettier-ignore-end -->
@@ -0,0 +1,31 @@
1
+ <!-- prettier-ignore-start -->
2
+ # Job Step: ExportInventoryLists
3
+
4
+ **Type ID:** `ExportInventoryLists`
5
+ **Scope:** Site (add to a site-level job flow)
6
+ **Category:** Standard / system job step (Export)
7
+
8
+ Exports inventory lists.
9
+
10
+ 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.
11
+
12
+ ## Configuration Parameters
13
+
14
+ | Parameter | Required | Default | Allowed Values | Description |
15
+ | --- | --- | --- | --- | --- |
16
+ | `ExportFile` | No | — | — | Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix. |
17
+ | `FileNamePrefix` | No | — | — | Prefix for the export file. A timestamp is appended and site information as applicable. To order the files chronologically, sort alphanumerically. Path is relative to 'IMPEX/src' and can include a subdirectory. Required if not using ExportFile. |
18
+ | `InventoryListIDs` | No | — | — | Optional comma separated list of inventory list ids to be exported. If not specified, the inventory list assigned to the Site is exported. |
19
+ | `OverwriteExportFile` | No | `true` | — | If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error. |
20
+
21
+ ## Working With IMPEX Files
22
+
23
+ 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.
24
+
25
+ ## Related
26
+
27
+ - Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
28
+ - Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
29
+ - Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
30
+
31
+ <!-- prettier-ignore-end -->
@@ -0,0 +1,32 @@
1
+ <!-- prettier-ignore-start -->
2
+ # Job Step: ExportMetaData
3
+
4
+ **Type ID:** `ExportMetaData`
5
+ **Scope:** Organization (add to an organization-level job flow)
6
+ **Category:** Standard / system job step (Export)
7
+
8
+ Export System Object Type extensions and Custom Object Type definitions.
9
+
10
+ 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.
11
+
12
+ ## Configuration Parameters
13
+
14
+ | Parameter | Required | Default | Allowed Values | Description |
15
+ | --- | --- | --- | --- | --- |
16
+ | `ExportCustomTypes` | Yes | `true` | — | Export Custom Object Type definitions. |
17
+ | `ExportFile` | No | — | — | Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix. |
18
+ | `ExportSystemTypes` | Yes | `true` | — | Export System Object Type extensions. |
19
+ | `FileNamePrefix` | No | — | — | Prefix for the export file. A timestamp is appended and site information as applicable. To order the files chronologically, sort alphanumerically. Path is relative to 'IMPEX/src' and can include a subdirectory. Required if not using ExportFile. |
20
+ | `OverwriteExportFile` | No | `true` | — | If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error. |
21
+
22
+ ## Working With IMPEX Files
23
+
24
+ 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.
25
+
26
+ ## Related
27
+
28
+ - Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
29
+ - Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
30
+ - Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
31
+
32
+ <!-- prettier-ignore-end -->
@@ -0,0 +1,42 @@
1
+ <!-- prettier-ignore-start -->
2
+ # Job Step: ExportOrders
3
+
4
+ **Type ID:** `ExportOrders`
5
+ **Scope:** Site (add to a site-level job flow)
6
+ **Category:** Standard / system job step (Export)
7
+
8
+ Exports all orders matching the selected criteria using Search Service, with a maximum of 1000 orders per run. After an order has been exported successfully, its export status is EXPORTED. If an order did not export successfully, its order export status is FAILED. It is important to note that an asynchronous write action performed on an order by another process can result in an optimistic locking exception during order export.
9
+
10
+ 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.
11
+
12
+ ## Configuration Parameters
13
+
14
+ | Parameter | Required | Default | Allowed Values | Description |
15
+ | --- | --- | --- | --- | --- |
16
+ | `Canceled` | No | `true` | — | Include orders in order status CANCELED. |
17
+ | `Completed` | No | `true` | — | Include orders in order status COMPLETED. |
18
+ | `Confirmation Status` | Yes | `All` | `All`, `Not Confirmed`, `Confirmed` | The confirmation status. |
19
+ | `Created` | No | `true` | — | Deprecated. Created orders cannot be exported. |
20
+ | `Export Status` | Yes | `Ready for Export` | `All`, `Not Exported`, `Exported`, `Ready for Export`, `Export Failed` | The export status. Recommendation is to use READY FOR EXPORT to signal the export is needed. |
21
+ | `ExportFile` | No | — | — | Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix. |
22
+ | `Failed` | No | `true` | — | Deprecated. Failed orders cannot be exported. |
23
+ | `FileNamePrefix` | No | — | — | Prefix for the export file. A timestamp is appended and site information as applicable. To order the files chronologically, sort alphanumerically. Path is relative to 'IMPEX/src' and can include a subdirectory. Required if not using ExportFile. |
24
+ | `New` | No | `true` | — | Include orders in order status NEW. |
25
+ | `Open` | No | `true` | — | Include orders in order status OPEN. |
26
+ | `OverwriteExportFile` | No | `true` | — | If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error. |
27
+ | `Payment Status` | Yes | `All` | `All`, `Not Paid`, `Partially Paid`, `Paid` | The payment status. |
28
+ | `Replaced` | No | `true` | — | Include orders in order status REPLACED. |
29
+ | `Shipment Status` | Yes | `All` | `All`, `Not Shipped`, `Partially Shipped`, `Shipped` | The shipment status. |
30
+ | `Use Order Export Delay` | No | `false` | — | See 'Order Export Delay' at 'Site Preferences' -> 'Order Preferences' -> 'Order Export Settings' |
31
+
32
+ ## Working With IMPEX Files
33
+
34
+ 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.
35
+
36
+ ## Related
37
+
38
+ - Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
39
+ - Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
40
+ - Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
41
+
42
+ <!-- prettier-ignore-end -->
@@ -0,0 +1,34 @@
1
+ <!-- prettier-ignore-start -->
2
+ # Job Step: ExportPageLocalization
3
+
4
+ **Type ID:** `ExportPageLocalization`
5
+ **Scope:** Site (add to a site-level job flow)
6
+ **Category:** Standard / system job step (Export)
7
+
8
+ Export page content for localization purposes
9
+
10
+ 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.
11
+
12
+ ## Configuration Parameters
13
+
14
+ | Parameter | Required | Default | Allowed Values | Description |
15
+ | --- | --- | --- | --- | --- |
16
+ | `ExportFile` | No | — | — | Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix. |
17
+ | `FileFormat` | Yes | — | `JSON`, `RESOURCE` | The format in which the data will be exported. |
18
+ | `FileNamePrefix` | No | — | — | Prefix for the export file. A timestamp is appended and site information as applicable. To order the files chronologically, sort alphanumerically. Path is relative to 'IMPEX/src' and can include a subdirectory. Required if not using ExportFile. |
19
+ | `Locale` | Yes | — | — | The locale for which the Page data will be exported. |
20
+ | `OverwriteExportFile` | No | `true` | — | If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error. |
21
+ | `PageIDs` | No | — | — | A JSON object containing the single property 'page_ids', which is an array of Page IDs. When not specified, 'PageIDsFile' must be used. |
22
+ | `PageIDsFile` | No | — | — | When no 'PageIDs parameter is supplied, this is the name of a file containing one Page ID per line. Its is referenced relative to the 'Impex/src' folder.' |
23
+
24
+ ## Working With IMPEX Files
25
+
26
+ 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.
27
+
28
+ ## Related
29
+
30
+ - Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
31
+ - Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
32
+ - Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
33
+
34
+ <!-- prettier-ignore-end -->
@@ -0,0 +1,31 @@
1
+ <!-- prettier-ignore-start -->
2
+ # Job Step: ExportPriceBook
3
+
4
+ **Type ID:** `ExportPriceBook`
5
+ **Scope:** Organization (add to an organization-level job flow)
6
+ **Category:** Standard / system job step (Export)
7
+
8
+ Exports price data.
9
+
10
+ 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.
11
+
12
+ ## Configuration Parameters
13
+
14
+ | Parameter | Required | Default | Allowed Values | Description |
15
+ | --- | --- | --- | --- | --- |
16
+ | `ExportFile` | No | — | — | Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix. |
17
+ | `FileNamePrefix` | No | — | — | Prefix for the export file. A timestamp is appended and site information as applicable. To order the files chronologically, sort alphanumerically. Path is relative to 'IMPEX/src' and can include a subdirectory. Required if not using ExportFile. |
18
+ | `OverwriteExportFile` | No | `true` | — | If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error. |
19
+ | `PriceBookID` | Yes | — | — | The ID of the Pricebook which will be exported. |
20
+
21
+ ## Working With IMPEX Files
22
+
23
+ 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.
24
+
25
+ ## Related
26
+
27
+ - Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
28
+ - Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
29
+ - Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
30
+
31
+ <!-- prettier-ignore-end -->
@@ -0,0 +1,34 @@
1
+ <!-- prettier-ignore-start -->
2
+ # Job Step: ExportProductLists
3
+
4
+ **Type ID:** `ExportProductLists`
5
+ **Scope:** Site (add to a site-level job flow)
6
+ **Category:** Standard / system job step (Export)
7
+
8
+ Exports product lists of a site. If all the options are selected, all product lists that were created by anonymous or registered customers, either empty or non-empty, that are either new (has never been exported) or modified (changed since the last time it was exported) will be exported. If none of the options are selected, all non-empty product lists that are owned by a registered customer will be exported.
9
+
10
+ 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.
11
+
12
+ ## Configuration Parameters
13
+
14
+ | Parameter | Required | Default | Allowed Values | Description |
15
+ | --- | --- | --- | --- | --- |
16
+ | `ExportFile` | No | — | — | Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix. |
17
+ | `FileNamePrefix` | No | — | — | Prefix for the export file. A timestamp is appended and site information as applicable. To order the files chronologically, sort alphanumerically. Path is relative to 'IMPEX/src' and can include a subdirectory. Required if not using ExportFile. |
18
+ | `IncludeAnonymousLists` | No | `true` | — | Includes anonymous product lists in the export. An anonymous product list is a product list that does not belong to a registered user. |
19
+ | `IncludeEmptyLists` | No | `true` | — | Includes empty product lists. Empty product lists do not have any items added to them. When disabled, these lists are excluded from the export. |
20
+ | `ModifedListsOnly` | No | `false` | — | Limits the export to modified lists only. A modified product list is a list that has changed in some way since it was last exported. If the NewListsOnly option is also set, the export will contain new or modified product lists only. |
21
+ | `NewListsOnly` | No | `false` | — | Limits the export to new lists only. A new product list is a list that has never been exported previously. If the ModifedListsOnly option is also set, the export will contain new or modified product lists only. |
22
+ | `OverwriteExportFile` | No | `true` | — | If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error. |
23
+
24
+ ## Working With IMPEX Files
25
+
26
+ 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.
27
+
28
+ ## Related
29
+
30
+ - Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
31
+ - Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
32
+ - Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
33
+
34
+ <!-- prettier-ignore-end -->
@@ -0,0 +1,30 @@
1
+ <!-- prettier-ignore-start -->
2
+ # Job Step: ExportPromotions
3
+
4
+ **Type ID:** `ExportPromotions`
5
+ **Scope:** Site (add to a site-level job flow)
6
+ **Category:** Standard / system job step (Export)
7
+
8
+ Exports promotions.
9
+
10
+ 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.
11
+
12
+ ## Configuration Parameters
13
+
14
+ | Parameter | Required | Default | Allowed Values | Description |
15
+ | --- | --- | --- | --- | --- |
16
+ | `ExportFile` | No | — | — | Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix. |
17
+ | `FileNamePrefix` | No | — | — | Prefix for the export file. A timestamp is appended and site information as applicable. To order the files chronologically, sort alphanumerically. Path is relative to 'IMPEX/src' and can include a subdirectory. Required if not using ExportFile. |
18
+ | `OverwriteExportFile` | No | `true` | — | If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error. |
19
+
20
+ ## Working With IMPEX Files
21
+
22
+ 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.
23
+
24
+ ## Related
25
+
26
+ - Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
27
+ - Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
28
+ - Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
29
+
30
+ <!-- prettier-ignore-end -->
@@ -0,0 +1,30 @@
1
+ <!-- prettier-ignore-start -->
2
+ # Job Step: ExportShippingMethods
3
+
4
+ **Type ID:** `ExportShippingMethods`
5
+ **Scope:** Site (add to a site-level job flow)
6
+ **Category:** Standard / system job step (Export)
7
+
8
+ Exports shipping methods.
9
+
10
+ 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.
11
+
12
+ ## Configuration Parameters
13
+
14
+ | Parameter | Required | Default | Allowed Values | Description |
15
+ | --- | --- | --- | --- | --- |
16
+ | `ExportFile` | No | — | — | Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix. |
17
+ | `FileNamePrefix` | No | — | — | Prefix for the export file. A timestamp is appended and site information as applicable. To order the files chronologically, sort alphanumerically. Path is relative to 'IMPEX/src' and can include a subdirectory. Required if not using ExportFile. |
18
+ | `OverwriteExportFile` | No | `true` | — | If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error. |
19
+
20
+ ## Working With IMPEX Files
21
+
22
+ 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.
23
+
24
+ ## Related
25
+
26
+ - Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
27
+ - Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
28
+ - Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
29
+
30
+ <!-- prettier-ignore-end -->
@@ -0,0 +1,30 @@
1
+ <!-- prettier-ignore-start -->
2
+ # Job Step: ExportSourceCodeGroups
3
+
4
+ **Type ID:** `ExportSourceCodeGroups`
5
+ **Scope:** Site (add to a site-level job flow)
6
+ **Category:** Standard / system job step (Export)
7
+
8
+ Exports source code groups.
9
+
10
+ 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.
11
+
12
+ ## Configuration Parameters
13
+
14
+ | Parameter | Required | Default | Allowed Values | Description |
15
+ | --- | --- | --- | --- | --- |
16
+ | `ExportFile` | No | — | — | Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix. |
17
+ | `FileNamePrefix` | No | — | — | Prefix for the export file. A timestamp is appended and site information as applicable. To order the files chronologically, sort alphanumerically. Path is relative to 'IMPEX/src' and can include a subdirectory. Required if not using ExportFile. |
18
+ | `OverwriteExportFile` | No | `true` | — | If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error. |
19
+
20
+ ## Working With IMPEX Files
21
+
22
+ 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.
23
+
24
+ ## Related
25
+
26
+ - Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
27
+ - Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
28
+ - Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
29
+
30
+ <!-- prettier-ignore-end -->
@@ -0,0 +1,31 @@
1
+ <!-- prettier-ignore-start -->
2
+ # Job Step: ExportStores
3
+
4
+ **Type ID:** `ExportStores`
5
+ **Scope:** Site (add to a site-level job flow)
6
+ **Category:** Standard / system job step (Export)
7
+
8
+ Exports stores.
9
+
10
+ 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.
11
+
12
+ ## Configuration Parameters
13
+
14
+ | Parameter | Required | Default | Allowed Values | Description |
15
+ | --- | --- | --- | --- | --- |
16
+ | `ExportFile` | No | — | — | Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix. |
17
+ | `FileNamePrefix` | No | — | — | Prefix for the export file. A timestamp is appended and site information as applicable. To order the files chronologically, sort alphanumerically. Path is relative to 'IMPEX/src' and can include a subdirectory. Required if not using ExportFile. |
18
+ | `OverwriteExportFile` | No | `true` | — | If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error. |
19
+ | `StoreID` | Yes | — | — | Define the ID of the store to be exported or '*' to export all stores. |
20
+
21
+ ## Working With IMPEX Files
22
+
23
+ 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.
24
+
25
+ ## Related
26
+
27
+ - Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
28
+ - Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
29
+ - Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
30
+
31
+ <!-- prettier-ignore-end -->
@@ -0,0 +1,30 @@
1
+ <!-- prettier-ignore-start -->
2
+ # Job Step: ExportTaxTable
3
+
4
+ **Type ID:** `ExportTaxTable`
5
+ **Scope:** Site (add to a site-level job flow)
6
+ **Category:** Standard / system job step (Export)
7
+
8
+ Exports tax data.
9
+
10
+ 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.
11
+
12
+ ## Configuration Parameters
13
+
14
+ | Parameter | Required | Default | Allowed Values | Description |
15
+ | --- | --- | --- | --- | --- |
16
+ | `ExportFile` | No | — | — | Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix. |
17
+ | `FileNamePrefix` | No | — | — | Prefix for the export file. A timestamp is appended and site information as applicable. To order the files chronologically, sort alphanumerically. Path is relative to 'IMPEX/src' and can include a subdirectory. Required if not using ExportFile. |
18
+ | `OverwriteExportFile` | No | `true` | — | If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error. |
19
+
20
+ ## Working With IMPEX Files
21
+
22
+ 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.
23
+
24
+ ## Related
25
+
26
+ - Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
27
+ - Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
28
+ - Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
29
+
30
+ <!-- prettier-ignore-end -->
@@ -0,0 +1,34 @@
1
+ <!-- prettier-ignore-start -->
2
+ # Job Step: ImportABTests
3
+
4
+ **Type ID:** `ImportABTests`
5
+ **Scope:** Site (add to a site-level job flow)
6
+ **Category:** Standard / system job step (Import)
7
+
8
+ Imports A/B tests.
9
+
10
+ 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.
11
+
12
+ ## Configuration Parameters
13
+
14
+ | Parameter | Required | Default | Allowed Values | Description |
15
+ | --- | --- | --- | --- | --- |
16
+ | `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. |
17
+ | `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. |
18
+ | `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. |
19
+ | `ImportFailedHandling` | Yes | `WARN` | `ERROR`, `WARN` | The step exit status that will be used when the import process failed. |
20
+ | `ImportMode` | Yes | `Merge` | `Merge`, `Delete`, `Replace`, `Update` | The import mode. |
21
+ | `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. |
22
+ | `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. |
23
+
24
+ ## Working With IMPEX Files
25
+
26
+ 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.
27
+
28
+ ## Related
29
+
30
+ - Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
31
+ - Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
32
+ - Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
33
+
34
+ <!-- prettier-ignore-end -->
@@ -0,0 +1,33 @@
1
+ <!-- prettier-ignore-start -->
2
+ # Job Step: ImportActiveData
3
+
4
+ **Type ID:** `ImportActiveData`
5
+ **Scope:** Site (add to a site-level job flow)
6
+ **Category:** Standard / system job step (Import)
7
+
8
+ Imports active data from the provided CSV files.
9
+
10
+ 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.
11
+
12
+ ## Configuration Parameters
13
+
14
+ | Parameter | Required | Default | Allowed Values | Description |
15
+ | --- | --- | --- | --- | --- |
16
+ | `AfterImportFileHandling` | Yes | `Archive` | `Keep`, `Delete`, `Archive`, `Archive Zipped` | 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. |
17
+ | `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. |
18
+ | `FileNamePattern` | No | — | — | Regular expression pattern to select import files, e.g. 'import_.*\.csv'. Matching files are imported in alphanumerical order. If not defined all files in working folder are imported. |
19
+ | `ImportFailedHandling` | Yes | `WARN` | `ERROR`, `WARN` | The step exit status that will be used when the import process failed. |
20
+ | `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. |
21
+ | `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. |
22
+
23
+ ## Working With IMPEX Files
24
+
25
+ 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.
26
+
27
+ ## Related
28
+
29
+ - Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
30
+ - Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
31
+ - Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
32
+
33
+ <!-- prettier-ignore-end -->
@@ -0,0 +1,34 @@
1
+ <!-- prettier-ignore-start -->
2
+ # Job Step: ImportAssignments
3
+
4
+ **Type ID:** `ImportAssignments`
5
+ **Scope:** Organization (add to an organization-level job flow)
6
+ **Category:** Standard / system job step (Import)
7
+
8
+ Imports assignments
9
+
10
+ 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.
11
+
12
+ ## Configuration Parameters
13
+
14
+ | Parameter | Required | Default | Allowed Values | Description |
15
+ | --- | --- | --- | --- | --- |
16
+ | `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. |
17
+ | `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. |
18
+ | `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. |
19
+ | `ImportFailedHandling` | Yes | `WARN` | `ERROR`, `WARN` | The step exit status that will be used when the import process failed. |
20
+ | `ImportMode` | Yes | `Merge` | `Merge`, `Delete`, `Replace`, `Update` | The import mode. |
21
+ | `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. |
22
+ | `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. |
23
+
24
+ ## Working With IMPEX Files
25
+
26
+ 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.
27
+
28
+ ## Related
29
+
30
+ - Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
31
+ - Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
32
+ - Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
33
+
34
+ <!-- prettier-ignore-end -->
@@ -0,0 +1,34 @@
1
+ <!-- prettier-ignore-start -->
2
+ # Job Step: ImportCatalog
3
+
4
+ **Type ID:** `ImportCatalog`
5
+ **Scope:** Organization (add to an organization-level job flow)
6
+ **Category:** Standard / system job step (Import)
7
+
8
+ Imports catalog data.
9
+
10
+ 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.
11
+
12
+ ## Configuration Parameters
13
+
14
+ | Parameter | Required | Default | Allowed Values | Description |
15
+ | --- | --- | --- | --- | --- |
16
+ | `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. |
17
+ | `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. |
18
+ | `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. |
19
+ | `ImportFailedHandling` | Yes | `WARN` | `ERROR`, `WARN` | The step exit status that will be used when the import process failed. |
20
+ | `ImportMode` | Yes | `Merge` | `Merge`, `Delete`, `Replace`, `Update` | The import mode. |
21
+ | `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. |
22
+ | `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. |
23
+
24
+ ## Working With IMPEX Files
25
+
26
+ 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.
27
+
28
+ ## Related
29
+
30
+ - Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
31
+ - Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
32
+ - Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
33
+
34
+ <!-- prettier-ignore-end -->
@@ -0,0 +1,34 @@
1
+ <!-- prettier-ignore-start -->
2
+ # Job Step: ImportContent
3
+
4
+ **Type ID:** `ImportContent`
5
+ **Scope:** Site (add to a site-level job flow)
6
+ **Category:** Standard / system job step (Import)
7
+
8
+ Imports content. If no library-id is specified in the import file, the data is imported into the private library of the current site. If a library-id is specified in the import file, the data is imported into the specified shared library. There is no way to specify a private library using the "library-id" attribute in the import file.
9
+
10
+ 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.
11
+
12
+ ## Configuration Parameters
13
+
14
+ | Parameter | Required | Default | Allowed Values | Description |
15
+ | --- | --- | --- | --- | --- |
16
+ | `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. |
17
+ | `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. |
18
+ | `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. |
19
+ | `ImportFailedHandling` | Yes | `WARN` | `ERROR`, `WARN` | The step exit status that will be used when the import process failed. |
20
+ | `ImportMode` | Yes | `Merge` | `Merge`, `Delete`, `Replace`, `Update` | The import mode. |
21
+ | `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. |
22
+ | `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. |
23
+
24
+ ## Working With IMPEX Files
25
+
26
+ 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.
27
+
28
+ ## Related
29
+
30
+ - Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
31
+ - Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
32
+ - Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
33
+
34
+ <!-- prettier-ignore-end -->