Skip to main content

FV Kinesis Support

All the topics, resources needed for FV Kinesis.

FocusVision Knowledge Base

Community Components

This page is currently being updated for our Panel v4.0 release.

Components are modules that allow you to create and display specific types of content within your Community Pages. There are several types of component modules available, and each component will have a set of configuration options related to how that module works.

1:  Component Modules

Below is a list of available component modules, and configuration options associated with each.

1.1:  Article

The Article module allows you to create HTML and text content for display in your Community:

 

Configuration options include:

  • Title: Localized component title.
  • Name: Component title, for internal use only.
  • Description: Component description, for internal use only.
  • Article: Drop down to select which article gets displayed in this component.
  • Display title: Set whether to display the title or not.

1.2:  Surveys

The Available Surveys module displays campaign links for surveys made available through the Panel Campaign Manager. The tables for each survey type (Survey, Diary, Profiles) can be controlled via placeholders in the module:

%TABLE:SURVEYS%
%TABLE:DIARY%
%TABLE:PROFILER%

Other configuration options for this module include:

  • Number of Surveys to Show: Limit the number of available surveys displayed.
  • Show Name Column: Display the name of the available survey in a table column.
  • Show Description Column: Display the survey description from Project Settings in a table column.
  • Show Reward Column: Display the Redemption Reward assigned to a survey in a table column.
  • Show Received Column: Display data on a received redemption for a survey in a table column.
  • Show Expiration Column: Display the survey expiration data (specified in the Panel Campaign Manager in a table column.

1.3:  Completed Surveys

The Completed Surveys module displays details on surveys completed by the panelist. The Completed Surveys table can be controlled by adding the following placeholder:

%TABLE%

Other configuration options for this module include:

  • Show Project Column: Display the name of the available survey in a table column.
  • Show Description Column: Display the survey description from Project Settings in a table column.
  • Show Status Column: Display final status for each completed survey in a table column.
  • Show Time Column: Display timestamp for each completed survey in a table column.
  • Show Points Column: Display the Redemption Reward points rewarded for the survey.
  • Number of Completed Surveys to Show: Limit the number of completed surveys displayed.

1.4:  Refer a Friend

The Refer a Friend module allows the panelist to email a Community invitation to others for a point reward. This can be done via a form located in the Community, or through a Facebook iFrame that lets the panelist contact recommend the Community to individuals on their Friends List. To use and format these options, add the following placeholders to your module:

%FORM%
%FACEBOOK%

Note: you must have a valid Facebook admin in the Community Settings to use the Facebook Refer A Friend feature.

  • Points Awarded per Referral: Assigns a point reward for each successful panelist referral. Points are only rewarded once a recruit has confirmed their double opt-in.
  • Facebook Recruitment Source: Allows you to specify a Recruitment Source for Facebook referrals. This lets the Panel Manager track and report on the referral counts in the Recruitment Statistics tool.

1.5:  Reset Password

This module allows the panelist to reset their Community password. Passwords must be reset via the panelist's email account. To add a Reset Form to this module, use the following placeholder:

%FORM%

1.6:  Rewards

The Rewards module displays a table of rewards history (points received and points used) and it can also display a form for users redeem points. Each tab contains localized values for each language currently being used in the panel and community.

  • Table note column title: Note column header, used for the rewards history table note header.
  • Table points column title: Points column header, used for the rewards history table points header.
  • Table date column title: Date column header, used for the rewards history table date header.
  • Form button label: The label that appears in the submit button.
  • Form type label: The label that appears before the type field.
  • Form available label: The label that appears before the available section.
  • Form unavailable label: The label that appears before the unavailable section.
  • Table no records message: The message displayed if there is no rewards history.
  • Request success message: The message displayed when a redemption request has successfully been sent.
  • Request failure message: The message displayed when a redemption request has failed to be sent.
  • Content: HTML content to display any custom content as well as the redemption submission form and rewards history table. Valid placeholders:
%POINTS% - Display the points available for redeeming.
%FROM% - Display the submission form.
%TABLE% - Display the rewards history table.

Settings

  • Name: Module name, for internal use only.
  • Description: Module description, for internal use only.
  • Number of records to show in table: Limit the number of rewards history items to display in the table.
  • Show date column: Show or hide the date column.
  • Show note column: Show or hide the note column.
  • Show points column: Show or hide the points column.

1.7:  Resend Confirmation

The Resend confirmation module, displays a form for users to request a new confirmation be sent to them. Each tab contains localized values for each language currently being used in the panel and community.

  • Form email label: The label that appears before the email field.
  • Form button label: The label that appears in the submit button.
  • Email sent message: Message displayed when the request has successfully been submitted. %EMAIL% placeholder can be used to display the currently submitted email address.
  • Email failed message: Message displayed when the request has failed. %EMAIL% placeholder can be used to display the currently submitted email address.
  • Invalid email message: Message displayed if the user tried to submit an invalid email address, a value that is not an email.
  • Content: HTML content to display any custom content as well as the request form itself. Valid placeholders:
%FROM% - Display the resent confirmation request form.

Settings

  • Name: Module name, for internal use only.
  • Description: Module description, for internal use only.

1.8:  Unsubscribe

The Unsubscribe module provides a way for a panelist to unsubscribe from the community. It provides a two step method and ask them to confirm before they are actually unsubscribed. Each tab contains localized values for each language currently being used in the panel and community.


Step 1

  • Form message: The step one message explains the unsubscribe process and how to start.
  • Form button label: Start unsubscribe button label.

Step 2

  • Form message: The step two message has them confirm they want to unsubscribe before continuing.
  • From button label: Confirm unsubscribe button label.

 

  • Request success message: Message displayed when unsubscribe request was successful.
  • Request failure message: Message displayed when unsubscribe request failed.
  • Content: HTML content to display any custom content and the unsubscribe submission form. Valid placeholders:
%FROM% - Display the unsubscribe form.
  • Name: Module name, for internal use only.
  • Description: Module description, for internal use only.

1.9:  Contact Us

The Contact Us module provides a form for users to get in contact with your company directly from the community site. Each tab contains localized values for each language in use in the panel and community.

  • Error message failed: The message displayed if the message failed to send.
  • Error invalid email: The message displayed if the user entered an invalid email address.
  • Error empty field: The message displayed if the user did not enter all of the required fields.
  • Success message sent: The message displayed if the message was successfully sent.
  • Form name label: Label that appears before the name field.
  • Form email label: Label that appears before the email field.
  • Form subject label: Label that appears before the subject field.
  • Form message label: Label that appears before the message field.
  • Form send label: Label that appears in the send button.
  • Content: Custom HTML content. In order to display the form use the %FORM% placeholder.

Settings

  • Name: Module name, for internal use only.
  • Description: Module description, for internal use only.
  • Send to email: The email address submitted messages should be sent to.
  • Send to name: The name submitted messages should be addressed to.

1.10:  Profile

The Profile component displays the information such as avatar image, screen name, preferred time zone, preferred date time format, email and preferred language about the user logged in. Each tab contains localized values for each language currently being used in the panel and community.

  • Title: The label that appears on the top of profile view.
  • Avatar label: The label that appears for the avatar image.
  • Screen name label: The label that appears for the screen name of the user.
  • Time zone label: The label that appears for the time zone.
  • Date / time format label: The label that appears for the date / time format
  • Email address label: The label that appears for the email address.
  • Password label: The label that appears for the password.
  • Confirm password label: The label that appears for the confirm password.
  • Language preference label: The label that appears for the language preference.
  • Edit avatar label: The text that appears on the action that allows to edit the avatar.
  • No avatar selected message: The text that appears when there is no avatar in use.
  • Profile saved message: The text that appears after the profile is saved.
  • Contact frequency label: The label that appears for the contact frequency dropdowns.
  • SMS times label: The label that appears for the sms contact time dropdowns.
  • Content: HTML content to display any custom content as well as the submission form itself. Valid placeholders:
%PROFILE_AVATAR_IMAGE% - Display the avatar image of the user.
%PROFILE_SCREEN_NAME% - Display the screen name of the user.
%PROFILE_TIME_ZONE% - Display the time zone of the user.
%PROFILE_DATE_TIME_FORMAT% - Display the date / time format of the user.
%PROFILE_EMAIL% - Display the email of the user.
%PROFILE_PASSWORD% - Display the password field of the user.
%PROFILE_LANGUAGE% - Display the preferred language of the user.
%PROFILE_SUBSCRIBED% - Display the panelist subscription status.
%PROFILE_MESSAGE_LIMIT% - Allow the panelist to change his contact frequencies (invitations per day/week or unlimited).
%PROFILE_MESSAGE_TIMES% - Allow the panelist to control when he is willing to receive SMS Invitations.

Settings

  • Name: Module name, for internal use only.
  • Description: Module description, for internal use only.

1.11:  Discussion

The Discussion component displays the list of discussion threads and allows the users and moderators to create discussions and reply on the discussions. Each tab contains localized values for each language currently being used in the panel and community.

  • List view title: The label that appears on the top of discussion list view.
  • Back action label: The label that appears on the action on which allows the users to go back to the discussion list view.
  • Title label: The label that appears in the create discussion view. The title label of the discussion content.
  • Content label: The label that appears in the create discussion view. The content label of the discussion.
  • Create view title: The label that appears on the top of create discussion view.
  • Error empty title: The text that appears on submitting an empty discussion title on create discussion view.
  • Error empty content: The text that appears on submitting an empty discussion content on create discussion view.
  • Show action label: The label that appears on the action on which allows the users to show more discussions in the discussion list view.
  • Display no text: The text that appears when there are no availabel discussions to display on create discussion view.
  • Media label: The label that appears in the create discussion view. The image file upload label for the discussion content.
  • Comment action label: The label that appears in the reply of the discussion view.
  • Content: HTML content to display any custom content as well as the submission form itself. Valid placeholders:
%DISCUSSION% - Display the discussion view.

Settings

  • Name: Module name, for internal use only.
  • Description: Module description, for internal use only.
  • Maximum number of posts per page: The number of posts to be displayed to the user in the discussion list view.
  • Hide posts after this many days: The number of days after the posts should not be shown in the discussion.
  • Users can see each other's posts: Allows the user to see other user created post.
  • Only moderators can start new threads: Allows only the moderator to create new post thread.
  • All new threads are moderated: Allows moderator to approve a thread before publishing.
  • All posts are moderated: Allows moderator to approve a post before publishing.
  • Panelist can upload media: Allows users to attach images and videos to posts.
  • All posts involving media are moderated: Allows moderator to approve a media post before publishing.
  • Display new posts first: Allows the posts to be shown in the order of newly created first in the discussion list view.
  • Display discussion list view title: Allows to show the title in the discussion list view.
  • Display create view title: Allows to show the title in the create discussion view.
  • Require comment to see other comments: Requires the panelist to comment on a thread before they can see other panelist's comments.

1.12:  Reset Password Confirm

The Reset Password Confirm module displays a form that allows panelist to reset their password. Panelist can only view this page with a valid link sent to them by requesting a password reset using the Reset password module. If a panelist tries to use this module without a link sent to them, they will get an invalid link warning and no form will appear. Each tab contains localized values for each language currently being used in the panel and community.

  • New password: The label that appears before the new password field.
  • Confirm new password: The label that appears before the confirm new password field.
  • Reset password button: The label that appears in the reset password/submit button.
  • Link expired message: Message appears if the panelist is trying to use the module without using a valid link sent to them, or if the emailed link has expired.
  • Success message: Message appears when the reset was successful. %AUTHLINK% placeholder can be used to display a link to the login page. Example:
<a href="%AUTHLINK%">Click here</a> to login.
  • Error message: Message appears if the password of confirm fields are empty, if they do not match, or if the password is less than 6 characters.
  • Content: HTML content to display any custom content as well as the reset form itself. Valid placeholders:
%FROM% - Display the reset form.

Settings

  • Name: Module name, for internal use only.
  • Description: Module description, for internal use only.