Skip to end of metadata
Go to start of metadata

The course element Survey offers the possibility to conduct anonymous statistical surveys in the course. This allows you, for example, to obtain direct feedback on your course.

The learning platform supports the ONYX Testsuite and therefore enables convenient survey creation with a wide range of functions.


Usage: Learners' View 


In the course element  Survey, you have the possibility to start and run a survey configured by the course author. A survey can only be carried out once.

The author may also activate the option to pause the survey in the survey settings, i. e. you will be able to exit the survey early and resume it later where you left off. However, if this function is not enabled and you exit the survey, it will be considered as completed and cannot be re-accessed.

Survey in the course view

Functions for users

Start and finish survey

Start a survey as follows:

Open the course element Survey.

Now click on Start survey.

A survey can only be started if no visibility or access restrictions prevent it. However, in contrast to tests, there is principally only one attempt available. If necessary, you can pause this attempt using Pause and continue or finish it later. When you close the attempt with Finish survey, the attempt will be completed, and you cannot start another attempt for the survey.


The survey will be opened and started immediately unless any release restrictions prevent it. Now you can start answering the questions. To advance to the next question, click on Next. Depending on the author's configuration, you can also select questions from the navigation pane.

Similar to tests, the survey will be carried out in the ONYX web interface. For more information, refer to the chapter Onyx>Test procedure from the participants' point of view .


To close the survey, click on Finish survey.

Please note that no further processing of this attempt will be possible after finishing the survey.

Automatic progress

If the course progress indicator is activated for a course, the course element will automatically be marked as completed upon the first finished attempt of the user. This process is independent of any possible assessment.

For more information on conducting a survey, refer to the section Test procedure from the participants' view in the ONYX Testsuite help.

Configuration: Authors' View 

In the course editor

The following functions are available to you in the course editor:

Add a course element survey

To integrate a course element into your course, proceed as follows:

Open the course you want to edit.

Use the pencil icon at the top of the page to open the editing mode.

Switch from the course view to the editing mode


Select a course element from the menu on the right.

Select course element


In the new window, you can define the position of the new course element within your course structure (left navigation pane). The available positions are marked with an insert icon.

To insert the new course element into an existing substructure, you need to open the substructure by clicking on the small triangle symbol next to its title. The area will open and you will again see insert icons at the positions which are available.

Click on the insert icon at the desired position within the structure. The selected area will be highlighted.

Confirm your choice with Insert course element.

Insert course element into the course tree


The element will be inserted into the course structure at the selected position.

Depending on the course element, you have to make additional configurations or add content in order to complete the configuration.

For these changes to take effect, you must publish the course. The course element will then also become available in the course view.

Configure and publish course element

General configuration settings

In the course editor, you will find the following configuration tabs:

Title and description

Course editor settings in the tab title and description

You need to enter a title for the course element. The title can comprise a maximum of 100 characters. All special characters and numbers are permitted. The title will appear in the navigation menu of the course and also as a heading in the content area.

(warning)  If you change the title of the first course element, the new content will only be applied to the main course node and then displayed in the opened course. If you wish to edit the course title or description, you can do so using the more settings menu of the course.

SubtitleYou can enter a subtitle for the course element with a maximum of 255 characters. All special characters and numbers are permitted. The title will appear as a tooltip in the navigation menu and - if selected and configured accordingly - as a subtitle in the content area.

Here you can describe the course element. The description will appear in the content area below the title.

Depending on the settings configured in the element Display, this additional text is displayed to the user when opening the course element. The user can expand or collapse the view of the text.


Define which information about the course element should be displayed in the course view. In addition to the content, you can optionally display the title and description. All course elements are provided with a reasonable presetting, which mostly includes the setting Title, description and content. You can adjust this setting in accordance with the options available for each course element. For an example of the different setting options, refer to the help page Displaying information about the course element.

Set link for this course element

Each course element can be accessed via fixed link addresses. Therefore, an internal and an external URL is assigned to each course element. These direct links to concrete elements can be used within courses or provided to learners. The URLs are located below the title and description of the element and will appear upon selecting Set link for this course element.  

  • External link: To refer to this course element from outside of the course or learning platform, you can use the external link and insert it, for example as a href attribute, into the desired HTML page.
  • Internal link: To set a link to another course element within the same course, you can insert the internal link as a href attribute into the desired HTML page.
IDYou will need the ID number of the course element (on the bottom right), for example, if you wish to use the expert mode in the visibility or access tab.


In the areas Visibility and Access, authors and course owners can individually determine the presentation of course elements. If no input is made in the access area, the content of a course element will by default be visible to all course participants after publishing the element. Apart from the general options listed below, additional configuration options are available depending on the course element.

The following general options are available for the configuration of visibility and access:

Course editor - Tab visibility and access

General configuration optionsDescription
Blocked for learners

If you select this checkbox, all other configuration options will disappear. The course element content is now exclusively accessible for tutors and administrators of the course.

Block access or visibility for learners
Depending on dateMark this checkbox to specify a particular access time. You can set individual dates or date ranges by filling in only one or both input fields respectively. You can also create or delete dates via the + and - buttons.

Set access or visibility rights depending on dates

Depending on group

Select this checkbox to restrict the accessibility of the course element to learning groups or learning areas. You can then select existing groups and areas or create new ones.

If you set restrictions with the configuration option "depending on group", the corresponding course element will be restricted for all non-members of the group. This includes, for example, users who have not yet confirmed the group invitation or who are on the waiting list for a group. Such users cannot yet see or access the restricted course element.

Set access or visibility rights depending on groups

Depending on assessmentHere, you will find all assessable course elements. These include, for example, the elements test, assessment, task, or structure. 

If you select the option Check for "passed", you will be able to choose a course element from the input field Course element, which the user must have passed as a prerequisite to accessing this course element. 

If you select the option Check score, you can indicate a number of points in the input field "Passing score", which have to be achieved in order to be able to access the course element.

Set access or visibility rights depending on assessments

Depending on attribute

The visibility of this option is system-dependent.

Via this option, you can set visibility or access rights according to user attributes. Only users who meet the predefined attributes will be able to see the course element or have access to its content. Multiple attributes need to be linked with an operator (AND/OR).

Different kinds of relational operators might be available depending on the selected attribute. For example:

  • "contains the value"
  • "does not contain value"
  • "has exactly the value"
  • "does not have value"
  • "starts with value"
  • "ends with value"
  • "greater than" (>)
  • "less than" (<)
  • "greater than/equals" (<=)
  • "less than/equals" (>=)

A list of all available attributes of several selected institutions can be found on the page Overview of the OPAL-Shibboleth attributes.

Set access or visibility rights depending on attributes

Apply rules also for author, owner and tutorThis option does not become visible until one of the other options has been selected. If you activate the checkbox, the same access rules which apply to users will also be valid for tutors and course administrators.

Apply rules also for author, owner and tutor

PasswordThis option is only available in the area Access and can either be applied to the whole course or a structural element of the course. Enter the desired password, which users will need to use in order to gain access to the course content, in the text field.

Set access or visibility rights depending on passwords

Display expert modeClick on the button Display expert mode to open an input field, which allows you to perform a more complex configuration according to your needs. For more detailed information about the expert mode, see the help page Publishing within Courses (Expert Mode).
Set access or visibility rights in the expert mode
Advanced configuration optionsIn the case of individual course element types, there are further attributes to configure access to editing rights for course participants.

If various restrictive single options are set, they will be linked with AND, i.e. all conditions of the single options must be met for the user to see and have access to the course element. The only exceptions are the single options Attributes. In this case, various restrictive single options can also be linked with OR. The OR linking only requires the fulfilment of one condition in order to enable visibility or access, unless other restrictive single options prevent this.

All restrictions are also automatically valid for all subordinate course elements.

Note about hiding access restrictions

If a course element is visible, but there are

  • current or future access restrictions or
  • restricted rights for the course element,

the user will be informed accordingly when accessing the course element. This information helps the user to learn more about the functions available, e.g. which functions will be available at what time and under what conditions.

If required, however, you can hide this information text (from the user) for each course element individually.

Notification message about existing access and authorisation restrictions in the course view:

Course element with notification message about authorisation restrictions


To hide this message, open the course editor and switch to the Visibility tab of the respective course element.

In the section Information if course node is visible but not accessible (max. 248 characters), remove the check mark in front of the entry Show access restrictions below the text field.

Publish your changes.

Course editor setting to hide notification message


The note will no longer be visible in the course view.

Course element without notification message about authorisation restrictions

For individual course element types, there are further attributes which can be used to regulate access to editing rights for course participants.

The following editing rights can be restricted or extended using the general configuration attributes (depending on date, group, etc.):

  • Assignment
  • Edit task folder  
  • Drop box - Delete own solutions
  • Drop box  
  • Return box
  • Assessment
  • Sample solution
  • Read  
  • Read and write
  • Moderate
File Dialogue
  • Only file download / read in the forum  
  • File up- and download/ read and write in the forum
  • Edit or delete files / Moderate in the forum
  • Read  
  • Read and write
  • Moderate
  • Read  
  • Add and edit dates
Link List
  • Display  
  • Display and add
  • Display, edit, and delete
  • Display  
  • Display and edit
  • Read
  • Write
  • Manage
  • Download
  • Upload
  • Delete
  • Read  
  • Read and write
  • Moderate
  • Display  
  • Display and edit
  • Display
  • Add

Configurable in the tab Visibility :

  • Conduct test
  • View assessment
  • View results
  • Read  
  • Add and edit articles

Survey configurationIn this tab, you can store a learning resource of the type survey and configure settings for the implementation of the survey. Detailed instructions are given in the following section Survey configuration.
MultilingualismIn this tab, different translations can be added to individual course element areas.

Survey configuration

Assign survey

Here you can assign a Survey resource to your course element Survey. To do this, you can choose from the following options:

  • Select survey (option 1)
  • Create survey (option 2)
  • Import survey (option 3)


Open the course editor in the course element Survey and switch to the  Survey configuration tab.

Assign survey

Click on the button Select, create or import survey.


A page with functions to select, create, and import a survey resource opens.

Decide on one of the following options:

Functions to select, create or import a survey

Select an existing survey (option 1)

  • Select an existing survey resource from the overview and click on the plus icon in the Actions column.
Select survey

Create a new survey (option 2)

  • Start by clicking on Create below the heading of the dialogue.
  • The dialogue for creating survey resources opens. Enter a title and optionally a description in the appropriate text fields.
  • Click on Save.
  • If necessary, upload an image for the detailed view of the new resource.
  • Click on Finish to complete the creation process.
Create survey

Import survey (option 3)

  • Click on Import. You will find this button located below the heading Search for referenceable learning resources.
  • The dialogue for uploading survey resources opens. Use the buttons Select folder or Upload file to navigate to the location of the file you wish to import. Confirm your choice with Upload and fill in all necessary data for the new survey resource.
Import survey

The resource will now be displayed in the Survey configuration tab.

Current survey choice
  • Replace: Click this button to replace the stored resource with another resource. The same window will open as described above in the section Assign survey. You can now select, create, or import a survey resource. If there is a newer survey version available, you can also update the old version using this path. For more information, see the section Replace survey version.
  • Edit: Click this button to open the survey resource in the ONYX editor. In this area, you can edit the content of the survey and create and configure additional questions. For more information on working with the ONYX editor and available question formats, refer to the chapter Creating test content with the ONYX Suite.

If a newer survey version exists, the older version can no longer be edited. The Edit button will then be disabled.

Functions after adding a survey resource

A learning resource of the type survey must be integrated into the course element. Further information on independent learning resources as well as tutorials on their creation and management can be found in the section Learning resources.

Add information text

You can provide the learner with an information text about the survey. This text will be displayed in the course view above the Start survey button.

Information about the survey


Open the course editor of the course element and switch to the Survey configuration tab.

Add information page

Then click on Select or create page.

A window with functions for creating or selecting an HTML page as well as for uploading an HTML file opens. Decide on one of the following options:

Three options


Enter the name of the new file in the appropriate text field, select a different character set if necessary, and then click the Create button.

Create a new HTML page

The editor window for creating a new HTML page opens. Alternatively, you can also open the editor window manually by clicking the Open page in editor button.

Enter the desired content. You can also use the numerous formatting options in the Text editor.

Then click on Save.

Fill in the new HTML page

Click on the button Select page.

Select page button

An overview of all HTML pages available in the storage folder opens. Mark the desired file by clicking on its title and confirm your selection with Select.

Select file from storage folder
  • Click on the button Select file.
  • Now select a file from your computer and upload it.
  • Confirm the process with Upload.
Upload file

The selected file will be uploaded to the storage folder, automatically linked, and displayed under Selected page.

Selected page

After adding an HTML page, you have the following options: 

Open page in editor: 

  • Click on this button to make changes to your HTML page.

Replace page:

  • Click on this button to create, select, or upload anew HTML page. Follow the steps outlined above.

Delete page:

  • If the HTML page has been added to a course element as an information page, you can completely clear this assignment using the Delete Page button.

Functions after adding an HTML page

Run survey

After adding a survey, you have the option to configure various settings for running the survey.

Please note:

Survey results will be recorded anonymously, and it must be ensured that each participant can answer the survey only once per course element. For this reason, unlike tests, you cannot configure the number of attempts for a survey course element. Resetting the number of attempts for a user is also not possible. When you close the attempt with Finish survey, the attempt at the survey will be completed and no further attempt can be started.

Surveys can be paused and continued later. Once submitted, a survey in the same course element cannot be answered again by the same user. In order to have the same user answer the same survey again within the learning platform, you can alternatively copy the course element.

Running the survey

Show navigation tree

This checkbox is enabled by default.

Disable the option to hide the navigation tree including the question titles during the survey.

Show item titles

This checkbox is enabled by default. All question titles will be displayed as stored in the survey resource.

Clear this checkbox if you prefer neutral question titles instead. The original question titles will then be replaced with neutral ones such as "question 1", question 2", etc. and all displayed questions will be numbered linearly.

Confirm your configuration with Save .

Sample images of the effects of individual configuration parameters can be obtained from the page ONYX Testsuite>Test procedure configuration.

After completing the survey

You can influence a user’s navigation after completing a survey and determine the course element to which they should jump.

Jump target after completing the survey

To do this, mark the checkbox Jump to another course node. The selection list Select course node will open. Click on the triangle at the end of the list box to display the available entries. Select the desired course element from the list and confirm your settings with Save.

After the submission and successful storage of the survey attempt, the user will now automatically jump to the selected course element. However, this does not apply to survey attempts that are cancelled or paused.

Correction mode and new survey version

The integrated survey resource can also be edited or enhanced. However, if user results for the resource are already available in the system, it must be ensured, for the assessment, that these results match their survey version. Therefore, the following options are available for making changes:

  • This mode can be used for small changes, such as spelling corrections. However, essential survey content cannot be modified. This means that it is not possible to add new questions or change survey or question options or assessments.

    • This option can be used to make significant changes to the survey content. All editing functions can be used and all implementing options can be adapted.

Both options will be displayed when opening a resource with existing user results for editing. If the option correction mode is used, no further changes or publishing of the course element will be necessary. The modified version will be immediately accessible to users starting the survey. However, if a new survey version is created, the old survey version must be actively replaced so that the new one will be displayed to the user. As long as this has not been done, the user will be shown the old version when opening the resource.

Replace survey version
Replacing a new survey version is done in the same way as replacing any other test resource. Further information is provided in the section Replace test version.

Evaluate survey

In the assessment tool of the course, you can view the statistical evaluation of the survey. More information can also be found in the Statistical evaluation section of the ONYX help.