Contact and recipient

This is a complex element used to represent customers connected to a request. It also handles mail recipients.

Configuration

Setting	Description
label	UI label
ticketId
noDefaultFields	Whether to override the default fields (name, email, and company)
controlVersion	The version of this element (1 or 2) Determines the fields you can retrieve with `getFieldValue()`

Example

HtmlElement recipients = addHtmlElement(getScreenElementId(screenElementIndex),
  getScreenElementName(screenElementIndex),
  getScreenElementType(screenElementIndex),
  "ticketId = " + getCgiVariable("ticketId") + "\nlabel = Recipients\nnoDefaultFields = true\n");

Map colMap;

colMap.insert("displayField", "person.firstname");
colMap.insert("searchField", "person.firstname");
colMap.insert("operator", "OperatorBeginsWith");
colMap.insert("label", "Firstname");
recipients.setFieldValue("addColumn", colMap);

Repeat populating the map and calling setFieldValue() for each column you want to show. For example, person.lastname, Email.email_address, and phone.phone.

Functions

getFieldValue(String field)

Field	Control ver.	Description
to	1 and 2	A string of all email addresses with type = to
cc	1 and 2	A string of all email addresses with type = cc
bcc	1 and 2	A string of all email addresses with type = bcc
sms	1 and 2	A string of all email addresses with type = sms
contacts	1 and 2	A string array with the IDs of all customers. [0] is the primary customer
copyToFacebook	1 and 2
json	1 and 2
recipientCount	1 and 2	The number of recipients
rows	1	The number of customers in the grid
columns	1	The number of rows in the grid
row.x.y	1	The string at position x,y
primaryContact	1	The ID of the primary contact
ownerType	1	to, cc, bcc, or sms if the owner has been added to the contact (email) list
defaultCopyToContacts	1	A string array of all email addresses that were added to the recipient list because of the default copy to flag

setFieldValue(String action, Map values)

Action	Map keys	Description
addId		Adds a customer with the given ID to the element
addRow		Same as for the multiple relations element
addCriteria		Same as for the multiple relations element
addColumn		Same as for the multiple relations element
defaultCopy		Adds the email address of all customers as a default to the recipient list
addRecipient	type	Adds an email or SMS address to the recipient list

​Configuration

​Example

​Functions

​getFieldValue(String field)

​setFieldValue(String action, Map values)

Configuration

Example

Functions

getFieldValue(String field)

setFieldValue(String action, Map values)