getLetterDataElements

The getLetterDataElements class is used to retrieve the required metadata for your letter, it returns a map with the following string keys:

Key

Description

DDE

This key is mapped with a list of data dictionary elements for this letter. For differentiating between Collection DDEs and other DDEs, Collection DDEs uses a collection marker “[]” to differentiate them. For example, if DDE "person" has "account" as collection which has composite "accNumber" then path is set as "person.account[].accNumber" where "[]" indicates that "account" is of type collection.

PH

This key is mapped with a list of Variables (List<Variable>) which are used in this letter and for which data must be provided. All place-holder variables having following binding in this letter is added into this list:
  • Place holder variables bound to type "User".

  • Place holder variables bound to Data Dictionary of type unprotected in this letter.

Any PH variables which are bound as "Literal" or "Variable" or "Field" or "Content" or "Data Dictionary (protected)" is not added into this list.

Field

This key is mapped with a list of Fields object (List<Field>) which are used in this letter and for which data must be provided. All fields having following binding in this letter is added into this list:
  • Field bound to type "User".

  • Field bound to Data Dictionary of type unprotected in this letter.

Any Field which are bound as "Literal" or "Variable" or "Content" or "Ignore" or "Data Dictionary (protected)" is not added into this list.

The getLetterDataElements syntax is as follows:
public Map<String,List> getLetterDataElements(String letterID) throws ICCException;

// Ethnio survey code removed