July 2023 release of Adobe Experience Manager Guides as a Cloud Service
This release note covers the upgrade instructions, compatibility matrix, and issues fixed in version July 2023 of Adobe Experience Manager Guides (later referred as AEM Guides as a Cloud Service).
For more information about the new features and enhancements, see What’s new in July 2023 release of AEM Guides as a Cloud Service.
Upgrade to July 2023 release
Upgrade your current AEM Guides as a Cloud Service setup by performing the following steps:
- Check out the Cloud Services’ Git code and switch to the branch configured in the Cloud Services pipeline corresponding to the environment that you want to upgrade.
- Update
<dox.version>property in/dox/dox.installer/pom.xmlfile of your Cloud Services Git code to 2023.7.0.314. - Commit the changes and run the Cloud Services pipeline to upgrade to the July 2023 release of AEM Guides as a Cloud Service.
Steps to enable the trigger of a script via a servlet
(Only if you are on a version prior to June 2023 release of AEM Guides as a Cloud Service)
After you complete the installation, you can choose to HIT the trigger to start the translation job:
POST:
http://localhost:4503/bin/guides/script/start?jobType=translation-map-upgrade
Response:
{
"msg": "Job is successfully submitted and lock node is created for future reference",
"lockNodePath": "/var/dxml/executor-locks/translation-map-upgrade/1683190032886",
"status": "SCHEDULED"
}
In the previous response JSON, the key lockNodePath holds the path to the node created in the repository pointing to the job submitted. It will automatically be deleted once the job is completed, till then, you can refer to this node for the current status of the job.
Wait till this job is completed before proceeding to the next steps.
GET
http://<aem_domain>/var/dxml/executor-locks/translation-map-upgrade/1683190032886.json
Steps to post process the existing content to use the broken link report
(Only if you are on a version prior to June 2023 release of AEM Guides as a Cloud Service)
Perform the following steps for post processing the existing content and using the new broken link report:
-
(Optional) If there are more than 100,000 dita files in the system, update the
queryLimitReadsunderorg.apache.jackrabbit.oak.query.QueryEngineSettingsServiceto a larger value (any value greater than the number of assets present, for example 200,000) and then redeploy.-
Use the instructions given in Configuration overrides section in Install and configure Adobe Experience Manager Guides
as a Cloud Service, to create the configuration file. -
In the configuration file, provide the following (property) details to configure the queryLimitReads option:
table 0-row-3 1-row-3 PID Property Key Property Value org.apache.jackrabbit.oak.query.QueryEngineSettingsService queryLimitReads Value: 200000 Default Value: 100000
-
-
Run a POST request to the server (with correct authentication) -
http://<server:port>//bin/guides/reports/upgrade. -
The API will return a jobId. To check the status of the job, you can send a GET request with job id to the same end point -
http://<server:port>/bin/guides/reports/upgrade?jobId= {jobId}
(For example:http://localhost:8080/bin/guides/map-find/indexing?jobId=2022/9/15/7/27/7dfa1271-981e-4617-b5a4-c18379f11c42_678) -
Once the job is complete, the previous GET request will respond with success. If job fails for some reason then failure can be seen from server logs.
-
Revert back to the default or previous existing value of
queryLimitReadsif you have changed it in step 1.
Steps to index the existing content to use the new find and replace and topic list under the Reports tab:
(Only if you are on a version prior to June 2023 release of AEM Guides as a Cloud Service)
Perform the following steps for indexing the existing content and use the new find and replace text at map level and topic list under the reports tab:
-
Run a POST request to the server (with correct authentication) -
http://<server:port\>/bin/guides/map-find/indexing. (Optional: You can pass specific paths of the maps to index them, by default all maps will be indexed || For example :https://<Server:port\>/bin/guides/map-find/indexing?paths=<map\_path\_in\_repository\>) -
You can also pass a root folder to index the DITA maps of a specific folder (and its subfolders). For example,
http://<server:port\>/bin/guides/map-find/indexing?root=/content/dam/test. Note that if both the paths parameter and root parameter are passed, only the paths parameter is considered. -
The API will return a jobId. To check the status of the job, you can send a GET request with job id to the same end point -
http://<server:port\>/bin/guides/map-find/indexing?jobId=\{jobId\}(For example:http://localhost:8080/bin/guides/map-find/indexing?jobId=2022/9/15/7/27/7dfa1271-981e-4617-b5a4-c18379f11c42) -
Once the job is complete, the previous GET request will respond with success and mention if any maps failed. The successfully indexed maps can be confirmed from the server logs.
Compatibility matrix
This section lists the compatibility matrix for the software applications supported by AEM Guides as a Cloud Service July 2023 release.
FrameMaker and FrameMaker Publishing Server
Oxygen Connector
Fixed issues
The bugs fixed in various areas are listed below:
Authoring
- Inline/Display attributes do not show up in the Layout view of the Web Editor. (12498)
- Upload files in Oxygen Plugin for AEM Guides is not working in cloud services if you have ! in the file name. (12207)
- DITA map publishing is very slow with editable template. (12075)
- Global Profile UI config does not match with Folder Profile. (11970)
- Content references are broken when DITA files are copied and pasted. (11959)
- Not able to edit content fragment in column view with AEM Guides installed. (7342)
- Content is lost when an unwrapped xref is under a sub element tags. (12532)
Publishing
- Approval workflow does not work when docstate is changed to “end state” from File properties of the right panel. (11026)