Overview

You can customize Correspondence Management user interface and present users with a tailored set of properties and tabs. This customization includes adding custom fields/properties and tabs to specific asset types/letters or all the asset types and letters.

Adding custom properties to Correspondence Management assets

The following scenarios show how you can add properties/tabs to Correspondence Management assets and letters:

  • Adding a common property to all the asset types
  • Adding a common tab to all the asset types
  • Adding custom properties to specific asset types

By tweaking the properties, paths, and values in these scenarios, you can add custom properties and tabs to a different set of assets according to your requirements.

Scenario: Adding a common property to all the asset types

This scenario shows how you can add a custom property to all the asset types (text, list, condition, and layout fragments) and the letters. Using this scenario, you can add a property, Location of recipients, to all the assets and letters. The Location of recipients property helps identify which geographical area of delivery an asset or letter is relevant to. 

Custom property added to all asset types

Complete the following steps to add a custom property to all the asset types and letters:

  1. Go to http://[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) using the following steps:

    1. Right-click the items folder at the following path and select Overlay Node

      /libs/fd/cm/ma/gui/content/cmmetadataproperties/commonproperties/col1/items

      Overlay node
    2. Ensure that the Overlay Node dialog has the following values:

      Path: /libs/fd/cm/ma/gui/content/cmmetadataproperties/commonproperties/col1/items

      Location: /apps/

      Match Node Types: Selected

      Overlay node
    3. Click OK. The folder structure is created in the apps folder.

    4. Click Save All.

  3. Under the newly created items folder, add a node for the custom property in all the asset (Example: GeoLocation) using the following steps:

    1. Right click the items folder and select Create > Create Node.

      Create node in CRX
    2. Ensure that the Create Node dialog has the following values and click OK:

      Name: GeoLocation (or the name you want to give to this property)

      Type: nt:unstructured

      Create node: GeoLocation
    3. Click the new node you have created (here GeoLocation). CRX displays the node's properties. 

    4. Add the following properties to the node (here GeoLocation):

      Name Type Value
      fieldLabel String The name you want to give the field/property. (Here: Location of recipients)
      name String ./extendedproperties/GeoLocation (Keep the value same as the field name you created under the items node)
      renderReadOnly Boolean true
      sling:resourceType String granite/ui/components/foundation/form/textfield
    5. Click Save All.

  4. To view your customization, hover over an asset (text, list, condition, or layout fragment) or letter, click View Properties, and click Edit. The new field (Location of recipients) appears in the Basic tab in the asset/letter properties.

    Note:

    You may need to clear the browser cache before your customization appears in the UI.

    Custom property added to all the assets

Scenario: Common tab for all asset types

This scenario shows how you can add a custom tab, Recipients, to all the asset types (text, list, condition, and layout fragments) and the letters. The Recipients tab is where you can plan to put all your custom properties relevant to the recipients. 

Custom tab added for all asset types

Using the following procedure, you can add a tab with a field to all your assets:

  1. Go to http://[server]:[port]/[ContextPath]/crx/de and login as Administrator.

  2. In the apps folder, create a folder named cmmetadataproperties with path/structure similar to the cmmetadataproperties folder (located in content folder) using the following steps:

    1. Right-click the cmmetadataproperties folder at the following path and select Overlay Node

      /libs/fd/cm/ma/gui/content/cmmetadataproperties

      Overlay node
    2. Ensure that the Overlay Node dialog has the following values:

      Path: /libs/fd/cm/ma/gui/content/cmmetadataproperties

      Location: /apps/

      Match Node Types: Selected

    3. Click OK. The folder structure is created in the apps folder.

      Overlay folder structure created in CRX

      Click Save All.

  3. Under the cmmetadataproperties folder, add a node for creating a custom tab for all the assets (Example: commontab) using the following steps:

    1. Right click the cmmetadataproperties folder and select Create > Create Node.

      Create node
    2. Ensure that the Create Node dialog has the following values and click OK:

      Name: commontab (or the name you want to give to this property)

      Type: nt:unstructured

    3. Click the new node you have created (here commontab). CRX displays the node's properties. 

    4. Add the following properties to the node (here commontab):

      Name Type Value
      jcr:title String The name you want to give the column. (Here: Recipients)
      sling:resourceType String granite/ui/components/foundation/section
    5. Click Save All.

  4. For the tab node created in the last step (here customtab), create a node called item using the following step:

    1. Right-click the relevant node (here customtab) and select Create > Create Node.

    2. Ensure that the Create Node dialog has the following values and click OK:

      Name: items

      Type: nt:unstructured

       

    3. Click Save All:

  5. In the items node you created in the previous step (under CustomTab), add a node for creating a column (here Column1) in the custom tab using the following steps (to add more columns, repeat this step):

    1. Right-click the items node and select Create > Create Node.

    2. Ensure that the Create Node dialog has the following values and click OK:

      Name: Column1 (Or the name you want to give to the node - this name does not appear in the User Interface.)

      Type: nt:unstructured

       

    3. Add the following property to the node (Here Column1) and then click Save All:

      Name Type Value
      sling:resourceType String granite/ui/components/foundation/container
  6. In the node you created in the previous step (here Column1), add a node called items using the following steps:

    1. Right-click the node (here Column1) and select Create > Create Node.

    2. Ensure that the Create Node dialog has the following values and click OK:

      Name: items

      Type: nt:unstructured

    3. Click Save All.

  7. To create a field in the custom tab (here Recipients), add a node (here GeographicalLocation). This property corresponds to the column you created. Use the following steps to create the field (to create more fields/nodes, repeat these steps.):

    1. Right-click the items node and select Create > Create Node.

    2. Ensure that the Create Node dialog has the following values and click OK:

      Name: GeographicalLocation (or another name for the field property)

      Type: nt:unstructured

    3. Add the following properties to the field node (here GeographicalLocation) and click Save All.

      Name Type Value
      fieldLabel String Location of recipients (or the name you want to give the field.)
      name String ./extendedproperties/GeographicalLocation
      renderReadOnly Boolean true
      sling:resourceType String /libs/granite/ui/components/foundation/form/textfield
  8. To add this tab for Letters, create an overlay folder with path/structure similar to the following items folder at the following path:

    /libs/fd/cm/ma/gui/content/cmmetadataproperties/properties/letter/items/tabs/items

    To create overlay for a letters or a different asset use the following path by replacing [assettype] with text, condition, list, datadictionary, or fragment: 

    /libs/fd/cm/ma/gui/content/cmmetadataproperties/properties/[assettype]/items/tabs/items

    1. Right-click the items folder at the following path and select Overlay Node

      /libs/fd/cm/ma/gui/content/cmmetadataproperties/properties/letter/items/tabs/items

    2. Ensure that the Overlay Node dialog has the following values:

      Path: /libs/fd/cm/ma/gui/content/cmmetadataproperties/properties/letter/items/tabs/items

      Location: /apps/

      Match Node Types: Selected

    3. Click OK. The folder structure is created in the apps folder.

      Click Save All.

  9. In the newly created items folder, add a node for the custom tab in the asset (here mytab - this name does not show up in the User Interface) using the following steps:

    1. Right click the items folder and select Create > Create Node.

    2. Ensure that the Create Node dialog has the following values and click OK:

      Name: mytab (or the name you want to give to this property)

      Type: nt:unstructured

    3. Click the new node you have created (here mytab). CRX displays the node's properties. 

    4. Add the following two properties to the node (here customtab):

      Name Type Value
      path
      String fd/cm/ma/gui/content/cmmetadataproperties/commontab
      sling:resourceType String granite/ui/components/foundation/include
    5. Click Save All.

  10. To view your customization, hover over the relevant asset (here a letter), click View Properties, and click Edit. The new tab (Recipients) and field (Location of Recipients) appear in the user interface.

    Note:

    You may need to clear the browser cache before your customization appears in the UI.

    Custom tab added to letters

Scenario: Adding custom properties for specific asset types

This scenario shows how you can add a property to a particular asset type, such as a field to all the text assets. Using this process, you can add properties to one of the following:

  • Text
  • Condition
  • List
  • Layout Fragment
  • Data Dictionary
  • Letter
For example, only to the text assets, you want to add a property, Location of recipients, to identify which geographical area an asset is relevant to. 
Custom property added to an asset

To add a property to an asset type, complete the following steps:

  1. Go to http://[server]:[port]/[ContextPath]/crx/de and login as Administrator.

  2. To create a tab in an asset type (such as Text), create the following folder structure in the apps folder:

    /libs/fd/cm/ma/gui/content/cmmetadataproperties/properties/[AssetType]/items/tabs/items

    [AssetType]  = text, condition, list, letter, datadictionary, or fragment

    Following are the steps to create this folder structure:

    1. Right-click the items folder at the following path and select Overlay Node

      /libs/fd/cm/ma/gui/content/cmmetadataproperties/properties/[AssetType]/items/tabs/items

      For example, if you want to create a property for text assets, select the following folder:

      /libs/fd/cm/ma/gui/content/cmmetadataproperties/properties/text/items/tabs/items

      Overlay node
    2. Ensure that the Overlay Node dialog has the following values:

      Path: /libs/fd/cm/ma/gui/content/cmmetadataproperties/properties/[AssetType]/items/tabs/items

      Location: /apps/

      Match Node Types: Selected

    3. Click OK. The folder structure is created in the apps folder.

      Click Save All.

  3. In the newly created items folder, add a node for the custom tab in the asset (Example: customtab) using the following steps:

    1. Right click the items folder and select Create > Create Node.

    2. Ensure that the Create Node dialog has the following values and click OK:

      Name: customtab (or the name you want to give to this property)

      Type: nt:unstructured

    3. Click the new node you have created (here customtab). CRX displays the node's properties. 

    4. Add the following two properties to the node (here customtab):

      Name Type Value
      sling:resourceType String granite/ui/components/foundation/section
      jcr:title String The name of the field on the User Interface (here Location of recipients)
    5. Click Save All.

  4. In the node you created in the previous step (here customtab), add a node called items using the following steps:

    1. Right-click the node (here customtab) and select Create > Create Node.

    2. Ensure that the Create Node dialog has the following values and click OK:

      Name: items

      Type: nt:unstructured

    3. Click Save All.

  5. In the items node you created in the previous step (under customtab), add a node for creating a column (here Column1) in the custom tab using the following steps (to add more columns, repeat this step):

    1. Right-click the items node and select Create > Create Node.

    2. Ensure that the Create Node dialog has the following values and click OK:

      Name: Column1 (or the name you want to give to the node)

      Type: nt:unstructured

       

    3. Add the following property to the node (Here Column1) and then click Save All.

      Name Type Value
      sling:resourceType String granite/ui/components/foundation/container
  6. For each column you create (as specified in the previous step - here Column1), create a node called item using the following steps: 

    1. Right-click the relevant column node (here Column1) and select Create > Create Node.

    2. Ensure that the Create Node dialog has the following values and click OK:

      Name: items

      Type: nt:unstructured

       

    3. Click Save All:

  7. For each of the columns created, create a node under the items node for creating a field in the new tab in the User Interface. Repeat this step to create more fields in the column:

    1. Right-click the relevant node (here items under Column1) and select Create > Create Node.

    2. Ensure that the Create Node dialog has the following values and click OK:

      Name: A name of your choice (here GeoLocation)

      Type: nt:unstructured

       

    3. Add the following properties to the node and then click Save All.

      Name Type Value
      fieldLabel String Location of recipients (or the name you want to give the field.)
      name String ./extendedproperties/GeoLocation
      renderReadOnly Boolean true
      sling:resourceType String granite/ui/components/foundation/form/textfield
  8. To view your customization, hover over the relevant asset (here a text), click View Properties, and click Edit. The new tab and field (Location of Recipients) appear in the user interface.

    Note:

    You may need to clear the browser cache before your customization appears in the UI.

    Custom property added to a specific asset

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy