Uploaded image for project: 'Magnolia Synchronization Module'
  1. Magnolia Synchronization Module
  2. MGNLSYNC-49

DOC: Synchronization module changes for 1.9

    XMLWordPrintable

Details

    • Task
    • Resolution: Fixed
    • Neutral
    • 1.9
    • 1.9
    • None
    • None

    Description

      GET .rest/synchronization/v1/reset //Resets and flushes all synchronizations
      GET .rest/synchronization/v1/status/ {syncId}
      //Returns the status of a synchronization request
      
      POST .rest/synchronization/v1/trigger //Starts a synchronization of content on a Magnolia public instance
      JSON body of the request (in the current documentation these are request params, now part of the request body instead): "template" and "url" are mutually exclusive params, you can choose either but not both. 
      {
         "workspace": "website" //target workspace
         "path" : "/", //target path
         "template" : "receiverName" //receiver template configured under synchronization module config (can be added via module config decoration)
          "url" : "http://localhost:8080/magnoliaPublic" //target URL
         "fromPath" : "/", 
         "fromDate" : "2012-03-29T10:05:45-06:00"}
         ... (all params in the current documentation)
      }
      

      To be clarified (ask Roman or Mika): what's the difference between path and fromPath?

      Also a nice request example (copy/pasteable), courtesy of Roman

      curl -u superuser:superuser http://localhost:8080/magnoliaAuthor/.rest/synchronization/v1/trigger --data '
      {"url" : "http://localhost:8080/magnoliaPublic", "workspace": "website", "fromPath" : "/", "fromDate" : "2012-03-29T10:05:45-06:00"}
      ' --header "Content-Type: application/json"
      

      There also are some known issues upon updating in case a 1.9 beta version is installed

      2020-06-25 15:10:19,851 WARN  agnolia.transformer.ClassPropertyBasedTypeResolver: Encountered the 'class' property but failed to resolved the type from its value: [info.magnolia.synchronization.commands.RestSynchronizationCommand]
      

      This is harmless and the following node will have to be removed manually from the JCR configuration

      /modules/synchronization-rest/commands

      Due to the fact that update/install tasks are not run from beta to final versions, the following configuration will have to be created manually

      Also, in case 1.9-beta3 is installed, the following node will have to be removed from JCR configuration

      /modules/synchronization-core/commands/synchronization/synchronize/synchronizationSenderClass

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            Activity

              People

                rgange Richard Gange
                fgrilli Federico Grilli
                Nucleus
                Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  Checklists

                    Task DoR