Jump to: navigation, search
(Created target blank page For Version: PSAAS:Julie)
 
(Automated save: adding PEC_Migrated template.)
 
Line 1: Line 1:
<!-- Creation of the target page -->
+
= Field Codes=
 +
 
 +
{{Template:PEC_Migrated}}
 +
 
 +
 
 +
 
 +
Although Field Codes are used mostly in standard responses, they are the most complex and powerful aspect of standard responses, so they are described in this separate section.
 +
 
 +
Knowledge Manager enables you to create a wide range of Field Codes types, from simple Field Codes that function similarly to a Mail Merge-type word processor feature to complex Field Codes that include multiple objects, formulas, and constants (see [[FCexmpls#Using_a_Complex_Field_Code|Using a Complex Field Code]] for an example).
 +
 
 +
Once you create a Field Code, you can use it in multiple standard responses.
 +
 
 +
The interface for creating Field Codes is simple; creating really useful Field Codes requires a deeper understanding of how Field Codes can be constructed. [[FCinKM|How to Create and Insert Field Codes]] provides step-by-step instructions, with links to detailed reference information at the relevant places.
 +
 
 +
The reference information consists of the following topics:
 +
*[[variables|Field Code Variables]]
 +
*[[FCanatomy|Using Formulas in Field Codes]]
 +
*[[FCexmpls|Field Code Examples]]
 +
 
 +
{{NoteFormat|You can [[cutcopy|cut, copy, paste, and delete]] Field Codes as well as other Knowledge Management objects.|2}}
 +
 
 +
==Field Codes Overview==
 +
The main use of field codes is to particularize standard responses.
 +
 
 +
For example, you can use the field code <tt><$Contact.FirstName$></tt> in a response beginning <tt>Dear <$Contact.FirstName$>,</tt> which you send to dozens of recipients. In each message, <tt><$Contact.FirstName$></tt> is replaced by the first name of the addressee of the message (the contact) as listed in the Universal Contact Server database.
 +
 
 +
More generally, a "field code" is a formula that you insert into an outgoing text object, such as an e-mail that E-mail Server generates when triggered to do so by a routing strategy object.
 +
 
 +
The most common type of such text object is a standard response (triggered by an Autoresponse or Acknowledgement object), but you can also insert field codes into other types, such as chat transcripts, SMS messages, and forwarded or redirected e-mails. In some cases, the only place you can insert a field code is in the Subject line using the '''Format''' tab in a strategy object.
 +
 
 +
The following is a complete list of the strategy objects that can use field codes either in a standard response or in the Subject line:<br/>
 +
<ul>
 +
<li>
 +
Acknowledgement<br/>
 +
</li>
 +
<li>
 +
Autoresponse<br/>
 +
</li>
 +
<li>
 +
ChatTranscript<br/>
 +
</li>
 +
<li>
 +
Create EmailOut<br/>
 +
</li>
 +
<li>
 +
Create Notification<br/>
 +
</li>
 +
<li>
 +
Create SMS<br/>
 +
</li>
 +
<li>
 +
Forward<br/>
 +
</li>
 +
<li>
 +
RenderMessageContent<br/>
 +
</li>
 +
</ul>
 +
 
 +
The following is a complete list of the strategy objects that can use field codes only in the Subject line:<br/>
 +
<ul>
 +
<li>
 +
Redirect<br/>
 +
</li>
 +
<li>
 +
Reply from External Resource<br/>
 +
</li>
 +
<li>
 +
Send<br/>
 +
</li>
 +
</ul>
 +
 
 +
When a text object containing such a formula is processed, the following happens:<br/>
 +
<ol>
 +
<li>
 +
The formula performs an operation, which produces a result.<br/>
 +
</li>
 +
<li>
 +
The result replaces the field code in the text object.<br/>
 +
</li>
 +
</ol>
 +
 
 +
This process of performing an operation and substituting its result is called "rendering."
 +
<br/>
 +
<!-- Available styles: (default)-Important, 2-Tip, 3-Warning -->
 +
{{NoteFormat|Field codes can be used in outgoing text objects only.}}
 +
 
 +
A complete reference list of field codes is available in the [[Documentation:ES:FldCod:welcome:latest|Genesys eServices Field Codes Reference Manual]].
 +
 
 +
[[Category:V:PSAAS:Julie]]

Latest revision as of 23:31, June 21, 2020

Field Codes

Important
This content may not be the latest Genesys Engage cloud content. To find the latest content, go to Genesys Engage cloud for Administrators.



Although Field Codes are used mostly in standard responses, they are the most complex and powerful aspect of standard responses, so they are described in this separate section.

Knowledge Manager enables you to create a wide range of Field Codes types, from simple Field Codes that function similarly to a Mail Merge-type word processor feature to complex Field Codes that include multiple objects, formulas, and constants (see Using a Complex Field Code for an example).

Once you create a Field Code, you can use it in multiple standard responses.

The interface for creating Field Codes is simple; creating really useful Field Codes requires a deeper understanding of how Field Codes can be constructed. How to Create and Insert Field Codes provides step-by-step instructions, with links to detailed reference information at the relevant places.

The reference information consists of the following topics:

Tip
You can cut, copy, paste, and delete Field Codes as well as other Knowledge Management objects.

Field Codes Overview

The main use of field codes is to particularize standard responses.

For example, you can use the field code <$Contact.FirstName$> in a response beginning Dear <$Contact.FirstName$>, which you send to dozens of recipients. In each message, <$Contact.FirstName$> is replaced by the first name of the addressee of the message (the contact) as listed in the Universal Contact Server database.

More generally, a "field code" is a formula that you insert into an outgoing text object, such as an e-mail that E-mail Server generates when triggered to do so by a routing strategy object.

The most common type of such text object is a standard response (triggered by an Autoresponse or Acknowledgement object), but you can also insert field codes into other types, such as chat transcripts, SMS messages, and forwarded or redirected e-mails. In some cases, the only place you can insert a field code is in the Subject line using the Format tab in a strategy object.

The following is a complete list of the strategy objects that can use field codes either in a standard response or in the Subject line:

  • Acknowledgement
  • Autoresponse
  • ChatTranscript
  • Create EmailOut
  • Create Notification
  • Create SMS
  • Forward
  • RenderMessageContent

The following is a complete list of the strategy objects that can use field codes only in the Subject line:

  • Redirect
  • Reply from External Resource
  • Send

When a text object containing such a formula is processed, the following happens:

  1. The formula performs an operation, which produces a result.
  2. The result replaces the field code in the text object.

This process of performing an operation and substituting its result is called "rendering."

Important
Field codes can be used in outgoing text objects only.

A complete reference list of field codes is available in the Genesys eServices Field Codes Reference Manual.

This page was last edited on June 21, 2020, at 23:31.
Comments or questions about this documentation? Contact us for support!