From Bright Pattern Documentation
Jump to: navigation, search
 
Line 2: Line 2:
 
This function enables a variable to be pushed to a scenario as if the [[scenario-builder-reference-guide/SetVariable|Set Variable]] block is included; the variable is then available in scenarios and [[contact-center-administrator-guide/WorkflowEntries|workflows]].
 
This function enables a variable to be pushed to a scenario as if the [[scenario-builder-reference-guide/SetVariable|Set Variable]] block is included; the variable is then available in scenarios and [[contact-center-administrator-guide/WorkflowEntries|workflows]].
  
When invoking the postVariable method for a variable that starts with ''ActivityHistory'', Agent Desktop memorizes the value of the variable to post it in activity history. If an activity history field was marked for export in campaign results, it will be possible to export it with campaign results. The data is retained in Agent Desktop until changed or the interaction is completed. If a form is displaying that data, the form is also updated to reflect the new value. If the data changes in the form, it changes the value to be submitted.
+
When invoking the postVariable method for a variable that starts with ''ActivityHistory'', Agent Desktop memorizes the value of the variable to post it in activity history (see the ''Form Builder Reference Guide'', section [[5.3:Form-builder-reference-guide/HowtoConfigureActivityHistoryForms#Action_2:_Map_Activity_History_Values_to_Form_Fields |  How to Configure Activity History Forms]] for more information on mapping activity history values). If an activity history field was marked for export in campaign results, it will be possible to export it with campaign results. The data is retained in Agent Desktop until changed or the interaction is completed. If a form is displaying that data, the form is also updated to reflect the new value. If the data changes in the form, it changes the value to be submitted.
  
 
== Syntax ==
 
== Syntax ==

Latest revision as of 18:38, 3 September 2019

• 5.2 • 5.3 • 5.8

postVariable

This function enables a variable to be pushed to a scenario as if the Set Variable block is included; the variable is then available in scenarios and workflows.

When invoking the postVariable method for a variable that starts with ActivityHistory, Agent Desktop memorizes the value of the variable to post it in activity history (see the Form Builder Reference Guide, section How to Configure Activity History Forms for more information on mapping activity history values). If an activity history field was marked for export in campaign results, it will be possible to export it with campaign results. The data is retained in Agent Desktop until changed or the interaction is completed. If a form is displaying that data, the form is also updated to reflect the new value. If the data changes in the form, it changes the value to be submitted.

Syntax

postVariable(name, value);

Parameters

Parameter Data Type Description
name String The name of the desired variable
value String The resulting value of the variable


< Previous | Next >