Getting Started with Refactoring Tools getting-started-refactoring-tools
Availability availability
Running the Refactoring Tools running-refactoring-tools
Use the Refactoring Tool to migrate your code for compatibility with AEM as a Cloud Service.
-
If you haven’t created a CAM project yet, refer to Creating and Managing a Project in CAM.
-
Click the Code Refactoring card to upload the source code.
-
When you first access the Source Code View, you will see an empty state prompting you to upload your source code.
Uploading Source Code uploading
When customers first access the Refactoring Tools, they are presented with an empty state in the Source Code View. Follow the steps below to upload your project and begin the inspection process:
-
Access the Project Upload Page
Click on the Project Upload button in the empty state to start the upload process.
-
Upload Your Source Code
- In the upload dialog, select your source code ZIP file.
- Click Upload to begin.
- The upload progress will be displayed in the dialog. Duration depends on your project’s size.
-
Inspection Process
- After uploading, the Inspection Process begins automatically in the background.
- The Source Code View will now display your uploaded project and its inspection status.
-
Inspection Status The inspection process is designed to simplify the execution of refactoring tools by reducing the overhead of manual configurations.
The inspection will show one of the following statuses:
- Running – The inspection is in progress.
- Ready – The inspection is complete; you may now run refactoring tools.
- Failed – An error occurred. Click the project to review the inspection report and resolve any issues.
Refactoring Jobs refactoring-jobs
When you click the Refactoring Job tab, you will see a list of existing jobs. If no jobs have been created yet, an empty state will be displayed prompting job creation.
1. Create a New Refactoring Job
- Click the Create New Job button.
- Select the desired refactoring tool(s).
- Click Start to initiate the refactoring process.
2. Job Status
- Running – The job is currently in progress. Status updates automatically upon completion or failure.
- Completed – The job finished successfully. You can now review results or download the refactored code.
- Failed – The job encountered an error. Click on the job to view detailed logs and troubleshoot the issue.
When the job is completed successfully, the Download button becomes available, allowing you to retrieve:
- The Refactored Project: This is the updated code after the transformation is applied. Customers can download the latest code for their project.
- Activity Logs: During the job execution, all steps performed by the tool and the changes made are logged as part of this.
- Findings Report: This report contains items that were not fully executed by the tool but still need to be addressed. All such changes are logged here.
