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.
Advanced Settings provides access to the generic settings for all form types.
To get to the Advanced Settings ''Main Menu > Form Management > Form - Primary Management > Form - Advanced Settings > Choose your form > ''
[[File:advanced_settings_001.png|800px]]
= Sections =
* {| class="wikitable" style="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 ==* {| class="wikitable" style="width: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 the form. False overrides the date options above. || |-| Available From|| The date and time when users will be able to interact with the form || * |-| Available Until|| The date and time when users will no longer be able to interact with the 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 the user has an entry in the Contact History. Within Inbound Contact "My Data - Admin View", allows you to override this limitation. || |-| Use Outcome security || Outcome Security is turned on (true) or off (false) || [[Form_-_Outcome_Access]]|-|} == Search == {| class="wikitable" style="width: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 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. || |-|}
* Active{| class="wikitable" style="width:100%;"* External Reference Code! style="width:15%" | Heading* Contact History ! style="width:60%" | Description! style="width:25%" | Link|- Sort Order* Public Outcome| Enable Integrated Warehousing || Integrated Warehousing actives automatically but can be manually activated. || * Externally Available|-* | Use Outcome securityWorkflow || || [[Outcome_-_Workflow]]* Cross User Lookup|-* Record Move Next Bar| Contact History - Sort Order || The is the sort order of how the contacts are presented in the Contact History window. || * Enable Offline Usage|-* | 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. || * Precision Search Fields|-* Enable Integrated Warehousing|}* Dashboard - Contact Source
* {| class="wikitable" style="width:100%;"! style="width:15%" | Heading! style="width:60%" | Description! style="width:25%" | Link|-| Exception : Track Reopen|| || |-* | Exception : Time|| || |-* | Exception : Contacts|| || * |-| Service Level Agreement|| || |-|}
* {| class="wikitable" style="width:100%;"! style="width:15%" | Heading! style="width:60%" | Description! style="width:25%" | Link|-| Email From|| || * |-| SMS From|| || |-|} == 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 || |-|}
== eCourse Prerequisites ==
== Dashboard and Reporting Defaults ==
{| 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 , ||
|-
|}
* Working Days
* Working Hours - Start
* Working Hours - End
* Non Working Days
* Sales Outcomes
* {| 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|| || |-|} == External == {| 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 || |-|} == Inbox Elements == === Inbox - Management === {| 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. || |-|} === Inbox - Storage === {| 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 || || |-|} === Inbox - Content === {| 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 field contains 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]]|-|}
=== Inbox - SPAM ===
== Inbox Management ==
{| 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]]
|-
|}
=== Inbox - onArrival ===
{| 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]]
|-
|}
* BEmail Account
* DateTime field
* From field
* To field
* CC field
* Subject field
* Body Field
* Attachments as CCLs
* Notify on Receipt
* Process as Outcome
* Attempt matching?
* Field to match on
* Match pattern
* Content retrieval
* Content replacement
* {| 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 || || |-|} == 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 - Options ==
== JavaScript onLoad ==
{| 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 |-
|}
* Opening code execution
* Lookup code execution
* Additional Libraries
* Department User Functions
* Autobuild Logic
* Self Generating Logic
* {| 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. || |-|} == Queue Communications == {| 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. || |-|}
* {| class="wikitable" style="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. || |-|}
* {| 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. || |-|} == Scheduled Data Protection == {| 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 || |-|}
* {| class="wikitable" style="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. |||-|}
* {| 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 Time Zone|| Display the time zone in the time box. || |-|}
== Campaign CMI XML Arrival Management ==
== bxp_API XML Arrival Management ==
* Email notifications to
* Parameters
* Server to deliver to
* XML data structure
* HTTP Post Headers
* Test All
{| class="wikitable" style="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. ||
|-
|}
== Campaign CMI API bxp_API XML and Excel AutoLoad File Options ==
* {| 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. || |-|}
== Campaign CMI API XML and Excel AutoLoad Processing Options ==
== bxp_API XML Processing Options ==
{| 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. ||
|-
|}
== Revenue Engine ==
This section it's fields and options are full explained here [[Form_-_Revenue_Engine]
== Owner Only ==
This section is fully described here [[Form_-_OwnerOnly]]
* Load / Append
* Loading ID Field
* Contact Log
* XML Element
* Button 1This section is fully described here [[Form_-_Quick_Link_Buttons]]* Button 2* Button 3* Button 4* Button 5== Phonovation ==* Button 6* Button 7* Button 8Coming soon.* Button 9* Button 10 == Listing == This feature is fully detailed here [[Form_-_Advanced_Settings_-_Listing]] [[Category:Topic:bxp API]][[Category:Module Specific:Form Management]][[Category:To Be Revised]]