Input fields are a way for the end user of the survey to send information to the Nextiva back-end. There is a wide variety of inputs available, and each can be customized in its own way. Form fields, labels and conditions can all be used to present different options in a dynamic way which makes the User Survey a great tool for creating scripts that will guide agents through the process of collecting customer information.
The best way to use inputs is to consider when an agent or customer will be required to register some piece of information in the application. There are many reasons why they may want to do this, but there are two main categories.
The first category is for use in a workflow. Customer-facing surveys are often used for starting Chat workitems or requesting Callbacks, and these will need to pass data into a workflow that will handle the incoming or outgoing workitem.
The second is for reporting purposes. Many businesses may need to send Questionnaires to their customers to see how satisfied they are with the quality of the service, product or customer support. These will require some questions and answers to be recorded. Each input field includes a report label so that a survey report can be used more efficiently.
Boolean
A boolean variable is binary, either True or False. It allows for the display of dynamic components based on quick 2-way selections. It can be used for both agent-facing and customer-facing surveys.
Configuration Fields
The Boolean input will have the following configuration fields:
Field Name |
Description |
Component Type |
Boolean |
Component Description |
A description of the Boolean input. |
Label |
The component title. |
Report Label |
The tag that will identify the field inside the survey reports. |
Font Size |
The font size of the component title. |
Assistance |
The description to be displayed in the assistance button, when it’s hovered over. |
Width |
The width in pixels or otherwise, following the CSS formatting rules. E.g., 180px. |
Margin |
The margin in pixels or otherwise, following the CSS formatting rules. E.g., 4px, 8px or 0px, 0px, 0px, 4px. |
Default value |
If the toggle is to be enabled by default, select True. |
Fieldname |
The unique name that identifies the field within the survey, should be alphanumeric and cannot contain whitespace. |
Condition |
A JavaScript expression for displaying the component. The component will show if the expression returns true. |
Captcha
If Captcha inputs are required to verify a customer-facing survey is not being handled by an automated process, then use this component.
Configuration Fields
The Captcha input will have the following fields:
Field Name |
Description |
Component Type |
Captcha |
Component Description |
A description of the Captcha input. |
Label |
The component title. |
Fieldname |
The unique name that identifies the field within the survey, should be alphanumeric and cannot contain whitespace. |
ReCaptcha Site Key |
The license from Captcha, this needs to be purchased separately. |
Chat Panel
Chat panels are the Nextiva resource from which messages can be sent to and from a customer’s device. This component is linked to a company campaign that must hold a Chat specific workflow. Please refer to the Chat function or Chat campaign documentation for details on configuring these.
Configuration Fields
The Chat panel input will have the following configuration fields:
Field Name |
Description |
Component Type |
Chat Panel |
Component Description |
A description of the Chat Panel input. |
Vertical Alignment |
Whether the chat panel will occupy the entire height available to it or fit to the contents. |
Width |
The width in pixels or otherwise, following the CSS formatting rules. E.g., 180px. |
Margin |
The margin in pixels or otherwise, following the CSS formatting rules. E.g., 4px, 8px or 0px, 0px, 0px, 4px. |
Allow Attachments |
If enabled, attachments will be allowed in the chat panel. |
Allow Voice Messages |
If enabled, voice messages will be allowed in the chat panel |
Allow Emoji |
If enabled, emojis will be allowed in the |
On Terminate |
The action to be carried out when the agent terminates the chat workitem:
|
Termination Message |
If the On Terminate field is set to Display message, enter the message to be displayed. |
End Panel |
If the On Terminate field is set to End Panel, select the end panel. |
Date
A date input is used to pass a particular epoch value as an integer to the workitem survey. This input drops a calendar in the survey, which can be used to select a particular date and time, which is then converted into an epoch value. This value will then be stored in the workitem survey results object and used for callbacks and other event triggers, such as sending emails.
Configuration Fields
The Date input will have the following configuration fields:
Field Name |
Description |
Component Type |
Date |
Component Description |
A description of the date input. |
Label |
The component title. |
Report Label |
The tag that will identify the field inside the survey reports. |
Font size |
The font size of the component title. |
Assistance |
The description to be displayed in the assistance button, when it’s hovered over. |
Width |
The width in pixels or otherwise, following the CSS formatting rules. E.g., 180px. |
Margin |
The margin in pixels or otherwise, following the CSS formatting rules. E.g., 4px, 8px or 0px, 0px, 0px, 4px. |
Fieldname |
The unique name that identifies the field within the survey, should be alphanumeric and cannot contain whitespace. |
Default value |
A default value in epoch time to select. This will be the current date at which the calendar is opened if not defined. |
Condition |
A JavaScript expression for displaying the component. The component will show if the expression returns true. |
Mandatory Field |
Enable this toggle if the field must be filled in. A survey validation disposition will not allow dispositioning of the workitem if the field is not filled in. |
Show Time |
Enable the calendar to include the time in the date field displayed. |
Select Year |
Enable the calendar to include the year selection. |
HTML
The HTML input allows users to add HTML that will be rendered in the survey. This gives the user more flexibility in how they want the survey presented. With this input, the text size, text color, bold, italics, and more can be edited. The user must be proficient in HTML.
Configuration Fields
The HTML input will have the following configuration fields:
Field Name |
Description |
Component Type |
HTML |
Component Description |
A description of the HTML input. |
Label |
The label for the input that will be displayed in the survey. |
HTML HTML |
The custom HTML to be displayed in the survey. |
Assistance |
The description to be displayed in the assistance button, when it’s hovered over. |
Height |
The height in pixels or otherwise following the CSS formatting rules. E.g., 180px. |
Width |
The width in pixels or otherwise, following the CSS formatting rules. E.g., 180px. |
Margin |
The margin in pixels or otherwise follows the CSS formatting rules. E.g., 4px, 8px or 0px, 0px, 0px, 4px. |
Condition |
A JavaScript expression for displaying the component. The component will show if the expression returns true. |
Image
The Image input allows an image to uploaded to a Nextiva Contact Center survey
Configuration Fields
The Image input will have the following fields:
Field Name |
Description |
Component Type | Image |
Component Description | A description of the Image input |
Message | The message here will presented under the image in the survey. |
Attached File | The image file. |
Image Width | Use the slider to set the image width in the survey. |
Image Height | Use the slider to set the image height in the survey. |
Margin | The desired size in pixels or otherwise, following the CSS formatting rules. E.g., 4px, 8px or 0px, 0px, 0px, 4px |
Condition | A JavaScript expression for displaying the component. Component will show if the expression returns true. |
Set Variables | Any variables that are to be set that contain the image. |
Panel | The panel to move to after seeing the image. |
Style | Any custom styling for the message. |
Input
This input provides a form where the end user can input information. It is a plain box in which the information may be recorded and saved in the corresponding field name in the survey.
Configuration Fields
The Input input will have the following fields:
Field Name |
Description |
Component Type |
Input |
Component Description |
A description of the input. |
Label |
The component title. |
Report Label |
The tag that will identify the field inside the survey reports. |
Font size |
The font size of the component title. |
Assistance |
The description to be displayed in the assistance button, when it’s hovered over. |
Width |
The width in pixels or otherwise, following the CSS formatting rules. E.g., 80px. |
Margin |
The margin in pixels or otherwise, following the CSS formatting rules. E.g., 4px, 8px or 0px, 0px, 0px, 4px. |
Fieldname |
The unique name that identifies the field within the survey, should be alphanumeric and cannot contain whitespace. |
Default value |
The default value of the field. |
Condition |
A JavaScript expression for displaying the component. The component will show if the expression returns true. |
REGEX |
Allows you to choose a regular expression from the list. This expression will be applied to the input value and will not let the user proceed unless it’s satisfied. It is a form of input validation. |
Validation Message |
This is the message that will be displayed after the validation of the regular expression from the REGEX field. |
Mandatory Field |
Enable, if the field must be filled in. A survey validation disposition will not allow dispositioning of the workitem if the field is not filled in. |
Read Only |
Enable, if this input field is read-only. This will stop a user from changing its value. |
Validate Condition on Each Character Input |
Validates the REGEX on each character input from the user. For example, if you are asking for only numbers and the user inputs a special character it will immediately warn the user. |
Sensitive Data Do Not Store |
Enable, if the input field will contain sensitive data, so it will not be saved. |
Save to Local Storage |
If enabled, this will save data to the storage the application is using. |
Knowledge Base
The Knowledge Base component performs an API call with a keyword to a knowledgebase and displays that information.
Configuration Fields
The Knowledge Base input will have the following configuration fields:
Field Name |
Description |
Component Type |
Knowledge Base |
Component Description |
A description of the Knowledge Base input. |
Label |
The component title. |
Label Alignment |
The alignment of the component title. |
Label Font Size |
The font size of the component title. |
Description |
The description of the knowledge base that customers will see. |
Description Alignment |
The alignment of the description text. |
Description Font Size |
The size of the description font. |
Assistance |
The description to be displayed in the assistance button, when it’s hovered over. |
Tab Label |
The tab name to be displayed above the survey. |
Condition |
A JavaScript expression for displaying the component. The survey component will show if the expression returns true. |
Search Label |
The name of the Search field displayed to customers. |
Search Label Alignment |
The alignment of the Search Label. |
Search Label Font Size |
The font size of the Search Label. |
Placeholder |
The text that will be shown when the field is empty indicating to the user they can type something in there. |
Type |
The type of HTTP method. The types are: Delete, Form, Get, Patch and Post. |
URL |
The API being called to pass data for the knowledge base search. |
Icon |
The icon in the field that you want to click on to do the search. The options are: Bullseye, Eye, Filter, Like, Next, Operator, Play, Right, Search and Send. |
Input Margin |
The margin in pixels or otherwise of the input, following the CSS formatting rules. E.g., 4px, 8px or 0px, 0px, 0px, 4px. |
Background Color |
The background color of the text field. |
Fieldname |
The unique name that identifies the field within the survey, should be alphanumeric and cannot contain whitespace. |
Default Value |
The value you want to be searched for by default. |
Result Variable |
The variable name in which to store the result of the search used primarily when calling APIs. |
Properties |
Properties to be passed in the body of the search: these are label – value pairs. |
Headers |
Headers that are to be included with the search: these are label – value pairs. |
Width |
The width in pixels or otherwise, following the CSS formatting rules. E.g., 180px. |
Margin |
The margin in pixels or otherwise, following the CSS formatting rules. E.g., 4px, 8px or 0px, 0px, 0px, 4px. |
Name Fieldname |
The fieldname that will hold the list of items. |
Fieldname Row 1 |
The first option to pass “Name Fieldname” from other components (usually previous list information “Name Fieldname”). |
Fieldname Row 2 |
The second option to pass “Name fieldname” from other components (usually previous list information “Name Fieldname”). |
Fieldname Row 3 |
The third option to pass “Name fieldname” from other components (usually previous list information “Name Fieldname”). |
Select Variable Name |
The variable being passed to the knowledge base that a knowledge base can do a search for and return data. |
Show Scrollbar |
If enabled, there will be a visible scroll bar on the panel. |
List
A list displays information from an API call, for example, from an action button. The list is formed from an array that is the result of a call to either Nextiva or a third-party system. The variables inside the calls are then displayed in a list, similar to the multi-select component but with its own formatting. It has the option to select values from it.
Configuration Fields
The List input will have the following configuration fields:
Field Name |
Description |
Component Type |
List |
Component Description |
A description of the List input. |
Label |
The component title. |
Label Alignment |
The alignment of the component title. |
Label Font Size |
The font size of the component title. |
Description |
The description of the list. |
Description Alignment |
The alignment of the description text. |
Description Font Size |
The size of the description font. |
Assistance |
The description to be displayed in the assistance button, when it’s hovered over. |
Tab Label |
The tab name to be displayed above the survey. |
Panel alignment |
The alignment desired for the contents of the panel. |
Vertical alignment |
Full or Fit Content. |
Margin |
The margin in pixels or otherwise, following the CSS formatting rules. E.g., 4px, 8px or 0px, 0px, 0px, 4px. |
Data variable |
The name of the variable that contains the data to be displayed in the component. |
Icon fieldname |
The fieldname of the variable that will define the icon to be displayed (use this or The Icon field). |
Icon |
The icon to be displayed (use this or The Icon Filename field). |
Name Fieldname |
The fieldname that will hold the list of items. |
Fieldname row 1 |
The first option to pass “Name Fieldname” from other components (usually previous list information “Name Fieldname”). |
Fieldname row 2 |
The second option to pass “Name fieldname” from other components (usually previous list information “Name Fieldname”). |
Fieldname row 3 |
The third option to pass “Name fieldname” from other components (usually previous list information “Name Fieldname”). |
Selected Variable Name |
The name of the variable that will be displayed in a list. |
Variable to Store (Empty to Store Item) |
This is the variable that will be used in subsequent survey components to access the result of the API call. |
Multi Select
A multi-select component displays a list of values allowing multiple selections of these. It is a check-box component, and a user can select up to all the values. The component takes a list, displays the labels, and passes the values to the survey results variable inside a workitem. You may display the values by hard coding values or by passing a JavaScript function result of type array.
Configuration Fields
The Multi-Select input will have the following configuration fields:
Field Name |
Description |
Component Type |
Multi Select |
Component Description |
A description of the multi-select input. |
Label |
The component title. |
Report Label |
The tag that will identify the field inside the survey reports. |
Font size |
The font size of the component title. |
Assistance |
The description to be displayed in the assistance button, when it’s hovered over. |
Width |
The width in pixels or otherwise, following the CSS formatting rules. E.g., 180px. |
Margin |
The margin in pixels or otherwise, following the CSS formatting rules. E.g., 4px, 8px or 0px, 0px, 0px, 4px. |
List max height |
The maximum height of the list in pixels or otherwise, following the CSS formatting rules. E.g., 180px. |
Fieldname |
The unique name that identifies the field within the survey, should be alphanumeric and cannot contain whitespace. |
Options |
The list of radio button options. The label will be displayed and value will be passed in the survey result at the end of the workitem. |
Allow Wrap Text |
The list of radio button options. Label will be displayed and value will be passed in the survey result at the end of the workitem. |
Expression |
This expression takes an array variable. It may be the result of an API call or a JavaScript function, making this component very flexible for displaying filtered results in an automated way, allowing the survey to load values rather than hard-code them. |
Default value |
Insert a default value that you would like the component to display. This may be single value or array-like. |
Condition |
A JavaScript expression for displaying the component. The survey component will show if the expression returns true. |
Mandatory Field |
Select this toggle if the field must be filled in. A survey validation disposition will not allow dispositioning of the workitem if the field is not filled in. |
Radio button
A radio button allows a mutually exclusive set of values to be displayed. Only one value may be selected from a radio button component. The user may have multiple options, though only a single circular box will be selected by the user. This is most useful when only one option of many is to be selected.
Configuration Fields
The Radio Button input will have the following configuration fields:
Field Name |
Description |
Component Type |
Radio Button |
Component Description |
A description of the radio button. |
Label |
The component title. |
Report Label |
The tag that will identify the field inside the survey reports. |
Font size |
The font size of the component title. |
Assistance |
The description to be displayed in the assistance button, when it’s hovered over. |
Orientation |
Whether the buttons are to be vertically or horizontally displayed. |
Width |
The width in pixels or otherwise, following the CSS formatting rules. E.g., 180px. |
Margin |
The margin in pixels or otherwise, following the CSS formatting rules. E.g., 4px, 8px or 0px, 0px, 0px, 4px. |
List max height |
The maximum height of the list in pixels or otherwise, following the CSS formatting rules. E.g., 180px. |
Fieldname |
The unique name that identifies the field within the survey, should be alphanumeric and cannot contain whitespace. |
Options |
The list of radio button options. The label will be displayed and value will be passed in the survey result at the end of the workitem. |
Allow Wrap Text |
Allows longer labels by wrapping the text around to fit inside the component width. |
Expression |
This expression takes an array variable. It may be the result of an API call or a JavaScript function, making this component very flexible for displaying filtered results in an automated way, allowing the survey to load values rather than hard-code them. |
Default value |
Insert a default value that you would like the component to display. |
Condition |
A JavaScript expression for displaying the component. The survey component will show if the expression returns true. |
Mandatory Field |
Enable, if the field must be filled in. A survey validation disposition will not allow dispositioning of the workitem if the field is not filled in. |
Rate
The Rate input is used to set up a star-rating field, commonly used in customer satisfaction surveys. There are multiple options available including stars and smiley faces.
Configuration Fields
The Rate input will have the following configuration fields:
Field Name |
Description |
Component Type |
Rate |
Component Description |
A description of the Rate component. |
Label |
The component title. |
Report Label |
The tag that will identify the field inside the survey reports. |
Font size |
The font size of the component title. |
Assistance |
The description to be displayed in the assistance button, when it’s hovered over. |
Fieldname |
The unique name that identifies the field within the survey, should be alphanumeric and cannot contain whitespace. |
Items |
Number of items to include (up to 10). |
Icon |
The style of icon to use. |
Width |
The width in pixels or otherwise, following the CSS formatting rules. E.g., 180px. |
Margin |
The margin in pixels or otherwise, following the CSS formatting rules. E.g., 4px, 8px or 0px, 0px, 0px, 4px. |
Default value |
Insert a default value that you would like the component to display. |
Condition |
A JavaScript expression for displaying the component. The component will show if the expression returns true. |
Mandatory Field |
Enable, if the field must be filled in. A survey validation disposition will not allow dispositioning of the workitem if the field is not filled in. |
Rate Agent
This input allows a customer to rate the agent they were interacting with. The customer will see the message, the agent will not.
Configuration Fields
The Rate Agent input will have the following configuration fields:
Field Name |
Description |
Component Type |
Rate Agent |
Component Description |
A description of the Rate Agent component. |
Label |
Rate Agent |
Report Label |
The tag that will identify the field inside the survey reports. |
Font size |
The font size of the component title. |
Assistance |
The description to be displayed in the assistance button, when it’s hovered over. |
Fieldname |
The unique name that identifies the field within the survey, should be alphanumeric and cannot contain whitespace. |
Thumbs Up |
An icon that will represent a positive review. |
Thumbs Down |
An icon that will represent a negative review. |
Width |
The desired width of the input, in pixels or otherwise, following the CSS formatting rules. EG: 4px,8px or 0px,0px,0px,4px |
Margin |
The desired margin of the input, in pixels or otherwise, following the CSS formatting rules. EG: 4px,8px or 0px,0px,0px,4px |
Default value |
If the toggle is to be on by default, select True. |
Condition |
A JavaScript expression for displaying the component. The component will show if the expression returns true. |
Mandatory Field |
Enable, if the field must be filled in. A survey validation disposition will not allow dispositioning of the workitem if the field is not filled in. |
Rate Message |
The message that will be inserted in the conversation and sent to the agent, if enabled. |
Display to Agent |
If Display to Agent is enabled, then the agent will see the feedback in near real-time in the chat. If disabled, the agent will not receive feedback. |
Search
This component will display information based on a search from an API call with a keyword. The search component allows you to specify where you’re searching in the URL. You can specify the fields that will be presented in the list as part of the parameters of the component.
Configuration Fields
The Search input will have the following configuration fields:
Field Name |
Description |
Component Type |
Search |
Component Description |
A description of the search. |
Placeholder |
The text that will be shown when the field is empty indicating to the user they can type something in there. |
Type |
The type of HTTP method. The types are: Delete, Form, Get, Patch and Post. |
URL |
The URL that is to be accessed. |
Icon |
The icon style that will be used for the search. |
Background Color |
The background color of the search field. |
Width |
The width in pixels or otherwise, following the CSS formatting rules. E.g., 180px. |
Margin |
The margin in pixels or otherwise, following the CSS formatting rules. E.g., 4px, 8px or 0px, 0px, 0px, 4px. |
Fieldname |
The unique name that identifies the field within the survey, should be alphanumeric and cannot contain whitespace. |
Default Value |
The default value in the search box. |
Condition |
A JavaScript expression for displaying the component. The survey component will show if the expression returns true. |
Result Variable |
The variable name in which to store the result of the search used primarily when calling APIs |
Properties |
Properties to be passed in the body of the search: these are label – value pairs. |
Headers |
Headers that are to be included with the search: these are label – value pairs. |
Set Variables on Success |
Variables to set on success, you may use this to create new variables or change values of fields in the survey when the search is successful. |
On Success |
The action to be taken if the search is successful. It will be either Message, Move to Panel, None… and Show Overlay |
Success Message |
If On Success is set to Message, this is the message when the search is successful. |
On Success Panel |
The panel to go to if the search is successful. If On Success is set to Move To Panel, this will be the panel that it moves to. |
Set Variables on Error |
Variables to set on error, you may use this to create new variables or change values of fields in the survey when the search fails. |
On Error |
The action to be taken if the search fails. It will be either Message, Move To Panel or None… |
Error Message |
If On Error is set to Message, this is the message when the search is unsuccessful. |
On Error Panel |
The panel to go to if the search is unsuccessful. If On Error is set to Move To Panel, this will be the panel that it moves to. |
Select
A Select component is the classic drop-down field in web forms. It is used to select a single value from a list of values. As with the multi-select component you may use this component to draw on an array from an API result.
Configuration Fields
The Select input will have the following configuration fields:
Field Name |
Description |
Component Type |
Select |
Component Description |
A description of the Select input. |
Label |
The component title. |
Report Label |
The tag that will identify the field inside the survey reports. |
Font size |
The font size of the component title. |
Assistance |
The description to be displayed in the assistance button, when it’s hovered over. |
Width |
The width in pixels or otherwise, following the CSS formatting rules. E.g., 180px. |
Margin |
The margin in pixels or otherwise, following the CSS formatting rules. E.g., 180px. |
Fieldname |
The unique name that identifies the field within the survey, should be alphanumeric and cannot contain whitespace. |
Options |
Options the customers are given to select from, The label is what’s displayed. Value is stored. |
Expression |
This expression takes an array variable. It may be the result of an API call or a JavaScript function, making this component very flexible for displaying filtered results in an automated way, allowing the survey to load values rather than hard-code them. |
Default value |
Insert a default value that you would like the component to display. |
Condition |
A JavaScript expression for displaying the component. The component will show if the expression returns true. |
Mandatory Field |
Enable, if the field must be filled in. A survey validation disposition will not allow dispositioning of the workitem if the field is not filled in. |
On Data Changed Event |
When the data of a component is changed, this triggers a refresh of the list in the Select component. |
Sort Based On |
How to sort the options presented to the customer. The options are: Label, Value, Other. |
Separator
A separator is a horizontal line that may be used to separate components or panels. This is a flexible component that can be used to create solid color boxes as well.
Configuration Fields
The Separator input will have the following configuration fields:
Field Name |
Description |
Component Type |
Separator |
Component Description |
A description of the Separator input. |
Line Size |
Select the thickness of the line. |
Line Color |
Select the color of the line. |
Orientation |
Horizontal or vertical. |
Width |
The width in pixels or otherwise, following the CSS formatting rules. E.g., 180px. |
Height |
The height in pixels or otherwise, following the CSS formatting rules. E.g., 180px. |
Margin |
The margin in pixels or otherwise, following the CSS formatting rules. E.g., 4px, 8px or 0px, 0px, 0px, 4px. |
Condition |
A JavaScript expression for displaying the component. The survey component will show if the expression returns true. |
Stylized Radio Button
Similar to the radio button component, this is used when only one selection is to be made in a field. The difference between this component and the radio button, is that HTML may be used here to style the size and shape of the buttons, rather than adapting to the theme of the survey.
Configuration Fields
The Stylized radio button input will have the following configuration fields:
Field Name |
Description |
Component Type |
Stylized Radio Button |
Component Description |
A description of the Stylized Radio Button. |
Label |
The component title. |
Report Label |
The tag that will identify the field inside the survey reports. |
Font size |
The font size of the component title. |
Assistance |
The description to be displayed in the assistance button, when it’s hovered over. |
Orientation |
The orientation of the radio button. |
Width |
The width in pixels or otherwise, following the CSS formatting rules. E.g., 180px. |
Margin |
The margin in pixels or otherwise, following the CSS formatting rules. E.g., 4px, 8px or 0px, 0px, 0px, 4px. |
List max height |
The maximum height of the list in pixels or otherwise, following the CSS formatting rules. E.g., 180px. |
Fieldname |
The unique name that identifies the field within the survey, should be alphanumeric and cannot contain whitespace. |
Options |
The list of radio button options. The label will be displayed and the value will be passed in the survey result at the end of the workitem. |
Expression |
This expression takes an array variable. It may be the result of an API call or a JavaScript function, making this component very flexible for displaying filtered results in an automated way, allowing the survey to load values rather than hard-code them. |
Default value |
Insert a default value that you would like the component to display. |
Condition |
A JavaScript expression for displaying the component. The component will show if the expression returns true. |
Mandatory Field |
Enable, if the field must be filled in. A survey validation disposition will not allow dispositioning of the workitem if the field is not filled in. |
Text
A text component is used to display direct text. The text field may take HTML and CSS to modify the look and field of the text inside it, as well as taking variables to create dynamic changes in the component. The text component is more a display component than an input component as it does not take any input from the end user.
Configuration Fields
The Text input will have the following configuration fields:
Field Name |
Description |
Component Type |
Text |
Component Description |
A description of the Text input. |
Text |
The text to be displayed. |
Font Size |
The font size of the component. |
Assistance |
The description to be displayed in the assistance button, when it’s hovered over. |
Width |
The width in pixels or otherwise, following the CSS formatting rules. E.g., 180px. |
Margin |
The margin in pixels or otherwise, following the CSS formatting rules. E.g., 4px, 8px or 0px, 0px, 0px, 4px. |
Text Alignment |
The alignment of the text. |
Condition |
A JavaScript expression for displaying the component. The survey component will show if the expression returns true. |
Textarea
A textarea component is a free-form text component which takes input from the end user. This is a free-form box which allows for large amounts of texts to be input. A good example of use for this component is to write descriptions or long pieces of text.
Configuration Fields
The Textarea input will have the following configuration fields:
Field Name |
Description |
Component Type |
Textarea |
Component Description |
A description of the Textarea input. |
Label |
The component title. |
Report Label |
The tag that will identify the field inside the survey reports. |
Font Size |
The font size of the component title. |
Assistance |
The description to be displayed in the assistance button, when it’s hovered over. |
Width |
The width in pixels or otherwise, following the CSS formatting rules. E.g., 180px. |
Height |
The height in pixels or otherwise, following the CSS formatting rules. E.g., 180px. |
Margin |
The margin in pixels or otherwise, following the CSS formatting rules. E.g., 4px, 8px or 0px, 0px, 0px, 4px. |
Fieldname |
The unique name that identifies the field within the survey, should be alphanumeric and cannot contain whitespace. |
Default value |
Insert a default value that you would like the component to display. |
Condition |
A JavaScript expression for displaying the component. The survey component will show if the expression returns true |
Mandatory Field |
Select this toggle if the field must be filled in. A survey validation disposition will not allow dispositioning of the workitem if the field is not filled in. |
Validate Condition on Each Character |
Validates the regex on each character input by the user. For example, if you are asking for only numbers and the user inputs a special character it will immediately warn the user of this. |
Sensitive Data Do Not Store |
If the input field contains sensitive data, enable so the information is not saved. |