Create Letter create-letter

AEM 6.4 has reached the end of extended support and this documentation is no longer updated. For further details, see our technical support periods. Find the supported versions here.

Correspondence Management workflow correspondence-management-workflow

The Correspondence Management workflow consists of four phases:

  1. Template creation
  2. Document Fragment creation
  3. Letter creation
  4. Postprocessing

Template creation template-creation

The following graphic shows a typical workflow for creating a correspondence template.

Workflow for creating a correspondence template

In this workflow:

  1. Form Designers create layouts and fragment layouts using Adobe Forms Designer and upload them to a CRX repository. The layouts contain typical form fields, layout features such as a header and footer, and empty “target areas” for the placement of content. Later, Application Specialists map the content that is required for these target areas. More information on designing layout.

  2. Subject Matter Experts from Legal, Finance, or Marketing departments, create, and upload content such as text clauses disclaimers, terms and conditions, and images such as logos, that are reused in various correspondence templates.

  3. Application Specialists create correspondence templates. The Application Specialist

    • Maps text clauses and images to target areas in the layout templates
    • Defines conditions/rules for the inclusion of content
    • Binds layout fields and variables to underlying data models
  4. Author previews the letter and submits it for post processing. More information about post processing.

Using letter templates provided with Correspondence Management using-letter-templates-provided-with-correspondence-management

Instead of creating a layout template from scratch, you can choose to modify and reuse the templates that Correspondence Management provides. You can use designer to quickly modify the branding and the data and content fields of the templates to suit your organization’s needs. For more information on Correspondence Management templates, see Reference letter templates.

Document fragment creation document-fragment-creation

Document fragments are reusable parts\components of a correspondence using which you can compose letters\correspondence.

The document fragments are of the following types:

Text text

A text asset is a piece of content that consists of one or more paragraphs of text. A paragraph can be static or dynamic. A dynamic paragraph contains references to data elements, whose values are supplied at runtime.

List list

List is a series of document fragments, including text, lists (the same list cannot be `` added in itself), conditions, and images. The order of the list elements can be fixed or editable. While creating a letter, you can use some or all the list elements to replicate a reusable pattern of elements.

Condition condition

Conditions enable you to define what content gets included at correspondence creation time, based on the supplied data. The condition is described in terms of control variables. The variables can be either a data dictionary element or a placeholder. When you add a condition, you can choose to include an asset based on the value that the control variable has. Conditions have a single output based on an expression. The first expression is found to be true, based on current condition variable. Its value becomes the condition’s output.

Layout fragment layout-fragment

A layout fragment is a layout that can be used within one or more letters. A layout fragment is used to create repeatable patterns, especially dynamic tables. The layout can contain typical form fields such as “Address” and “Reference Number.” It also contains empty sub forms that denote target areas. The layouts (XDPs) are created in Designer and then are uploaded to Forms and Documents.

Letter creation letter-creation

There are two ways to generate the correspondence that is sent to your customers: user-driven and system-driven.

User driven user-driven

Customer-facing employees such as claims adjustors or case workers can create customized correspondence. Using a simple and intuitive letter-filling interface, business users can add optional text to the correspondence, personalize editable content while previewing the correspondence in real time. They can then submit the customized correspondence to a back-end process.

User-driven, customized correspondence

System driven system-driven

The correspondence generation is automated, driven by event triggers. For example, a reminder notice sent to a citizen prompting her for advance tax filing, is generated by merging the predefined template with citizen data. The final letter can be emailed, printed, faxed, or archived.

System-driven correspondence

Post processing post-processing

The final correspondence can be sent to a back-end process for postprocessing. The correspondence can be:

  1. Processed for email, fax, or batch printing, or placed in a folder for printing or e-mailing.
  2. Submitted for review and approval.
  3. Secured by applying digital signatures, certification, encryption, or rights management.
  4. Converted to a searchable PDF document that contains all the necessary metadata for archiving and auditing purposes.
  5. Included in a PDF Portfolio that includes more documents, such as marketing material. The PDF Portfolio can then be sent as the final correspondence.

Correspondence Management solution architecture correspondence-management-solution-architecture

The following graphic provides an overview of an example architecture of the Letters Solution.

Letter solution architecture

Deconstructing a letter deconstructing-a-letter

This Notice of Cancelation document is an example of a typical correspondence:

A sample letter of cancelation

Letter elements
Formed with
Data from back-end Enterprise systems
Data that is sourced from backend enterprise systems. The data is merged dynamically with the correspondence template.
Data file created based on a Data Dictionary
Entered by front-line Employee
Data that can be supplied by a front-line employee who is customizing the letter before sending it out.
Unprotected DD elements
Editable text paragraphs
Text Paragraphs
Pre-approved text content. Experts in Legal, Finance, or a line of business who understand the business context of the letter, typically author the text content. Content such as header, footer, disclaimers, and salutation would be common to most of the letters. However, content such as "reason for termination" would be specific to the particular letter.
Based on Custom Logic ?
For some letters, such as a letter to request more information regarding a claim, users such as the Claims Adjustor can add custom text content.
Fragment of type Condition
Images from Central Repository
Images such as logos and signature images. Images such as corporate logos would appear in most or all of the correspondence. Signature images are specific to the letter and to the person on whose behalf the letter is sent.
Images stored in AEM assets (DAM)

Analyze a letter before you construct it analyze-a-letter-before-you-construct-it

Analyze every letter to uncover the various pieces that make up the letter. The Application Specialist analyzes the correspondences that are generated.

  • Which parts of the correspondence are static and which are dynamic. The variables that are filled from backend data sources or by end users.

  • The order in which the various text paragraphs appear in the correspondence such as whether a business user can change paragraphs during correspondence creation.

  • Is the correspondence system-generated or does it require an end user to edit the correspondence? How many correspondences are system-generated and how many require user intervention?

  • How frequently does the correspondence template change? Will it be updated yearly, quarterly, or only when a particular legislation changes? What type of changes is expected? Is it a change to fix typographical errors, a layout change, adding more fields, adding more paragraphs, and so on.

  • When planning your correspondence requirements, assemble the list of new correspondence templates. For each correspondence template, you require:

    • Text clauses, images, and tables
    • Data values from backend systems
    • The layout and fragment layouts of the correspondence
    • The order in which content appears in the letter and rules for inclusion and exclusion of content
  • The conditions under which business users such as claims adjustors or case workers modify content or portions in the letter.

  • Scenarios are narratives that describe the user experience, requirements, and benefits of using the Letters Solution.

  • Scenarios also provide:The required skill sets and tools you require for your project.

  • Best practices for planning your implementation. ``High-level implementation overview.

Benefits of performing the analysis benefits-of-performing-the-analysis

Content reuse You have a consolidated list of new content required for generating correspondence. Much of the content such as headers, footers, disclaimers, and introductions are common to many letters and can be reused across various letters. All such common content can be created and approved by experts once and then reused in many pieces of correspondence.

Building the data dictionary There will be data values such as “Customer Id” and “Customer Name” that are common to many letters. You can prepare a consolidated list of all such data values. Typically someone from the enterprise middleware team is consulted when planning the structure. This forms the basis for building the Data Dictionary.

Sourcing data from backend enterprise systems You will also know all of the data values that are needed and from where the enterprise system data is obtained. You can then architect the implementation to extract the data from the enterprise system and feed to the Letters solution.

Estimating the complexity of letters It is important to determine how complex it will be to create a particular correspondence. This analysis helps in determining the amount of time and skill sets that will be required to create the letter templates. This in turn will help in estimating the resources and cost of implementing the Letters solution.

Correspondence complexity correspondence-complexity

The complexity of correspondence can be determined by analyzing the following parameters:

Layout complexity How complex is the layout? Letters such as Notice of Cancelation have simple layouts. Whereas letters such as Claims Coverage Confirmation has a complex layout with several tables and more than 60 form fields. Creating complex layouts takes more time and requires advanced layout design skill sets.

Number of text paragraphs and conditions A loan contract can be 10 pages long and contain more than 40 text clauses. Many of these clauses would depend `` loan parameters. Based on the exact terms and conditions, the clauses would be included or excluded from the contract. Creating such letters requires thorough planning and careful definition of the complex conditions.

This table provides some guidelines that you can use to classify your letters:

Complexity level
Layout complexity (subjective)
Number of text paragraphs
Number of conditional texts or images
Required skill set
Low complexity

Low. Layout has few form fields (<15).

Typically one page.

Medium Designer skills.
Medium complexity
Medium complexity layout. Includes structures such as tables. Typically more than one page long.

Medium Designer skills.

Capability to create complex expressions using user interfaces.

High complexity
Complex layout. Can be greater than three pages. Contains tables and more than 60 form fields.

Expert Designer skills.

Capability to create complex expressions using user interfaces.

Overview of Creating a Letter overview-of-creating-a-letter

  1. Select the appropriate layout that serves as the base of the letter and create a letter.
  2. Add data modules or layout fragments to the letter and configure them.
  3. Choose to preview the correspondence.
  4. Edit and set up the fields, variables, content, and attachments.

Prerequisites prerequisites

You need the following in place first to create a correspondence:

  • Compatibility Package. Install the Compatibility Package to view the Letters option on the Forms page.

  • The letter XDP (layout).

  • Other XDPs (layout fragments) that form parts of the letter. The XDPs\Layouts are created in Designer.

  • The relevant data dictionary (Optional).

  • The data modules you want to use in the correspondence.

  • Test Data is the XML file with the test data ported in it. Test data is required if you are using a data dictionary.

Create a letter template create-a-letter-template

Select a layout and enter the letter properties select-a-layout-and-enter-the-letter-properties

  1. Select Forms > Letters.

  2. Select Create > Letter. Correspondence Management displays the available layouts (XDPs). These layouts come from Designer. The layouts also include the letter templates that Correspondence Management provides out of the box. For more information on Correspondence Management templates, see Reference letter templates. To add your own layouts, create XDP (layout) files in Designer and then upload them to AEM Forms.


  3. Select a layout by tapping it and tap Next.

    Select layout to create a letter

  4. Enter the properties for the Correspondence and tap Save:

    • Title (Optional): Enter the title for the letter. Title need not be unique and can have special characters and non-english characters.
    • Name: The unique name for the letter. No two letters in any state can exist with the same name. In the Name field, you can enter only English language characters, numbers, and hyphens. The Name field is automatically populated based on the Title field. The special characters, spaces, numbers, and non-English characters entered in the Title field are replaced with hyphens in the Name field. Although the value in the Title field is automatically copied to the Name, you can edit the value.
    • Description (Optional): Describe the letter for your reference.
    • Data Dictionary (Optional): The Data Dictionary can be associated to the correspondence. The assets that you later insert in this correspondence should either have the same data dictionary as the one you choose for the correspondence here or no data dictionary.
    • Tags (Optional): Select the tags to apply to the correspondence. You can also type in a new/custom tag name and press Enter to create it.
    • Post Process (Optional): Select the post process to be applied to the letter template. There are out of the box post processes and the ones you have created using AEM, such as e-mail and print.

    Correspondence properties

  5. The system displays a message: “Letter created successfully.” (in the alert message) Tap Open to configure the data modules and layout fragments in it. Or tap Done to go back to the previous page.

    Alert message: letter created successfully

    Next: When you tap Open, Correspondence Management displays a representation of the layout with all the components in the layout (XDP) listed. Go ahead with inserting the Data Modules and Layout Fragments and Configuring them.

Insert data modules and layout fragments in a letter and configure them insert-data-modules-and-layout-fragments-in-a-letter-and-configure-them

When after creating a correspondence, you tap Open, Correspondence Management displays a representation of the layout with all the subforms/target areas in the layout (XDP) listed. In each of the target areas, you can choose to insert either a Data Module or a Layout Fragment (and then data modules in the layout fragment).

You can also choose to tap Edit icon for a letter in the Letters page to Insert data modules and layout fragments in a letter and configure them.
  1. Tap Insert for each of the subforms and select Data Modules or a Layout Fragment to insert in each of the subforms.

    Insert data modules and layout fragments

  2. Select Data Module or Layout Fragment for these options for each of the subforms and then choose the Data Modules or the Layout Fragments to insert. A layout fragment allows you to further insert data modules or layout fragments in it according to its design (up to four levels).


  3. If you insert a layout fragment, the name of the layout fragment appears in the subform. And according to the selected fragment, nested subforms appear in the subform.

  4. After the chosen Data Modules are inserted in the layout, you can tap configure mode and set the following after tapping the Edit icon for each of the modules:

    1. Editable: When this option is selected, the content can be edited in Create Correspondence user interface. Mark content as editable only if it requires the business user (such as a Claims Adjustor) to modify it.
    2. Mandatory: When this option is selected, the content is required in Create Correspondence user interface.
    3. Selected: When this option is selected, the content is selected by defaults in the Create Correspondence user interface.
    4. Indentation: Increase or decrease the indentation of the module/content in the letter. Indentation is specified in terms of levels, starting 0. Each level indents 36pts. For more information on customizing forms, see Correspondence Management Configurations in Forms workflow.
    5. Page break before: If you set the Page Break Before to on, the contents of THIS module always display on a new page.
    6. Page break after: If you set the Page Break After to on for a specific module, the contents of the NEXT module always display on a new page.

    Inserted data modules and layout fragments

  5. To edit a module, tap the Edit icon next to it. After editing the modules, tap Save.

    In this page, you can also do the following for the subforms:

    1. Allow Free Text: If Allow free Text is enabled then user can add inline text in letter in CCR view. In CCR view a ‘T’ action is enabled for those target areas which has Allow Free Text enabled and when user tap it then it asks for name and description of the text and then on tapping ok it opens that text in edit mode where user can add text. So this acts like other text modules
    2. Lock Order: Locks the order of the subforms in the letter. The author is not allowed to reorder the subforms/components while creating the letter.

    In this page, you can also do the following for each of the assets in the subforms:

    1. Change the order of the assets: drag-and-drop an asset holding the reorder icon for an asset ( dragndrop ).
    2. Delete assets: Tap the Delete icon next to an asset to delete it.
    3. Preview assets: Tap the show preview icon ( showpreview ) next to an asset.
  6. Tap Next.

  7. The Data page details how data fields and variables are used in the template. Data can be linked to data sources such as a data dictionary or user input. Each field defines properties from which data dictionary maps data or what caption is displayed for user input fields.


    • The field elements can be linked to a literal, data dictionary element, an asset, or a user specified value. You can also ignore a field element by binding it to the Ignore option.
    • The variable elements can be linked to a literal, data dictionary element, a field, a variable, an asset, or a user specified value.

    Following are some main fields in the linkage:

    • Multi-line: You can specify if the data entry for a field or variable is multi-line. If you select this option, the input box for the field or variable displays as multi-line input box in the Data Editing View. The field or variable also displays as multi-line in the Data and Content views in the Create Correspondence user interface. The multi-line input field is similar to the field for entering a comment in a TextModule. The multi-line option is available only for fields and variables with linkage type User or unprotected Data Dictionary Elements.

    • Optional: You can specify if the value for field or variable is optional or not. The optional field option is available for fields and variables with linkage type User or unprotected Data Dictionary Elements.

    • Field / Variable Validation: To provide enhanced validation of the value of a field or variable, you can assign a validator to the field or variable. This option is available only for fields and variables with linkage type User or unprotected Data Dictionary Elements.

    • Caption and Tooltip: Caption is the label of the field that appears before the field in the CCR user interface. This option is available for fields and variables with linkage type User or unprotected Data Dictionary Elements.

    Following are the types of validation you can use for the fields:

    • String Validator: Use the String Validator to specify a minimum and maximum length of the string entered in field or variable. When you create a String Validator, ensure that you specify valid validation parameters. Enter a valid length for both the minimum and maximum values. For String validator, you can specify the min and max length of the value that can be entered. If the value entered is not according to the min and max specified, the relevant field in the CCR user interface is marked in red color.

    • Number Validator: Use the Number Validator to specify the minimum and maximum numeric value entered in a field or variable. When you create a Number Validator, ensure that you specify valid validation parameters. Enter numeric values for both the minimum and maximum values.

    • Regular Expression Validator: Use the Regular Expression Validator to define a regular expression that is used to validate the value of a field or variable. In addition, you can customize the error message. When you create a Regular Expression Validator, ensure that you specify valid regular expression.

    note note
    The field and variable validators are only available on fields or variables with linkage type User or unprotected Data Dictionary Elements.


  8. After specifying linkage, tap Next. Correspondence Management displays the Attachments screen.

Set up the attachments set-up-the-attachments

  1. Select Add Asset.

  2. In the Select Asset screen, tap the assets to attach with the letter and tap Done. You need to have the assets first uploaded to Assets. It is recommended that you attach only PDF and Microsoft Office documents, but you can also attach images. For more information on uploading assets in DAM, see Uploading Assets.

  3. To lock the order of the assets in the list so that the Claims Adjustor cannot change the order, tap Lock Order. If you do not select this option, the Claims Adjustor can change the order of the list items.

  4. To change the order of the assets, drag-and-drop an asset holding the reorder icon for an asset ( dragndrop ).

  5. Tap Edit in front of an attachment and specify an attachment as Mandatory if you do not want the author to be able to delete it. Specify an attachment as Selected if you want it to be preselected in the CCR interface.

  6. Select Library Access to give the access to the library. If Library Access is enabled, the Claims Adjustor can access content library while creating a letter and insert attachments.

  7. Select Attachments Configuration and specify the maximum number of attachments.

  8. Tap Save. Your correspondence is created and listed on the Letters page.

After a letter template is created in Correspondence Management, the end user/agent/claim adjustor can open the letter in the CCR user interface and create a correspondence by entering data, setting up content, and managing attachments. For more information, see Create Correspondence.

Types of linkage available for each of the fields types-of-linkage-available-for-each-of-the-fields

The following table describes which types of linkage are available for various types of fields.

The following values in the table

  • Yes: Field type in the leftmost column supports that type of mapping
  • No: Field type in the leftmost column does not support that type of mapping
  • N/A: Field type in the leftmost column is not applicable
Data Dictionary
text only
plain text
text only
image only

Create copy of a letter template createcopylettertemplate

You can use an existing letter template to quickly create a letter template with similar properties, content, and inherited assets, such as document fragments and data dictionary. To do this, copy and paste a letter.

  1. In the Letters page, select one or more letters. The UI displays the Copy icon.
  2. Tap Copy. The UI displays the Paste icon. You can also choose to go inside a folder before you paste. Different folders can contain assets with same names. For more information on folders, see Folders and organizing assets.
  3. Tap Paste. The Paste dialog appears. If you are copying and pasting the letters at the same place, the system automatically assigns names and titles to the new copies of letters but you can edit the titles and names of the letters.
  4. If required, edit the Title and Name with which you want to save the copy of the letter.
  5. Tap Paste. The copy of the letter is created. Now you can make the required changes in your newly created letter.