Show Menu
TOPICS×

Customize create correspondence UI

Overview

Correspondence Management allows you to rebrand its solution template for better brand value and to adhere to your organization's branding standards. Rebranding the user interface includes changing the organization logo, which is displayed at the upper-left corner of Create Correspondence UI.
You can change the logo in the Create Correspondence UI with your organization's logo.
Figure: The custom icon in the Create Correspondence UI

Changing the logo in the Create Correspondence UI

To set up a logo image of your choice, do the following:
  1. Create the appropriate folder structure in CRX .
  2. Upload the new logo file in the folder you have created in CRX.
  3. Set up the CSS on CRX to refer to the new logo.
  4. Clear the browser history and refresh the Create Correspondence UI .

Creating the required folder structure

Create the folder structure, as explained below, for hosting the custom logo image and the stylesheet. The new folder structure with the root folder /apps is similar to the /libs folder's structure.
For any customization, create a parallel folder structure, as explained below, in the /apps branch.
The /apps branch (folder structure):
  • Ensures that your files are safe in case of an update to the system. In case of upgrade, feature pack, or a hot fix, the /libs branch gets updated and if you host your changes in the /libs branch, they are overwritten.
  • Helps you not to disturb the present system/branch, which you possibly can unsettle by mistake if you use the default locations for storing the custom files.
  • Helps your resources get higher priority when AEM searches for resources. AEM is configured to search the /apps branch first and then the /libs branch to find a resource. This mechanism means that the system uses your overlay (and the customizations defined there).
Use the following steps to create the required folder structure in the /apps branch:
  1. Go to https://[server]:[port]/[ContextPath]/crx/de and login as Administrator.
  2. In the apps folder, create a folder named css with path/structure similar to the css folder (located in ccrui folder).
    Steps for creating the css folder:
    1. Right-click the css folder at the following path and select Overlay Node : /libs/fd/cm/ccr/gui/components/admin/clientlibs/ccrui/css
    2. Ensure that the Overlay Node dialog has the following values:
      Path: /libs/fd/cm/ccr/gui/components/admin/clientlibs/ccrui/css
      Overlay Location: /apps/
      Match Node Types: Checked
      Do not make changes in the /libs branch. Any changes you do make may be lost, because this branch is liable to changes whenever you:
      • Upgrade on your instance
      • Apply a hot fix
      • Install a feature pack
    3. Click OK . The css folder is created in the specified path.
  3. In the apps folder, create a folder named imgs with path/structure similar to the imgs folder (located in ccrui folder).
    1. Right-click the imgs folder at the following path and select Overlay Node : /libs/fd/cm/ccr/gui/components/admin/clientlibs/ccrui/imgs
    2. Ensure that the Overlay Node dialog has the following values:
      Path: /libs/fd/cm/ccr/gui/components/admin/clientlibs/ccrui/imgs
      Overlay Location: /apps/
      Match Node Types: Checked
    3. Click OK .
      You can also create the folder structure in the /apps folder manually.
  4. Click Save All to save the changes on the server.

Create the CSS to integrate the logo with the UI

The custom logo image requires an additional style sheet to be loaded in the content context.
Use the following steps to set up the style sheet for rendering the logo:
  1. Go to https://[server]:[port]/[contextpath]/crx/de . If necessary, log in as Administrator.
  2. Create a file named customcss.css (you cannot use a different filename) in the following location:
    /apps/fd/cm/ccr/gui/components/admin/clientlibs/ccrui/css/
    Steps to create the customcss.css file:
    1. Right-click the css folder and select Create > Create File .
    2. In the New File dialog, specify the name of the CSS as customcss.css (you cannot use a different filename), and click OK .
    3. Add the following code to the newly created css file. In content:url in the code, specify the image name you have uploaded to the imgs folder in CRXDE.
      .logo, .logo:after {
      content:url("../imgs/CustomLogo.png");
      }
      
      
    4. Click Save All .

Refresh the Create Correspondence UI to see the custom logo

Clear the browser cache and then open the Create Correspondence UI instance in your browser. You should see your custom logo.
Figure: The custom icon in the Create Correspondence UI