@salesforce/b2c-tooling-sdk 1.16.0 → 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 (126) 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/docs/search.d.ts +6 -3
  121. package/dist/esm/docs/search.js +39 -8
  122. package/dist/esm/docs/search.js.map +1 -1
  123. package/dist/esm/docs/types.d.ts +1 -0
  124. package/dist/esm/docs/types.js +1 -0
  125. package/dist/esm/docs/types.js.map +1 -1
  126. package/package.json +4 -2
@@ -0,0 +1,2910 @@
1
+ {
2
+ "version": "2.0.0",
3
+ "provenance": {
4
+ "description": "Catalog of standard (system) B2C Commerce job step type IDs available in Business Manager job flows and jobs.xml site-import flows.",
5
+ "derivation": "Generated from the public B2C Commerce Job Step API documentation (the jobstepapi section of the Script API documentation archive obtained via `b2c docs download`). Each step lists its purpose, execution scope, and input parameters (required, description, allowed values, default) as published in that documentation.",
6
+ "platformDocVersion": "DWAPP 26.7",
7
+ "regenerate": "pnpm --filter @salesforce/b2c-tooling-sdk run build:job-steps-dataset -- <jobstep-html-dir>; then run generate:job-steps-docs"
8
+ },
9
+ "steps": [
10
+ {
11
+ "typeId": "CatalogDeltaExport",
12
+ "kind": "Export",
13
+ "scope": "Site",
14
+ "purpose": "Creates Delta Export for Catalogs. Support must be contacted to enable delta exports.",
15
+ "parameters": [
16
+ {
17
+ "name": "CatalogIDs",
18
+ "required": true,
19
+ "description": "Comma Separated list of Catalog Ids to be exported. Character limit 1000"
20
+ },
21
+ {
22
+ "name": "Consumers",
23
+ "required": true,
24
+ "description": "Comma Separated List of consumers. Character limit 1000"
25
+ },
26
+ {
27
+ "name": "ExportFile",
28
+ "required": true,
29
+ "description": "Delta Export name and Export file name and path relative to 'IMPEX/src'."
30
+ },
31
+ {
32
+ "name": "MasterProductExport",
33
+ "required": false,
34
+ "description": "If selected, the option exports all changes with the master product.",
35
+ "default": "false"
36
+ }
37
+ ]
38
+ },
39
+ {
40
+ "typeId": "CustomerListsDeltaExport",
41
+ "kind": "Export",
42
+ "scope": "Site",
43
+ "purpose": "Creates Delta Export for Customer Lists. Support must be contacted to enable delta exports.",
44
+ "parameters": [
45
+ {
46
+ "name": "Consumers",
47
+ "required": true,
48
+ "description": "Comma separated List of consumers, Character limit 1000"
49
+ },
50
+ {
51
+ "name": "CustomerLists",
52
+ "required": true,
53
+ "description": "Comma separated list of Customers, Character limit 1000"
54
+ },
55
+ {
56
+ "name": "ExportFile",
57
+ "required": true,
58
+ "description": "Delta Export name and Export file name and path relative to 'IMPEX/src'."
59
+ }
60
+ ]
61
+ },
62
+ {
63
+ "typeId": "ExportABTests",
64
+ "kind": "Export",
65
+ "scope": "Site",
66
+ "purpose": "Exports A/B tests.",
67
+ "parameters": [
68
+ {
69
+ "name": "ExportFile",
70
+ "required": false,
71
+ "description": "Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix."
72
+ },
73
+ {
74
+ "name": "FileNamePrefix",
75
+ "required": false,
76
+ "description": "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."
77
+ },
78
+ {
79
+ "name": "OverwriteExportFile",
80
+ "required": false,
81
+ "description": "If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error.",
82
+ "default": "true"
83
+ }
84
+ ]
85
+ },
86
+ {
87
+ "typeId": "ExportAssignments",
88
+ "kind": "Export",
89
+ "scope": "Organization",
90
+ "purpose": "Exports all assignments in the system.",
91
+ "parameters": [
92
+ {
93
+ "name": "ExportFile",
94
+ "required": false,
95
+ "description": "Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix."
96
+ },
97
+ {
98
+ "name": "FileNamePrefix",
99
+ "required": false,
100
+ "description": "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."
101
+ },
102
+ {
103
+ "name": "OverwriteExportFile",
104
+ "required": false,
105
+ "description": "If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error.",
106
+ "default": "true"
107
+ }
108
+ ]
109
+ },
110
+ {
111
+ "typeId": "ExportCatalog",
112
+ "kind": "Export",
113
+ "scope": "Organization",
114
+ "purpose": "Exports catalog data.",
115
+ "parameters": [
116
+ {
117
+ "name": "CatalogID",
118
+ "required": true,
119
+ "description": "The ID of the catalog which will be exported."
120
+ },
121
+ {
122
+ "name": "ExportCategories",
123
+ "required": false,
124
+ "description": "Optional flag indicating whether to export categories or not.",
125
+ "default": "true"
126
+ },
127
+ {
128
+ "name": "ExportCategoryAssignments",
129
+ "required": false,
130
+ "description": "Optional flag indicating whether to export category assignments or not.",
131
+ "default": "true"
132
+ },
133
+ {
134
+ "name": "ExportFile",
135
+ "required": false,
136
+ "description": "Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix."
137
+ },
138
+ {
139
+ "name": "ExportProductOptions",
140
+ "required": false,
141
+ "description": "Optional flag indicating whether to export product options or not.",
142
+ "default": "true"
143
+ },
144
+ {
145
+ "name": "ExportProducts",
146
+ "required": false,
147
+ "description": "Optional flag indicating whether to export products or not.",
148
+ "default": "true"
149
+ },
150
+ {
151
+ "name": "ExportRecommendations",
152
+ "required": false,
153
+ "description": "Optional flag indicating whether to export recommendations or not.",
154
+ "default": "true"
155
+ },
156
+ {
157
+ "name": "ExportVariationAttributes",
158
+ "required": false,
159
+ "description": "Optional flag indicating whether to export variation attributes or not.",
160
+ "default": "true"
161
+ },
162
+ {
163
+ "name": "FileNamePrefix",
164
+ "required": false,
165
+ "description": "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."
166
+ },
167
+ {
168
+ "name": "OverwriteExportFile",
169
+ "required": false,
170
+ "description": "If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error.",
171
+ "default": "true"
172
+ }
173
+ ]
174
+ },
175
+ {
176
+ "typeId": "ExportContent",
177
+ "kind": "Export",
178
+ "scope": "Organization & Sites",
179
+ "purpose": "Exports the folders in the specified content Library.",
180
+ "parameters": [
181
+ {
182
+ "name": "ExportFile",
183
+ "required": false,
184
+ "description": "Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix."
185
+ },
186
+ {
187
+ "name": "FileNamePrefix",
188
+ "required": false,
189
+ "description": "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."
190
+ },
191
+ {
192
+ "name": "LibraryID",
193
+ "required": true,
194
+ "description": "Content Library Id of the library to export."
195
+ },
196
+ {
197
+ "name": "OverwriteExportFile",
198
+ "required": false,
199
+ "description": "If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error.",
200
+ "default": "true"
201
+ }
202
+ ]
203
+ },
204
+ {
205
+ "typeId": "ExportContentSlots",
206
+ "kind": "Export",
207
+ "scope": "Site",
208
+ "purpose": "Exports all content slot data.",
209
+ "parameters": [
210
+ {
211
+ "name": "ExportFile",
212
+ "required": false,
213
+ "description": "Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix."
214
+ },
215
+ {
216
+ "name": "FileNamePrefix",
217
+ "required": false,
218
+ "description": "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."
219
+ },
220
+ {
221
+ "name": "OverwriteExportFile",
222
+ "required": false,
223
+ "description": "If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error.",
224
+ "default": "true"
225
+ }
226
+ ]
227
+ },
228
+ {
229
+ "typeId": "ExportCouponCodes",
230
+ "kind": "Export",
231
+ "scope": "Site",
232
+ "purpose": "Exports the codes of a specified coupon.",
233
+ "parameters": [
234
+ {
235
+ "name": "CouponID",
236
+ "required": true,
237
+ "description": "The ID of the coupon whose codes being exported."
238
+ },
239
+ {
240
+ "name": "ExportFile",
241
+ "required": false,
242
+ "description": "Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix."
243
+ },
244
+ {
245
+ "name": "FileNamePrefix",
246
+ "required": false,
247
+ "description": "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."
248
+ },
249
+ {
250
+ "name": "NumberOfCodes",
251
+ "required": false,
252
+ "description": "The number of coupon codes being exported."
253
+ },
254
+ {
255
+ "name": "OverwriteExportFile",
256
+ "required": false,
257
+ "description": "If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error.",
258
+ "default": "true"
259
+ },
260
+ {
261
+ "name": "StartFrom",
262
+ "required": false,
263
+ "description": "The start from position for coupon codes being exported."
264
+ }
265
+ ]
266
+ },
267
+ {
268
+ "typeId": "ExportCoupons",
269
+ "kind": "Export",
270
+ "scope": "Site",
271
+ "purpose": "Exports coupons.",
272
+ "parameters": [
273
+ {
274
+ "name": "ExportFile",
275
+ "required": false,
276
+ "description": "Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix."
277
+ },
278
+ {
279
+ "name": "FileNamePrefix",
280
+ "required": false,
281
+ "description": "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."
282
+ },
283
+ {
284
+ "name": "OverwriteExportFile",
285
+ "required": false,
286
+ "description": "If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error.",
287
+ "default": "true"
288
+ }
289
+ ]
290
+ },
291
+ {
292
+ "typeId": "ExportCustomerGroups",
293
+ "kind": "Export",
294
+ "scope": "Site",
295
+ "purpose": "Exports all customer groups.",
296
+ "parameters": [
297
+ {
298
+ "name": "ExportFile",
299
+ "required": false,
300
+ "description": "Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix."
301
+ },
302
+ {
303
+ "name": "FileNamePrefix",
304
+ "required": false,
305
+ "description": "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."
306
+ },
307
+ {
308
+ "name": "OverwriteExportFile",
309
+ "required": false,
310
+ "description": "If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error.",
311
+ "default": "true"
312
+ }
313
+ ]
314
+ },
315
+ {
316
+ "typeId": "ExportCustomerList",
317
+ "kind": "Export",
318
+ "scope": "Organization",
319
+ "purpose": "Exports a customer list, it's preferences as well as the customers assigned to the customer list.",
320
+ "parameters": [
321
+ {
322
+ "name": "CustomerListID",
323
+ "required": true,
324
+ "description": "The ID of the customer list which will be exported."
325
+ },
326
+ {
327
+ "name": "ExportFile",
328
+ "required": false,
329
+ "description": "Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix."
330
+ },
331
+ {
332
+ "name": "FileNamePrefix",
333
+ "required": false,
334
+ "description": "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."
335
+ },
336
+ {
337
+ "name": "OverwriteExportFile",
338
+ "required": false,
339
+ "description": "If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error.",
340
+ "default": "true"
341
+ }
342
+ ]
343
+ },
344
+ {
345
+ "typeId": "ExportCustomers",
346
+ "kind": "Export",
347
+ "scope": "Site",
348
+ "purpose": "Exports the customer profiles from the default customer list of the given site.",
349
+ "parameters": [
350
+ {
351
+ "name": "ExportFile",
352
+ "required": false,
353
+ "description": "Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix."
354
+ },
355
+ {
356
+ "name": "FileNamePrefix",
357
+ "required": false,
358
+ "description": "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."
359
+ },
360
+ {
361
+ "name": "OverwriteExportFile",
362
+ "required": false,
363
+ "description": "If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error.",
364
+ "default": "true"
365
+ }
366
+ ]
367
+ },
368
+ {
369
+ "typeId": "ExportCustomObjects",
370
+ "kind": "Export",
371
+ "scope": "Organization & Sites",
372
+ "purpose": "Exports custom objects of a specified type and scope. The scope of the job flow (Organization or Sites) must match the scope of the custom object type.",
373
+ "parameters": [
374
+ {
375
+ "name": "CustomObjectTypeID",
376
+ "required": true,
377
+ "description": "The ID of the custom object type."
378
+ },
379
+ {
380
+ "name": "ExportFile",
381
+ "required": false,
382
+ "description": "Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix."
383
+ },
384
+ {
385
+ "name": "FileNamePrefix",
386
+ "required": false,
387
+ "description": "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."
388
+ },
389
+ {
390
+ "name": "OverwriteExportFile",
391
+ "required": false,
392
+ "description": "If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error.",
393
+ "default": "true"
394
+ }
395
+ ]
396
+ },
397
+ {
398
+ "typeId": "ExportFacebookFeed",
399
+ "kind": "Export",
400
+ "scope": "Site",
401
+ "purpose": "Exports Catalog Feed for Facebook.",
402
+ "parameters": []
403
+ },
404
+ {
405
+ "typeId": "ExportGiftCertificates",
406
+ "kind": "Export",
407
+ "scope": "Site",
408
+ "purpose": "Exports Gift Certificates.",
409
+ "parameters": [
410
+ {
411
+ "name": "ExportFile",
412
+ "required": false,
413
+ "description": "Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix."
414
+ },
415
+ {
416
+ "name": "FileNamePrefix",
417
+ "required": false,
418
+ "description": "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."
419
+ },
420
+ {
421
+ "name": "OverwriteExportFile",
422
+ "required": false,
423
+ "description": "If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error.",
424
+ "default": "true"
425
+ }
426
+ ]
427
+ },
428
+ {
429
+ "typeId": "ExportInventoryLists",
430
+ "kind": "Export",
431
+ "scope": "Site",
432
+ "purpose": "Exports inventory lists.",
433
+ "parameters": [
434
+ {
435
+ "name": "ExportFile",
436
+ "required": false,
437
+ "description": "Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix."
438
+ },
439
+ {
440
+ "name": "FileNamePrefix",
441
+ "required": false,
442
+ "description": "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."
443
+ },
444
+ {
445
+ "name": "InventoryListIDs",
446
+ "required": false,
447
+ "description": "Optional comma separated list of inventory list ids to be exported. If not specified, the inventory list assigned to the Site is exported."
448
+ },
449
+ {
450
+ "name": "OverwriteExportFile",
451
+ "required": false,
452
+ "description": "If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error.",
453
+ "default": "true"
454
+ }
455
+ ]
456
+ },
457
+ {
458
+ "typeId": "ExportMetaData",
459
+ "kind": "Export",
460
+ "scope": "Organization",
461
+ "purpose": "Export System Object Type extensions and Custom Object Type definitions.",
462
+ "parameters": [
463
+ {
464
+ "name": "ExportCustomTypes",
465
+ "required": true,
466
+ "description": "Export Custom Object Type definitions.",
467
+ "default": "true"
468
+ },
469
+ {
470
+ "name": "ExportFile",
471
+ "required": false,
472
+ "description": "Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix."
473
+ },
474
+ {
475
+ "name": "ExportSystemTypes",
476
+ "required": true,
477
+ "description": "Export System Object Type extensions.",
478
+ "default": "true"
479
+ },
480
+ {
481
+ "name": "FileNamePrefix",
482
+ "required": false,
483
+ "description": "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."
484
+ },
485
+ {
486
+ "name": "OverwriteExportFile",
487
+ "required": false,
488
+ "description": "If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error.",
489
+ "default": "true"
490
+ }
491
+ ]
492
+ },
493
+ {
494
+ "typeId": "ExportOrders",
495
+ "kind": "Export",
496
+ "scope": "Site",
497
+ "purpose": "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.",
498
+ "parameters": [
499
+ {
500
+ "name": "Canceled",
501
+ "required": false,
502
+ "description": "Include orders in order status CANCELED.",
503
+ "default": "true"
504
+ },
505
+ {
506
+ "name": "Completed",
507
+ "required": false,
508
+ "description": "Include orders in order status COMPLETED.",
509
+ "default": "true"
510
+ },
511
+ {
512
+ "name": "Confirmation Status",
513
+ "required": true,
514
+ "description": "The confirmation status.",
515
+ "default": "All",
516
+ "allowedValues": [
517
+ "All",
518
+ "Not Confirmed",
519
+ "Confirmed"
520
+ ]
521
+ },
522
+ {
523
+ "name": "Created",
524
+ "required": false,
525
+ "description": "Deprecated. Created orders cannot be exported.",
526
+ "default": "true"
527
+ },
528
+ {
529
+ "name": "Export Status",
530
+ "required": true,
531
+ "description": "The export status. Recommendation is to use READY FOR EXPORT to signal the export is needed.",
532
+ "default": "Ready for Export",
533
+ "allowedValues": [
534
+ "All",
535
+ "Not Exported",
536
+ "Exported",
537
+ "Ready for Export",
538
+ "Export Failed"
539
+ ]
540
+ },
541
+ {
542
+ "name": "ExportFile",
543
+ "required": false,
544
+ "description": "Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix."
545
+ },
546
+ {
547
+ "name": "Failed",
548
+ "required": false,
549
+ "description": "Deprecated. Failed orders cannot be exported.",
550
+ "default": "true"
551
+ },
552
+ {
553
+ "name": "FileNamePrefix",
554
+ "required": false,
555
+ "description": "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."
556
+ },
557
+ {
558
+ "name": "New",
559
+ "required": false,
560
+ "description": "Include orders in order status NEW.",
561
+ "default": "true"
562
+ },
563
+ {
564
+ "name": "Open",
565
+ "required": false,
566
+ "description": "Include orders in order status OPEN.",
567
+ "default": "true"
568
+ },
569
+ {
570
+ "name": "OverwriteExportFile",
571
+ "required": false,
572
+ "description": "If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error.",
573
+ "default": "true"
574
+ },
575
+ {
576
+ "name": "Payment Status",
577
+ "required": true,
578
+ "description": "The payment status.",
579
+ "default": "All",
580
+ "allowedValues": [
581
+ "All",
582
+ "Not Paid",
583
+ "Partially Paid",
584
+ "Paid"
585
+ ]
586
+ },
587
+ {
588
+ "name": "Replaced",
589
+ "required": false,
590
+ "description": "Include orders in order status REPLACED.",
591
+ "default": "true"
592
+ },
593
+ {
594
+ "name": "Shipment Status",
595
+ "required": true,
596
+ "description": "The shipment status.",
597
+ "default": "All",
598
+ "allowedValues": [
599
+ "All",
600
+ "Not Shipped",
601
+ "Partially Shipped",
602
+ "Shipped"
603
+ ]
604
+ },
605
+ {
606
+ "name": "Use Order Export Delay",
607
+ "required": false,
608
+ "description": "See 'Order Export Delay' at 'Site Preferences' -> 'Order Preferences' -> 'Order Export Settings'",
609
+ "default": "false"
610
+ }
611
+ ]
612
+ },
613
+ {
614
+ "typeId": "ExportPageLocalization",
615
+ "kind": "Export",
616
+ "scope": "Site",
617
+ "purpose": "Export page content for localization purposes",
618
+ "parameters": [
619
+ {
620
+ "name": "ExportFile",
621
+ "required": false,
622
+ "description": "Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix."
623
+ },
624
+ {
625
+ "name": "FileFormat",
626
+ "required": true,
627
+ "description": "The format in which the data will be exported.",
628
+ "allowedValues": [
629
+ "JSON",
630
+ "RESOURCE"
631
+ ]
632
+ },
633
+ {
634
+ "name": "FileNamePrefix",
635
+ "required": false,
636
+ "description": "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."
637
+ },
638
+ {
639
+ "name": "Locale",
640
+ "required": true,
641
+ "description": "The locale for which the Page data will be exported."
642
+ },
643
+ {
644
+ "name": "OverwriteExportFile",
645
+ "required": false,
646
+ "description": "If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error.",
647
+ "default": "true"
648
+ },
649
+ {
650
+ "name": "PageIDs",
651
+ "required": false,
652
+ "description": "A JSON object containing the single property 'page_ids', which is an array of Page IDs. When not specified, 'PageIDsFile' must be used."
653
+ },
654
+ {
655
+ "name": "PageIDsFile",
656
+ "required": false,
657
+ "description": "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.'"
658
+ }
659
+ ]
660
+ },
661
+ {
662
+ "typeId": "ExportPriceBook",
663
+ "kind": "Export",
664
+ "scope": "Organization",
665
+ "purpose": "Exports price data.",
666
+ "parameters": [
667
+ {
668
+ "name": "ExportFile",
669
+ "required": false,
670
+ "description": "Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix."
671
+ },
672
+ {
673
+ "name": "FileNamePrefix",
674
+ "required": false,
675
+ "description": "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."
676
+ },
677
+ {
678
+ "name": "OverwriteExportFile",
679
+ "required": false,
680
+ "description": "If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error.",
681
+ "default": "true"
682
+ },
683
+ {
684
+ "name": "PriceBookID",
685
+ "required": true,
686
+ "description": "The ID of the Pricebook which will be exported."
687
+ }
688
+ ]
689
+ },
690
+ {
691
+ "typeId": "ExportProductLists",
692
+ "kind": "Export",
693
+ "scope": "Site",
694
+ "purpose": "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.",
695
+ "parameters": [
696
+ {
697
+ "name": "ExportFile",
698
+ "required": false,
699
+ "description": "Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix."
700
+ },
701
+ {
702
+ "name": "FileNamePrefix",
703
+ "required": false,
704
+ "description": "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."
705
+ },
706
+ {
707
+ "name": "IncludeAnonymousLists",
708
+ "required": false,
709
+ "description": "Includes anonymous product lists in the export. An anonymous product list is a product list that does not belong to a registered user.",
710
+ "default": "true"
711
+ },
712
+ {
713
+ "name": "IncludeEmptyLists",
714
+ "required": false,
715
+ "description": "Includes empty product lists. Empty product lists do not have any items added to them. When disabled, these lists are excluded from the export.",
716
+ "default": "true"
717
+ },
718
+ {
719
+ "name": "ModifedListsOnly",
720
+ "required": false,
721
+ "description": "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.",
722
+ "default": "false"
723
+ },
724
+ {
725
+ "name": "NewListsOnly",
726
+ "required": false,
727
+ "description": "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.",
728
+ "default": "false"
729
+ },
730
+ {
731
+ "name": "OverwriteExportFile",
732
+ "required": false,
733
+ "description": "If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error.",
734
+ "default": "true"
735
+ }
736
+ ]
737
+ },
738
+ {
739
+ "typeId": "ExportPromotions",
740
+ "kind": "Export",
741
+ "scope": "Site",
742
+ "purpose": "Exports promotions.",
743
+ "parameters": [
744
+ {
745
+ "name": "ExportFile",
746
+ "required": false,
747
+ "description": "Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix."
748
+ },
749
+ {
750
+ "name": "FileNamePrefix",
751
+ "required": false,
752
+ "description": "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."
753
+ },
754
+ {
755
+ "name": "OverwriteExportFile",
756
+ "required": false,
757
+ "description": "If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error.",
758
+ "default": "true"
759
+ }
760
+ ]
761
+ },
762
+ {
763
+ "typeId": "ExportShippingMethods",
764
+ "kind": "Export",
765
+ "scope": "Site",
766
+ "purpose": "Exports shipping methods.",
767
+ "parameters": [
768
+ {
769
+ "name": "ExportFile",
770
+ "required": false,
771
+ "description": "Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix."
772
+ },
773
+ {
774
+ "name": "FileNamePrefix",
775
+ "required": false,
776
+ "description": "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."
777
+ },
778
+ {
779
+ "name": "OverwriteExportFile",
780
+ "required": false,
781
+ "description": "If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error.",
782
+ "default": "true"
783
+ }
784
+ ]
785
+ },
786
+ {
787
+ "typeId": "ExportSourceCodeGroups",
788
+ "kind": "Export",
789
+ "scope": "Site",
790
+ "purpose": "Exports source code groups.",
791
+ "parameters": [
792
+ {
793
+ "name": "ExportFile",
794
+ "required": false,
795
+ "description": "Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix."
796
+ },
797
+ {
798
+ "name": "FileNamePrefix",
799
+ "required": false,
800
+ "description": "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."
801
+ },
802
+ {
803
+ "name": "OverwriteExportFile",
804
+ "required": false,
805
+ "description": "If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error.",
806
+ "default": "true"
807
+ }
808
+ ]
809
+ },
810
+ {
811
+ "typeId": "ExportStores",
812
+ "kind": "Export",
813
+ "scope": "Site",
814
+ "purpose": "Exports stores.",
815
+ "parameters": [
816
+ {
817
+ "name": "ExportFile",
818
+ "required": false,
819
+ "description": "Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix."
820
+ },
821
+ {
822
+ "name": "FileNamePrefix",
823
+ "required": false,
824
+ "description": "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."
825
+ },
826
+ {
827
+ "name": "OverwriteExportFile",
828
+ "required": false,
829
+ "description": "If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error.",
830
+ "default": "true"
831
+ },
832
+ {
833
+ "name": "StoreID",
834
+ "required": true,
835
+ "description": "Define the ID of the store to be exported or '*' to export all stores."
836
+ }
837
+ ]
838
+ },
839
+ {
840
+ "typeId": "ExportTaxTable",
841
+ "kind": "Export",
842
+ "scope": "Site",
843
+ "purpose": "Exports tax data.",
844
+ "parameters": [
845
+ {
846
+ "name": "ExportFile",
847
+ "required": false,
848
+ "description": "Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix."
849
+ },
850
+ {
851
+ "name": "FileNamePrefix",
852
+ "required": false,
853
+ "description": "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."
854
+ },
855
+ {
856
+ "name": "OverwriteExportFile",
857
+ "required": false,
858
+ "description": "If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error.",
859
+ "default": "true"
860
+ }
861
+ ]
862
+ },
863
+ {
864
+ "typeId": "LibraryDeltaExport",
865
+ "kind": "Export",
866
+ "scope": "Organization",
867
+ "purpose": "Creates Delta Export for Libraries. Support must be contacted to enable delta exports.",
868
+ "parameters": [
869
+ {
870
+ "name": "Consumers",
871
+ "required": true,
872
+ "description": "Comma Separated List of consumers. Limit of 1000 characters"
873
+ },
874
+ {
875
+ "name": "ExportFile",
876
+ "required": true,
877
+ "description": "Delta Export name and Export file name and path relative to 'IMPEX/src'."
878
+ },
879
+ {
880
+ "name": "LibraryIDs",
881
+ "required": true,
882
+ "description": "Comma Separated list of Library Content Ids to be exported. Limit of 1000 characters"
883
+ }
884
+ ]
885
+ },
886
+ {
887
+ "typeId": "SiteExport",
888
+ "kind": "Export",
889
+ "scope": "Organization",
890
+ "purpose": "Exports site data. The DataUnits parameter defines which objects are included in the export. Its function is similar to the Data Units to Export field on the Business Manager Site Import & Export page. The parameter requires a string in JSON format that describes the data to be exported. Units not included in the JSON are not included in the export.",
891
+ "parameters": [
892
+ {
893
+ "name": "DataUnits",
894
+ "required": true,
895
+ "description": "String in JSON format that describes the data to be exported."
896
+ },
897
+ {
898
+ "name": "ExportFile",
899
+ "required": false,
900
+ "description": "Export file name and path relative to 'IMPEX/src/instance'. Required if not using FileNamePrefix."
901
+ },
902
+ {
903
+ "name": "FileNamePrefix",
904
+ "required": false,
905
+ "description": "Prefix for the export file. Can include a path relative to 'IMPEX/src/instance'. The timestamp is appended. To order the files chronologically, sort alphabetically. Required if not using ExportFile."
906
+ },
907
+ {
908
+ "name": "OverwriteExportFile",
909
+ "required": true,
910
+ "description": "If selected, the option overwrites an existing file. If not selected and a file exists, the job exits and reports an error.",
911
+ "default": "true"
912
+ },
913
+ {
914
+ "name": "SaveOnRealm",
915
+ "required": true,
916
+ "description": "If selected, the export file will be saved in the global realm directory.",
917
+ "default": "false"
918
+ }
919
+ ]
920
+ },
921
+ {
922
+ "typeId": "ImportABTests",
923
+ "kind": "Import",
924
+ "scope": "Site",
925
+ "purpose": "Imports A/B tests.",
926
+ "parameters": [
927
+ {
928
+ "name": "AfterImportFileHandling",
929
+ "required": true,
930
+ "description": "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.",
931
+ "default": "Archive",
932
+ "allowedValues": [
933
+ "Keep",
934
+ "Delete",
935
+ "Archive",
936
+ "Archive Zipped",
937
+ "Archive In Subfolders",
938
+ "Archive Overwrite Existing"
939
+ ]
940
+ },
941
+ {
942
+ "name": "ArchiveFolder",
943
+ "required": false,
944
+ "description": "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.",
945
+ "default": "archive"
946
+ },
947
+ {
948
+ "name": "FileNamePattern",
949
+ "required": false,
950
+ "description": "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."
951
+ },
952
+ {
953
+ "name": "ImportFailedHandling",
954
+ "required": true,
955
+ "description": "The step exit status that will be used when the import process failed.",
956
+ "default": "WARN",
957
+ "allowedValues": [
958
+ "ERROR",
959
+ "WARN"
960
+ ]
961
+ },
962
+ {
963
+ "name": "ImportMode",
964
+ "required": true,
965
+ "description": "The import mode.",
966
+ "default": "Merge",
967
+ "allowedValues": [
968
+ "Merge",
969
+ "Delete",
970
+ "Replace",
971
+ "Update"
972
+ ]
973
+ },
974
+ {
975
+ "name": "NoFilesFoundHandling",
976
+ "required": true,
977
+ "description": "The step exit status that will be used when no matching files were found.",
978
+ "default": "NO_FILES_FOUND",
979
+ "allowedValues": [
980
+ "OK",
981
+ "ERROR",
982
+ "WARN",
983
+ "NO_FILES_FOUND"
984
+ ]
985
+ },
986
+ {
987
+ "name": "WorkingFolder",
988
+ "required": false,
989
+ "description": "The folder that contains the import files, relative to the 'IMPEX/src/' folder. If not defined 'IMPEX/src/' is used as working folder."
990
+ }
991
+ ]
992
+ },
993
+ {
994
+ "typeId": "ImportActiveData",
995
+ "kind": "Import",
996
+ "scope": "Site",
997
+ "purpose": "Imports active data from the provided CSV files.",
998
+ "parameters": [
999
+ {
1000
+ "name": "AfterImportFileHandling",
1001
+ "required": true,
1002
+ "description": "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.",
1003
+ "default": "Archive",
1004
+ "allowedValues": [
1005
+ "Keep",
1006
+ "Delete",
1007
+ "Archive",
1008
+ "Archive Zipped"
1009
+ ]
1010
+ },
1011
+ {
1012
+ "name": "ArchiveFolder",
1013
+ "required": false,
1014
+ "description": "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.",
1015
+ "default": "archive"
1016
+ },
1017
+ {
1018
+ "name": "FileNamePattern",
1019
+ "required": false,
1020
+ "description": "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."
1021
+ },
1022
+ {
1023
+ "name": "ImportFailedHandling",
1024
+ "required": true,
1025
+ "description": "The step exit status that will be used when the import process failed.",
1026
+ "default": "WARN",
1027
+ "allowedValues": [
1028
+ "ERROR",
1029
+ "WARN"
1030
+ ]
1031
+ },
1032
+ {
1033
+ "name": "NoFilesFoundHandling",
1034
+ "required": true,
1035
+ "description": "The step exit status that will be used when no matching files were found.",
1036
+ "default": "NO_FILES_FOUND",
1037
+ "allowedValues": [
1038
+ "OK",
1039
+ "ERROR",
1040
+ "WARN",
1041
+ "NO_FILES_FOUND"
1042
+ ]
1043
+ },
1044
+ {
1045
+ "name": "WorkingFolder",
1046
+ "required": false,
1047
+ "description": "The folder that contains the import files, relative to the 'IMPEX/src/' folder. If not defined 'IMPEX/src/' is used as working folder."
1048
+ }
1049
+ ]
1050
+ },
1051
+ {
1052
+ "typeId": "ImportAssignments",
1053
+ "kind": "Import",
1054
+ "scope": "Organization",
1055
+ "purpose": "Imports assignments",
1056
+ "parameters": [
1057
+ {
1058
+ "name": "AfterImportFileHandling",
1059
+ "required": true,
1060
+ "description": "What to do with the import file after successful or failed import.",
1061
+ "default": "Archive",
1062
+ "allowedValues": [
1063
+ "Keep",
1064
+ "Delete",
1065
+ "Archive",
1066
+ "Archive Zipped",
1067
+ "Archive In Subfolders",
1068
+ "Archive Overwrite Existing"
1069
+ ]
1070
+ },
1071
+ {
1072
+ "name": "ArchiveFolder",
1073
+ "required": false,
1074
+ "description": "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.",
1075
+ "default": "archive"
1076
+ },
1077
+ {
1078
+ "name": "FileNamePattern",
1079
+ "required": false,
1080
+ "description": "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.",
1081
+ "default": ".*\\.xml"
1082
+ },
1083
+ {
1084
+ "name": "ImportFailedHandling",
1085
+ "required": true,
1086
+ "description": "The step exit status that will be used when the import process failed.",
1087
+ "default": "WARN",
1088
+ "allowedValues": [
1089
+ "ERROR",
1090
+ "WARN"
1091
+ ]
1092
+ },
1093
+ {
1094
+ "name": "ImportMode",
1095
+ "required": true,
1096
+ "description": "The import mode.",
1097
+ "default": "Merge",
1098
+ "allowedValues": [
1099
+ "Merge",
1100
+ "Delete",
1101
+ "Replace",
1102
+ "Update"
1103
+ ]
1104
+ },
1105
+ {
1106
+ "name": "NoFilesFoundHandling",
1107
+ "required": true,
1108
+ "description": "The step exit status that will be used when no matching files were found.",
1109
+ "default": "NO_FILES_FOUND",
1110
+ "allowedValues": [
1111
+ "OK",
1112
+ "ERROR",
1113
+ "WARN",
1114
+ "NO_FILES_FOUND"
1115
+ ]
1116
+ },
1117
+ {
1118
+ "name": "WorkingFolder",
1119
+ "required": false,
1120
+ "description": "The folder that contains the import files, relative to the 'IMPEX/src/' folder. If not defined 'IMPEX/src/' is used as working folder."
1121
+ }
1122
+ ]
1123
+ },
1124
+ {
1125
+ "typeId": "ImportCatalog",
1126
+ "kind": "Import",
1127
+ "scope": "Organization",
1128
+ "purpose": "Imports catalog data.",
1129
+ "parameters": [
1130
+ {
1131
+ "name": "AfterImportFileHandling",
1132
+ "required": true,
1133
+ "description": "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.",
1134
+ "default": "Archive",
1135
+ "allowedValues": [
1136
+ "Keep",
1137
+ "Delete",
1138
+ "Archive",
1139
+ "Archive Zipped",
1140
+ "Archive In Subfolders",
1141
+ "Archive Overwrite Existing"
1142
+ ]
1143
+ },
1144
+ {
1145
+ "name": "ArchiveFolder",
1146
+ "required": false,
1147
+ "description": "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.",
1148
+ "default": "archive"
1149
+ },
1150
+ {
1151
+ "name": "FileNamePattern",
1152
+ "required": false,
1153
+ "description": "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."
1154
+ },
1155
+ {
1156
+ "name": "ImportFailedHandling",
1157
+ "required": true,
1158
+ "description": "The step exit status that will be used when the import process failed.",
1159
+ "default": "WARN",
1160
+ "allowedValues": [
1161
+ "ERROR",
1162
+ "WARN"
1163
+ ]
1164
+ },
1165
+ {
1166
+ "name": "ImportMode",
1167
+ "required": true,
1168
+ "description": "The import mode.",
1169
+ "default": "Merge",
1170
+ "allowedValues": [
1171
+ "Merge",
1172
+ "Delete",
1173
+ "Replace",
1174
+ "Update"
1175
+ ]
1176
+ },
1177
+ {
1178
+ "name": "NoFilesFoundHandling",
1179
+ "required": true,
1180
+ "description": "The step exit status that will be used when no matching files were found.",
1181
+ "default": "NO_FILES_FOUND",
1182
+ "allowedValues": [
1183
+ "OK",
1184
+ "ERROR",
1185
+ "WARN",
1186
+ "NO_FILES_FOUND"
1187
+ ]
1188
+ },
1189
+ {
1190
+ "name": "WorkingFolder",
1191
+ "required": false,
1192
+ "description": "The folder that contains the import files, relative to the 'IMPEX/src/' folder. If not defined 'IMPEX/src/' is used as working folder."
1193
+ }
1194
+ ]
1195
+ },
1196
+ {
1197
+ "typeId": "ImportContent",
1198
+ "kind": "Import",
1199
+ "scope": "Site",
1200
+ "purpose": "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.",
1201
+ "parameters": [
1202
+ {
1203
+ "name": "AfterImportFileHandling",
1204
+ "required": true,
1205
+ "description": "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.",
1206
+ "default": "Archive",
1207
+ "allowedValues": [
1208
+ "Keep",
1209
+ "Delete",
1210
+ "Archive",
1211
+ "Archive Zipped",
1212
+ "Archive In Subfolders",
1213
+ "Archive Overwrite Existing"
1214
+ ]
1215
+ },
1216
+ {
1217
+ "name": "ArchiveFolder",
1218
+ "required": false,
1219
+ "description": "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.",
1220
+ "default": "archive"
1221
+ },
1222
+ {
1223
+ "name": "FileNamePattern",
1224
+ "required": false,
1225
+ "description": "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."
1226
+ },
1227
+ {
1228
+ "name": "ImportFailedHandling",
1229
+ "required": true,
1230
+ "description": "The step exit status that will be used when the import process failed.",
1231
+ "default": "WARN",
1232
+ "allowedValues": [
1233
+ "ERROR",
1234
+ "WARN"
1235
+ ]
1236
+ },
1237
+ {
1238
+ "name": "ImportMode",
1239
+ "required": true,
1240
+ "description": "The import mode.",
1241
+ "default": "Merge",
1242
+ "allowedValues": [
1243
+ "Merge",
1244
+ "Delete",
1245
+ "Replace",
1246
+ "Update"
1247
+ ]
1248
+ },
1249
+ {
1250
+ "name": "NoFilesFoundHandling",
1251
+ "required": true,
1252
+ "description": "The step exit status that will be used when no matching files were found.",
1253
+ "default": "NO_FILES_FOUND",
1254
+ "allowedValues": [
1255
+ "OK",
1256
+ "ERROR",
1257
+ "WARN",
1258
+ "NO_FILES_FOUND"
1259
+ ]
1260
+ },
1261
+ {
1262
+ "name": "WorkingFolder",
1263
+ "required": false,
1264
+ "description": "The folder that contains the import files, relative to the 'IMPEX/src/' folder. If not defined 'IMPEX/src/' is used as working folder."
1265
+ }
1266
+ ]
1267
+ },
1268
+ {
1269
+ "typeId": "ImportContentSlots",
1270
+ "kind": "Import",
1271
+ "scope": "Site",
1272
+ "purpose": "Imports content slot configurations in the specified mode.",
1273
+ "parameters": [
1274
+ {
1275
+ "name": "AfterImportFileHandling",
1276
+ "required": true,
1277
+ "description": "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.",
1278
+ "default": "Archive",
1279
+ "allowedValues": [
1280
+ "Keep",
1281
+ "Delete",
1282
+ "Archive",
1283
+ "Archive Zipped",
1284
+ "Archive In Subfolders",
1285
+ "Archive Overwrite Existing"
1286
+ ]
1287
+ },
1288
+ {
1289
+ "name": "ArchiveFolder",
1290
+ "required": false,
1291
+ "description": "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.",
1292
+ "default": "archive"
1293
+ },
1294
+ {
1295
+ "name": "FileNamePattern",
1296
+ "required": false,
1297
+ "description": "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."
1298
+ },
1299
+ {
1300
+ "name": "ImportFailedHandling",
1301
+ "required": true,
1302
+ "description": "The step exit status that will be used when the import process failed.",
1303
+ "default": "WARN",
1304
+ "allowedValues": [
1305
+ "ERROR",
1306
+ "WARN"
1307
+ ]
1308
+ },
1309
+ {
1310
+ "name": "ImportMode",
1311
+ "required": true,
1312
+ "description": "The import mode.",
1313
+ "default": "Merge",
1314
+ "allowedValues": [
1315
+ "Merge",
1316
+ "Delete",
1317
+ "Replace",
1318
+ "Update"
1319
+ ]
1320
+ },
1321
+ {
1322
+ "name": "NoFilesFoundHandling",
1323
+ "required": true,
1324
+ "description": "The step exit status that will be used when no matching files were found.",
1325
+ "default": "NO_FILES_FOUND",
1326
+ "allowedValues": [
1327
+ "OK",
1328
+ "ERROR",
1329
+ "WARN",
1330
+ "NO_FILES_FOUND"
1331
+ ]
1332
+ },
1333
+ {
1334
+ "name": "WorkingFolder",
1335
+ "required": false,
1336
+ "description": "The folder that contains the import files, relative to the 'IMPEX/src/' folder. If not defined 'IMPEX/src/' is used as working folder."
1337
+ }
1338
+ ]
1339
+ },
1340
+ {
1341
+ "typeId": "ImportCouponCodeRedemptions",
1342
+ "kind": "Import",
1343
+ "scope": "Site",
1344
+ "purpose": "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.",
1345
+ "parameters": [
1346
+ {
1347
+ "name": "AfterImportFileHandling",
1348
+ "required": true,
1349
+ "description": "What to do with the import file after successful or failed import.",
1350
+ "default": "Archive",
1351
+ "allowedValues": [
1352
+ "Keep",
1353
+ "Delete",
1354
+ "Archive",
1355
+ "Archive Zipped",
1356
+ "Archive In Subfolders",
1357
+ "Archive Overwrite Existing"
1358
+ ]
1359
+ },
1360
+ {
1361
+ "name": "ArchiveFolder",
1362
+ "required": false,
1363
+ "description": "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.",
1364
+ "default": "archive"
1365
+ },
1366
+ {
1367
+ "name": "FileNamePattern",
1368
+ "required": false,
1369
+ "description": "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."
1370
+ },
1371
+ {
1372
+ "name": "ImportFailedHandling",
1373
+ "required": true,
1374
+ "description": "The step exit status that will be used when the import process failed.",
1375
+ "default": "WARN",
1376
+ "allowedValues": [
1377
+ "ERROR",
1378
+ "WARN"
1379
+ ]
1380
+ },
1381
+ {
1382
+ "name": "ImportMode",
1383
+ "required": true,
1384
+ "description": "The import mode.",
1385
+ "default": "Merge",
1386
+ "allowedValues": [
1387
+ "Merge",
1388
+ "Delete",
1389
+ "Replace",
1390
+ "Update"
1391
+ ]
1392
+ },
1393
+ {
1394
+ "name": "NoFilesFoundHandling",
1395
+ "required": true,
1396
+ "description": "The step exit status that will be used when no matching files were found.",
1397
+ "default": "NO_FILES_FOUND",
1398
+ "allowedValues": [
1399
+ "OK",
1400
+ "ERROR",
1401
+ "WARN",
1402
+ "NO_FILES_FOUND"
1403
+ ]
1404
+ },
1405
+ {
1406
+ "name": "WorkingFolder",
1407
+ "required": false,
1408
+ "description": "The folder that contains the import files, relative to the 'IMPEX/src/' folder. If not defined 'IMPEX/src/' is used as working folder."
1409
+ }
1410
+ ]
1411
+ },
1412
+ {
1413
+ "typeId": "ImportCoupons",
1414
+ "kind": "Import",
1415
+ "scope": "Site",
1416
+ "purpose": "Imports coupons in the specified mode.",
1417
+ "parameters": [
1418
+ {
1419
+ "name": "AfterImportFileHandling",
1420
+ "required": true,
1421
+ "description": "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.",
1422
+ "default": "Archive",
1423
+ "allowedValues": [
1424
+ "Keep",
1425
+ "Delete",
1426
+ "Archive",
1427
+ "Archive Zipped",
1428
+ "Archive In Subfolders",
1429
+ "Archive Overwrite Existing"
1430
+ ]
1431
+ },
1432
+ {
1433
+ "name": "ArchiveFolder",
1434
+ "required": false,
1435
+ "description": "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.",
1436
+ "default": "archive"
1437
+ },
1438
+ {
1439
+ "name": "FileNamePattern",
1440
+ "required": false,
1441
+ "description": "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."
1442
+ },
1443
+ {
1444
+ "name": "ImportFailedHandling",
1445
+ "required": true,
1446
+ "description": "The step exit status that will be used when the import process failed.",
1447
+ "default": "WARN",
1448
+ "allowedValues": [
1449
+ "ERROR",
1450
+ "WARN"
1451
+ ]
1452
+ },
1453
+ {
1454
+ "name": "ImportMode",
1455
+ "required": true,
1456
+ "description": "The import mode.",
1457
+ "default": "Merge",
1458
+ "allowedValues": [
1459
+ "Merge",
1460
+ "Delete",
1461
+ "Replace",
1462
+ "Update"
1463
+ ]
1464
+ },
1465
+ {
1466
+ "name": "NoFilesFoundHandling",
1467
+ "required": true,
1468
+ "description": "The step exit status that will be used when no matching files were found.",
1469
+ "default": "NO_FILES_FOUND",
1470
+ "allowedValues": [
1471
+ "OK",
1472
+ "ERROR",
1473
+ "WARN",
1474
+ "NO_FILES_FOUND"
1475
+ ]
1476
+ },
1477
+ {
1478
+ "name": "WorkingFolder",
1479
+ "required": false,
1480
+ "description": "The folder that contains the import files, relative to the 'IMPEX/src/' folder. If not defined 'IMPEX/src/' is used as working folder."
1481
+ }
1482
+ ]
1483
+ },
1484
+ {
1485
+ "typeId": "ImportCustomerGroups",
1486
+ "kind": "Import",
1487
+ "scope": "Site",
1488
+ "purpose": "Imports customer groups in the specified mode.",
1489
+ "parameters": [
1490
+ {
1491
+ "name": "AfterImportFileHandling",
1492
+ "required": true,
1493
+ "description": "What to do with the import file after successful or failed import.",
1494
+ "default": "Archive",
1495
+ "allowedValues": [
1496
+ "Keep",
1497
+ "Delete",
1498
+ "Archive",
1499
+ "Archive Zipped",
1500
+ "Archive In Subfolders",
1501
+ "Archive Overwrite Existing"
1502
+ ]
1503
+ },
1504
+ {
1505
+ "name": "ArchiveFolder",
1506
+ "required": false,
1507
+ "description": "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.",
1508
+ "default": "archive"
1509
+ },
1510
+ {
1511
+ "name": "FileNamePattern",
1512
+ "required": false,
1513
+ "description": "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."
1514
+ },
1515
+ {
1516
+ "name": "ImportFailedHandling",
1517
+ "required": true,
1518
+ "description": "The step exit status that will be used when the import process failed.",
1519
+ "default": "WARN",
1520
+ "allowedValues": [
1521
+ "ERROR",
1522
+ "WARN"
1523
+ ]
1524
+ },
1525
+ {
1526
+ "name": "ImportMode",
1527
+ "required": true,
1528
+ "description": "The import mode.",
1529
+ "default": "Merge",
1530
+ "allowedValues": [
1531
+ "Merge",
1532
+ "Delete",
1533
+ "Replace",
1534
+ "Update"
1535
+ ]
1536
+ },
1537
+ {
1538
+ "name": "NoFilesFoundHandling",
1539
+ "required": true,
1540
+ "description": "The step exit status that will be used when no matching files were found.",
1541
+ "default": "NO_FILES_FOUND",
1542
+ "allowedValues": [
1543
+ "OK",
1544
+ "ERROR",
1545
+ "WARN",
1546
+ "NO_FILES_FOUND"
1547
+ ]
1548
+ },
1549
+ {
1550
+ "name": "WorkingFolder",
1551
+ "required": false,
1552
+ "description": "The folder that contains the import files, relative to the 'IMPEX/src/' folder. If not defined 'IMPEX/src/' is used as working folder."
1553
+ }
1554
+ ]
1555
+ },
1556
+ {
1557
+ "typeId": "ImportCustomerList",
1558
+ "kind": "Import",
1559
+ "scope": "Organization",
1560
+ "purpose": "Deprecated. Imports customer list data. Use ImportCustomerLists instead.",
1561
+ "parameters": [
1562
+ {
1563
+ "name": "AfterImportFileHandling",
1564
+ "required": true,
1565
+ "description": "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.",
1566
+ "default": "Archive",
1567
+ "allowedValues": [
1568
+ "Keep",
1569
+ "Delete",
1570
+ "Archive",
1571
+ "Archive Zipped",
1572
+ "Archive In Subfolders",
1573
+ "Archive Overwrite Existing"
1574
+ ]
1575
+ },
1576
+ {
1577
+ "name": "ArchiveFolder",
1578
+ "required": false,
1579
+ "description": "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.",
1580
+ "default": "archive"
1581
+ },
1582
+ {
1583
+ "name": "FileNamePattern",
1584
+ "required": false,
1585
+ "description": "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."
1586
+ },
1587
+ {
1588
+ "name": "ImportFailedHandling",
1589
+ "required": true,
1590
+ "description": "The step exit status that will be used when the import process failed.",
1591
+ "default": "WARN",
1592
+ "allowedValues": [
1593
+ "ERROR",
1594
+ "WARN"
1595
+ ]
1596
+ },
1597
+ {
1598
+ "name": "ImportMode",
1599
+ "required": true,
1600
+ "description": "The import mode.",
1601
+ "default": "Merge",
1602
+ "allowedValues": [
1603
+ "Merge",
1604
+ "Delete",
1605
+ "Replace",
1606
+ "Update"
1607
+ ]
1608
+ },
1609
+ {
1610
+ "name": "NoFilesFoundHandling",
1611
+ "required": true,
1612
+ "description": "The step exit status that will be used when no matching files were found.",
1613
+ "default": "NO_FILES_FOUND",
1614
+ "allowedValues": [
1615
+ "OK",
1616
+ "ERROR",
1617
+ "WARN",
1618
+ "NO_FILES_FOUND"
1619
+ ]
1620
+ },
1621
+ {
1622
+ "name": "WorkingFolder",
1623
+ "required": false,
1624
+ "description": "The folder that contains the import files, relative to the 'IMPEX/src/' folder. If not defined 'IMPEX/src/' is used as working folder."
1625
+ }
1626
+ ]
1627
+ },
1628
+ {
1629
+ "typeId": "ImportCustomerLists",
1630
+ "kind": "Import",
1631
+ "scope": "Organization",
1632
+ "purpose": "Imports customer lists.",
1633
+ "parameters": [
1634
+ {
1635
+ "name": "AfterImportFileHandling",
1636
+ "required": true,
1637
+ "description": "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.",
1638
+ "default": "Archive",
1639
+ "allowedValues": [
1640
+ "Keep",
1641
+ "Delete",
1642
+ "Archive",
1643
+ "Archive Zipped",
1644
+ "Archive In Subfolders",
1645
+ "Archive Overwrite Existing"
1646
+ ]
1647
+ },
1648
+ {
1649
+ "name": "ArchiveFolder",
1650
+ "required": false,
1651
+ "description": "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.",
1652
+ "default": "archive"
1653
+ },
1654
+ {
1655
+ "name": "FileNamePattern",
1656
+ "required": false,
1657
+ "description": "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."
1658
+ },
1659
+ {
1660
+ "name": "ImportFailedHandling",
1661
+ "required": true,
1662
+ "description": "The step exit status that will be used when the import process failed.",
1663
+ "default": "WARN",
1664
+ "allowedValues": [
1665
+ "ERROR",
1666
+ "WARN"
1667
+ ]
1668
+ },
1669
+ {
1670
+ "name": "ImportMode",
1671
+ "required": true,
1672
+ "description": "The import mode.",
1673
+ "default": "Merge",
1674
+ "allowedValues": [
1675
+ "Merge",
1676
+ "Delete",
1677
+ "Replace",
1678
+ "Update"
1679
+ ]
1680
+ },
1681
+ {
1682
+ "name": "NoFilesFoundHandling",
1683
+ "required": true,
1684
+ "description": "The step exit status that will be used when no matching files were found.",
1685
+ "default": "NO_FILES_FOUND",
1686
+ "allowedValues": [
1687
+ "OK",
1688
+ "ERROR",
1689
+ "WARN",
1690
+ "NO_FILES_FOUND"
1691
+ ]
1692
+ },
1693
+ {
1694
+ "name": "WorkingFolder",
1695
+ "required": false,
1696
+ "description": "The folder that contains the import files, relative to the 'IMPEX/src/' folder. If not defined 'IMPEX/src/' is used as working folder."
1697
+ }
1698
+ ]
1699
+ },
1700
+ {
1701
+ "typeId": "ImportCustomers",
1702
+ "kind": "Import",
1703
+ "scope": "Site",
1704
+ "purpose": "Imports Customers based on customer.xsd",
1705
+ "parameters": [
1706
+ {
1707
+ "name": "AfterImportFileHandling",
1708
+ "required": true,
1709
+ "description": "What to do with the import file after successful or failed import.",
1710
+ "default": "Archive",
1711
+ "allowedValues": [
1712
+ "Keep",
1713
+ "Delete",
1714
+ "Archive",
1715
+ "Archive Zipped",
1716
+ "Archive In Subfolders",
1717
+ "Archive Overwrite Existing"
1718
+ ]
1719
+ },
1720
+ {
1721
+ "name": "ArchiveFolder",
1722
+ "required": false,
1723
+ "description": "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.",
1724
+ "default": "archive"
1725
+ },
1726
+ {
1727
+ "name": "FileNamePattern",
1728
+ "required": false,
1729
+ "description": "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."
1730
+ },
1731
+ {
1732
+ "name": "ImportFailedHandling",
1733
+ "required": true,
1734
+ "description": "The step exit status that will be used when the import process failed.",
1735
+ "default": "WARN",
1736
+ "allowedValues": [
1737
+ "ERROR",
1738
+ "WARN"
1739
+ ]
1740
+ },
1741
+ {
1742
+ "name": "ImportMode",
1743
+ "required": true,
1744
+ "description": "The import mode.",
1745
+ "default": "Merge",
1746
+ "allowedValues": [
1747
+ "Merge",
1748
+ "Delete",
1749
+ "Replace",
1750
+ "Update"
1751
+ ]
1752
+ },
1753
+ {
1754
+ "name": "NoFilesFoundHandling",
1755
+ "required": true,
1756
+ "description": "The step exit status that will be used when no matching files were found.",
1757
+ "default": "NO_FILES_FOUND",
1758
+ "allowedValues": [
1759
+ "OK",
1760
+ "ERROR",
1761
+ "WARN",
1762
+ "NO_FILES_FOUND"
1763
+ ]
1764
+ },
1765
+ {
1766
+ "name": "WorkingFolder",
1767
+ "required": false,
1768
+ "description": "The folder that contains the import files, relative to the 'IMPEX/src/' folder. If not defined 'IMPEX/src/' is used as working folder."
1769
+ }
1770
+ ]
1771
+ },
1772
+ {
1773
+ "typeId": "ImportCustomObjects",
1774
+ "kind": "Import",
1775
+ "scope": "Organization & Sites",
1776
+ "purpose": "Imports Custom Objects.",
1777
+ "parameters": [
1778
+ {
1779
+ "name": "AfterImportFileHandling",
1780
+ "required": true,
1781
+ "description": "What to do with the import file after successful or failed import.",
1782
+ "default": "Archive",
1783
+ "allowedValues": [
1784
+ "Keep",
1785
+ "Delete",
1786
+ "Archive",
1787
+ "Archive Zipped",
1788
+ "Archive In Subfolders",
1789
+ "Archive Overwrite Existing"
1790
+ ]
1791
+ },
1792
+ {
1793
+ "name": "ArchiveFolder",
1794
+ "required": false,
1795
+ "description": "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.",
1796
+ "default": "archive"
1797
+ },
1798
+ {
1799
+ "name": "FileNamePattern",
1800
+ "required": false,
1801
+ "description": "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.",
1802
+ "default": ".*\\.xml"
1803
+ },
1804
+ {
1805
+ "name": "ImportFailedHandling",
1806
+ "required": true,
1807
+ "description": "The step exit status that will be used when the import process failed.",
1808
+ "default": "WARN",
1809
+ "allowedValues": [
1810
+ "ERROR",
1811
+ "WARN"
1812
+ ]
1813
+ },
1814
+ {
1815
+ "name": "ImportMode",
1816
+ "required": true,
1817
+ "description": "The import mode.",
1818
+ "default": "Merge",
1819
+ "allowedValues": [
1820
+ "Merge",
1821
+ "Delete",
1822
+ "Replace",
1823
+ "Update"
1824
+ ]
1825
+ },
1826
+ {
1827
+ "name": "NoFilesFoundHandling",
1828
+ "required": true,
1829
+ "description": "The step exit status that will be used when no matching files were found.",
1830
+ "default": "NO_FILES_FOUND",
1831
+ "allowedValues": [
1832
+ "OK",
1833
+ "ERROR",
1834
+ "WARN",
1835
+ "NO_FILES_FOUND"
1836
+ ]
1837
+ },
1838
+ {
1839
+ "name": "WorkingFolder",
1840
+ "required": false,
1841
+ "description": "The folder that contains the import files, relative to the 'IMPEX/src/' folder. If not defined 'IMPEX/src/' is used as working folder."
1842
+ }
1843
+ ]
1844
+ },
1845
+ {
1846
+ "typeId": "ImportGiftCertificates",
1847
+ "kind": "Import",
1848
+ "scope": "Site",
1849
+ "purpose": "Import the Gift Certificates contained in ImportFile in the specified mode.",
1850
+ "parameters": [
1851
+ {
1852
+ "name": "AfterImportFileHandling",
1853
+ "required": true,
1854
+ "description": "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.",
1855
+ "default": "Archive",
1856
+ "allowedValues": [
1857
+ "Keep",
1858
+ "Delete",
1859
+ "Archive",
1860
+ "Archive Zipped",
1861
+ "Archive In Subfolders",
1862
+ "Archive Overwrite Existing"
1863
+ ]
1864
+ },
1865
+ {
1866
+ "name": "ArchiveFolder",
1867
+ "required": false,
1868
+ "description": "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.",
1869
+ "default": "archive"
1870
+ },
1871
+ {
1872
+ "name": "FileNamePattern",
1873
+ "required": false,
1874
+ "description": "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."
1875
+ },
1876
+ {
1877
+ "name": "ImportFailedHandling",
1878
+ "required": true,
1879
+ "description": "The step exit status that will be used when the import process failed.",
1880
+ "default": "WARN",
1881
+ "allowedValues": [
1882
+ "ERROR",
1883
+ "WARN"
1884
+ ]
1885
+ },
1886
+ {
1887
+ "name": "ImportMode",
1888
+ "required": true,
1889
+ "description": "The import mode.",
1890
+ "default": "Merge",
1891
+ "allowedValues": [
1892
+ "Merge",
1893
+ "Delete",
1894
+ "Replace",
1895
+ "Update"
1896
+ ]
1897
+ },
1898
+ {
1899
+ "name": "NoFilesFoundHandling",
1900
+ "required": true,
1901
+ "description": "The step exit status that will be used when no matching files were found.",
1902
+ "default": "NO_FILES_FOUND",
1903
+ "allowedValues": [
1904
+ "OK",
1905
+ "ERROR",
1906
+ "WARN",
1907
+ "NO_FILES_FOUND"
1908
+ ]
1909
+ },
1910
+ {
1911
+ "name": "WorkingFolder",
1912
+ "required": false,
1913
+ "description": "The folder that contains the import files, relative to the 'IMPEX/src/' folder. If not defined 'IMPEX/src/' is used as working folder."
1914
+ }
1915
+ ]
1916
+ },
1917
+ {
1918
+ "typeId": "ImportInventoryLists",
1919
+ "kind": "Import",
1920
+ "scope": "Organization",
1921
+ "purpose": "Imports inventory data.",
1922
+ "parameters": [
1923
+ {
1924
+ "name": "AfterImportFileHandling",
1925
+ "required": true,
1926
+ "description": "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.",
1927
+ "default": "Archive",
1928
+ "allowedValues": [
1929
+ "Keep",
1930
+ "Delete",
1931
+ "Archive",
1932
+ "Archive Zipped",
1933
+ "Archive In Subfolders",
1934
+ "Archive Overwrite Existing"
1935
+ ]
1936
+ },
1937
+ {
1938
+ "name": "ArchiveFolder",
1939
+ "required": false,
1940
+ "description": "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.",
1941
+ "default": "archive"
1942
+ },
1943
+ {
1944
+ "name": "FileNamePattern",
1945
+ "required": false,
1946
+ "description": "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."
1947
+ },
1948
+ {
1949
+ "name": "ImportFailedHandling",
1950
+ "required": true,
1951
+ "description": "The step exit status that will be used when the import process failed.",
1952
+ "default": "WARN",
1953
+ "allowedValues": [
1954
+ "ERROR",
1955
+ "WARN"
1956
+ ]
1957
+ },
1958
+ {
1959
+ "name": "ImportMode",
1960
+ "required": true,
1961
+ "description": "The import mode.",
1962
+ "default": "Merge",
1963
+ "allowedValues": [
1964
+ "Merge",
1965
+ "Delete",
1966
+ "Replace",
1967
+ "Update"
1968
+ ]
1969
+ },
1970
+ {
1971
+ "name": "InventoryListLockWaitSeconds",
1972
+ "required": false,
1973
+ "description": "The time in seconds to attempt to gain a lock on an inventory list to be imported before timing out, defaults to 10 seconds."
1974
+ },
1975
+ {
1976
+ "name": "NoFilesFoundHandling",
1977
+ "required": true,
1978
+ "description": "The step exit status that will be used when no matching files were found.",
1979
+ "default": "NO_FILES_FOUND",
1980
+ "allowedValues": [
1981
+ "OK",
1982
+ "ERROR",
1983
+ "WARN",
1984
+ "NO_FILES_FOUND"
1985
+ ]
1986
+ },
1987
+ {
1988
+ "name": "WorkingFolder",
1989
+ "required": false,
1990
+ "description": "The folder that contains the import files, relative to the 'IMPEX/src/' folder. If not defined 'IMPEX/src/' is used as working folder."
1991
+ }
1992
+ ]
1993
+ },
1994
+ {
1995
+ "typeId": "ImportKeyValueMapping",
1996
+ "kind": "Import",
1997
+ "scope": "Organization",
1998
+ "purpose": "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",
1999
+ "parameters": [
2000
+ {
2001
+ "name": "AfterImportFileHandling",
2002
+ "required": true,
2003
+ "description": "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'.",
2004
+ "default": "Archive",
2005
+ "allowedValues": [
2006
+ "Keep",
2007
+ "Delete",
2008
+ "Archive",
2009
+ "Archive Zipped"
2010
+ ]
2011
+ },
2012
+ {
2013
+ "name": "ArchiveFolder",
2014
+ "required": false,
2015
+ "description": "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'.",
2016
+ "default": "archive"
2017
+ },
2018
+ {
2019
+ "name": "FileNamePattern",
2020
+ "required": false,
2021
+ "description": "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'."
2022
+ },
2023
+ {
2024
+ "name": "ImportFailedHandling",
2025
+ "required": true,
2026
+ "description": "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'.",
2027
+ "default": "WARN",
2028
+ "allowedValues": [
2029
+ "WARN",
2030
+ "ERROR"
2031
+ ]
2032
+ },
2033
+ {
2034
+ "name": "ImportMode",
2035
+ "required": true,
2036
+ "description": "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.",
2037
+ "default": "Replace",
2038
+ "allowedValues": [
2039
+ "Replace",
2040
+ "Merge",
2041
+ "Delete"
2042
+ ]
2043
+ },
2044
+ {
2045
+ "name": "KeyCount",
2046
+ "required": false,
2047
+ "description": "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'.",
2048
+ "default": "1"
2049
+ },
2050
+ {
2051
+ "name": "MappingName",
2052
+ "required": true,
2053
+ "description": "Name used to access the mapping. Example: 'backend-to-web-skus' or 'web-products-to-backend'."
2054
+ },
2055
+ {
2056
+ "name": "WorkingFolder",
2057
+ "required": false,
2058
+ "description": "Folder containing import files, relative to 'IMPEX/src'. If not defined, working folder is 'IMPEX/src'. Ignored if using import mode 'Delete'."
2059
+ }
2060
+ ]
2061
+ },
2062
+ {
2063
+ "typeId": "ImportPageLocalization",
2064
+ "kind": "Import",
2065
+ "scope": "Site",
2066
+ "purpose": "Import translated page content for localization purposes",
2067
+ "parameters": [
2068
+ {
2069
+ "name": "AfterImportFileHandling",
2070
+ "required": true,
2071
+ "description": "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.",
2072
+ "default": "Archive",
2073
+ "allowedValues": [
2074
+ "Keep",
2075
+ "Delete",
2076
+ "Archive",
2077
+ "Archive Zipped"
2078
+ ]
2079
+ },
2080
+ {
2081
+ "name": "ArchiveFolder",
2082
+ "required": false,
2083
+ "description": "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.",
2084
+ "default": "archive"
2085
+ },
2086
+ {
2087
+ "name": "FileFormat",
2088
+ "required": true,
2089
+ "description": "The format in which the data is provided.",
2090
+ "allowedValues": [
2091
+ "JSON",
2092
+ "RESOURCE"
2093
+ ]
2094
+ },
2095
+ {
2096
+ "name": "FileName",
2097
+ "required": true,
2098
+ "description": "File name for the file to be imported (relative to the 'WorkingFolder')."
2099
+ },
2100
+ {
2101
+ "name": "ImportFailedHandling",
2102
+ "required": true,
2103
+ "description": "The step exit status that will be used when the import process failed.",
2104
+ "default": "WARN",
2105
+ "allowedValues": [
2106
+ "ERROR",
2107
+ "WARN"
2108
+ ]
2109
+ },
2110
+ {
2111
+ "name": "NoFilesFoundHandling",
2112
+ "required": true,
2113
+ "description": "The step exit status that will be used when no matching files were found.",
2114
+ "default": "NO_FILES_FOUND",
2115
+ "allowedValues": [
2116
+ "OK",
2117
+ "ERROR",
2118
+ "WARN",
2119
+ "NO_FILES_FOUND"
2120
+ ]
2121
+ },
2122
+ {
2123
+ "name": "WorkingFolder",
2124
+ "required": true,
2125
+ "description": "The folder that contains the import files, relative to the 'IMPEX/src/' folder. If not defined 'IMPEX/src/' is used as working folder."
2126
+ }
2127
+ ]
2128
+ },
2129
+ {
2130
+ "typeId": "ImportPriceBook",
2131
+ "kind": "Import",
2132
+ "scope": "Organization",
2133
+ "purpose": "Imports price data.",
2134
+ "parameters": [
2135
+ {
2136
+ "name": "AfterImportFileHandling",
2137
+ "required": true,
2138
+ "description": "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.",
2139
+ "default": "Archive",
2140
+ "allowedValues": [
2141
+ "Keep",
2142
+ "Delete",
2143
+ "Archive",
2144
+ "Archive Zipped",
2145
+ "Archive In Subfolders",
2146
+ "Archive Overwrite Existing"
2147
+ ]
2148
+ },
2149
+ {
2150
+ "name": "ArchiveFolder",
2151
+ "required": false,
2152
+ "description": "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.",
2153
+ "default": "archive"
2154
+ },
2155
+ {
2156
+ "name": "FileNamePattern",
2157
+ "required": false,
2158
+ "description": "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."
2159
+ },
2160
+ {
2161
+ "name": "ImportFailedHandling",
2162
+ "required": true,
2163
+ "description": "The step exit status that will be used when the import process failed.",
2164
+ "default": "WARN",
2165
+ "allowedValues": [
2166
+ "ERROR",
2167
+ "WARN"
2168
+ ]
2169
+ },
2170
+ {
2171
+ "name": "ImportMode",
2172
+ "required": true,
2173
+ "description": "The import mode.",
2174
+ "default": "Merge",
2175
+ "allowedValues": [
2176
+ "Merge",
2177
+ "Delete",
2178
+ "Replace",
2179
+ "Update"
2180
+ ]
2181
+ },
2182
+ {
2183
+ "name": "NoFilesFoundHandling",
2184
+ "required": true,
2185
+ "description": "The step exit status that will be used when no matching files were found.",
2186
+ "default": "NO_FILES_FOUND",
2187
+ "allowedValues": [
2188
+ "OK",
2189
+ "ERROR",
2190
+ "WARN",
2191
+ "NO_FILES_FOUND"
2192
+ ]
2193
+ },
2194
+ {
2195
+ "name": "WorkingFolder",
2196
+ "required": false,
2197
+ "description": "The folder that contains the import files, relative to the 'IMPEX/src/' folder. If not defined 'IMPEX/src/' is used as working folder."
2198
+ }
2199
+ ]
2200
+ },
2201
+ {
2202
+ "typeId": "ImportProductLists",
2203
+ "kind": "Import",
2204
+ "scope": "Site",
2205
+ "purpose": "Imports product lists.",
2206
+ "parameters": [
2207
+ {
2208
+ "name": "AfterImportFileHandling",
2209
+ "required": true,
2210
+ "description": "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.",
2211
+ "default": "Archive",
2212
+ "allowedValues": [
2213
+ "Keep",
2214
+ "Delete",
2215
+ "Archive",
2216
+ "Archive Zipped",
2217
+ "Archive In Subfolders",
2218
+ "Archive Overwrite Existing"
2219
+ ]
2220
+ },
2221
+ {
2222
+ "name": "ArchiveFolder",
2223
+ "required": false,
2224
+ "description": "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.",
2225
+ "default": "archive"
2226
+ },
2227
+ {
2228
+ "name": "FileNamePattern",
2229
+ "required": false,
2230
+ "description": "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."
2231
+ },
2232
+ {
2233
+ "name": "ImportFailedHandling",
2234
+ "required": true,
2235
+ "description": "The step exit status that will be used when the import process failed.",
2236
+ "default": "WARN",
2237
+ "allowedValues": [
2238
+ "ERROR",
2239
+ "WARN"
2240
+ ]
2241
+ },
2242
+ {
2243
+ "name": "ImportMode",
2244
+ "required": true,
2245
+ "description": "The import mode.",
2246
+ "default": "Merge",
2247
+ "allowedValues": [
2248
+ "Merge",
2249
+ "Delete",
2250
+ "Replace",
2251
+ "Update"
2252
+ ]
2253
+ },
2254
+ {
2255
+ "name": "NoFilesFoundHandling",
2256
+ "required": true,
2257
+ "description": "The step exit status that will be used when no matching files were found.",
2258
+ "default": "NO_FILES_FOUND",
2259
+ "allowedValues": [
2260
+ "OK",
2261
+ "ERROR",
2262
+ "WARN",
2263
+ "NO_FILES_FOUND"
2264
+ ]
2265
+ },
2266
+ {
2267
+ "name": "WorkingFolder",
2268
+ "required": false,
2269
+ "description": "The folder that contains the import files, relative to the 'IMPEX/src/' folder. If not defined 'IMPEX/src/' is used as working folder."
2270
+ }
2271
+ ]
2272
+ },
2273
+ {
2274
+ "typeId": "ImportPromotions",
2275
+ "kind": "Import",
2276
+ "scope": "Site",
2277
+ "purpose": "Imports promotions in the specified mode.",
2278
+ "parameters": [
2279
+ {
2280
+ "name": "AfterImportFileHandling",
2281
+ "required": true,
2282
+ "description": "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.",
2283
+ "default": "Archive",
2284
+ "allowedValues": [
2285
+ "Keep",
2286
+ "Delete",
2287
+ "Archive",
2288
+ "Archive Zipped",
2289
+ "Archive In Subfolders",
2290
+ "Archive Overwrite Existing"
2291
+ ]
2292
+ },
2293
+ {
2294
+ "name": "ArchiveFolder",
2295
+ "required": false,
2296
+ "description": "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.",
2297
+ "default": "archive"
2298
+ },
2299
+ {
2300
+ "name": "FileNamePattern",
2301
+ "required": false,
2302
+ "description": "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."
2303
+ },
2304
+ {
2305
+ "name": "ImportFailedHandling",
2306
+ "required": true,
2307
+ "description": "The step exit status that will be used when the import process failed.",
2308
+ "default": "WARN",
2309
+ "allowedValues": [
2310
+ "ERROR",
2311
+ "WARN"
2312
+ ]
2313
+ },
2314
+ {
2315
+ "name": "ImportMode",
2316
+ "required": true,
2317
+ "description": "The import mode.",
2318
+ "default": "Merge",
2319
+ "allowedValues": [
2320
+ "Merge",
2321
+ "Delete",
2322
+ "Replace",
2323
+ "Update"
2324
+ ]
2325
+ },
2326
+ {
2327
+ "name": "NoFilesFoundHandling",
2328
+ "required": true,
2329
+ "description": "The step exit status that will be used when no matching files were found.",
2330
+ "default": "NO_FILES_FOUND",
2331
+ "allowedValues": [
2332
+ "OK",
2333
+ "ERROR",
2334
+ "WARN",
2335
+ "NO_FILES_FOUND"
2336
+ ]
2337
+ },
2338
+ {
2339
+ "name": "WorkingFolder",
2340
+ "required": false,
2341
+ "description": "The folder that contains the import files, relative to the 'IMPEX/src/' folder. If not defined 'IMPEX/src/' is used as working folder."
2342
+ }
2343
+ ]
2344
+ },
2345
+ {
2346
+ "typeId": "ImportShippingMethods",
2347
+ "kind": "Import",
2348
+ "scope": "Site",
2349
+ "purpose": "Imports shipping methods in the specified mode.",
2350
+ "parameters": [
2351
+ {
2352
+ "name": "AfterImportFileHandling",
2353
+ "required": true,
2354
+ "description": "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.",
2355
+ "default": "Archive",
2356
+ "allowedValues": [
2357
+ "Keep",
2358
+ "Delete",
2359
+ "Archive",
2360
+ "Archive Zipped",
2361
+ "Archive In Subfolders",
2362
+ "Archive Overwrite Existing"
2363
+ ]
2364
+ },
2365
+ {
2366
+ "name": "ArchiveFolder",
2367
+ "required": false,
2368
+ "description": "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.",
2369
+ "default": "archive"
2370
+ },
2371
+ {
2372
+ "name": "FileNamePattern",
2373
+ "required": false,
2374
+ "description": "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."
2375
+ },
2376
+ {
2377
+ "name": "ImportFailedHandling",
2378
+ "required": true,
2379
+ "description": "The step exit status that will be used when the import process failed.",
2380
+ "default": "WARN",
2381
+ "allowedValues": [
2382
+ "ERROR",
2383
+ "WARN"
2384
+ ]
2385
+ },
2386
+ {
2387
+ "name": "ImportMode",
2388
+ "required": true,
2389
+ "description": "The import mode.",
2390
+ "default": "Merge",
2391
+ "allowedValues": [
2392
+ "Merge",
2393
+ "Delete",
2394
+ "Replace",
2395
+ "Update"
2396
+ ]
2397
+ },
2398
+ {
2399
+ "name": "NoFilesFoundHandling",
2400
+ "required": true,
2401
+ "description": "The step exit status that will be used when no matching files were found.",
2402
+ "default": "NO_FILES_FOUND",
2403
+ "allowedValues": [
2404
+ "OK",
2405
+ "ERROR",
2406
+ "WARN",
2407
+ "NO_FILES_FOUND"
2408
+ ]
2409
+ },
2410
+ {
2411
+ "name": "WorkingFolder",
2412
+ "required": false,
2413
+ "description": "The folder that contains the import files, relative to the 'IMPEX/src/' folder. If not defined 'IMPEX/src/' is used as working folder."
2414
+ }
2415
+ ]
2416
+ },
2417
+ {
2418
+ "typeId": "ImportSiteArchive",
2419
+ "kind": "Import",
2420
+ "scope": "Organization",
2421
+ "purpose": "Imports a site import archive file into the current instance.",
2422
+ "parameters": [
2423
+ {
2424
+ "name": "ImportFile",
2425
+ "required": true,
2426
+ "description": "Import file name located directly under 'IMPEX/src/instance' folder."
2427
+ },
2428
+ {
2429
+ "name": "ImportFromRealm",
2430
+ "required": false,
2431
+ "description": "If selected, the import file lookup will be taken in the global realm directory.",
2432
+ "default": "false"
2433
+ },
2434
+ {
2435
+ "name": "ImportMode",
2436
+ "required": false,
2437
+ "description": "The import mode.",
2438
+ "default": "merge",
2439
+ "allowedValues": [
2440
+ "merge"
2441
+ ]
2442
+ }
2443
+ ]
2444
+ },
2445
+ {
2446
+ "typeId": "ImportSourceCodeGroups",
2447
+ "kind": "Import",
2448
+ "scope": "Site",
2449
+ "purpose": "Imports source code groups in the specified mode.",
2450
+ "parameters": [
2451
+ {
2452
+ "name": "AfterImportFileHandling",
2453
+ "required": true,
2454
+ "description": "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.",
2455
+ "default": "Archive",
2456
+ "allowedValues": [
2457
+ "Keep",
2458
+ "Delete",
2459
+ "Archive",
2460
+ "Archive Zipped",
2461
+ "Archive In Subfolders",
2462
+ "Archive Overwrite Existing"
2463
+ ]
2464
+ },
2465
+ {
2466
+ "name": "ArchiveFolder",
2467
+ "required": false,
2468
+ "description": "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.",
2469
+ "default": "archive"
2470
+ },
2471
+ {
2472
+ "name": "FileNamePattern",
2473
+ "required": false,
2474
+ "description": "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."
2475
+ },
2476
+ {
2477
+ "name": "ImportFailedHandling",
2478
+ "required": true,
2479
+ "description": "The step exit status that will be used when the import process failed.",
2480
+ "default": "WARN",
2481
+ "allowedValues": [
2482
+ "ERROR",
2483
+ "WARN"
2484
+ ]
2485
+ },
2486
+ {
2487
+ "name": "ImportMode",
2488
+ "required": true,
2489
+ "description": "The import mode.",
2490
+ "default": "Merge",
2491
+ "allowedValues": [
2492
+ "Merge",
2493
+ "Delete",
2494
+ "Replace",
2495
+ "Update"
2496
+ ]
2497
+ },
2498
+ {
2499
+ "name": "NoFilesFoundHandling",
2500
+ "required": true,
2501
+ "description": "The step exit status that will be used when no matching files were found.",
2502
+ "default": "NO_FILES_FOUND",
2503
+ "allowedValues": [
2504
+ "OK",
2505
+ "ERROR",
2506
+ "WARN",
2507
+ "NO_FILES_FOUND"
2508
+ ]
2509
+ },
2510
+ {
2511
+ "name": "WorkingFolder",
2512
+ "required": false,
2513
+ "description": "The folder that contains the import files, relative to the 'IMPEX/src/' folder. If not defined 'IMPEX/src/' is used as working folder."
2514
+ }
2515
+ ]
2516
+ },
2517
+ {
2518
+ "typeId": "ImportStores",
2519
+ "kind": "Import",
2520
+ "scope": "Site",
2521
+ "purpose": "Imports Stores based on store.xsd",
2522
+ "parameters": [
2523
+ {
2524
+ "name": "AfterImportFileHandling",
2525
+ "required": true,
2526
+ "description": "What to do with the import file after successful or failed import.",
2527
+ "default": "Archive",
2528
+ "allowedValues": [
2529
+ "Keep",
2530
+ "Delete",
2531
+ "Archive",
2532
+ "Archive Zipped",
2533
+ "Archive In Subfolders",
2534
+ "Archive Overwrite Existing"
2535
+ ]
2536
+ },
2537
+ {
2538
+ "name": "ArchiveFolder",
2539
+ "required": false,
2540
+ "description": "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.",
2541
+ "default": "archive"
2542
+ },
2543
+ {
2544
+ "name": "FileNamePattern",
2545
+ "required": false,
2546
+ "description": "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.",
2547
+ "default": ".*\\.xml"
2548
+ },
2549
+ {
2550
+ "name": "ImportFailedHandling",
2551
+ "required": true,
2552
+ "description": "The step exit status that will be used when the import process failed.",
2553
+ "default": "WARN",
2554
+ "allowedValues": [
2555
+ "ERROR",
2556
+ "WARN"
2557
+ ]
2558
+ },
2559
+ {
2560
+ "name": "ImportMode",
2561
+ "required": true,
2562
+ "description": "The import mode.",
2563
+ "default": "Merge",
2564
+ "allowedValues": [
2565
+ "Merge",
2566
+ "Delete",
2567
+ "Replace",
2568
+ "Update"
2569
+ ]
2570
+ },
2571
+ {
2572
+ "name": "NoFilesFoundHandling",
2573
+ "required": true,
2574
+ "description": "The step exit status that will be used when no matching files were found.",
2575
+ "default": "NO_FILES_FOUND",
2576
+ "allowedValues": [
2577
+ "OK",
2578
+ "ERROR",
2579
+ "WARN",
2580
+ "NO_FILES_FOUND"
2581
+ ]
2582
+ },
2583
+ {
2584
+ "name": "WorkingFolder",
2585
+ "required": false,
2586
+ "description": "The folder that contains the import files, relative to the 'IMPEX/src/' folder. If not defined 'IMPEX/src/' is used as working folder."
2587
+ }
2588
+ ]
2589
+ },
2590
+ {
2591
+ "typeId": "ImportTaxTable",
2592
+ "kind": "Import",
2593
+ "scope": "Site",
2594
+ "purpose": "Imports Tax Classes, Tax Jurisdictions and Tax Rates from the given ImportFile in the specified mode.",
2595
+ "parameters": [
2596
+ {
2597
+ "name": "AfterImportFileHandling",
2598
+ "required": true,
2599
+ "description": "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.",
2600
+ "default": "Archive",
2601
+ "allowedValues": [
2602
+ "Keep",
2603
+ "Delete",
2604
+ "Archive",
2605
+ "Archive Zipped",
2606
+ "Archive In Subfolders",
2607
+ "Archive Overwrite Existing"
2608
+ ]
2609
+ },
2610
+ {
2611
+ "name": "ArchiveFolder",
2612
+ "required": false,
2613
+ "description": "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.",
2614
+ "default": "archive"
2615
+ },
2616
+ {
2617
+ "name": "FileNamePattern",
2618
+ "required": false,
2619
+ "description": "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."
2620
+ },
2621
+ {
2622
+ "name": "ImportFailedHandling",
2623
+ "required": true,
2624
+ "description": "The step exit status that will be used when the import process failed.",
2625
+ "default": "WARN",
2626
+ "allowedValues": [
2627
+ "ERROR",
2628
+ "WARN"
2629
+ ]
2630
+ },
2631
+ {
2632
+ "name": "ImportMode",
2633
+ "required": true,
2634
+ "description": "The import mode.",
2635
+ "default": "Merge",
2636
+ "allowedValues": [
2637
+ "Merge",
2638
+ "Delete",
2639
+ "Replace",
2640
+ "Update"
2641
+ ]
2642
+ },
2643
+ {
2644
+ "name": "NoFilesFoundHandling",
2645
+ "required": true,
2646
+ "description": "The step exit status that will be used when no matching files were found.",
2647
+ "default": "NO_FILES_FOUND",
2648
+ "allowedValues": [
2649
+ "OK",
2650
+ "ERROR",
2651
+ "WARN",
2652
+ "NO_FILES_FOUND"
2653
+ ]
2654
+ },
2655
+ {
2656
+ "name": "WorkingFolder",
2657
+ "required": false,
2658
+ "description": "The folder that contains the import files, relative to the 'IMPEX/src/' folder. If not defined 'IMPEX/src/' is used as working folder."
2659
+ }
2660
+ ]
2661
+ },
2662
+ {
2663
+ "typeId": "CreateSitemap",
2664
+ "kind": "Process",
2665
+ "scope": "Site",
2666
+ "purpose": "Creates Sitemap.",
2667
+ "parameters": []
2668
+ },
2669
+ {
2670
+ "typeId": "DownloadActiveDataFromStorage",
2671
+ "kind": "Process",
2672
+ "scope": "Site",
2673
+ "purpose": "Download active data from storage system to current site. This step downloads active data to the new site from storage system during a site move if active data is required to migrate to the new site. Before this step can run, set the new site to 'Online' mode. This prevents premature migration for the new site. The StorageFolderName parameter needs to use the value from UploadActiveDataToStorageStep's log.",
2674
+ "parameters": [
2675
+ {
2676
+ "name": "StorageFolderName",
2677
+ "required": true,
2678
+ "description": "This is the storage folder name created by the UploadActiveDataToStorage step."
2679
+ }
2680
+ ]
2681
+ },
2682
+ {
2683
+ "typeId": "ExecuteCategorizationRules",
2684
+ "kind": "Process",
2685
+ "scope": "Organization",
2686
+ "purpose": "Executes the Categorization based on the Categorization Rules and Conditions defined on a CatalogCategory.",
2687
+ "parameters": [
2688
+ {
2689
+ "name": "CatalogID",
2690
+ "required": true,
2691
+ "description": "The Catalog Id which needs Categorization."
2692
+ },
2693
+ {
2694
+ "name": "CategoryID",
2695
+ "required": true,
2696
+ "description": "The Category Id which needs Categorization. If we need to run the Categorization for all Categories, this should be set as 'ALL'."
2697
+ }
2698
+ ]
2699
+ },
2700
+ {
2701
+ "typeId": "ExecuteDataReplication",
2702
+ "kind": "Process",
2703
+ "scope": "Organization",
2704
+ "purpose": "Replicates data to a target system. The ReplicationConfiguration parameter requires a string in JSON format that describes the replication process and its tasks that will be executed. The parameter section that describes the tasks is similar to the Replication Tasks step of the Business Manager Data Replication wizard. Replication tasks not included in the JSON are not included in the data replication process. Replication tasks set to 'false' are also not included in the data replication process.",
2705
+ "parameters": [
2706
+ {
2707
+ "name": "ReplicationConfiguration",
2708
+ "required": true,
2709
+ "description": "Describes the replication process and its replication tasks that will be executed."
2710
+ }
2711
+ ]
2712
+ },
2713
+ {
2714
+ "typeId": "ExecutePipeline",
2715
+ "kind": "Process",
2716
+ "scope": "Organization & Sites",
2717
+ "purpose": "Executes a pipeline. The name and start node of the pipeline has to be configured at parameter 'ExecutePipeline.Pipeline'. This step has been provided to ease the transition from pipeline based jobs to the new job framework. To fully leverage the new framework use system or custom job steps. Deprecated: This job step is deprecated. We recommend you replace pipelines with system job steps and custom job steps.",
2718
+ "parameters": [
2719
+ {
2720
+ "name": "ExecutePipeline.Pipeline",
2721
+ "required": true,
2722
+ "description": "The process pipeline to execute, e.g. 'MyProcessPipeline-Start'."
2723
+ }
2724
+ ]
2725
+ },
2726
+ {
2727
+ "typeId": "ExecutePreconfiguredCodeReplicationProcess",
2728
+ "kind": "Process",
2729
+ "scope": "Organization",
2730
+ "purpose": "Executes the preconfigured code replication process with the ID defined at parameter 'ReplicationProcessID'. The code replication process has to be created / configured using the BM UI for code replication, with activation set to 'Job Step' and type 'Code Transfer & Activation'.",
2731
+ "parameters": [
2732
+ {
2733
+ "name": "ReplicationProcessID",
2734
+ "required": true,
2735
+ "description": "The ID of the preconfigured replication process."
2736
+ }
2737
+ ]
2738
+ },
2739
+ {
2740
+ "typeId": "ExecutePreconfiguredDataReplicationProcess",
2741
+ "kind": "Process",
2742
+ "scope": "Organization",
2743
+ "purpose": "Executes the preconfigured data replication process with the ID defined at parameter 'ReplicationProcessID'. The data replication process has to be created / configured using the BM UI for data replication, with activation set to 'Job Step' and type 'Transfer & Publication'.",
2744
+ "parameters": [
2745
+ {
2746
+ "name": "ReplicationProcessID",
2747
+ "required": true,
2748
+ "description": "The ID of the preconfigured replication process."
2749
+ }
2750
+ ]
2751
+ },
2752
+ {
2753
+ "typeId": "ExecuteScriptModule",
2754
+ "kind": "Process",
2755
+ "scope": "Organization & Sites",
2756
+ "purpose": "Executes a function exported by a script module. The module ID has to be configured at parameter 'ExecuteScriptModule.Module'. Deprecated: This job step is deprecated. We recommend that you use the steptypes.json file to execute a script.",
2757
+ "parameters": [
2758
+ {
2759
+ "name": "ExecuteScriptModule.Module",
2760
+ "required": true,
2761
+ "description": "The ID of the script module, e.g. my_cartridge/cartridge/scripts/job/myScriptModule.js"
2762
+ },
2763
+ {
2764
+ "name": "ExecuteScriptModule.FunctionName",
2765
+ "required": false,
2766
+ "description": "The name of the script module's exported function to execute. If not defined teh script is supposed to export a function named 'execute'.",
2767
+ "default": "execute"
2768
+ },
2769
+ {
2770
+ "name": "ExecuteScriptModule.TimeoutInSeconds",
2771
+ "required": false,
2772
+ "description": "The timeout in seconds for the script module's function. If not defined the batch processing framework applies the default timeout."
2773
+ },
2774
+ {
2775
+ "name": "ExecuteScriptModule.Transactional",
2776
+ "required": false,
2777
+ "description": "Indicates if the script module's function requires transaction handling. The default value is 'false'. To avoid a negative impact on system performance and allow more granular transaction control, keep the default setting of 'false'. Implement transaction handling within the job step using the dw.system.Transaction API.",
2778
+ "default": "false"
2779
+ }
2780
+ ]
2781
+ },
2782
+ {
2783
+ "typeId": "IncludeStepsFromJob",
2784
+ "kind": "Process",
2785
+ "scope": "Organization & Sites",
2786
+ "purpose": "Includes steps from another job. This step makes it easy to create a set of standard steps that you can execute in multiple jobs. It is recommended to use the IncludeStepsFromJob step in single execution scope flows only (Organization or one specific Storefront Site). If the IncludeStepsFromJob step is used in multi-site execution scope flows (more than one specific Storefront Site, All Storefront Sites) inclusion of the steps is done multiple times.",
2787
+ "parameters": [
2788
+ {
2789
+ "name": "JobID",
2790
+ "required": true,
2791
+ "description": "The ID of the job to import steps from."
2792
+ }
2793
+ ]
2794
+ },
2795
+ {
2796
+ "typeId": "InvalidateCache",
2797
+ "kind": "Process",
2798
+ "scope": "Site",
2799
+ "purpose": "Invalidate Page and Static Content Cache Invalidates the page cache and/or static content cache (images, styles, etc.) of the sites specified for the job flow. Portions of the page cache may be invalidated by specifying a set of page cache partition IDs, which will invalidate only the page cache that matches the controllers/pipelines specified with these partitions.",
2800
+ "parameters": [
2801
+ {
2802
+ "name": "InvalidatePageCache",
2803
+ "required": true,
2804
+ "description": "If selected, then pages in the page cache are deleted. If the PageCachePartitionIDs parameters is specified, only those partitions are invalidated, otherwise the entire page cache.",
2805
+ "default": "true"
2806
+ },
2807
+ {
2808
+ "name": "InvalidateStaticCache",
2809
+ "required": true,
2810
+ "description": "If selected, then all files in the static content cache are invalidated. Page cache should be invalidated at the same time to refresh static content URLs.",
2811
+ "default": "true"
2812
+ },
2813
+ {
2814
+ "name": "PageCachePartitionIDs",
2815
+ "required": false,
2816
+ "description": "A comma separated list of page cache partition IDs to invalidate in the page cache. If specified, only the portion of the page cache specified by the partitions is invalidated, as opposed to the entire page cache."
2817
+ }
2818
+ ]
2819
+ },
2820
+ {
2821
+ "typeId": "SearchReindex",
2822
+ "kind": "Process",
2823
+ "scope": "Site",
2824
+ "purpose": "Rebuilds or updates search indexes. The number of search indexes that can be rebuilt or updated in parallel is globally limited. If the limit is exceeded, any rebuild or update action will be queued and executed once resources are available again.",
2825
+ "parameters": [
2826
+ {
2827
+ "name": "Active data search index",
2828
+ "required": false,
2829
+ "description": "Reindex active data search indexes.",
2830
+ "default": "false"
2831
+ },
2832
+ {
2833
+ "name": "Content search index",
2834
+ "required": false,
2835
+ "description": "Reindex content search indexes.",
2836
+ "default": "false"
2837
+ },
2838
+ {
2839
+ "name": "Indexer Type",
2840
+ "required": true,
2841
+ "description": "Determines whether to rebuild or update incrementally.",
2842
+ "default": "Full Index Rebuild",
2843
+ "allowedValues": [
2844
+ "Full Index Rebuild",
2845
+ "Incremental Index Update"
2846
+ ]
2847
+ },
2848
+ {
2849
+ "name": "Product related search indexes",
2850
+ "required": false,
2851
+ "description": "Reindex product related search indexes which contain 'Product', 'Suggest' and 'Synonym' search indexes.",
2852
+ "default": "false"
2853
+ }
2854
+ ]
2855
+ },
2856
+ {
2857
+ "typeId": "UndoPreconfiguredCodeReplicationProcess",
2858
+ "kind": "Process",
2859
+ "scope": "Organization",
2860
+ "purpose": "Undo the preconfigured code replication process with the ID defined at parameter 'ReplicationProcessID'. The given code replication process must have been executed using a step of type 'ExecutePreconfiguredCodeReplicationProcess' by this job.",
2861
+ "parameters": [
2862
+ {
2863
+ "name": "ReplicationProcessID",
2864
+ "required": true,
2865
+ "description": "The ID of the preconfigured replication process."
2866
+ }
2867
+ ]
2868
+ },
2869
+ {
2870
+ "typeId": "UndoPreconfiguredDataReplicationProcess",
2871
+ "kind": "Process",
2872
+ "scope": "Organization",
2873
+ "purpose": "Undo the preconfigured data replication process with the ID defined at parameter 'ReplicationProcessID'. The given data replication process must have been executed using a step of type 'ExecutePreconfiguredDataReplicationProcess' by the same job.",
2874
+ "parameters": [
2875
+ {
2876
+ "name": "ReplicationProcessID",
2877
+ "required": true,
2878
+ "description": "The ID of the preconfigured replication process."
2879
+ }
2880
+ ]
2881
+ },
2882
+ {
2883
+ "typeId": "UpdateStorefrontURLs",
2884
+ "kind": "Process",
2885
+ "scope": "Site",
2886
+ "purpose": "Updates the Storefront URLs for objects like categories, products, folders and content assets. This will update the URLs for all sites assigned under 'Scope'. This job step will not work in production instances and the storefront URLs are to be replicated from STG.",
2887
+ "parameters": []
2888
+ },
2889
+ {
2890
+ "typeId": "UploadActiveDataBackupToStorage",
2891
+ "kind": "Process",
2892
+ "scope": "Site",
2893
+ "purpose": "Upload current site's active data to storage system (as a backup). This step uploads active data as a backup to storage system during a site move if active data is required to migrate to the new site.",
2894
+ "parameters": []
2895
+ },
2896
+ {
2897
+ "typeId": "UploadActiveDataToStorage",
2898
+ "kind": "Process",
2899
+ "scope": "Site",
2900
+ "purpose": "Upload current site's active data to storage system. This step uploads active data from an old site to storage system during a site move if active data is required to migrate to the new site. Before this step can run, put the old site in 'Maintenance' mode for at least 90 minutes. This lets the old site fully process active data before the migration happens. When the job finishes, copy the storage folder name from the job log.",
2901
+ "parameters": [
2902
+ {
2903
+ "name": "TargetRealm",
2904
+ "required": true,
2905
+ "description": "The 4-letter target realm where the Active Data is intended to be downloaded by the DownoadActiveDataFromStorage step."
2906
+ }
2907
+ ]
2908
+ }
2909
+ ]
2910
+ }