DocumentationAEM GuidesAEM Guides Documentation

November 2023 release of Adobe Experience Manager Guides as a Cloud Service

Last update: Thu Feb 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Leader

This release note covers the upgrade instructions, compatibility matrix, and issues fixed in version November 2023 of Adobe Experience Manager Guides as a Cloud Service (later referred as Experience Manager Guides as a Cloud Service).

For more information about the new features and enhancements, view What’s new in the November 2023 release of Experience Manager Guides as a Cloud Service.

Upgrade to November 2023 release

Upgrade your current Experience Manager Guides as a Cloud Service setup by performing the following steps:

  1. 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.
  2. Update <dox.version> property in /dox/dox.installer/pom.xml file of your Cloud Services Git code to 2023.11.0.406.
  3. Commit the changes and run the Cloud Services pipeline to upgrade to the November 2023 release of Experience Manager 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 the June 2023 release of Experience Manager 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, then, you can refer to this node for the status of the job.

Wait till this job is completed before proceeding to the next steps.

NOTE
You should check if the node is still present, and the status of the job.
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 the June 2023 release of Experience Manager Guides as a Cloud Service)

Perform the following steps for post-processing the existing content and using the new broken link report:

  1. (Optional) If there are more than 100,000 DITA files in the system, update the queryLimitReads and queryLimitInMemory under org.apache.jackrabbit.oak.query.QueryEngineSettingsService to a larger value (any value greater than the number of assets present, for example 200,000) and then redeploy.

    • Use the instructions given in the 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 and queryLimitInMemory option:

      table 0-row-3 1-row-3 2-row-3
      PID Property Key Property Value
      org.apache.jackrabbit.oak.query.QueryEngineSettingsService queryLimitReads Value: 200000 Default Value: 100000
      org.apache.jackrabbit.oak.query.QueryEngineSettingsService queryLimitInMemory Value: 200000 Default Value: 100000

  2. Run a POST request to the server (with correct authentication) - http://<server:port>//bin/guides/reports/upgrade.

  3. The API returns 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)

  4. Once the job is completed, the previous GET request responds with success. If the job fails for some reason, then failure can be seen from server logs.

  5. Revert to the default or previous existing value of queryLimitReads if 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 the June 2023 release of Experience Manager 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:

  1. 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>)

  2. 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.

  3. The API returns 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)

  4. Once the job is completed, the previous GET request responds with success and mention if any maps failed. The successfully indexed maps can be confirmed from the server logs.

Steps to handle the 'fmdita rewriter' conflict

Experience Manager Guides has a custom sling rewriter module for handling the links generated in case of cross-maps (links between the topics of two different maps).

If you have another custom sling rewriter in your codebase, use an 'order' value greater than 50, as Experience Manager Guides sling rewriter uses 'order' 50. To override this, you need a value >50. For more details, view Output Rewriting Pipelines.

During this upgrade, since the 'order' value is changed from 1000 to 50, you need to merge the existing custom rewriter, if any, with 'fmdita-rewriter'.

Compatibility matrix

This section lists the compatibility matrix for the software applications supported by Experience Manager Guides as a Cloud Service November 2023 release.

FrameMaker and FrameMaker Publishing Server

Experience Manager Guides Guides as a Cloud Release
FMPS
FrameMaker
2023.11.0
Not compatible
2022 or higher

Oxygen Connector

Experience Manager Guides as a Cloud Release
Oxygen Connector Windows
Oxygen Connector Mac
Edit in Oxygen Windows
Edit in Oxygen Mac
2023.11.0
3.2-uuid 5
3.2-uuid 5
2.3
2.3

Knowledge base template version

Components package name
Components version
Template version
Experience Manager Guides Components Content Package for Cloud Service
dxml-components.all-1.2.2
aem-site-template-dxml.all-1.0.15

Fixed issues

The bugs fixed in various areas are listed below:

Authoring

  • Space after conref <ph> element disappears on saving the topic. (13642)
  • Application error occurs when trying to save DITA files before the post-processing is complete. (13571)
  • If the title of a topic contains a slash /, the tab in the editor only shows the letters coming after it. (13455)
  • The image preview doesn’t disappear after displaying the preview in the Editor. (13454)
  • Insert keyword pop-up does not appear when using root map-defined keys in other topics. (12950)
  • Close icons is not visbile when very tall graphics are previewed in the Version History panel. (12867)
  • Unable to modify the timezone of Version Created On column for the Baselines. (12711)
  • The Version History panel in the Assets UI shows an incorrect timestamp for the Current field. (12624)
  • Creating a DITA file from a template with a filename starting with numeric characters results in a namespace error. (12188)
  • In the Web Editor, the Key References window opens when inserting the varname tag. (10940)
  • Zip files are not recognized in the Web Editor, and you cannot drag and drop them. (12709)
  • The content with some attributes applied on it is not being highlighted in Author or Preview mode. (11063)
  • On closing a topic after editing it, you are redirected to the AEM Home page instead of returning to the folder view. (13306)
  • Delay occurs in the post-processing of files that have been copied and pasted into the cloud services. (12457)
  • The rootmap setting persists in the Web Editor even if the user has not set it explicitly from the User Preferences. (11551)

Publishing

  • Publish as content fragment functionality not working for files listed in search results. (14090)
  • In Native PDF publishing, the background color selection on template layout requires a page reload when reverting to None. (13621)
  • Issue in committing to datastore for a large DITA map with scope peer links in AEM Site publishing. (13530)
  • In Native PDF publishing, accessibility is compromised as images in header and footer doesn’t display alt text. (12829)
  • Duplicating page layout in Native PDF doesn’t work with no extension added automatically. (12534)
  • When generating the PDF output with Native PDF publishing, the file name is truncated after a period. (13620)
  • Incorrect icon and tooltip are displayed for Edit content option in the Page Layouts toolbar of the Templates used in Native PDF publishing. (13492)
  • Custom metadata isn’t available in the final output. (12116)
  • fmdita rewriter conflicts with the user’s rewriter config and leads to the display of long URLs instead of the links. (12076)
  • In the AEM Site preset, the option to Generate separate PDF for every topic is non-functional. (11555)
  • Native PDF publishing lacks the support for CMYK color space conversion. (10754)
  • Dynamic baseline calls are using the name instead of title, which results in the failure of Export DITA map API. (14268)

Management

  • Content reference is broken on copy-pasting the DITA files having self-reference links without GUID. (13540)
  • In the Web Editor, the baseline shows the title for the previous version instead of the selected version of the DITA file. (13444)
  • The Reports tab in the Web Editor UI fails to show the topic list for old DITA maps created prior to the July 2023 upgrade of Experience Manager Guides as a Cloud Service. (11852)
  • Condition presets for large DITA map aren’t getting created. (10936)
  • A self-reference link appears under the list of Broken Links in Reports. (13539)

Review

  • Side by side review panels of the previous and the current versions in the Web Editor are not correct in the October 2023 release of Experience Manager Guides as a Cloud Service. (14156)
  • Email template customization for Review workflow doesn’t work with overlaying the nodes. (13954)
  • The Close button on the Review page in the Experience Manager Guides takes the users to the AEM Homepage. (13535)
  • Broken characters appear while creating the snippets in Korean language. (13489)
  • Korean attachments in the Experience Manager Guides Review screen aren’t clickable. (13436)
  • Map title gets cut off in the review and collaboration screen, with no option to view the full title. (13012)

Translation

  • Auto approve isn’t working sometimes, and exceptions occur if an incorrect value is set on Translation Status. (13607)
  • The baseline exported from the Translation dashboard fails and doesn’t open in the target language. (12993)

Known issue

Adobe has identified the following known issue for the November 2023 release.

  • Selective topic regeneration for AEM Site output fails.
recommendation-more-help
11125c99-e1a1-4369-b5d7-fb3098b9b178