Getting Started with Content Transfer Tool getting-started-content-transfer-tool
Availability availability
The Content Transfer Tool can be downloaded as a zip file from the Software Distribution Portal. You can install the package by way of Package Manager on your source ۶Ƶ Experience Manager (AEM) instance. Make sure to download the latest version. For more details on the latest version, see Release Notes.
Only version 2.0.0 and higher is supported, and it is advisable to use the most recent version.
Source Environment Connectivity source-environment-connectivity
The source AEM instance may be running behind a firewall where it can only reach certain hosts which have been added to an Allow List. To successfully run an extraction, the following endpoints need to be accessible from the instance that is running AEM:
- The Azure blob storage service:
casstorageprod.blob.core.windows.net
Enable SSL Logging enable-ssl-logging
Understanding SSL/TLS connection problems can sometimes be difficult. To troubleshoot connection issues during an extraction process, you can enable SSL logging via the System Console of the source AEM environment by following these steps:
-
Navigate to the ۶Ƶ Experience Manager Web Console on your source instance, by going to Tools > Operations > Web Console or directly to the URL at https://serveraddress:serverport/system/console/configMgr
-
Search for Content Transfer Tool Extraction Service Configuration
-
Use the pencil icon button to edit its configuration values
-
Enable the Enable ssl logging for extraction setting, then press Save:
Running the Content Transfer Tool running-tool
The following section applies to the new version of the Content Transfer Tool. Follow this section to learn how to use the Content Transfer Tool to migrate content to AEM as a Cloud Service:
Extraction Setup Phase extraction-setup-phase
-
Log into Cloud Acceleration Manager (CAM) and click the CAM project that you had created previously to assess your readiness to move to AEM as a Cloud Service. If you haven’t created a CAM project, refer to Creating and Managing a Project in CAM.
-
Click the Content Transfer card to open the Migration Set List view.
-
Create a Migration Set by clicking Create Migration Set.
note note NOTE A maximum of 10 migration sets, including expired sets, can be created per project in Cloud Acceleration Manager. The following dialog box is presented. Notice that a migration set will expire after a prolonged period of inactivity. After warnings are displayed on the project card and the migration job table rows for a time period, the migration set will expire and its data will no longer be available. Review Migration Set Expiry for details.
note note NOTE The name must follow the same conventions of an AEM node so cannot contain any of these characters: . / : [ ] | * -
You should now see your migration list in the list view. Select the three dots symbol (…) to open the drop-down and select Copy Extraction key. You need this key during the Extraction phase. Copy this Extraction key.
note note NOTE The extraction key enables your source AEM environment to securely connect to the migration set. Treat this key with the same care that you would a password, and never share it over an unsecured medium like email.
Populating the Migration Set populating-the-migration-set
To populate the migration set you created in the Cloud Acceleration Manager, install the latest version of the Content Transfer Tool on your source ۶Ƶ Experience Manager (AEM) instance. To learn how to populate the migration set, follow this section.
-
After installing the latest version of the Content Transfer Tool on your source ۶Ƶ Experience Manager instance, go to Operations - Content Migration
-
Click Create Migration Set.
-
Paste the extraction key that was copied from CAM earlier into the Extraction key input field of Create Migration Set form. After you do this, the Migration set name and Cloud Acceleration Manager (CAM) Project name fields are automatically populated. These should match the Migration Set name in CAM and the CAM project name that you created. You can now add content paths. After you have added content paths, save the migration set. You can run the extraction with either versions included or excluded.
note note NOTE Make sure that the extraction key is valid and is not near its expiration. You can get this information in the Create Migration Set dialog after you paste the extraction key. If you get a connection error, see Source Environment Connectivity for more information. -
Next, select the following Parameters to create a Migration Set:
-
Include Version: Select as required. When versions are included, the path
/var/audit
is automatically included to migrate audit events.note note NOTE If you intend to include versions as part of a migration set, and are performing top-ups with wipe=false
, then you must disable version purging due to a current limitation in the Content Transfer Tool. If you prefer to keep version purge enabled and are performing top-ups into a migration set, then you must perform the ingestion aswipe=true
. -
Paths to be included: Use path browser to select paths which need to be migrated. Path picker accepts input by typing or by selection.
note important IMPORTANT Following paths are restricted while creating a migration set: /apps
/libs
/home
/etc
(some/etc
paths are allowed to be selected in CTT)
-
-
Click Save after you populate all the fields in the Create Migration Set details screen.
Determining migration set size migration-set-size
After creating a migration set, it is highly recommended to run a size check on the migration set before starting an Extraction process.
By running a size check on the migration set, you are able to:
- Determine if there is sufficient disk space in the
crx-quickstart
subdirectory to complete extraction successfully. - Determine if the migration set size falls within supported product limits and avoid failed content ingestions.
Follow the steps below to run a size check:
-
Select a migration set and click Check Size.
-
This opens up the Check Size dialog.
-
Click Check Size to start the process. You will then return to the migration set list view, and you should see a message indicating that Check Size is running.
-
After Check Size process is completed, the status changes to FINISHED. Select the same migration set and click Check Size to view results. Below is an example of Check Size results with no warnings.
-
If the Check Size results indicate that either there is insufficient disk space, or the migration set exceeds product limits, or both, a WARNING status is displayed.
What’s Next whats-next
Once you have learned how to create a migration set, you are now ready to learn about Extraction and Ingestion Processes in Content Transfer Tool. Before you learn these processes, you must review Handling Large Content Repositories to significantly speed-up the extraction and ingestion phases of the content transfer activity to move content to AEM as a Cloud Service.