@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.
- package/data/content-schemas/regiondefinition.json +1 -0
- package/data/job-steps/CatalogDeltaExport.md +31 -0
- package/data/job-steps/CreateSitemap.md +22 -0
- package/data/job-steps/CustomerListsDeltaExport.md +30 -0
- package/data/job-steps/DownloadActiveDataFromStorage.md +24 -0
- package/data/job-steps/ExecuteCategorizationRules.md +25 -0
- package/data/job-steps/ExecuteDataReplication.md +24 -0
- package/data/job-steps/ExecutePipeline.md +24 -0
- package/data/job-steps/ExecutePreconfiguredCodeReplicationProcess.md +24 -0
- package/data/job-steps/ExecutePreconfiguredDataReplicationProcess.md +24 -0
- package/data/job-steps/ExecuteScriptModule.md +27 -0
- package/data/job-steps/ExportABTests.md +30 -0
- package/data/job-steps/ExportAssignments.md +30 -0
- package/data/job-steps/ExportCatalog.md +37 -0
- package/data/job-steps/ExportContent.md +31 -0
- package/data/job-steps/ExportContentSlots.md +30 -0
- package/data/job-steps/ExportCouponCodes.md +33 -0
- package/data/job-steps/ExportCoupons.md +30 -0
- package/data/job-steps/ExportCustomObjects.md +31 -0
- package/data/job-steps/ExportCustomerGroups.md +30 -0
- package/data/job-steps/ExportCustomerList.md +31 -0
- package/data/job-steps/ExportCustomers.md +30 -0
- package/data/job-steps/ExportFacebookFeed.md +26 -0
- package/data/job-steps/ExportGiftCertificates.md +30 -0
- package/data/job-steps/ExportInventoryLists.md +31 -0
- package/data/job-steps/ExportMetaData.md +32 -0
- package/data/job-steps/ExportOrders.md +42 -0
- package/data/job-steps/ExportPageLocalization.md +34 -0
- package/data/job-steps/ExportPriceBook.md +31 -0
- package/data/job-steps/ExportProductLists.md +34 -0
- package/data/job-steps/ExportPromotions.md +30 -0
- package/data/job-steps/ExportShippingMethods.md +30 -0
- package/data/job-steps/ExportSourceCodeGroups.md +30 -0
- package/data/job-steps/ExportStores.md +31 -0
- package/data/job-steps/ExportTaxTable.md +30 -0
- package/data/job-steps/ImportABTests.md +34 -0
- package/data/job-steps/ImportActiveData.md +33 -0
- package/data/job-steps/ImportAssignments.md +34 -0
- package/data/job-steps/ImportCatalog.md +34 -0
- package/data/job-steps/ImportContent.md +34 -0
- package/data/job-steps/ImportContentSlots.md +34 -0
- package/data/job-steps/ImportCouponCodeRedemptions.md +34 -0
- package/data/job-steps/ImportCoupons.md +34 -0
- package/data/job-steps/ImportCustomObjects.md +34 -0
- package/data/job-steps/ImportCustomerGroups.md +34 -0
- package/data/job-steps/ImportCustomerList.md +34 -0
- package/data/job-steps/ImportCustomerLists.md +34 -0
- package/data/job-steps/ImportCustomers.md +34 -0
- package/data/job-steps/ImportGiftCertificates.md +34 -0
- package/data/job-steps/ImportInventoryLists.md +35 -0
- package/data/job-steps/ImportKeyValueMapping.md +35 -0
- package/data/job-steps/ImportPageLocalization.md +34 -0
- package/data/job-steps/ImportPriceBook.md +34 -0
- package/data/job-steps/ImportProductLists.md +34 -0
- package/data/job-steps/ImportPromotions.md +34 -0
- package/data/job-steps/ImportShippingMethods.md +34 -0
- package/data/job-steps/ImportSiteArchive.md +30 -0
- package/data/job-steps/ImportSourceCodeGroups.md +34 -0
- package/data/job-steps/ImportStores.md +34 -0
- package/data/job-steps/ImportTaxTable.md +34 -0
- package/data/job-steps/IncludeStepsFromJob.md +24 -0
- package/data/job-steps/InvalidateCache.md +26 -0
- package/data/job-steps/LibraryDeltaExport.md +30 -0
- package/data/job-steps/SearchReindex.md +27 -0
- package/data/job-steps/SiteExport.md +32 -0
- package/data/job-steps/UndoPreconfiguredCodeReplicationProcess.md +24 -0
- package/data/job-steps/UndoPreconfiguredDataReplicationProcess.md +24 -0
- package/data/job-steps/UpdateStorefrontURLs.md +22 -0
- package/data/job-steps/UploadActiveDataBackupToStorage.md +22 -0
- package/data/job-steps/UploadActiveDataToStorage.md +24 -0
- package/data/job-steps/index.json +426 -0
- package/data/job-steps/job-steps.json +2910 -0
- package/data/job-steps/job-steps.md +96 -0
- package/data/script-api/TopLevel.APIException.md +1 -1
- package/data/script-api/dw.catalog.CatalogMgr.md +8 -2
- package/data/script-api/dw.crypto.Cipher.md +5 -1
- package/data/script-api/dw.customer.Profile.md +45 -0
- package/data/script-api/dw.customer.consent.ConsentStatusEntry.md +92 -0
- package/data/script-api/dw.customer.consent.MarketingConsentSubscription.md +247 -0
- package/data/script-api/dw.customer.consent.ShopperConsentErrorCodes.md +74 -0
- package/data/script-api/dw.customer.consent.ShopperConsentException.md +63 -0
- package/data/script-api/dw.customer.consent.ShopperConsentMgr.md +152 -0
- package/data/script-api/dw.customer.consent.md +10 -0
- package/data/script-api/dw.extensions.payments.SalesforcePaymentsHooks.md +24 -0
- package/data/script-api/dw.extensions.payments.SalesforcePaymentsSiteConfiguration.md +76 -0
- package/data/script-api/dw.object.CustomAttributes.md +72 -29
- package/data/script-api/dw.object.md +1 -1
- package/data/script-api/dw.order.Basket.md +3 -2
- package/data/script-api/dw.order.GiftCertificateLineItem.md +1 -1
- package/data/script-api/dw.order.LineItem.md +88 -0
- package/data/script-api/dw.order.LineItemCtnr.md +41 -11
- package/data/script-api/dw.order.LineItemTax.md +142 -0
- package/data/script-api/dw.order.OrderMgr.md +8 -0
- package/data/script-api/dw.order.PriceAdjustment.md +1 -1
- package/data/script-api/dw.order.ProductLineItem.md +1 -1
- package/data/script-api/dw.order.ProductShippingLineItem.md +1 -1
- package/data/script-api/dw.order.Shipment.md +12 -4
- package/data/script-api/dw.order.ShippingLineItem.md +1 -1
- package/data/script-api/dw.order.TaxMgr.md +54 -0
- package/data/script-api/dw.order.hooks.TaxHooks.md +495 -0
- package/data/script-api/dw.order.hooks.md +1 -0
- package/data/script-api/dw.order.md +1 -0
- package/data/script-api/dw.sitemap.SitemapFile.md +1 -1
- package/data/script-api/dw.sitemap.SitemapMgr.md +23 -0
- package/data/script-api/dw.system.Request.md +0 -1
- package/data/script-api/dw.util.Assert.md +29 -0
- package/data/script-api/dw.util.Locale.md +5 -2
- package/data/script-api/dw.web.Cookie.md +0 -6
- package/data/script-api/dw.web.PageMetaTag.md +25 -1
- package/data/script-api/dw.ws.WSUtil.md +2 -2
- package/data/script-api/index.json +49 -2
- package/data/script-api/index.md +2 -1
- package/data/xsd/commercefeaturestate.xsd +1 -0
- package/data/xsd/customer.xsd +11 -0
- package/data/xsd/eventrouting.xsd +257 -0
- package/data/xsd/index.json +6 -2
- package/data/xsd/order.xsd +53 -0
- package/data/xsd/store.xsd +8 -0
- package/data/xsd/storefronts.xsd +57 -1
- package/dist/esm/auth/dispatch-fetch.js +9 -2
- package/dist/esm/auth/dispatch-fetch.js.map +1 -1
- package/dist/esm/auth/oauth-jwt.js +9 -1
- package/dist/esm/auth/oauth-jwt.js.map +1 -1
- package/dist/esm/auth/oauth.js +9 -1
- package/dist/esm/auth/oauth.js.map +1 -1
- package/dist/esm/auth/stateful-oauth-strategy.js +26 -3
- package/dist/esm/auth/stateful-oauth-strategy.js.map +1 -1
- package/dist/esm/clients/am-api.js +9 -1
- package/dist/esm/clients/am-api.js.map +1 -1
- package/dist/esm/clients/middleware.js +9 -1
- package/dist/esm/clients/middleware.js.map +1 -1
- package/dist/esm/clients/webdav.js +14 -6
- package/dist/esm/clients/webdav.js.map +1 -1
- package/dist/esm/docs/search.d.ts +6 -3
- package/dist/esm/docs/search.js +39 -8
- package/dist/esm/docs/search.js.map +1 -1
- package/dist/esm/docs/types.d.ts +1 -0
- package/dist/esm/docs/types.js +1 -0
- package/dist/esm/docs/types.js.map +1 -1
- package/dist/esm/errors/index.d.ts +1 -0
- package/dist/esm/errors/index.js +1 -0
- package/dist/esm/errors/index.js.map +1 -1
- package/dist/esm/errors/network-error.d.ts +104 -0
- package/dist/esm/errors/network-error.js +301 -0
- package/dist/esm/errors/network-error.js.map +1 -0
- package/dist/esm/operations/cap/pull.js +4 -1
- package/dist/esm/operations/cap/pull.js.map +1 -1
- package/dist/esm/operations/code/constants.d.ts +17 -0
- package/dist/esm/operations/code/constants.js +23 -0
- package/dist/esm/operations/code/constants.js.map +1 -0
- package/dist/esm/operations/code/deploy.js +31 -2
- package/dist/esm/operations/code/deploy.js.map +1 -1
- package/dist/esm/operations/code/download.js +1 -2
- package/dist/esm/operations/code/download.js.map +1 -1
- package/dist/esm/operations/debug/dap-adapter.d.ts +9 -0
- package/dist/esm/operations/debug/dap-adapter.js +17 -0
- package/dist/esm/operations/debug/dap-adapter.js.map +1 -1
- package/dist/esm/operations/debug/debug-session.d.ts +8 -0
- package/dist/esm/operations/debug/debug-session.js +18 -0
- package/dist/esm/operations/debug/debug-session.js.map +1 -1
- package/dist/esm/operations/debug/sdapi-client.d.ts +30 -0
- package/dist/esm/operations/debug/sdapi-client.js +80 -6
- package/dist/esm/operations/debug/sdapi-client.js.map +1 -1
- package/dist/esm/skills/github.js +77 -24
- package/dist/esm/skills/github.js.map +1 -1
- package/dist/esm/slas/token.js +9 -1
- package/dist/esm/slas/token.js.map +1 -1
- package/package.json +4 -2
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
<!-- prettier-ignore-start -->
|
|
2
|
+
# Job Step: ImportContentSlots
|
|
3
|
+
|
|
4
|
+
**Type ID:** `ImportContentSlots`
|
|
5
|
+
**Scope:** Site (add to a site-level job flow)
|
|
6
|
+
**Category:** Standard / system job step (Import)
|
|
7
|
+
|
|
8
|
+
Imports content slot configurations in the specified mode.
|
|
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: ImportCouponCodeRedemptions
|
|
3
|
+
|
|
4
|
+
**Type ID:** `ImportCouponCodeRedemptions`
|
|
5
|
+
**Scope:** Site (add to a site-level job flow)
|
|
6
|
+
**Category:** Standard / system job step (Import)
|
|
7
|
+
|
|
8
|
+
Imports the coupon code redemptions based on the couponredemption.xsd. Note: Coupon redemptions are evaluated during checkout. A large number of coupon redemptions negatively impacts order creation performance and scale. Avoid importing unnecessary coupon redemptions. Clean up coupon codes and related redemptions when they are no longer required.
|
|
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 | — | — | 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: ImportCoupons
|
|
3
|
+
|
|
4
|
+
**Type ID:** `ImportCoupons`
|
|
5
|
+
**Scope:** Site (add to a site-level job flow)
|
|
6
|
+
**Category:** Standard / system job step (Import)
|
|
7
|
+
|
|
8
|
+
Imports coupons in the specified mode.
|
|
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: ImportCustomObjects
|
|
3
|
+
|
|
4
|
+
**Type ID:** `ImportCustomObjects`
|
|
5
|
+
**Scope:** Organization & Sites (add to an organization- or site-level job flow)
|
|
6
|
+
**Category:** Standard / system job step (Import)
|
|
7
|
+
|
|
8
|
+
Imports Custom Objects.
|
|
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: ImportCustomerGroups
|
|
3
|
+
|
|
4
|
+
**Type ID:** `ImportCustomerGroups`
|
|
5
|
+
**Scope:** Site (add to a site-level job flow)
|
|
6
|
+
**Category:** Standard / system job step (Import)
|
|
7
|
+
|
|
8
|
+
Imports customer groups in the specified mode.
|
|
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 | — | — | 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: ImportCustomerList
|
|
3
|
+
|
|
4
|
+
**Type ID:** `ImportCustomerList`
|
|
5
|
+
**Scope:** Organization (add to an organization-level job flow)
|
|
6
|
+
**Category:** Standard / system job step (Import)
|
|
7
|
+
|
|
8
|
+
Deprecated. Imports customer list data. Use ImportCustomerLists instead.
|
|
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: ImportCustomerLists
|
|
3
|
+
|
|
4
|
+
**Type ID:** `ImportCustomerLists`
|
|
5
|
+
**Scope:** Organization (add to an organization-level job flow)
|
|
6
|
+
**Category:** Standard / system job step (Import)
|
|
7
|
+
|
|
8
|
+
Imports customer 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
|
+
| `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: ImportCustomers
|
|
3
|
+
|
|
4
|
+
**Type ID:** `ImportCustomers`
|
|
5
|
+
**Scope:** Site (add to a site-level job flow)
|
|
6
|
+
**Category:** Standard / system job step (Import)
|
|
7
|
+
|
|
8
|
+
Imports Customers based on customer.xsd
|
|
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 | — | — | 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: ImportGiftCertificates
|
|
3
|
+
|
|
4
|
+
**Type ID:** `ImportGiftCertificates`
|
|
5
|
+
**Scope:** Site (add to a site-level job flow)
|
|
6
|
+
**Category:** Standard / system job step (Import)
|
|
7
|
+
|
|
8
|
+
Import the Gift Certificates contained in ImportFile in the specified mode.
|
|
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,35 @@
|
|
|
1
|
+
<!-- prettier-ignore-start -->
|
|
2
|
+
# Job Step: ImportInventoryLists
|
|
3
|
+
|
|
4
|
+
**Type ID:** `ImportInventoryLists`
|
|
5
|
+
**Scope:** Organization (add to an organization-level job flow)
|
|
6
|
+
**Category:** Standard / system job step (Import)
|
|
7
|
+
|
|
8
|
+
Imports inventory 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
|
+
| `InventoryListLockWaitSeconds` | No | — | — | The time in seconds to attempt to gain a lock on an inventory list to be imported before timing out, defaults to 10 seconds. |
|
|
22
|
+
| `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. |
|
|
23
|
+
| `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. |
|
|
24
|
+
|
|
25
|
+
## Working With IMPEX Files
|
|
26
|
+
|
|
27
|
+
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.
|
|
28
|
+
|
|
29
|
+
## Related
|
|
30
|
+
|
|
31
|
+
- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
|
|
32
|
+
- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
|
|
33
|
+
- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
|
|
34
|
+
|
|
35
|
+
<!-- prettier-ignore-end -->
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
<!-- prettier-ignore-start -->
|
|
2
|
+
# Job Step: ImportKeyValueMapping
|
|
3
|
+
|
|
4
|
+
**Type ID:** `ImportKeyValueMapping`
|
|
5
|
+
**Scope:** Organization (add to an organization-level job flow)
|
|
6
|
+
**Category:** Standard / system job step (Import)
|
|
7
|
+
|
|
8
|
+
Import or delete a key/value mapping in the Generic Mapping high-performance data store. Key/value mappings are exposed through Script API class dw.util.MappingMgr. See Generic Mapping
|
|
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 ImportFailedHandling is ERROR and the file failed to validate. Ignored if using import mode 'Delete'. |
|
|
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. Ignored if using import mode 'Delete'. |
|
|
18
|
+
| `FileNamePattern` | No | — | — | Regular expression pattern to select the import files, e.g. 'import_.*\.csv'. Matching files are imported in alphanumerical order. If not defined all files in working folder are imported. Ignored if using import mode 'Delete'. |
|
|
19
|
+
| `ImportFailedHandling` | Yes | `WARN` | `WARN`, `ERROR` | WARN - Skip malformed files. Perform action specified by AfterImportFileHandling on files. Use Exit Status WARN. ERROR - If invalid file is found, do not perform action specified by AfterImportFileHandling and abort immediately with Exit Status ERROR. Ignored if using import mode 'Delete'. |
|
|
20
|
+
| `ImportMode` | Yes | `Replace` | `Replace`, `Merge`, `Delete` | Replace - Create new mapping or replace existing mapping, Merge - Create new mapping or update/create values in existing mapping, Delete - Delete specified mapping. All import file related parameters are ignored. |
|
|
21
|
+
| `KeyCount` | No | `1` | — | Number of columns in CSV file that are composite key columns, from left to right. Default is 1, which indicates that the first column in CSV file is a key. All other columns are an aggregated list of values. Ignored if using import mode 'Delete'. |
|
|
22
|
+
| `MappingName` | Yes | — | — | Name used to access the mapping. Example: 'backend-to-web-skus' or 'web-products-to-backend'. |
|
|
23
|
+
| `WorkingFolder` | No | — | — | Folder containing import files, relative to 'IMPEX/src'. If not defined, working folder is 'IMPEX/src'. Ignored if using import mode 'Delete'. |
|
|
24
|
+
|
|
25
|
+
## Working With IMPEX Files
|
|
26
|
+
|
|
27
|
+
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.
|
|
28
|
+
|
|
29
|
+
## Related
|
|
30
|
+
|
|
31
|
+
- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
|
|
32
|
+
- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
|
|
33
|
+
- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
|
|
34
|
+
|
|
35
|
+
<!-- prettier-ignore-end -->
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
<!-- prettier-ignore-start -->
|
|
2
|
+
# Job Step: ImportPageLocalization
|
|
3
|
+
|
|
4
|
+
**Type ID:** `ImportPageLocalization`
|
|
5
|
+
**Scope:** Site (add to a site-level job flow)
|
|
6
|
+
**Category:** Standard / system job step (Import)
|
|
7
|
+
|
|
8
|
+
Import translated 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
|
+
| `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
|
+
| `FileFormat` | Yes | — | `JSON`, `RESOURCE` | The format in which the data is provided. |
|
|
19
|
+
| `FileName` | Yes | — | — | File name for the file to be imported (relative to the 'WorkingFolder'). |
|
|
20
|
+
| `ImportFailedHandling` | Yes | `WARN` | `ERROR`, `WARN` | The step exit status that will be used when the import process failed. |
|
|
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` | Yes | — | — | 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: ImportPriceBook
|
|
3
|
+
|
|
4
|
+
**Type ID:** `ImportPriceBook`
|
|
5
|
+
**Scope:** Organization (add to an organization-level job flow)
|
|
6
|
+
**Category:** Standard / system job step (Import)
|
|
7
|
+
|
|
8
|
+
Imports 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
|
+
| `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: ImportProductLists
|
|
3
|
+
|
|
4
|
+
**Type ID:** `ImportProductLists`
|
|
5
|
+
**Scope:** Site (add to a site-level job flow)
|
|
6
|
+
**Category:** Standard / system job step (Import)
|
|
7
|
+
|
|
8
|
+
Imports product 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
|
+
| `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: ImportPromotions
|
|
3
|
+
|
|
4
|
+
**Type ID:** `ImportPromotions`
|
|
5
|
+
**Scope:** Site (add to a site-level job flow)
|
|
6
|
+
**Category:** Standard / system job step (Import)
|
|
7
|
+
|
|
8
|
+
Imports promotions in the specified mode.
|
|
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: ImportShippingMethods
|
|
3
|
+
|
|
4
|
+
**Type ID:** `ImportShippingMethods`
|
|
5
|
+
**Scope:** Site (add to a site-level job flow)
|
|
6
|
+
**Category:** Standard / system job step (Import)
|
|
7
|
+
|
|
8
|
+
Imports shipping methods in the specified mode.
|
|
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,30 @@
|
|
|
1
|
+
<!-- prettier-ignore-start -->
|
|
2
|
+
# Job Step: ImportSiteArchive
|
|
3
|
+
|
|
4
|
+
**Type ID:** `ImportSiteArchive`
|
|
5
|
+
**Scope:** Organization (add to an organization-level job flow)
|
|
6
|
+
**Category:** Standard / system job step (Import)
|
|
7
|
+
|
|
8
|
+
Imports a site import archive file into the current instance.
|
|
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
|
+
| `ImportFile` | Yes | — | — | Import file name located directly under 'IMPEX/src/instance' folder. |
|
|
17
|
+
| `ImportFromRealm` | No | `false` | — | If selected, the import file lookup will be taken in the global realm directory. |
|
|
18
|
+
| `ImportMode` | No | `merge` | `merge` | The import mode. |
|
|
19
|
+
|
|
20
|
+
## Working With IMPEX Files
|
|
21
|
+
|
|
22
|
+
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.
|
|
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 -->
|