Survey Component: Action

Survey Component: Action

Overview

The Action component is a button that can be configured to either execute a REST API or to open a URL in a new window/tab.

A RESTful API is an architectural style for an application program interface (API) that uses HTTP requests to access and use data. That data can be used to GET, PUT, POST and DELETE data types, which refers to the reading, updating, creating and deleting of operations concerning resources.

Configuration Options

Component Type Displays the type of this component.
Label Enter the text to be displayed for the field.
Font Size Set the size of the label.
Height Sets the height of the component in the panel. This value can be entered as a % or in pixels (px)

  • Example: Width can be entered as 50% or as 450px.

Width Sets the width of the component in the panel. This value can be entered as a % or in pixels (px)

  • Example: Width can be entered as 50% or as 450px.

Padding Sets the padding around the button. This value can be entered as a % or in pixels (px)

  • Example: Padding can be entered as 2% or as 5px.

Margin Sets the margins around the inside of the component. The margin can be broken down into 4 sections separated by a space. Each section can be entered as a % or in pixels (px). The 4 sections are the margins for: Top, Right, Bottom, Left.

  • Example: The margin can be entered as 5% 5% 5% 5% or as 10px 10px 10px 10px.

Condition If the condition returns true, then the component will be visible to the user. If condition returns false, then the component will be hidden to the user. If there is no condition specified, the component will always be displayed.

Type Select the action to be performed when the user clicks on this button from the dropdown list.

URL Enter the URL that shall be executed when the user clicks on this button.

  • Note: Depending if the Type is set to SMS or Email ,the campaign selected must have a verified SMS phone number or a valid Email account associated to it or the workitem will fail to go out.

Window Name Enter the name of the window/tab to be used when selecting the type as New Window or New Tab.

Result Variable Enter the variable name to be used to store the result set of the REST API call.

Properties This field is used to pass the body information to the REST API call when inserting or updating data.

  • Click on the ‘+’ to add the data of the list in fields to be sent to the campaign workflow.
  • The 2 columns that will be displayed are:
  • Label Enter the variable name to be passed to the workflow.
  • Value Enter the value that will be stored into the Label to be passed to the workflow. This value can Variables can be used in this field.
  • Clicking on the garbage can icon at the end of the row will remove the specified option form the list.

Headers This field is used to pass the header information to the REST API call.

  • Click on the ‘+’ to add the data of the list in fields to be sent to the campaign workflow.
  • The 2 columns that will be displayed are:
  • Label Enter the variable name to be passed to the workflow.
  • Value Enter the value that will be stored into the Label to be passed to the workflow. Variables can be used in this field.
  • Clicking on the garbage can icon at the end of the row will remove the specified option form the list.

Set Variables On Success Click on the ‘+’ to add the data of the fields selected to save in the database for reporting purposes if the action is successful.

  • Note: For each variable added, an Input field will need to be created with the field name matching the name of the Labels. This field can have a condition of false if it should not be visible to the user.

On Success Select from the dropdown list what should be done if the action is successful.

  • Move to Panel Will prompt to specify the panel to move to upon successfully activating the Chat.

Set Variables On Error Click on the ‘+’ to add the data of the fields selected to save in the database for reporting purposes if the action fails.

  • Note: For each variable added, an Input field will need to be created with the field name matching the name of the Labels. This field can have a condition of false if it should not be visible to the user.

On Error Select from the dropdown list what should be done if the action fails.

  • Move to Panel Will prompt to specify the panel to move to is the action fails.

Save Select save to save the changes made and continue editing.
Save & Close Select save & close to save the changes made and close the survey.
Close Select close to cancel the changes made and close the survey.

When selecting a component that has been placed in a panel, there are 3 icons in the top right corner:

  • Copy The icon on the left will duplicate the component.
  • Move The icon in the middle, picture of a hand, allows you to dragging and drop the component to a different location in the survey.
  • Note Drag the component over the component that you wish it to be under.
  • You will notice as you hover over existing component that they will have a red border. When you release the button on the mouse your component will be placed right below the one with the red border.
  • Delete The icon on the right, picture of a garbage can, will delete the component from the panel.

Click Here to Download Linked File

What’s a Rich Text element?

The rich text element allows you to create and format headings, paragraphs, blockquotes, images, and video all in one place instead of having to add and format them individually. Just double-click and easily create content.

Static and dynamic content editing

A rich text element can be used with static or dynamic content. For static content, just drop it into any page and begin editing. For dynamic content, add a rich text field to any collection and then connect a rich text element to that field in the settings panel. Voila!

How to customize formatting for each rich text

Headings, paragraphs, blockquotes, figures, images, and figure captions can all be styled after a class is added to the rich text element using the "When inside of" nested selector system.