Job Step ExecuteDataReplication
Executes a data replication process.

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. The JSON syntax and replication tasks are validated when you add the step to the job. If something is wrong, a log message is written during runtime. The following is an example JSON-snippet for the ReplicationConfiguration parameter.


{
  "data_replication_configuration" : {
    "target" : "production",
    "type" : "transfer_and_publish",
    "description" : "Any data replication process description",
    "keep_caches" : false,
    "notification" : {
      "type": "process_end",
      "to": [
        "[email protected]",
        "[email protected]"
      ]
    },
    "tasks" : {
      "global" : {
        "csc_settings" : true,
        "csrf_whitelists" : true,
        "catalogs" : {
          "catalogDEMO" : true
        },
        "custom_object_types" : true,
        "custom_objects" : true,
        "customer_lists" : true,
        "geolocations" : true,
        "global_sorting" : true,
        "libraries" : {
          "libDEMO" : true
        },
        "oauth_providers" : true,
        "ocapi_settings" : true,
        "page_meta_tags" : true,
        "preferences" : {
          "system_preferences" : true,
          "custom_preferences" : true
        },
        "price_books": true,
        "sites" : {
          "siteDEMO" : true
        },
        "static_content" : true,
        "webdav_client_permissions" : true
      },
      "sites" : {
        "siteDEMO" : {
          "ab_tests" : true,
          "ab_tests_and_experiences" : true,
          "active_data_feeds" : true,
          "cache_settings" : true,
          "campaigns_and_promotions" : true,
          "content_library" : true,
          "content_slots" : true,
          "coupons" : true,
          "custom_objects" : true,
          "customer_groups" : true,
          "dynamic_content" : true,
          "ocapi_settings" : true,
          "payment" : true,
          "preferences" : {
            "system_preferences" : true,
            "custom_preferences" : true
          },
          "search_indexes" : true,
          "shipping_methods" : true,
          "sorting" : true,
          "source_codes" : true,
          "storefront_urls" : {
            "catalog_urls" : true,
            "content_urls" : true,
            "pipeline_urls" : true,
            "redirects" : true
          },
          "stores" : true,
          "taxation" : true
        }
      }
    }
  }
}

 
Execution Context:
Organization
Parallel Execution:
Not Supported
Always execute on restart:
Supported
Input Parameters
ReplicationConfiguration  :  JSONString (Required)
Describes the replication process and its replication tasks that will be executed.
Exit Status
ERROR
Data replication process has failed.
OK
Data replication process was successful.
NO_STAGING_INSTANCE
Step is used on non-staging instances.
ERROR_LOCKING
Data replication could not get all locks required.
ERROR_REPLICATION_IN_PROGRESS
Data replication could not be started because another replication process is currently running.
X Privacy Update: We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used. By continuing to use this site you are giving us your consent to do this. Privacy Policy.