Fields

Fields

Complete list of fields available in the Scripter

This section will list all of the current fields along with examples of how they can be customized and used within a script.

1. Address
2. Button
3. Cart
4. Check
5. Checkboxes
6. Credit/Debit card
7. Dropdown
8. Embedded link
9. Name
10. Number/Quantity
11. Paragraph
12. Radios
13. Text input
14. Text input (multi-line)
15. Date input

 

 

1. Address

For information on how to create an address capture slide in your script, see Creating an Address Capture Slide Tutorial on the Video Tutorial page.

• Label: Address
• Prompt: [empty]

Default configuration on slide

*All components accept free text (letters, numbers, special characters).

• Line 1
• placeholder= line 1
• Line 2
• placeholder= line 2
• Locality
• placeholder= city/locality
• Region
• placeholder= state/province
• Postal code
• placeholder= zip/postal code
  *A zip code lookup is performed on this field at runtime. If a valid zip code is entered, the Locality, Region, and Country will auto-fill. Postal codes for the following areas are currently supported: United States, Canada, Puerto Rico, U.S. Minor Outlying Islands, Guam, American Samoa, Northern Mariana Islands, and the U.S. Virgin Islands.
• Country
• placeholder= country
  

Additional components that can be added:

• Line 3
• placeholder= line 3

Options

• • • Zip Code Type validation disabled? [unchecked]
      • Disables Zip Code Type (P.O. Box, APO, DPO) when using system zip code lookup
    • Zip Code lookup disabled? [unchecked]
      • Disables system Zip Code Lookup to auto populate/update City, State based on zip code entered
    • Private? [unchecked]
    • Required? [unchecked]
    • Character limit [250]
      • minimum character limit = 20

Conditions

• Visibility
• Defaults to Always
• Mirroring
  • Line 1
  • Line 2
  • Line 3
  • City/Locality
  • State/Region
  • Zip/Postal Code
• Local components that can be mirrored include:

 

 

2. Button

The button field is used to initiate an integration in order to return data in a real-time event.
For example: If you are collecting promotional codes that were mailed to callers, you could configure the button to check against a data table for that code, and if successful, return information associated with that code to areas within the script.

 

• Label: Button
• Prompt: [empty]

Default configuration on a slide

 

• Button text: click me!
• This default text can be changed within the field's settings.

Conditions

• Validity
• Defaults to Always
• Enabled
• Defaults to Always
  Button is the only field to offer this option. When the set of conditions for enabling the button have not been met, it will not be clickable and will not trigger the integration. Unlike unsatisfied validity conditions however, the agent will still be able to move forward to the next slide.
• Visibility
• Defaults to Always

 

 

3. Cart

For information on how to add a cart to your script, see Adding a Shopping Cart Tutorial on the Video Tutorial page.

The Cart field is your virtual shopping cart.

*Place your cart in the Sticky Slide and it will be visible on all slides within the script.

• Label: Cart
• Prompt: [empty]

Default configuration on slide

 

Options

• Private? [unchecked]
  
  *Be careful using this option on the Cart. If the Cart resides on the Sticky Slide, it is shown on every slide in the script, therefore the recording would be paused for the entire call.

Field settings unique to the Cart

• Spread tax?
• Disable system tax lookup?
• Billing fields/Shipping fields
• Billing name/Shipping name: 
• Billing address/Shipping address: 
• Tax Jurisdictions (70/70 selected by default)
  This dropdown allows you to individually select/deselect any of the 70 available areas for their current sales tax rates. Jurisdictions include all 50 U.S. states and the District of Columbia, all 10 provinces and 3 territories in Canada, plus American Samoa, Guam, Northern Mariana Islands, Puerto Rico, U.S. Minor Outlying Islands, and the U.S. Virgin Islands.

*You can also select/deselect all from this list. For example, if you are only charging sales tax to a few states, you can deselect all and then easily choose the areas from the alphabetical list.

• Payment Plans
• Single and multi-pay plans (up to a maximum of 8 installments) are available.
  
• SKUs
• Once payment plans are added, SKUs can be created here
  

Conditions

• Visibility
• Defaults to Always
• Mirroring
• Name and Address fields are mirrored into the Billing/Shipping Name/Address areas of the Cart, but do not utilize this modal. they are mirrored using the field option listed above.
• The only field that can be mirrored to the Cart from the Mirroring modal is the Number field. This must be done if allowing the SKU option for Manually Adjustable Quantity within the script.

*A functioning Cart from inside a script. This one shows a total of 9 items in the cart, a 2-pay payment plan, along with the Quantity Controls in Cart SKU feature.

 

 

4. Check

The Check field is where an agent can collect all of the relevant bank account information from callers wishing to pay via eCheck.

• Label: Check
• Prompt: [empty]

Default configuration on a slide

*All fields accept free text, except where noted.

• bank name
• branch city
• check number
• routing number
• This text box will only accept valid 9-digit routing transit numbers.
• account number

Options

• Private? [checked]
• This option is defaulted on for the Check and Credit/Debit card fields.
  
  *Any time the Private? option is enabled for a field, it will render the entire slide as private. If you only want to stop the call recording for the payment information, it is advised that you place private fields on a slide by themselves, or alongside other fields that do not need to be recorded.
• Required? [unchecked]
• Collect State? [unchecked]
• If you would like to, or are required to also collect the state where the bank is located, this option can be enabled as part of the Check field.
• placeholder= branch state/province

*Check field with Collect State? option enabled.

Conditions

• Visibility
• Defaults to Always
• Mirroring
• There are no remote fields available to mirror from/to the Check field

 

 

5. Checkboxes

Checkboxes allow for multiple selections to be made in a single field.

 

• Label: Checkboxes
• Prompt: Select some options...

Default configuration on a slide

 

Options

• On slide back [unchecked]
• When invisible [unchecked]
• Private? [unchecked]
• Required? [unchecked]

Choices
Choice options are unique to the following fields: Checkboxes, Dropdown, Radios.

• The Checkboxes field has three choices enabled by default.
  
• Option 1/ Option 2/ Option 3
• Insert/ Settings/ Remove buttons
  
  
  

Conditions

• Visibility
• Defaults to Always
• Mirroring
• The only remote field available to mirror from a Checkboxes field is another set of Checkboxes. However, the Local/Values can be mirrored to another set of Checkboxes, or a Text input field. If mirrored to a text-type field and multiple choices are selected, they will be displayed in a comma-separated list.

 

 

6. Credit/Debit card

The Credit/Debit card field is where an agent can collect all of the relevant account information from callers wishing to make a credit or debit card purchase.

• Label: Credit/Debit card
• Prompt: [empty]

Default configuration on slide

 

• number
• This text box accepts numbers only, and will also automatically add dashes where appropriate.
• Expiration month dropdown (1-12)
• placeholder= [none]
• All months are listed, unless the present year has already been selected. In that instance, only the current and upcoming months will be available to choose from.
• Expiration year dropdown
• placeholder= [none]
• Displays the current year plus the next ten years

Options

• Private? [checked]
• This option is defaulted on for the Check and Credit/Debit card fields.
  
  *Any time the Private? option is enabled for a field, it will render the entire slide as private. If you only want to stop the call recording for the payment information, it is advised that you place private fields on a slide by themselves, or alongside other fields that do not need to be recorded.
• Required? [unchecked]
• CCV/CVC present? [unchecked]
• placeholder= ccv/cvc
  
• The Credit Card Verification or Card Verification Code is the 3 or 4-digit security code assigned to that card for online purchases or purchases in which the card is not physically present.
• This text box accepts a maximum of four numbers only.
• CCV/CVC required? [unchecked]
• Available only when CCV/CVC present? is enabled.

*Credit/Debit card field with CCV/CVC present? option enabled.

Conditions

• Visibility
• Defaults to Always
• Mirroring
• There are no remote fields available to mirror from/to the Credit/Debit card field.

 

 

7. Dropdown

Dropdowns allow for a single selection to be made from a list of items.

*Do you have a really long list of items? Consider using the Dropdown field. By default, the list will be compressed to a single line until it is clicked by the agent. Only then will the choices "drop down" for view. It will save a lot of space on the slide!

• Label: Dropdown
• Prompt: Select an option...

Default configuration on a slide

 

Options

• On slide back [unchecked]
• When invisible [unchecked]
• Private? [unchecked]
• Required? [unchecked]

Choices
Choice options are unique to the following fields: Checkboxes, Dropdown, Radios.

• The Dropdown field has three choices enabled by default
  
• Option 1/ Option 2/ Option 3
• Insert/ Settings/ Remove buttons
  

Conditions

• Visibility
• Defaults to Always
• Mirroring
• The only remote fields available to mirror from a Dropdown would be either another Dropdown, or Radios. However, the Local/Value can be mirrored to another Dropdown, Radios, or a Text input field (single or multi-line)

 

 

8. Embedded link

Placing an Embedded Link field on a slide allows a live web page to be viewed from inside the script.

• Label: Embedded link
• Prompt: [empty]

Options

• Private? [unchecked]

URL

• This is where you assign the web address of the page you are embedding.
• Because SingleComm sends all scripts over a secure connection, any website that you display must also be https://  

*An example of a complete URL text box. There is no need to fill in the https:// or the www.

Conditions

• Visibility
• Defaults to Always
• Mirroring
• There are no remote fields available to mirror from/to the Embedded link field.

 

 

9. Name

The Name field is a standard way to collect a caller's first and last name.

• Label: Name
• Prompt: [empty]

Default configuration on slide

• first/given name
• last/family name

Options

• Private? [unchecked]
• Required? [unchecked]

Conditions

• Visibility
• Defaults to Always
• Mirroring
  • Name (First)
  • Name (Last)
• The individual components of the Name field must be mirrored separately. They can be mirrored from another Name or Text input (single or multi-line) or mirrored to either another Name or Text-type field.
• When mirroring, the fields are titled:

 

 

10. Number/Quantity

The Number/Quantity field accepts only numerical characters. This field is unique because it can be used to mirror item quantity from the script directly to a SKU within the Cart.

 

• Label: Number/Quantity
• Prompt: [empty]

Default configuration on slide

*In preview mode and at runtime, the Number field has an up/down arrow control that can be used to increment/decrement the number value.

Options

• Clear on back? [unchecked]
• Private? [unchecked]
• Required? [unchecked]
• Rounding? [checked]
• This option is only available on the Number field.
• Numbers with fractional values will be rounded up or down accordingly.

Placeholder: [empty]

*Because both the Prompt and the Placeholder are defaulted as empty, when the script runs, this field will appear as a blank text box with no indication of how it should be filled. A custom placeholder or prompt text is highly recommended.

• Default value, Minimum value, Maximum value [all empty]
  
• These values, if set, will dictate at runtime the number that will appear in the script (Default), the lowest possible number that can be assigned (Minimum), and the highest possible number that would be accepted (Maximum).
• The Clear button next to each will erase any value that was assigned.
• Step size: (1)
• If the up/down arrow is used to increment/decrement the value of the Number field, this will determine the set amount by which it is raised or lowered each time.
• The Reset button to the right returns the value to its default (1).

Conditions

• Visibility
• Defaults to Always
• Mirroring
• The only remote fields available to mirror from the Number field would be either another Number field or a SKU quantity. However, the Local/Value can be mirrored to another Number field, a SKU quantity or a Text input field.

 

 

11. Paragraph

A Paragraph is used to display a block of text only. There is no input from the agent and nothing that can be reported in the session details.

 

• Label: Paragraph
• Prompt: A bunch of text to be read.

Default configuration on slide

Options

• Private? [unchecked]
• Togglable? [unchecked]
• This feature is unique to Paragraphs and gives the agent the option to expand/contract the field at runtime.

Conditions

• Visibility
• Defaults to Always
• Mirroring
• There are no remote fields available to mirror from/to the Paragraph field.

 

 

12. Radios

Radios allow for a single selection to be made from a list of items.

 

• Label: Radios
• Prompt: Select an option...

Default configuration on a slide

Options

• On slide back [unchecked]
• When invisible [unchecked]
• Private? [unchecked]
• Required? [unchecked]

Choices
Choice options are unique to the following fields: Checkboxes, Dropdown, Radios.

• The Radios field has three choices enabled by default.
  
  
• Option 1, Option 2, Option 3
• Insert/ Settings/ Remove buttons
  
  

Conditions

• Visibility
• Defaults to Always
• Mirroring
• The only remote fields available to mirror from Radios would be either another Radios field or a Dropdown. However, the Local\Value can to be mirrored to another set of Radios, a Dropdown, or a Text input (single or multi-line) field.
  

 

 

13. Text input

The Text input field can be used to capture text-type responses. The Text input field does not cap the amount of information that can be captured, but will only display it in a single text box (scrollable right and left, if necessary).

 

• Label: Text input
• Prompt: Enter a line of text...

Default configuration on a slide

Options

• Clear on back? [unchecked]
• Multi-line? [unchecked]
• Private? [unchecked]
• Required? [unchecked]
• Limit Characters? [unchecked]

Placeholder: enter text

Conditions

• Validity
  • Defaults to free text [no selection]
  • Defaults to Always
• Pattern Matching
• Validity Conditions
• Visibility
• Defaults to Always
• Mirroring
  • Address (Line 1, Line 2, Line 3, City/Locality, State/Region, Zip/Postal Code)
  • Checkboxes
  • Dropdown
  • Name (First, last)
  • Number
  • Radios
  • Text input
  • Text input (multi-line)
  • Address (Line 1, Line 2, Line 3, City/Locality, State/Region, Zip/Postal Code)
  • Name (First, Last)
  • Text input
  • Text input (multi-line)
• The following fields are available to mirror from:
• The Text input field can only be mirrored to other text-type fields, including:

 

 

14. Text input (multi-line)

The Text input (multi-line) field can also be used to capture text-type responses. The difference between this and the regular Text input field is that this field allows the agent to use the <Enter> key so that text can be broken up across multiple lines.

 

• Label: Text input (multi-line)
• Prompt: Enter a few lines of text...

Default configuration on a slide

Options

• Clear on back? [unchecked]
• Multi-line? [checked]
• Private? [unchecked]
• Required? [unchecked]
• Limit Characters? [unchecked]

Placeholder: enter text

Conditions

• Validity
  • Defaults to Always
• Pattern Matching [feature not available]
• Validity Conditions
• Visibility
• Defaults to Always
• Mirroring
  • Address (Line 1, Line 2, Line 3, City/Locality, State/Region, Zip/Postal Code)
  • Checkboxes
  • Dropdown
  • Name (First, last)
  • Number
  • Radios
  • Text input
  • Text input (multi-line)
• The following fields are available to mirror from:

*Even though the Text input (multi-line) field can accept multiple lines of text, you can still only mirror a single field to it. If you mirror more than one field to this or any other field, only the item mirrored last will appear at runtime.

• The Text input field can only be mirrored to other text-type fields, including:
• Address (Line 1, Line 2, Line 3, City/Locality, State/Region, Zip/Postal Code)
• Name (First, Last)
• Text input
• Text input (multi-line)

 

15. Date input

The Date input field is used to collect a specific date by choosing from the calendar or by typing it in the text box.

• Label: Date input
• Prompt: Enter a date...

Default configuration on a slide

*In preview mode and at runtime, when the Agent clicks within the text box, the Date input field will pop up a calendar that can be used to assign the date value. Any date (within range) can also be typed using the following format: MM/DD/YYYY.

Options

• Clear on back? [unchecked]
• Clear when invisible? [unchecked]
• Private? [unchecked]
• Required? [unchecked]

Placeholder: enter date

Conditions

• Visibility
• Defaults to Always

Minimum date
Set the limit for the soonest date allowed.

• Current date [unchecked]
  
• Selecting this checkbox will auto-assign the current date as the Minimum date value

Maximum date
Set the limit for the latest date allowed.

The information in this article is up to date as of:
Frontend Version : 1.0.0-428
Frontend Git Revision : c8ca2bd0eed699c7122697627613850d39a56c0c
Backend Version : 0.0.0
Backend Git Revision : cc68917d1480c8fcc6e9dce4f32ff6c782d654cb