Difference between revisions of "Form - InScript Main Hidden Variables"
From All n One's bxp software Wixi
Philip Lacey (talk | contribs) (Created page with "In order to help the JavaScript coding and ability for clients to perform very clever logic management there are a number of key system variables drawn directly into the hidde...") |
Philip Lacey (talk | contribs) |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | == Overview == | |
| − | + | In order to help the JavaScript coding and ability for clients to perform very clever logic management there are a number of key system variables drawn directly into the hidden HTML of a Form script. This page details the fields that are available and their usual usage. | |
| + | |||
| + | |||
| + | == Sample Block == | ||
| + | |||
| + | <source lang="javascript"> | ||
| + | |||
| + | // VOIP | ||
<input type="hidden" name="strClient_VOIP_BEProtocol" id="strClient_VOIP_BEProtocol" value="http://" /> | <input type="hidden" name="strClient_VOIP_BEProtocol" id="strClient_VOIP_BEProtocol" value="http://" /> | ||
<input type="hidden" name="strClient_VOIP_BESystem" id="strClient_VOIP_BESystem" value="127.0.0.1" /> | <input type="hidden" name="strClient_VOIP_BESystem" id="strClient_VOIP_BESystem" value="127.0.0.1" /> | ||
| Line 10: | Line 17: | ||
<input type="hidden" name="strClient_VOIP_Extension" id="strClient_VOIP_Extension" value="XXXX" /> | <input type="hidden" name="strClient_VOIP_Extension" id="strClient_VOIP_Extension" value="XXXX" /> | ||
<input type="hidden" name="strClient_VOIP_PIN" id="strClient_VOIP_PIN" value="YYYY" /> | <input type="hidden" name="strClient_VOIP_PIN" id="strClient_VOIP_PIN" value="YYYY" /> | ||
| + | |||
| + | // User Values | ||
<input type="hidden" name="strBEDisplayed_Username" id="strBEDisplayed_Username" value="Philip Lacey" /> | <input type="hidden" name="strBEDisplayed_Username" id="strBEDisplayed_Username" value="Philip Lacey" /> | ||
| − | |||
<input type="hidden" name="intCurrentUser_Department" id="intCurrentUser_Department" value="0" /> | <input type="hidden" name="intCurrentUser_Department" id="intCurrentUser_Department" value="0" /> | ||
<input type="hidden" name="intCurrentUser_Role" id="intCurrentUser_Role" value="1" /> | <input type="hidden" name="intCurrentUser_Role" id="intCurrentUser_Role" value="1" /> | ||
<input type="hidden" name="strCurrentUser_Email" id="strCurrentUser_Email" value="x.y@z.com" /> | <input type="hidden" name="strCurrentUser_Email" id="strCurrentUser_Email" value="x.y@z.com" /> | ||
<input type="hidden" name="strClientIPAddress" id="strClientIPAddress" value="127.0.0.1" /> | <input type="hidden" name="strClientIPAddress" id="strClientIPAddress" value="127.0.0.1" /> | ||
| + | |||
| + | // Campaign Values | ||
| + | <input type="hidden" name="intCampaign_Id" id="intCampaign_Id" value="1234" /> | ||
<input type="hidden" name="intCDA_Id" id="intCDA_Id" value="0" /> | <input type="hidden" name="intCDA_Id" id="intCDA_Id" value="0" /> | ||
| + | |||
| + | // Case Management Values | ||
<input type="hidden" name="intPreviousStaff" id="intPreviousStaff" value="" /> | <input type="hidden" name="intPreviousStaff" id="intPreviousStaff" value="" /> | ||
<input type="hidden" name="strPreviousStatus" id="strPreviousStatus" value="" /> | <input type="hidden" name="strPreviousStatus" id="strPreviousStatus" value="" /> | ||
| + | |||
| + | // Cross Campaign Functionality | ||
<input type="hidden" name="strPreset_Fields" id="strPreset_Fields" value="" /> | <input type="hidden" name="strPreset_Fields" id="strPreset_Fields" value="" /> | ||
<input type="hidden" name="strPreset_Values" id="strPreset_Values" value="" /> | <input type="hidden" name="strPreset_Values" id="strPreset_Values" value="" /> | ||
| + | |||
| + | // Operating Values | ||
<input type="hidden" name="intCDA_X_StaffId" id="intCDA_1154_StaffId" value="10" /> | <input type="hidden" name="intCDA_X_StaffId" id="intCDA_1154_StaffId" value="10" /> | ||
<input type="hidden" name="dteCCL_X_StartDateTime" value="2014-04-07 21:18:41" /> | <input type="hidden" name="dteCCL_X_StartDateTime" value="2014-04-07 21:18:41" /> | ||
<input type="hidden" name="intCDA_X_NoOfAttempts" value="0" /> | <input type="hidden" name="intCDA_X_NoOfAttempts" value="0" /> | ||
| − | </script | + | </source> |
| + | |||
| + | |||
| + | |||
| + | == VOIP == | ||
| + | |||
| + | This block of fields are used when using Click to Call functionality or when a VOIP phone system needs live integration. The users configurations are set up in System Access Management when editing the security details of the user. | ||
| + | |||
| + | |||
| + | == User Values == | ||
| + | |||
| + | These values are useful for logic decisions and for creating custom layouts and validations based on the settings of the logged in user. | ||
| + | |||
| + | |||
| + | |||
| + | == Campaign Values == | ||
| + | |||
| + | These two values are the most key values on the script. A new record will have an intCDA_Id = 0. | ||
| + | |||
| + | |||
| + | |||
| + | == Case Management Values == | ||
| + | |||
| + | These values are populated for Case Management reasons. It allows previous cases to be used, recorded and allow them to influence decisions of the current case. | ||
| + | |||
| + | |||
| + | |||
| + | == Cross Campaign Functionality == | ||
| + | |||
| + | When using Campaign Search functionality these fields hold the other campaigns fields to display and search against. | ||
| + | |||
| + | |||
| + | |||
| + | == Operating Values == | ||
| + | |||
| + | |||
| + | These are the CDA fields that are used by every CDA record to enable BE operation. | ||
| + | |||
| + | |||
| + | |||
| + | [[Category:Topic:JavaScript]] | ||
| + | [[Category:Module Specific:Form Management]] | ||
Latest revision as of 20:59, 9 November 2014
Contents
1 Overview
In order to help the JavaScript coding and ability for clients to perform very clever logic management there are a number of key system variables drawn directly into the hidden HTML of a Form script. This page details the fields that are available and their usual usage.
2 Sample Block
// VOIP
<input type="hidden" name="strClient_VOIP_BEProtocol" id="strClient_VOIP_BEProtocol" value="http://" />
<input type="hidden" name="strClient_VOIP_BESystem" id="strClient_VOIP_BESystem" value="127.0.0.1" />
<input type="hidden" name="strClient_VOIP_BEClient" id="strClient_VOIP_BEClient" value="client_master" />
<input type="hidden" name="strClient_VOIP_ServerIP" id="strClient_VOIP_ServerIP" value="123.123.123.123" />
<input type="hidden" name="strClient_VOIP_ServerPort" id="strClient_VOIP_ServerPort" value="5000" />
<input type="hidden" name="strClient_VOIP_Extension" id="strClient_VOIP_Extension" value="XXXX" />
<input type="hidden" name="strClient_VOIP_PIN" id="strClient_VOIP_PIN" value="YYYY" />
// User Values
<input type="hidden" name="strBEDisplayed_Username" id="strBEDisplayed_Username" value="Philip Lacey" />
<input type="hidden" name="intCurrentUser_Department" id="intCurrentUser_Department" value="0" />
<input type="hidden" name="intCurrentUser_Role" id="intCurrentUser_Role" value="1" />
<input type="hidden" name="strCurrentUser_Email" id="strCurrentUser_Email" value="x.y@z.com" />
<input type="hidden" name="strClientIPAddress" id="strClientIPAddress" value="127.0.0.1" />
// Campaign Values
<input type="hidden" name="intCampaign_Id" id="intCampaign_Id" value="1234" />
<input type="hidden" name="intCDA_Id" id="intCDA_Id" value="0" />
// Case Management Values
<input type="hidden" name="intPreviousStaff" id="intPreviousStaff" value="" />
<input type="hidden" name="strPreviousStatus" id="strPreviousStatus" value="" />
// Cross Campaign Functionality
<input type="hidden" name="strPreset_Fields" id="strPreset_Fields" value="" />
<input type="hidden" name="strPreset_Values" id="strPreset_Values" value="" />
// Operating Values
<input type="hidden" name="intCDA_X_StaffId" id="intCDA_1154_StaffId" value="10" />
<input type="hidden" name="dteCCL_X_StartDateTime" value="2014-04-07 21:18:41" />
<input type="hidden" name="intCDA_X_NoOfAttempts" value="0" />
3 VOIP
This block of fields are used when using Click to Call functionality or when a VOIP phone system needs live integration. The users configurations are set up in System Access Management when editing the security details of the user.
4 User Values
These values are useful for logic decisions and for creating custom layouts and validations based on the settings of the logged in user.
5 Campaign Values
These two values are the most key values on the script. A new record will have an intCDA_Id = 0.
6 Case Management Values
These values are populated for Case Management reasons. It allows previous cases to be used, recorded and allow them to influence decisions of the current case.
7 Cross Campaign Functionality
When using Campaign Search functionality these fields hold the other campaigns fields to display and search against.
8 Operating Values
These are the CDA fields that are used by every CDA record to enable BE operation.
