This article provides a comprehensive guide on creating and editing panel pages in the EFS Panel. It covers various function modules, their options, and how to configure them for optimal panel management.
Before you start
If the website you are editing contains several language versions, please note:
- There is only a one-page structure available for each website, which is used by all language versions. If you create a new page it will be incorporated in all language versions.
- You can configure a page differently to some extent in the various language versions.
- Content and functions on a certain page can differ between language versions.
- Each language version has its own set of templates, meaning that you can link a page to other templates in each language version.
- A page’s online and offline status can differ in different language versions. In particular, when publishing a new page, the publication always only refers to the current language version.
Managing Pages
Page Overview
To view the pages of a website, open it in the Website editor, then change to the Pages tab.
- If you create more than one language version or even set up several websites, there will be a set of pages for each website; page configuration and content, however, may differ between language versions. You can use the selection function in the upper part of the dialog to switch from the current language version to the other versions.
- The tree view on the left-hand shows all pages. The tree arrangement reflects the external navigation structure.
- Clicking on a page title opens its corresponding edit dialog on the right hand.
- Traffic light: publishing status of the page.
- i: The links and the wildcard used to address the page.
- Copy page: The page is copied, and a new page name has to be entered.
- Delete page: The page and all its subpages in all language versions will be deleted following a confirmation prompt.
- + Page: Opens the dialog where you can enter the data for a new page.
- Search: Opens a list of all pages along with detailed information (status, page identifier, internal page name, HTML title, URL alias) and a search function. The actions in the drop-down list below the overview allow you to change several selected pages en bloc.
- Delete selected pages: The pages and all their subpages in all language versions will be deleted following a confirmation prompt.
- Publish selected pages: The pages are published, i.e. they are available both in the working version and the online version.
- Set selected pages offline: The selected pages are no longer available online.
Editing Pages
Edit Dialog
Open any page, for example, “Home”.
Actions
Actions can be carried out with the help of buttons and drop-down lists in the head section:
- + Page module: Allows to create new modules.
- Save:
- Save: Saves the page. It is subsequently available in the working version. Please note: In the publicly accessible version, the page is only available once it has been published.
- Save & publish page: The page is published. This means it is not only available in the working version but also in the online version.
- Save & Set page offline: The page is no longer accessible online.
- Preview: Various preview modes can be opened in a new browser tab.
- Offline version: The current working version of the page, i.e. the version you usually prepare changes in.
- Direct editing: In this modus, you can make changes in the preview itself.
- Online version: The page version that can be accessed by visitors.
Tabs
Further functions for editing page content and configuration are located on the tabs:
- Page modules: This tab is used to create and edit the page modules.
- Page configuration: Contains configuration option.
- Modules from other pages: Referenced modules.
Editing Options for Page Modules in Detail
Page content and functions can be set on the Page Modules tab, which is usually automatically opened first.
The central part of the tab contains the modules already created for the page.
You can either display only the title or all module properties:
- [+], [-]: These icons allow you to open and close individual modules.
- Move: You can use the arrow icons to change the order of the modules.
- Edit page module: From EFS 10.4, you can find the reference name, page module title, and module template below this icon.
- Delete page module: The respective module is deleted after a confirmation prompt.
Page Configuration in Detail
You can define page properties, such as position in the navigation and access rights, in the Page Configuration tab. The tables explain the configuration options.
Language-independent configuration options
| Field | Meaning |
|---|---|
| Page identifier | Page identifier: The page identifier is used to uniquely identify the page within the system, regardless of language settings. It is particularly used in the browser address bar and for internal links. Therefore it should not contain any blank spaces or special characters. |
| Parent page | You can change the level of the page in the page tree and the navigation. |
| Position | You can change the position of the page in the page tree and the navigation. |
Language-specific configuration options
| Field | Meaning |
|---|---|
| Internal page name | Name of the page in the tree view. Can be defined individually for each language version. |
| Main template | Template responsible for the overall structure of the page. Usually “main_default”. |
| Positioning template | If several content modules have been defined for a page you can define their location with the help of the positioning template. |
| HTML title | The HTML title is the name of the page, which is displayed in the browser header. In addition, the HTML title is also used as a label in the website navigation for the link to this page. |
| Access control | You can restrict access to the page. Select one of the following options:Public: All panel visitors can see the page.All logged-in panelists: All logged-in panelists can see the page.For logged-in panelists of a panel group only: If you choose this option, a drop-down list is displayed, from which you can select a certain panel group. Only members of the selected group can see the page. |
| Show in navigation | Depending on the setting the page is either shown or hidden in the navigation. The following options are available:NeverAlwaysOnly when logged inOnly when logged outOnly if access is possible |
| Meta keywords | Key terms under which search engines are to find the page. |
| URL alias | Optionally definable page name is used for the URL of the page in the current language version. Language-specific adjustment of page URLs is particularly important for search engine optimization. |
| From EFS 10.5: Metadata (CSS classes) | TIVIAN customizing feature for Responsive layout websites. |
| From EFS 10.5: External link | TIVIAN customizing feature for Responsive layout websites. |
| From EFS 10.5: Show breadcrumb | TIVIAN customizing feature for Responsive layout websites. |
Referencing Page Modules from Multiple Pages
By creating appropriate page modules, you can easily compile the desired contents and functions for each panel page. However, if an element such as a news list, for example, is to be displayed on multiple pages, creating the respective module on every single page would be very time-consuming. The updating of changes would also involve considerable effort: every copy of the page module would have to be adjusted manually.
Therefore, once you have created a page module, EFS allows you to reference it from other pages as well: the modules are created only once, and changes are made only once, but the contents will be visible on all desired pages.
Example
In the example shown above, the “Latest News”, the display of the currently logged-in panelists, and the list of blogs are referenced page modules. In the website editor, they are located on a dedicated page “GLOBAL”.
Please note: For many page module types, referencing does not make sense. Therefore the referencing feature is only available for selected page module types. For an up-to-date list, please see the Modules from Other Pages tab in the editing dialog of the respective page.
Additional modules can be made available for reference. If this is necessary, please contact support.
Work Steps
Referencing page modules from multiple pages requires three steps:
- Deciding where the global page modules should be placed in the overall structure and modifying the main template accordingly
- Creating page modules
- Referencing page modules from the desired pages
Defining the Position of Global Page Modules
First, you have to decide at which position the global page modules are to be displayed. Then you have to modify the main template accordingly.
In the standard panel, for example, the following code is used to insert various page modules on the right-hand side between the login section and the quick poll, as shown in the example above:
{* START GLOBALS *}{if $global_page_contents}{foreach from=$global_page_contents item=s key=k}<div class="gpRightColBox">{$s}</div>{/foreach}{/if}</div>{/foreach}{* END GLOBALS *}
This code checks whether there are any page modules referenced from the currently opened page. The wildcard used for addressing these modules is $global_page_contents. If modules have been referenced, it will be checked whether the panelist is logged in: if so, the contents of these modules will be displayed.
Of course, you can also insert the referenced page modules at other positions.
Creating Page Modules
Create the desired page modules.
- They can be created as usual on any page of the CMS.
- Optionally, you can also create the repeatedly used page modules on a dedicated page set up for this purpose. This is useful, for example, if these modules do not fill the content area of a normal page but are displayed in special areas on the page margins, as in the standard panel shown above.
Referencing Page Modules from the Desired Pages
- Go to the page from where page modules are to be referenced.
- Open the Modules from the Other Pages tab.
- Tick the “Select” checkboxes for those page modules that are to be displayed.
- Confirm by clicking on Save. A reference is now established between the page and the selected page module.
- Repeat these steps for all pages where the page modules are to be displayed.
A Detailed Look at Modules
This Chapter will take a detailed look at the modules used to compile panel pages.
→ → Overview of the Wildcards ← ←
Content Module: Headline + Text
The most frequently used module is certainly the “Headline + text” content module. It is used to create page sections that are for informational purposes only. One example of such an information text can be found on the About Us page of the standard panel.
In the standard panel, you can use the “cont_headline_text” template to change the appearance of the “Headline + text” module.
Options
The following options are available:
| Option | Meaning | Standard panel „About us“ page |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | about_us |
| Page module title | Name of the module in the page’s module overview | About us |
| Module template | Module-specific template that controls how data provided by the module are displayed. | cont_headline_text |
| Headline | This field contains the section headline. | About us |
| Text | Enter the body text of the section in this field. E.g. you can use HTML and CSS to format the text, you can enter images or links. |
Function Module: Lost Account Functionality
The “Lost account” module newly introduced in EFS 10.4 creates a form via which panelists can ask for their forgotten account name.
EFS Panel provides various design options:
- You can select the mail template used to deliver the account name.
- Once the account name has been successfully delivered a confirmation message will be displayed.
Optionally, account and password can be used for authentication instead of e-mail and password
Options
The “Lost account” function module offers the following options.
| Option | Meaning | Standard panel “Password recover” page |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | module_password_recover_3 |
| Page module title | Name of the module in the page’s module overview. | Lost account |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_lostaccount |
| Mail template for password recovery mail | Mail template used for password delivery.The “Password recovery” mail templates are available. Please make sure that the selected template contains all necessary wildcards. | |
| Hint for e-mail address | ||
| Message upon successful delivery | This text is displayed once the mail has been sent. |
Function Module: Master Data Category Overview
The function module „Master data categories list“ allows you to display one or more master data categories. This may be of use, for example, if you offer separate „Change data“ forms for each category. Links to corresponding sections of the master data survey may also be displayed in such a list. The module is controlled via the “func_md_view” template. If this template is not available in your installation, you can revert to the „masterdata_categories“ template in the template library.
EFS Panel provides various design options:
- You can select the desired master data categories.
- The categories can be relabeled. This is particularly important in multilingual panels.
- Several sort order options are available.
Options
The “Master data categories list” function module offers the following options.
| Option | Meaning | Standard panel |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | |
| Page module title | Name of the module in the page’s module overview | |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_md_view |
| Master data category | You can choose from the categories created in the Panel → Master data → Master data categories menu.You can enter an alternative label for each category. | |
| Directory for file selection | All asset library directories of the respective panel installation are available. | |
| Sort master data categories by | Possible criteria:Defined sort orderAlphabeticalPossible sort order:AscendingDescending |
Function Module: Display of Private Messages
When using the community function “Messages from panelists to panelists”, the function module “Display of private messages” allows you to create different lists of received messages:
- a message overview, e.g. on the personalized homepage.
- a detailed list of the received messages.
Which list is created depends on the selected template (“func_messages_light”, “func_messages”).
Options
The “Display of private messages” function module offers the following options.
| Option | Meaning | Standard panel |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | |
| Page module title | Name of the module in the page’s module overview | |
| Module template | Module-specific template controlling the display of the data provided by the module.Depending on what you wish to display, you select one of the following templates:func_messages_light: Message overview, e.g. on the personalized homepage.func_messages: Detailed list of the received messages. | |
| Maximum number of posts displayed | Limits the length of the display per page. Excess posts are displayed on subsequent pages. | |
| Sort posts by date | Possible sort order:AscendingDescending |
Function Module: Picture Upload for Panelist Profile
With the function module “Picture upload for panelist profile,” you can set up an upload form that enables the panelists to upload two profile images.
In the standard panel, the appearance of the form is determined by the “func_profile_picture” template.
Options
The following setting options are available:
| Option | Meaning | Standard panel |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | My_picture |
| Page module title | Name of the module in the page’s module overview | My picture |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_profile_picture |
| Allow upload of picture 1 | Activates an upload form for the first image. | |
| Allow upload of picture 2 | Activates an upload form for the second image. | |
| Maximum file size for profile pictures (in kb) | Maximum value for the image size.Please mind: the size of the thumbnails of profile images can be changed in the Website → Panel websites → {Selected language version} menu on the Detail configuration tab | |
| Message upon successful change | This text is displayed after successfully uploading an image. |
Function Module: Chat
The “Chat” function module allows you to set up chats.
In the standard panel, the appearance of the form is determined by the “func_chat” template.
Options
The “Chat” function module provides the following setting options:
| Option | Meaning | Standard panel |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | Chat |
| Page module title | Name of the module in the page’s module overview | Chat |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_chat |
| Assigned section | All chats of the respective language versions are available. |
Function Module: Change Data
The “Change data” function module allows you to generate a form where panelists can subsequently edit the data they entered upon registration. In the standard panel, you can find this form on the Change details page, for example. You can determine which data can be edited in this form using a separate GUI.
You can use the “func_change_details” template to change the appearance of the “Change data” form.
Options
The following options are available:
| Option | Wildcard | Meaning | Standard panel “Change details” page |
|---|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | change_details | |
| Page module title | Name of the module in the page’s module overview | Change details | |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_change_details | |
| Form configuration | In this field, you choose the appropriate form | Change data form | |
| A new e-mail address must be entered twice (for confirmation). | An input field in which the new email address must be confirmed is displayed. | yes | |
| The new password must be entered twice (for confirmation). | An input field in which the new password must be confirmed is displayed. | yes | |
| Mail template for confirming change of e-mail address | The selected mail template is sent to the panelist’s new e-mail address, to validate the changes.The “Standard mail” mail templates are available.The data required for verification should be inserted into the mail template using wildcards. Use #mail_validation_code# to insert the actual verification code; by using #mail_validation_code_complete# you can create a complete clickable linkGET Paramater: validation_code | Change email confirm | |
| Message upon successful change of data | {$change_data.success_message} | In this field, you should enter the message to be displayed once data have been successfully changed. | Your data was changed successfully. |
Function Module: Discussion
The “Discussion” function module allows to set up discussions.
In the standard panel, the appearance of the form is determined by the “func_discussion” template.
Options
The “Discussion” function module provides the following setting options:
| Option | Meaning | Standard panel |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | Discussion |
| Page module title | Name of the module in the page’s module overview | Discussion |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_discussion |
| Assigned section | All discussions of the respective language versions are available. | |
| Message title is optional | Activates an additional input field where the participants in the discussion can enter a subject header for their posts. | |
| Maximum number of posts displayed | Limits the length of the display. There is no page break, excess posts are not displayed. | |
| Sort posts by date | Possible sort order:AscendingDescending |
Function Module: Downloads
The “Downloads” function module allows you to set up download lists.
In the standard panel, the appearance of the form is determined by the “func_download” template.
Options
The “Downloads” function module provides the following setting options:
| Option | Meaning | Standard panel |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | Download |
| Page module title | Name of the module in the page’s module overview | Download |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_download |
| Assigned section | All download sections of the respective language version are available. | |
| Sort the order of files | Possible sorting criteria:DateTitle# AccessesPossible sort order:AscendingDescending | |
| Maximum number of files displayed | Limits the length of the display per page. Excess posts are displayed on subsequent pages. | |
| Maximum thumbnail size (pixels) | If you want thumbnails to be displayed, specify a maximum size. If the field is left blank, no thumbnails will be displayed. Up to 300 pixels are possible. |
Function Module: Change E-Mail
It is essential for panel operation that panelists’ e-mail addresses are up-to-date. EFS Panel therefore provides a module that allows you to change e-mail addresses with the help of a form. In the standard panel, you can find such a form on the Change details → Change e-mail page, for example
EFS Panel provides various design options:
- In addition to the input field for the new e-mail address, you can optionally query the old address or request confirmation of the new e-mail address. Both options are used in the standard panel.
- By changing their e-mail address panelists trigger verification of their e-mail address in the standard panel, i.e. they are sent a confirmation mail.
- Once the change has been saved a message informs the panelists that they must confirm a verification mail to complete the process.
In the standard panel, you can use the “func_change_email” template to change the appearance of the change form and change confirmation.
Options
The “Change e-mail” function module offers the following options.
| Option | Wildcard | Meaning | Standard panel “Change email” page |
|---|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | change_email | |
| Page module title | Name of the module in the page’s module overview | Change email | |
| Module template | Module-specific template that controls how data provided by the module are displayed. | ||
| The previous e-mail address must be entered for confirmation? | An input field in which the old email address must be entered is displayed. | ||
| New e-mail address must be entered twice (for confirmation)? | An input field in which the new email address must be confirmed is displayed. | ||
| Mail template for confirming change of e-mail address | The selected mail template is sent to the panelist’s new e-mail address, to verify the changes.The “Standard mail” mail templates are available.The data required for verification should be inserted into the mail template using wildcards. Use #mail_validation_code# to insert the actual verification code; by using #mail_validation_code_complete# you can create a complete clickable link. | ||
| Message upon successful change | This text is displayed once the panelists have clicked on the verification link in the confirmation mail. |
Function Module: FAQ List
The “FAQ list” function module allows you to embed an FAQ list in a panel page. In the standard panel, such a list can be found for example on the How it works → FAQ page. The contents of the FAQ list are maintained via a separate GUI.
EFS Panel provides various design options:
- You can optionally limit the number of FAQ items to be displayed.
- You can create different FAQ lists for each language version and place them on different panel pages.
- You can sort items according to different criteria.
You can use the “func_faq” template to change the appearance of the FAQ. In the standard configuration, the questions are displayed; users can display the full text of the FAQ item by clicking on the [+] icon.
Options
The “FAQ list” function module offers the following options.
| Option | Wildcard | Standard panel “FAQ” page |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | FAQ |
| Page module title | Name of the module in the page’s module overview | FAQ |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_faq |
| Maximum number of entries to be displayed | You can limit the length of the list to a predefined number of FAQ items. This can be particularly useful if you have entered a large number of FAQ items.If you do not wish to limit the number of FAQ items to be displayed, enter “0” or delete the existing value. | 2 |
| Show FAQs from the list | The FAQ list from which the items are to be included. In the standard panel, only the “main” list is available. | |
| Sort order for items | Possible criteria:Defined sort orderQuestionAnswerAuthorPossible sort order:AscendingDescending | Defined sort order – Ascending |
Function Module: Form for Text Search in Modules
Text search is a custom feature that can be made available optionally for EFS 9.1 or higher.
This function module allows to set up a form for text search.
| Option | Meaning | Default |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | |
| Page module title | Name of the module in the page’s module overview | |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_search |
| Template for media display | In this field, you can enter the template that controls how uploaded files are output.The field should be kept empty for text search. | |
| Display results using | In this field, you specify the search page which is used to display the results. |
Function Module: Forum
You can use the “Forum” module to embed a forum in a panel page. The module is controlled by the “func_forum” template.
Options
The “Forum” function module offers the following options.
| Option | Meaning | Standard panel |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | Forum |
| Page module title | Name of the module in the page’s module overview | Forum |
| Module template | Module-specific template that controls how data provided by the module are displayed. | |
| Template for media display | In this field, you can enter the template that controls how uploaded files are output.Images are usually displayed. A download link is available for other file types. | tpl_media_display |
| Assigned forum | All forums for the respective language versions are available. | |
| Display mode | Available options are:Chronological, newest posts on topChronological, oldest posts on topOnly usable in the context of special programming: Threaded: Posts are displayed in such a way that clearly shows a hierarchy of main and side discussions. Please mind that this option requires special programming: The hierarchic display is not part of the standard scope. | |
| Topic sort order | Using the drop-down lists, you can define in which order the topics of a forum should be displayed on the website.Possible criteria:Topic titleDisplayed date of creationDate of last postNumber of postsPossible sort order:AscendingDescending | |
| Thread sort order | Using the drop-down lists, you can define in which order the threads should be displayed.Possible criteria:Thread titleNumber of postsDate of last postDate of creationFrom EFS 10.3: Number of ratingsFrom EFS 10.3: Average ratingPossible sort order:AscendingDescending | |
| From EFS 10.3: Panelists are allowed to modify the thread-sorting | If the option is activated, the thread sorting is displayed on the website. | Deactivated |
| Maximum number of posts displayed per page | Limits the length of the display per page. Excess posts are displayed on the following pages. | |
| From EFS 10.1: Maximum number of threads displayed per page | Limits the length of the display per page. Excess threads are displayed on the following pages.In the external view, the pagination feature will be displayed as soon as the number of threads exceeds the limit. | |
| Allow anonymous posts | You can permit anonymous posting.If the feature is activated, a checkbox „Anonymous post“ will be displayed on the website. If panelists mark the respective checkbox before submitting their posts, their profiles will not be linked – even if they have explicitly activated the sharing of profile data. To prevent abuse, it will of course be logged internally who authored such anonymous posts, and moderators can access this information in the admin area. | Deactivated |
| Mail template for thread subscription mail | The subscription feature is activated by selecting a mail template that contains the accompanying text for the notification.Available are templates of the “standard mail” type.The following wildcards can be used:#subscription_title#: Title of the section#subscription_post_title#: Title of the new post#subscription_post_link#: Link to post#subscription_unsubscribe#: Link that allows to unsubscribeOnce the feature is activated, Subscribe-/Unsubscribe links will be displayed in the forum threads.When panelists have subscribed to a forum thread they will receive an e-mail notification whenever a new post has been added.Panelists with panel status “inactive” (i.e. usually panelists who left the panel) will not get e-mails. | |
| Allow editing | You can decide for yourself whether you want to allow the members of your community to subsequently edit their forum posts. You can choose among the following options:Always allow editingAllow editing for 20 minutes after creationDisallow editing completelyWhen editing is enabled, the panelists will see an Edit icon in their posts.Moderators and other community members can identify subsequently edited posts via the date of the last change, which is displayed in the post itself on the website and in the list of posts in the admin area. | |
| Header for quotes | Where panelists use the “Reply w/ quote” function, the text they are replying to is displayed as a quote in their post.In this field, you can determine whether, and if so, which information is to be displayed in the header line of the quote.In doing so you can use the following wildcards:#poster_account#: The quoted panelist’s account#poster_firstname#: The quoted panelist’s first name#poster_name#: The quoted panelist’s last name#poster_email#: The quoted panelist’s e-mail address#post_date#: Date the quoted post was created#post_title#: Title of the quoted postExample:On #post_date# #poster_firstname# #poster_name”:is filled with:On January 1, 2008, John Doe wrote: | |
| Default Title of replies | When a panelist is answering a post, a default text can be inserted as the title. In this field, you can define this text. You can use the same wildcards as in “Header for quotes”. | |
| Style for quotes | You can decide how quotes should be displayed:Display quotes with leading > symbol: Word wraps are inserted into the quoted text, each line starting with a >.Display quotes in nested div elements: The quoted text will be enclosed by a div named “quote-main”. Via the CSS file (usually the “css_default” included), you can define how the quotes will be displayed. | |
| Maximum width of thumbnails | Maximum width in pixels of the thumbnails for the images uploaded by the panelists or the moderators in Pixels. | 100 |
| Maximum height of thumbnails | Maximum height in pixels of the thumbnails for the uploaded images, see above. | 100 |
| Maximum width of scaled images | Maximum width in pixels.Please mind: A change in this option affects only newly uploaded images. Existing images are not modified retroactively. | |
| Maximum height of scaled images | Maximum height in pixels, see above. |
Function Module: Tell-A-Friend
The “Tell-a-friend” function module allows you to generate a form that panelists can use to invite friends to participate in the panel as part of a campaign. In the standard panel, you can find such a form on the My Home → Tell-a-friend page, for example.
The campaigns themselves are created and maintained via a separate GUI.
In the standard panel, you can use the “func_tell_a_friend” template to change the appearance of the “Tell-a-friend” module.
Options
The “Tell-a-friend” function module offers the following options.
| Option | Meaning | Standard panel “Tell-a-friend” page |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | tell_a_friend |
| Page module title | Name of the module in the page’s module overview | Tell-a-friend |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_tell_a_friend |
| Maximum number of campaigns displayed | You can limit the length of the list to a predefined number of campaigns. This can be particularly useful if you have a large number of campaigns.If you do not wish to limit the number of campaigns to be displayed, enter “0” or delete the existing value. | 5 |
| Sort campaigns by | Possible criteria:Campaign startCampaign endCampaign titleBonus points for inviting friendsPossible sort order:AscendingDescending | Kampagnenstart – aufsteigend |
| Message displayed after successful dispatch | This text is displayed once the invitation mail has been sent. | ready! |
Function Module: Contact Form
The “Contact form” function module allows you to create a form that can be used by panel visitors and panelists to directly contact the panel operator. In the standard panel, you can find such a form on the Contact Us page, for example.
EFS Panel provides various design options:
- The form is status-dependent: Whereas normal visitors are required to enter their e-mail address and name, this information is automatically determined for logged-in panelists.
- After sending the contact request a confirmation message will be displayed.
- Optionally, you can offer users various topics to choose from, to which they can assign their inquiry.
- You can have the requests sent to different e-mail addresses depending on the topic. This allows you to directly sort requests into different inboxes by topic or have them sent to specially qualified staff members.
- In addition to the details of the person who sent the request, the delivered emails contain background information, such as information on their browser settings, IP, and referrer.
- You can modify the standard text elements of the mail.
You can use the “func_contact_form” template to change the appearance of the contact form and confirmation page.
Options
The “Contact form” function module offers the following options.
| Option | Meaning | Standard panel “Contact us” page |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | contact |
| Page module title | Name of the module in the page’s module overview | Contact form |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_contact_form |
| Mail sender | E-mail address from which the requests are sent. You can choose between two options:You can enter a fixed e-mail address. Please make sure that the mail account exists on a correctly configured mail server. Otherwise, the e-mails may be erroneously classified as spam.Alternatively, use the wildcard #u_email# to insert the e-mail address of the panelist resp. the e-mail entered into the contact form. | |
| Use CAPTCHA image | From EFS 10.0, you can optionally have a CAPTCHA image displayed.It is displayed to all unknown visitors to the page.The CAPTCHA image will never be displayed to logged-in panelists. Their contact data are dispatched with the contact mail, therefore they are usually not tempted to spam.Please note: If you have activated CAPTCHA, visually impaired users with a screen reader can no longer register. | no |
| Message upon successful change | This text is displayed on the contact page once the mail has been sent. | We have received your email and will process it as soon as possible. |
| One or optionally more feedback topics and corresponding recipient address | See the following section. |
Adding topics and corresponding recipients
You can offer users one or more topics to which they can assign their mail. Internally, each of these topics is often assigned to an individual recipient – usually a member of the panel operator’s staff specially qualified for the topic. Alternatively, you can have the e-mails sent to an inbox where they are filtered by topic.
To do so, enter the topic and the recipient in the input fields in the “Add new feedback topic” section and click on Save. Repeat these steps for each additional topic.
To delete a topic simply remove all content in the respective input fields and click on Save.
Editing default texts for contact mail
You can edit default e-mail text elements that can be sent via the contact form to the panel operator.
To do so, switch to the Website->Panel websites menu, select the desired language version, and open the Configuration tab.
- You can edit the text elements in the “Contact form” section.
- You can edit the name of the panel in the “Locale settings” section.
Function Module: Account Balance
You can use the “Account balance” function module to generate an overview of the panelists’ account balance, which includes all transactions carried out. In the standard panel, you can find such an overview on the My Home → Account balance page, for example.
In the standard panel, the account balance template is entitled “func_account_balance”.
Options
The “Account Balance” function module offers the following options.
| Option | Meaning | Standard panel “Account Balance” page |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | account_balance |
| Page module title | Name of the module in the page’s module overview | Account balance |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_account_balance |
| Show entries with zero points? | If this option is enabled, entries that did not affect the account balance will be displayed as well. | |
| Number of entries displayed/ page | Limits the length of the display per page. Excess entries are listed on the following pages. | 5 |
| Restrict the list to entries from the last x months | You can restrict the list to entries from recent months. | |
| Sort account balance by date | Possible sort order:AscendingDescending | Ascending |
Function Module: Leaderboard
The function module “Leaderboard” allows to set of a leaderboard for the community.
Options
The “Leaderboard2” function module and the old version of “Leaderboard” offer the following options.
| Option | Meaning | Standard panel |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | |
| Page module title | Name of the module in the page’s module overview | |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_leaderboard2, func_leaderboard |
| Headline | This field contains the section headline. | |
| Panelgroup | Allows to restrict the leaderboard to a specific group. | |
| Number of displayed panelists | Allows to restrict the list to a defined number of panelists. | 10 |
| From EFS 10.3 with Leaderboard2: Sort by | You can choose among a variety of data, e.g. date of entry, number of bonus points, average rating the panelist received for community content, etc. | |
| From EFS 10.3 with Leaderboard2: Sort order | Possible sort order:AscendingDescending |
Function Module: List of External Studies
The function module “List of external studies” allows to display of a list of the external studies in which the panelists participated on their homepage.
Options
The “List of external studies” function module offers the following options.
| Option | Meaning | Standard panel |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | survey_list |
| Page module title | Name of the module in the page’s module overview | Survey list |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_survey_list |
| Maximum number of surveys displayed | Allows to restrict the list to a defined number of studies. | 3 |
| Restrict the list to entries from the last x months | Allows to restrict the list to a defined interval. | |
| Sort Order | Possible sort order:AscendingDescending |
Function Module: List of Prize Draws Won
The “List of prize draws won” function module allows you to generate a list of prize draws won by a certain panelist.
Such lists are usually inserted on the panelist’s account balance page, in the standard panel they can be found on the My Home ->Account balance page beneath the actual account balance overview.
You can use the “func_won_prize_draws” template to change the appearance of the list of prize draws won.
Options
The “List of prize draws won” function module offers the following options.
| Option | Meaning | Standard panel “Account Balance” page |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | prize_draws_won |
| Page module title | Name of the module in the page’s module overview | Prize draws won |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_won_prize_draws |
| Number of entries displayed/page | You can limit the length of the list to a predefined number of entries.If you do not wish to limit the number of entries to be displayed, enter “0” or delete the existing value. | 5 |
| Restrict the list to entries from the last x months | You can restrict the list to winnings from recent months. | |
| Sort winnings by date | Possible sort order:AscendingDescending | Ascending |
Function Module: List of Featured Panelist Blogs
With the function module “List of featured panelist blogs” you can create a list of blogs that are particularly worth reading.
In the standard panel, the appearance of the blog list is determined by the “func_blogs_featured” template.
Options
The “List of featured panelist blogs” function module provides the following setting options:
| Option | Meaning | Standard panel |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | Featured_blogs |
| Page module title | Name of the module in the page’s module overview | Featured blogs |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_blogs_featured |
| Blog section | The blogs from the selected section are available. | |
| Sort blogs by | Possible sorting criteria:DateTitleLatest postNumber of postsPossible sort order:AscendingDescending | |
| Maximum number of blogs displayed | You can limit the length of the list to a specific number of blogs. These are selected according to the criteria specified above.If you do not wish to limit the number of blogs to be displayed, enter “0” or delete the existing value. |
Function Module: Quit Membership Form
The “Quit membership” module allows you to create a form that panelists can use to quit their panel membership. In the standard panel, you can find such a form on the Change details → Quit membership page, for example.
EFS Panel provides various design options:
- You can define the panel status to be assigned to panelists who quit their membership.
- Reasons for quitting can be stored in a master data variable.
- After sending the form a confirmation message will be displayed.
In the standard panel, you can use the “func_quit_membership” template to change the appearance of the quit membership form and the quit membership confirmation.
Options
The “Quit membership” function module offers the following options.
| Option | Meaning | Standard panel“Quit membership” page |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | quit_membership |
| Page module title | Name of the module in the page’s module overview | Quit membership |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_quit_membership |
| Panel status after quitting membership | You can define the status to be assigned to panelists after they submit the form. The setting applies to the respective language version.Please note: Once panelists have been assigned the status “Deleted” you will no longer be able to access their data. You should therefore structure the quitting process in such a way that you still have access to data such as the reason for quitting before the panelists are finally deleted. In the standard panel such panelists who quit their membership are assigned the status “Inactive”, for example. | inactive |
| Save the reason for quitting in the master data variable | The reason for quitting is saved in a master data item. | m_yquit: Reason for quitting the panel |
| Message upon successful deregistration | Is displayed upon successful deregistration. | Your membership in this panel has ended. |
Function Module: News
You can use the “News” function module to create panel pages specifically for news items or to incorporate news sections in panel pages. News items are maintained via a separate GUI.
The following figures show the standard panel’s news overview and an individual news item. In the standard panel, you can use the “func_news” template to change the appearance of the news area.
Options
The “News” function module offers the following options:
| Option | Meaning | Standard panel “News” |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | news |
| Page module title | Name of the module in the page’s module overview | News Teaser |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_news |
| Maximum number of news items displayed per page | Once the maximum number has been reached there will be a line break. | 2 |
| Show news from the list | The news list from which the news items are to be included. Those lists to which news items have been assigned are available – in the standard panel, this only applies to the “main” list. | main |
| Sort news by | Possible criteria:HeadlineContentTeaserAuthorSubtitleDisplayed date and time of publication (GMT) (shown on website)Possible sort order:AscendingDescending |
Function Module: Panelists Online
With the function module “Panelists online” you can set up the display of the logged-in panelists. This function is particularly popular in communities.
In the standard panel, the appearance of the panelist counter is determined by the “func_panelists_online” template.
Setting options
The “Panelists online” function module provides the following setting options:
| Option | Meaning | Standard panel |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | Panelists_online |
| Page module title | Name of the module in the page’s module overview | Panelists online |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_panelists_online |
| Panelists can see themselves in the list | If this option is activated, the logged-in panelist can see himself in the list. | |
| Maximum number of entries to be displayed | Limits the length of the display. If the number of active panelists exceeds this maximum number, those displayed depend on the sorting criteria. | |
| Sort panelists by | Possible criteria:Account nameFirst nameLast nameE-mail addressCountryThe date of entry into the panel.Possible sort order:AscendingDescending |
Function Module: Panelist Blog
With the “Panelist blog” function module you can set up blogs for your panelists.
In the standard panel, the appearance of the panelist blogs is determined by the “func_blog” template.
Setting options
The “Panelist blog” function module provides the following setting options:
| Option | Meaning | Standard panel |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | Blog |
| Page module title | Name of the module in the page’s module overview. | Blog |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_blog |
| Template for media display | In this field, you can enter the template that controls how uploaded files are output.Images are usually displayed. A download link is available for other file types. | tpl_media_display |
| Blog section | All blog sections of the respective language versions are available. | |
| Maximum number of posts displayed per page | Limits the length of the display per page. Excess posts are displayed on subsequent pages. | |
| Mail template for thread subscription mail | The subscription feature is activated by selecting a mail template that contains the accompanying text for the notification.Available are templates of the “standard mail” type.The following wildcards can be used:#subscription_title#: Title of the section#subscription_post_title#: Title of the new post#subscription_post_link#: Link to post#subscription_unsubscribe#: Link that allows to unsubscribeOnce the feature is activated, Subscribe-/Unsubscribe links will be displayed in the blogs.When panelists have subscribed to a blog they will receive an e-mail notification whenever a new post has been added.Panelists with panel status “inactive” (i.e. usually panelists who left the panel) will not get e-mails. | |
| Maximum width of thumbnails (in pixels) | Maximum width of the thumbnails for the images uploaded by the panelists or the moderators. | 100 |
| Maximum height of thumbnails (in pixels) | Maximum height of the thumbnails for the uploaded images, see above. | 100 |
| Maximum width of scaled images | Maximum width in pixels.Please mind: A change in this option affects only newly uploaded images. Existing images are not modified retroactively. | |
| Maximum height of scaled images | Maximum height in pixels, see above. |
Function Module: Change Password Facility
It is essential for panel operation that panelists can change their password. EFS Panel therefore provides a module that allows you to create a special form for changing passwords.
In the standard panel, you can find such a form on the Change details → Change password page, for example.
EFS Panel provides various design options:
- In addition to the two input fields for the new password, you can optionally request panelists to enter their previous password. This option is used in the standard panel.
- After saving the change a confirmation message will be displayed.
In the standard panel, you can use the “func_change_password” template to change the appearance of the “Change password” page and change confirmation.
Options
The “Change password facility” function module offers the following options.
| Option | Meaning | Standard panel “Change password” page |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | change_pwd |
| Page module title | Name of the module in the page’s module overview. | Change password |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_change_password |
| The previous password must be entered for confirmation? | The previous password must be entered again. | yes |
| Message upon successful change | This text is displayed once the change has been saved. | You have changed your password successfully. |
Function Module: Recover Password Functionality
The “Recover password” module creates a form via which panelists can request a link for resetting their forgotten password. In the standard panel, panelists can access such a form by clicking on the forgot your password link.
EFS Panel provides various design options:
- You can select the mail template used to deliver the reset link.
- Once the reset link has been successfully delivered a confirmation message will be displayed.
- You can optionally restrict the validity period for the “Reset password” link.
- Optionally, a security question can be integrated into the “Request reset link” process.
In the standard panel, the “func_password_recover” template is responsible for the appearance of the “Recover password” page and confirmation message.
Options
The “Recover password” function module offers the following options.
| Option | Meaning | Standard panel “Password recover” page |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | password_recovery |
| Page module title | Name of the module in the page’s module overview. | Password recovery |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_password_recover |
| Mail template for password recovery mail | Mail template used for password delivery.The “Password recovery” mail templates are available. Please make sure that the selected template contains all necessary wildcards. | Password recovery |
| Hint for e-mail address | ||
| Hint for the security question | ||
| Message upon successful delivery | This text is displayed once the mail has been sent. | |
| Hint for password | ||
| Message upon successful update |
Function Module: Bonus List and Redemption
The “Bonus list and redemption” function module allows you to create pages where panelists can exchange their points for bonuses. In the standard panel, you can find the corresponding menu under My Home → Redeem points.
Bonuses are maintained via a separate GUI. In the standard panel, you can use the “func_redemption” template to change the appearance of the “Bonus list and redemption” module.
Optionally, you can allow your panelists to name an alternative recipient address for a bonus. E.g. they can name their place of employment or the address of friends who are to receive the bonus as a present. For this purpose, the alternative address is queried via a dedicated field in the bonus redemption form, stored in the context of the specific redemption process, and listed in the column „Altern. recipient“ in detail view and export.
The feature requires special programming, it is not implemented in the standard panel. If you are interested, please get in touch with our support.
Options
The “Bonus list and redemption” function module offers the following options.
| Option | Meaning | Standard panel “Redeem points” page |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | redeem_points |
| Page module title | Name of the module in the page’s module overview | Redeem points |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_redemption |
| Bonus category displayed at the start | When the bonus list is opened either the entire list (All) or one of the bonus categories can be displayed. If you want a certain bonus category to be displayed at the start, you can select it here. If no category has been selected the entire list will be displayed. | |
| Offer vouchers only from lists that still have unused voucher codes | Prevents further vouchers of a voucher bonus type from being redeemed if all available vouchers have been used.We recommend the use of this function if you are using the option for automatic sending of vouchers. | yes |
| Minimum number of points for redeeming bonuses | By entering a minimum number of points you can ensure that only panelists who have this amount of points can redeem bonuses on the respective page.Please note that panelists with fewer points will then generally not be able to use the respective bonus list: No differentiation is made between new panelists and panelists who had a higher number of points in the past, but who have redeemed points in the meantime.If you do not wish to enter a minimum number of points, enter “0” or delete the existing value. | |
| Mail template for confirmation mail | The selected mail template will be sent to the specified recipient every time a panelist redeems bonus points. Alternatively, it may be sent to the panelists themselves to confirm the redemption of points.The “Standard mail” mail templates are available.The necessary data should be inserted into the mail template using wildcards. Information on the redeeming panelist can be entered as usual via the participant variables u_000n. Information on the redeemed bonus will be displayed using the following wildcards only available for this particular function: #item_title#: Bonus title; #item_description#: Description; #item_description2#: Description 2; #item_category_title#: Bonus category title; #item_selected_amount#. Value of payment; #item_vendor#: Manufacturer | |
| Confirmation mail recipients | In this field, specify to whom the mail template selected above is to be sent. | |
| The following fields should be displayed for bank payments | It is up to you to decide which bank details should be used.The following bank details can be used: account holder, bank code, account number, SWIFT code, and IBAN. The data are stored in preconfigured database fields in the backend.For PayPal, authentification can be handled based on the e-mail address. In panels that were set up with EFS 8.1 or later, the “account_holder” field can store up to 100 characters. That way, it can be used to store e-mail addresses.If you want to store the entered details in master data, e.g. to use them to prefill the form for future payments, create appropriate master data (data type: text) and select these from the drop-down lists. | |
| Validation of bank code number | You can define your own Regex check to validate the bank code.E.g. to validate against a 1 to the 10-digit sized number you can specify the following expression: ^([0-9]{1,10})$ | |
| Validation of account number | You can define your own Regex check to validate the account number.I.e. to validate against a 1 to 10-digit sized number you can specify the following expression: ^([0-9]{1,10})$ | |
| Store entered data for bank payments in selected master data variables and use master data variables for preselection | Activate this option if you want to store the entered details and use them to prefill the form for future payments.If you use this option, create appropriate master data (data type: text) and select these from the drop-down lists in the field “The following fields should be displayed for bank payments”. |
Function Module: Send Private Messages to Panelists
When using the community function “Messages from panelists to panelists”, the function module “Send private messages to panelists” allows you to create the form for private messages:
In the standard panel, the appearance of the form is determined by the “func_messages_send” template.
Options
The “Send private messages to panelists” function module offers the following options.
| Option | Meaning | Standard panel |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | |
| Page module title | Name of the module in the page’s module overview | |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_messages_send |
| Message header is optional | If this option is activated, the panelists can leave the “Subject” field blank. | |
| Mail template for messages | Mail template for defining the accompanying text for the e-mail.Available are templates of the “standard mail” type.The following wildcards can be used:#sender_u_firstname#: The sender’s first name#sender_u_name#: The sender’s last name#message_title#: The message header#message_text#: The message textPlease note that first name and name are only filled in if the sender has made these data publicly available.Furthermore, the address variables of the receiving panelist can be inserted via the usual wildcards. | Message from panelist to panelist |
| Confirmation message for message dispatch | Your message was sent. |
Function Module: Profile Options
Many online communities allow their members to edit their profiles via a dedicated form and decide for themselves which of their data should be visible. With the function module “Profile options” you can set up such a form.
In the standard panel, the appearance of the form is determined by the “func_profile_settings” template.
Options
The “Profile options” function module provides the following setting options:
| Option | Meaning | Standard panel |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | Profilesettings |
| Page module title | Name of the module in the page’s module overview | Profile settings |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_profile_settings |
| The following options will be shown to panelists | In this field, you specify which profile options will be shown to the panelists. The following options are available:Show profile to othersAddress data.Master data groups.Two profile images.You can define the labels for the selected optionsyourself. | |
| Message upon successful change | This text is displayed after successfully changing the settings. |
Function Module: Profile Search
The “Profile search” function module is used for setting up the panelist profiles, the panelist search, and the results display for a community panel.
In the standard panel, the appearance of the profiles is determined by the “func_profile_search” template.
Options
The “Profile search” function module provides the following setting options:
| Option | Meaning | Standard panel |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | Profile_search |
| Page module title | Name of the module in the page’s module overview | Profile search |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_profile_search |
| Profile form configuration | In this field, you select the desired form. Only forms of the “Profile” type are available. | |
| Limit search to language version(s) | In this field, you define which panelists can be found with the search tool The following options are available:Show panelists from the same language version onlyShow panelists from all language versions of the current websiteShow panelists from all language versions | |
| Include panelists with the following panel statuses in the results lists | Use the select box to select those statuses that make sense to display. In principle, you can select all panel statuses except for “deleted”. | |
| Only show profiles if search criteria have been entered | If this option is activated, no panelists will be displayed until a panelist enters the search criteria and starts a search. This means that the complete list may never be displayed.If this option is not activated, the complete list will be displayed unless the panelists specify search criteria.Please note: The use of this option can improve the performance of the installation. The constant opening of the complete panelist list puts unnecessary strain on the server. | |
| Maximum number of profiles displayed per page | Limits the length of the display per page. Excess profiles are displayed on subsequent pages. | 80 |
| Profile sort order | Specify which variable is to be used for defining the sort order. The following variables are available:Address dataMaster datapenter_date: Date of entry into the panelsite_idPossible sort order:AscendingDescending | 80 |
Function Module: Panelist Ratings
With the “Panelist ratings” function module you can set up a form for the rating of panelists.
In the standard panel, the appearance of the form is determined by the “func_panelist_ rating” template.
Options
The “Panelist ratings” function module provides the following setting options:
| Option | Meaning | Standard panel |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | Give_stars |
| Page module title | Name of the module in the page’s module overview | Give stars |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_panelist_rating |
| Page module title | Name of the module in the page’s module overview | Give stars |
| Number of points a panelist can award per transaction | A range of values can be defined. | |
| A variable containing the number of remaining points of a panelist | Master data variable containing the number of points left for a panelist to award. | m_starcredit |
| A variable containing the sum of points awarded by other panelists | Master data variable containing the number of points a panelist has received from other panelists. | m_starsreceived |
| A variable containing the number of awards a panelist has received | Master data variable containing the number of awards to a panelist, i.e. every time the panelist receives points the value of this variable is increased by 1. | m_starcount |
| Message displayed when the step was successfully executed | This text is displayed after successfully awarding points. |
Function Module: Quick Poll
You can use the “Quick poll” function module to place a quick poll on the panel start page, in which logged-in panelists can participate. In the standard panel, you can use the “func_quick_poll” template to change the appearance of the quick poll.
Options
The “Quick poll” function module offers the following options:
| Option | Meaning | Standard panel |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | Give_stars |
| Page module title | Name of the module in the page’s module overview | Give stars |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_panelist_rating |
| Display quick poll | An active, existing quick poll is selected for the respective language version according to the following criteria:Last created and active pollLast created and active poll (without polls already answered)Random selectionRandom selection (without duplicates)Random selection (without polls already answered)Always use the static quick poll selected belowPlease note:To test the random selection of polls, you have to log out and in again. (The poll ID is stored in and read from the session.)If no poll fulfills the specified criteria (e.g. because the field time has ended), the newest active poll will be displayed as the default fallback. | Last created and active poll |
| Static quick poll | If the display option „Always use the static quick poll selected below“ has been selected, you may choose an existing active poll from this drop-down list. This poll will always be displayed. |
Function Module: Registration Form
The “Registration form” function module allows you to generate the form where panelists can enter their data upon registration. In the standard panel, you can find this form on the Registration page, for example. The data collected during the registration process are defined via a separate GUI.
In the standard panel, you can use the “func_registration” template to change the appearance of the “Registration form” module.
Options
The following options are available:
| Option | Meaning | Standard panel “Registration” page |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | registration |
| Page module title | Name of the module in the page’s module overview | Registration |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_registration |
| Panel status assigned during registration | You can choose which panel status you wish to assign to candidates after the registration page has been submitted. | admitted temporarily |
| Way of entry | Way of entry that is assigned to candidates if they do not have keys from a specific invitation campaign or tell-a-friend campaign.The default setting is “Please select”. As long as you do not change this setting, the way of entry “Default” will be assigned. | Please select |
| Registration is only possible with a valid code. | When this function has been activated, only candidates who have accessed the panel via a link with a way of entry and an active key can open the registration form. The registration page is not visible to other visitors. | no |
| From EFS 10.1 for Social Insight Connect: Automatic Facebook registration (no opt-in) | Activate this option if you want new panelists to register via Facebook authentication without the opt-in process.If this option is activated, the following six fields are superfluous and will therefore be hidden (Form configuration, New e-mail address must be entered twice, New password must be entered twice, Confirm privacy policy? Use CAPTCHA image, Automatically login after successful registration). | no |
| Form configuration | In this field, you choose the appropriate form. | Registration form |
| New e-mail address must be entered twice (for confirmation)? | An entry field in which the new e-mail address must be confirmed is displayed. | yes |
| The new password must be entered twice (for confirmation)? | An entry field in which the password must be confirmed is displayed. | yes |
| Confirm privacy policy. | An entry field is displayed where the candidate must expressly agree with the privacy policy. | yes |
| Use CAPTCHA image | You can optionally have a CAPTCHA image displayed.Please note: If you have activated CAPTCHA, visually impaired users with a screen reader can no longer register. | no |
| Automatically log in after successful registration | ||
| Mail template for welcome mail | The selected mail template is sent to the candidate.The “Welcome mail” mail templates are available.The required data (e.g. a verification link, if e-mail verification is being used) should be inserted into the mail template via wildcard.The data required for verification should be inserted into the mail template using wildcards. Use #mail_validation_code# to insert the actual verification code; by using #mail_validation_code_ complete# you can create a complete clickable link. | Welcome mail |
| Add panelist to master data survey sample | If you choose “Determine automatically”, the active master data survey will be selected. Otherwise, this must be done manually every time another master data survey is activated. | |
| Mail template for an invitation to master data survey | The selected mail template is sent to the panelist.The “Master data survey invitation mail” mail templates are available.The link to the master data survey should be inserted in the mail template via wildcard | Master data invitation mail |
| Text on successful registration | In this field, you should enter the message to be displayed once registration is successful. | Thank you for joining the panel! |
Function Module: Report Form
The “Report form” function module allows you to create a form that can be used by panelists to directly notify the panel operator of spam and other issues.
You can use the “func_report_form” template to change the appearance of the contact form and confirmation page. Most options are identical to the contact form options explained above in Chapter “Function Module: Leaderboard”.
Options
The “Report form” function module offers the following options.
| Option | Meaning | Standard panel “Report Post” page |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | |
| Page module title | Name of the module in the page’s module overview | Report Post |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_report_form |
| Mail sender | E-mail address from which the requests are sent. Use the wildcard #u_email# to insert the e-mail address of the panelist. | |
| Message upon successful change | This text is displayed on the contact page once the mail has been sent. | We have received your email and will process it as soon as possible. |
| Feedback topic and corresponding recipient address | See Chapter “Function Module: Contact Form”. |
Function Module: Survey List
In the panelists’ personal area, the “Survey list” module generates a list of surveys in which they can currently participate. Such a list is usually placed on the personal homepage, in the standard panel on My Home, for example. You can use the “func_survey_list” template to change the appearance of the survey list.
Options
The “Survey list” function module offers the following options.
| Option | Meaning | Standard panel “My home” page |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | survey_list |
| Page module title | Name of the module in the page’s module overview | Survey list |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_survey_list |
| Maximum number of surveys displayed per page | Once the maximum number has been reached there will be a line break. | 3 |
| Sort surveys by | Possible criteria:Project titleProject endProject startNumber of required participants outstandingNumber of bonus pointsPossible sort order:AscendingDescending | Number of required participants outstanding – Descending |
| In the “To-do list” module: Maximum thumbnail size (px) | If nothing is set, thumbnails are not available.The maximum value is 300. |
Function Module: Teaser
This function module, newly introduced in EFS 10.3, allows for setting up teasers for forums, blogs, and discussions.
| Option | Meaning | Default |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | |
| Page module title | Name of the module in the page’s module overview | |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_teaser |
| Headline | This field contains the section headline. | |
| Source | In this field, you specify the community content to be teased:ForumBlogDiscussion | |
| Selection | In this field, you select the specific forum, blog section, or discussion section. | |
| If a forum or blog is selected: Element | In this field, you can specify which elements should be displayed:Forums: threads or postsBlogs: posts or comments | |
| Number of elements | The number of elements should be restricted. | |
| Sort by | Possible criteria:Average ratingNumber of ratingsDate of creation | |
| Sort Order | Possible sort order:AscendingDescending | |
| Rating option | In this field, you can specify how unrated posts should be handled:Show only rated postsShow only unrated postsShow all postsShow unrated posts at the end | |
| Link | To generate clickable links into the forum, blog, or discussion for the teaser, the page identifier of the target page should be inserted into this field. | |
| Page module | To generate clickable links into the forum, blog, or discussion for the teaser, the reference name of the template on the target page should be inserted into this field. |
Function Module: Search for Text in Modules
Text search is a custom feature that can be made available optionally for EFS 9.1 or higher.
This function module allows to set up a search page with a search form and results list.
| Option | Meaning | Default |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | |
| Page module title | Name of the module in the page’s module overview | |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_search |
| Template for media display | In this field, you can enter the template that controls how uploaded files are output.The field should be kept empty for text search. | |
| Modules available in the search | In the drop-down list, you can select the content types that should be covered by the search.The content types selected in the menu Global Configuration are available. A further restriction in this module is specific to this module. | |
| Maximum number of search results | Maximum number of results to be displayed in the “All results” list per content type. | |
| Maximum number of search results in summary | Maximum number of results to be displayed in the summary per content type. |
Function Module: To-do List
In the panelists’ personal area, the “To-do list” module generates a list of projects in which they can currently participate, including forum discussions (i.e. qualitative projects) and tasks. Such a list is usually placed on the personal homepage, in the standard panel on My Home, for example.
You can use the “func_todo_list” template to change the appearance of the survey list. The options are identical to the survey list options explained above in Table “Function Module: Search for Text in Modules”.
You can decide for yourself whether you want to use the possibility to display forum discussions as qualitative projects in the to-do list and the admin area project list.
- To display already existing forum discussions, open the dialog Edit settings for the respective forum topics and tick the checkbox “Treat as qualitative project”.
- If you subsequently create your forum topics from within the project list, this option will be enabled automatically.
Function Module: Random File Selection
The “Random file selection” function module selects a predefined number of files of a certain type from an asset library directory and outputs them on a panel page. The module is controlled by the “file_picker” template, which is located in the template library.
EFS Panel provides various design options:
- You can choose the source directory in the asset library yourself.
- You can also choose the file type yourself.
- You can define the maximum number of files for selection.
- Random selection can be either chosen once per session or every time the respective page is invoked.
Options
The “Random file selection” function module offers the following options.
| Option | Meaning | Standard panel |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | |
| Page module title | Name of the module in the page’s module overview | |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_random_files |
| File selection type | Available options are:Random selection (once per session)Random selection (on each request) | Random selection (once per session) |
| Directory for file selection | All asset library directories of the respective panel installation are available. | |
| Permitted file types | Available options are:gifpngjpegjpgswfCSS | |
| Maximum number of files to be picked | If you do not wish to limit the number of files, enter “0” or delete the existing value. |
Function Module: Random Number Draw
The “Random number draw” function module generates a random number that can be used for random sample processes, for example. The module is controlled by the “random_draw” template, which is located in the template library.
Options
The “Random number draw” function module offers the following options.
| Option | Meaning | Standard panel |
|---|---|---|
| Reference name for template | Name that can be used to trigger the module in positioning templates. | |
| Page module title | Name of the module in the page’s module overview | |
| Module template | Module-specific template that controls how data provided by the module are displayed. | func_random |
| Random number generation type | Available options are:Random selection (once per session)Random selection (on each request) | Random selection (once per session) |
| Maximum random value (default value: 100) | If you do not enter anything the default value 100 will be set. |
FAQ
How do I reference a page module on multiple pages?
To reference a page module on multiple pages, first create the module on one page. Then, go to the “Modules from other pages” tab on the target pages and select the module you want to reference. Click “Save” to establish the reference.
Can I customize the appearance of function modules?
Yes, most function modules have a “Module template” option that allows you to select different templates to control how the module’s data is displayed. You can further customize these templates to match your panel’s design.
How do I set up a registration form for new panelists?
Use the “Registration Form” function module to set up a registration form. You can configure options such as the form layout, required fields, CAPTCHA, and welcome emails. Make sure to select the appropriate panel status to assign to new registrants.