Within bxp software (bxp), the Form structure is used the most extensively to deliver: * Inbound* Outbound* Blended* Case Management* Quality Assurance* Testing* Survey Managementdata storage for numerous modules.
To get to the Advanced Settings ''Main Menu > Form Management > Form - Primary Management > Form - Advanced Settings > Choose your form > ''
== Basic Details ==
[[File:advanced_settings_001.png|800px]]
* Type : [[Business_Express_Form_Types]]
* Name : This is your name for the form
* Available From : The date and time when users will be able to interact with the form= Sections =
* Available Until : The date and time when users will no longer be able to interact with the form
== Basic Details ==
{| class="wikitable" style= Advanced Options "width:100%;"! style="width:15%;" | Heading! style="width:60%;" | Description! style="width:25%;" | Link|-| Type || || [[Bxp_Form_Types]]|-| Name || This is your name for the form || |-|}
== Access ==
* Active : This is a simple true / false to allow users to interact with the form. False overrides the date options above.
* External Reference Code {| class="wikitable" style="width: When interacting 100%;"! style="width:15%" | Heading! style="width:60%" | Description! style="width:25%" | Link|-| Active || This is a simple true / false to allow users to interact with a phone system this field allows a the form . False overrides the date options above. || |-| Available From || The date and time when users will be able to respond interact with the form || |-| Available Until || The date and time when users will no longer be able to something different than interact with the Id form || |-| Cross User Lookup || When set to True, a user can only interact with a record IF the CDA_StaffId is that of the user, or Name of the formuser has an entry in the Contact History. In code Within Inbound Contact "My Data - Admin View", allows you to override this limitation. || |-| Use Outcome security || Outcome Security is referred to as the campaign_code turned on (true) or off (false) || [[Integration_with_a_Phone_SystemForm_-_Outcome_Access]]|-|}
* Contact History - Sort Order : The is the sort order of how the contacts are presented in the Contact History window.
* Public Outcome : When the form is used in a public way an outcome is automatically applied. This is the default outcome applied to public form record logging.== Search ==
* Externally Available : When the form is to be made accessible through the BEAPI this value is to be set to Public. [[BEAPI]] By default all forms are Private.
* Use Outcome security {| class="wikitable" style="width: Outcome Security 100%;"! style="width:15%" | Heading! style="width:60%" | Description! style="width:25%" | Link|-| Record Move Next Bar || This adds a bar at the top of the screen to allow easy navigation of records. This is turned on (true) or off (false) [[Form_ideal for testing but not suitable for most live production forms. || |-| Enable Search Export || Allows for search results page to be exported to a xls file || |-| Search Screen Export Fields || Alternate fields to be used in the search export. Fields seperated by ,'s || |-| Precision Search Fields || For more effective searching boolean matching can be employed. Listing the fields here, force boolean matching and can greatly speed up queries. || |-_Outcome_Access]]|}
* Cross User Lookup : When set to True, a user can only interact with a record IF the CDA_StaffId is that of the user, or the user has an entry in the Contact History. Within Inbound Contact "My Data - Admin View", allows you to override this limitation.
* Record Move Next Bar : This adds a bar at the top of the screen to allow easy navigation of records. This is ideal for testing but not suitable for most live production forms.
* Enable Offline Usage : This option allows a form to create an RSA encrypted snapshot of the data within the form. For more info [[Using_Forms_Offline]]== Advanced Options ==
* Page Header Replacement : Can be used to put extra header HTML data directly into the script.
* {| class="wikitable" style="width:100%;"! style="width:15%" | Heading! style="width:60%" | Description! style="width:25%" | Link|-| Enable Integrated Warehousing || Integrated Warehousing actives automatically but can be manually activated. || |-| Use Workflow || || [[Outcome_-_Workflow]]|-| Contact History - Sort Order || The is the sort order of how the contacts are presented in the Contact History window. || |-| Page Header Replacement || Can be used to put extra header HTML data directly into the script. || |-| Keyword Replacement : || Allows engine keywords to be replaced as needed.|| |-| Report - All Campaigns Fields || When cross campaign listings are employed, this allows the custom fields to be chosen. || |-| In-Module Reporting Fields || The columns displayed in the My and Team report data reports. || |-| CCL Column Replacements || When generating the reporting, the CCL column names can be replaced. || |-|}
* Report - All Campaigns Fields : When cross campaign listings are employed, this allows the custom fields to be chosen.
* In-Module Reporting Fields : The columns displayed in the My and Team report data reports.
* CCL Column Replacements : When generating the reporting, the CCL column names can be replaced.== Case Management ==
* Precision Search Fields : For more effective searching boolean matching can be employed. Listing the fields here, force boolean matching and can greatly speed up queries.
* Enable Integrated Warehousing {| class="wikitable" style="width: Integrated Warehousing actives automatically but can be manually activated.100%;"! style="width:15%" | Heading! style="width:60%" | Description! style="width:25%" | Link|-| Exception : Track Reopen || || |-| Exception : Time || || |-| Exception : Contacts || || |-| Service Level Agreement || || |-|}
* Dashboard - Contact Source : When using the Dashboard - Contact Source report, this field is the report that is reported against.
== Case Management Communications ==
* Exception {| class="wikitable" style="width: Track Reopen100%;"! style="width:15%" | Heading! style="width:60%" | Description! style="width:25%" | Link|-| Email From || || |-| SMS From || || |-|}
* Exception : Time
* Exception : Contacts
* Service Level Agreement== Dashboard Defaults ==
{| class="wikitable" style="width:100%;"
! style="width:15%" | Heading
! style="width:60%" | Description
! style="width:25%" | Link
|-
| Dashboard - Contact Source || When using the Dashboard - Contact Source report, this field is the field that is reported against. ||
|-
| Working Days || This field is used to delimit what days are considered working days ||
|-
| Working Hours - Start || This field sets what is considered the normal working start of the day ||
|-
| Working Hours - End || This field sets what is considered the normal working end of the day ||
|-
| Non Working Days || This field denotes days that should not be worked on ||
|-
| Sales Outcomes || This field takes a comma separated list of outcomes which are considered "Sale" ||
|-
| Worklist - Category Field || In various parts of bxp it is possible to generate an auto grid report of records which need to be reviewed. This self-generating worklist report needs to know which field contains the category for the Y axis of the report ||
|-
| Worklist - Status Field || In various parts of bxp it is possible to generate an auto grid report of records which need to be reviewed. This self-generating worklist report needs to know which field contains the status for the X axis of the report ||
|-
|}
== Communications eCourse Prerequisites ==
* Email From{| class="wikitable" style="width:100%;"! style="width:15%" | Heading! style="width:60%" | Description! style="width:25%" | Link|-| eCourse Prerequisites enabled || User Must complete an eCourse or a number of eCourse before accessing the form || |-| eCourse Book Id || eCourse Book Id's seperated by a , || |-|}
* SMS From
== Dimensions ==
== Dashboard and Reporting Defaults ==
* Working Days
* Working Hours - Start
* Working Hours - End
* Non Working Days{| class="wikitable" style="width:100%;"! style="width:15%" | Heading! style="width:60%" | Description! style="width:25%" | Link|-| Table || || |-| Info Button || || |-| Question || || |-| Lookup Button || || |-| Item || || |-| Weighting || || |-| Max Weighting || || |-| Row Height || || |-|}
* Sales Outcomes
== External ==
== Dimensions ==
{| class="wikitable" style="width:100%;"
! style="width:15%" | Heading
! style="width:60%" | Description
! style="width:25%" | Link
|-
| Externally Available || When the form is to be made accessible through the bxp_API this value is to be set to Public. [[bxp_API]] By default all forms are Private. ||
|-
| Public Outcome || When the form is used in a public way an outcome is automatically applied. This is the default outcome applied to public form record logging. ||
|-
| Enable Offline Usage || This option allows a form to create an RSA encrypted snapshot of the data within the form. For more info || [[Using_Forms_Offline]]
|-
| Allow External CCL file download || Allow external download of CCL files ||
|-
|}
* Table
* Info Button
* Question== Inbox Elements ==
* Lookup Button
* Item=== Inbox - Management ===
* Weighting
* Max Weighting{| class="wikitable" style="width:100%;"! style="width:15%" | Heading! style="width:60%" | Description! style="width:25%" | Link|-| BEmail Account || The mailbox to log into || |-| Attachments as CCLs || True means attachments will be stored in the CCL history || |-| Notify on Receipt || When an email is loaded into the system, should an email be sent? || |-| Process as Outcome || What outcome should each email be processed as? || |-| Scheduling Enabled || Auto retrieve emails periodically which is managed by bxp || |- | Scheduling Refresh Rate || The rate to check for new mails. || |-|}
* Row Height
=== Inbox - Storage ===
== Inbox Management ==
{| class="wikitable" style="width:100%;"
! style="width:15%" | Heading
! style="width:60%" | Description
! style="width:25%" | Link
|-
| DateTime field || ||
|-
| From field || ||
|-
| To field || ||
|-
| CC field || ||
|-
| Subject field || ||
|-
| Body Field || ||
|-
|}
* BEmail Account
* DateTime field
* From field=== Inbox - Content ===
* To field
* CC {| class="wikitable" style="width:100%;"! style="width:15%" | Heading! style="width:60%" | Description! style="width:25%" | Link|-| Attempt matching? || True will attempt to append to an existing record on a pattern || |-| Field to match on || Which fieldcontains the code to match on || |-| Match pattern || What pattern is used for matching on? eg ###--ID--# || |-| Content retrieval || || [[BEmail_Content_Retrieval]]|-| Content replacement || || [[BEmail_Content_Replacement]]|-|}
* Subject field
* Body Field
* Attachments as CCLs=== Inbox - SPAM ===
* Notify on Receipt
* Process as {| class="wikitable" style="width:100%;"! style="width:15%" | Heading! style="width:60%" | Description! style="width:25%" | Link|-| Filter SPAM? || || [[BEmail_SPAM_Management]]|-| SPAM Addresses || || [[BEmail_SPAM_Management]]|-| SPAM keywords || || [[BEmail_SPAM_Management]]|-| SPAM flag field || || [[BEmail_SPAM_Management]]|-| SPAM Outcome|| || [[BEmail_SPAM_Management]]|-|}
* Attempt matching?
* Field to match on
* Match pattern=== Inbox - onArrival ===
* Content retrieval
* Content replacement{| class="wikitable" style="width:100%;"! style="width:15%" | Heading! style="width:60%" | Description! style="width:25%" | Link|-| Contact Match Enabled || || [[BEMail_onArrival_matching_engine]]|-| Company Match Enabled || || [[BEMail_onArrival_matching_engine]]|-| Owner Match Enabled || || [[BEMail_onArrival_matching_engine]]|-| Match Form Id || || [[BEMail_onArrival_matching_engine]]|-| Contact (Email) field || || [[BEMail_onArrival_matching_engine]]|-| Company field || || [[BEMail_onArrival_matching_engine]]|-| Owner field || || [[BEMail_onArrival_matching_engine]]|-| Contact Result field || || [[BEMail_onArrival_matching_engine]]|-| Company Result field || || [[BEMail_onArrival_matching_engine]]|-| Owner Result field || || [[BEMail_onArrival_matching_engine]]|-| Matching result field || || [[BEMail_onArrival_matching_engine]]|-|}
* {| class="wikitable" style="width:100%;"! style="width:15%" | Heading! style="width:60%" | Description! style="width:25%" | Link|-| Dial Out Instructions|| Please put an outbound dialling code here if applicable. This box is hidden if left blank. |||-| Opening Instructions || || |-| Closing Instructions || || |-| Mail Merge Button Name || When using mail merge on an outcome, what name appears on the button. If blank will default to Print Form || |-| Lookup Instructions || || |-|}
* Opening Instructions
* Closing Instructions
* Mail Merge Button Name== JavaScript - onLoad ==
{| class="wikitable" style="width:100%;"
! style="width:15%" | Heading
! style="width:60%" | Description
! style="width:25%" | Link
|-
| Opening code execution || Used for logic branching and deterministic work based on loaded record values. ||
|-
| Lookup code execution || Used for custom rules when using the lookup pages. ||
|-
| Additional Libraries || Used to dynamically include JavaScript Libraries if the campaign needs them. ||
|-
|}
== JavaScript onLoad ==
* Opening code execution== JavaScript - Options ==
* Lookup code execution
* Additional Libraries{| class="wikitable" style="width:100%;"! style="width:15%" | Heading! style="width:60%" | Description! style="width:25%" | Link|-| Enable jQuery || Includes the bxp jQuery libraries on the page || |-| Department User Functions || Creates JavaScript in the background to allow for User / Department limitations. |||-| Autobuild Logic || Create the show | hide flow based on Question Sequence. (Horizontal Delivery) || |-| Self Generating Logic || Create the show / hide flow based on Question Sequence. (Vertical Delivery) || |-| WasIs Engine Enabled || Turn the WasIs form logging engine on || |-| WasIs Engine Output Format || Enter in a custom format for the WasIs output, by default it will be a set structure |- |}
* Department User Functions
* Autobuild Logic
* Self Generating Logic== Media Management ==
{| class="wikitable" style="width:100%;"
! style="width:15%" | Heading
! style="width:60%" | Description
! style="width:25%" | Link
|-
| Use Media Code Field || Displays the list of static media codes on screen. ||
|-
| Force Media Code Selection || Do not allow the record to be stored UNLESS a media code is selected. ||
|-
| Show Media Schedule || The media schedule appears at the bottom of a logging screen showing the upcoming Scheduled ads. ||
|-
| Time : History || The number of minutes in the past to show ads. Leave 20 mins here to show ads that have just aired. ||
|-
| Time : Upcoming || The number of minutes into the future to show scheduled ads. ||
|-
|}
== Media Management ==
* Use Media Code Field== Queue Communications ==
* Force Media Code Selection
* Show Media Schedule{| class="wikitable" style="width:100%;"! style="width:15%" | Heading! style="width:60%" | Description! style="width:25%" | Link|-| Queue Comms Enabled || Enable Queue Comms engine || [[Outbound_-_Queue_Communications]]|-| Queue Comms Outcomes || Limit the outcomes available. If blank all outcomes displayed. || |-| Queue Comms Arrival Outcomes || If a record comes in through the API, and matches, comms triggered. || |-|}
* Time : History
* Time : Upcoming
== Quota Management ==
{| class="wikitable" style= Quota Management "width:100%;"! style="width:15%" | Heading! style="width:60%" | Description! style="width:25%" | Link|-| Outcome || || [[Quota_Management]]|-| Quantity || The number of records of the above Outcome, at which the limit will be reached. || |-|}
* Outcome
* Quantity== Realex Credit Card and Direct Debit Details ==
{| class="wikitable" style="width:100%;"
! style="width:15%" | Heading
! style="width:60%" | Description
! style="width:25%" | Link
|-
| Merchant Id || Realex Merchant Id. || [[Realex_Outcomes]]
|-
| Secret || Realex Secret. ||
|-
| Account Id || Realex Account Id. ||
|-
| Currency || Default currency. ||
|-
|}
== Realex Credit Card and Direct Debit Details ==
* Merchant Id== Scheduled Data Protection ==
* Secret
* Account Id{| class="wikitable" style="width:100%;"! style="width:15%" | Heading! style="width:60%" | Description! style="width:25%" | Link|-| Scheduled Data Protection Enabled || Please select if you wnat to enable the scheduled data protection functionality || [[Form_-_Data_Protection_-_Scheduled]]|-| Scheduled Frequency || Select the frequency that the process is executed || |-| Time of execution || Select the time of day for execution || |-| Fields to wipe || Specify the fields that are to be wiped separated by a comma i.e strCDA_41_field_0_1,strCDA_41_field_0_2 || |-| Time frame to execute on || Select the time frame to execute the data protection process on. Records that have not been interacted with in the given time frame. || |-| Data dump encryption password || Set the password for the encrypted file || |-| Send notification email || Enable a summary notification email || |-| Email notification recipient list || Set the email notification list || |-|}
* Currency
== Survey ==
{| class="wikitable" style= Survey "width:100%;"! style="width:15%" | Heading! style="width:60%" | Description! style="width:25%" | Link|-| Layout || The survey can be displayed vertically or horizontally. || |-| Template || The external colour template to display the survey in. || |-| Horizontal - Show Progress || When delivering one question per page, show progress. || |-| Horizontal - Show Effort || When delivering one question per page, show effort for question. || |-| Short Code || The short code to add to the URL for sending externally. || |-| Contact Block || The fields in the contact block. |||-|}
* Layout
* Template== Time Zone ==
* Horizontal - Show Progress
* Horizontal {| class="wikitable" style="width:100%;"! style="width:15%" | Heading! style="width:60%" | Description! style="width:25%" | Link|- | Time Zone || Time zone of the campaign || |-| Show Time in Zone || Display the time zone. || |-| Show EffortTime Zone || Display the time zone in the time box. || |-|}
* Short Code
* Contact Block
== bxp_API XML Arrival Management ==
{| class="wikitable" style= Time Zone "width:100%;"! style="width:15%" | Heading! style="width:60%" | Description! style="width:25%" | Link|-| External Reference Code || When interacting with a phone system this field allows a form to respond to something different than the Id or Name of the form. In code is referred to as the campaign_code. Used when integrating bxp with other systems || [[Scenario_-_bxp_Integration_with_a_Phone_System]]|-| Email notifications to || Used when integrating BE with other systems || |-| Parameters || On error email notifications to || |-| Server to deliver to || Server to deliver XML Post to || |-| XML data structure || XML structure for replacement and delivery. -- notation for parameter replacement. || |-| HTTP Post Headers || The HTTP Post Headers. Separate items using [ [ X ] ] and item and value using [ [ Y ] ] e.g. header [ [ Y ] ] value [ [ X ] ] || |-| Test All || This is a quick tool which generates the testing email on all sends. || |-|}
== bxp_API XML File Options ==
* Time Zone
* Show Time in Zone{| class="wikitable" style="width:100%;"! style="width:15%" | Heading! style="width:60%" | Description! style="width:25%" | Link|-| Data Loading Format || Select the SFTP server from which to pull the files. || |-| Data SFTP Account || Select the SFTP Account from which to retrieve the files || |-| Data Leave Original || Delete the file from the origin server || |-| Data Load Notification || Email addresses, separated by commas, of those to receive notifications on this process being used. || |-|}
* Show Time Zone
== bxp_API XML Processing Options ==
== Campaign CMI XML Arrival Management ==
{| class="wikitable" style="width:100%;"
! style="width:15%" | Heading
! style="width:60%" | Description
! style="width:25%" | Link
|-
| Load / Append || Should all records be loaded as new or should matching be done for appending. ||
|-
| Loading ID Field || If Appending, what field to match on? ||
|-
| Contact Log || Add a contact record to the history. ||
|-
| XML Element || When loading an XML file what is the name the record elements. ||
|-
|}
* Email notifications to
* Parameters
* Server to deliver to== Revenue Engine ==
* XML data structure
* HTTP Post HeadersThis section it's fields and options are full explained here [[Form_-_Revenue_Engine]
* Test All
== Owner Only ==
== Campaign CMI API XML and Excel AutoLoad File Options ==
This section is fully described here [[Form_-_OwnerOnly]]
* Data Loading Format
* Data SFTP Account
* Data Leave Original== Quick Link Buttons ==
* Data Load Notification
This section is fully described here [[Form_-_Quick_Link_Buttons]]
== Campaign CMI API XML and Excel AutoLoad Processing Options ==
== Phonovation ==
* Load / Append
* Loading ID FieldComing soon.
* Contact Log
* XML Element
== Listing ==
== Quick Link Buttons ==This feature is fully detailed here [[Form_-_Advanced_Settings_-_Listing]]
* Button 1[[Category:Topic:bxp API]]* Button 2[[Category:Module Specific:Form Management]]* Button 3* Button 4* Button 5* Button 6* Button 7* Button 8* Button 9* Button 10[[Category:To Be Revised]]
