Skip to main content

Creating a survey in the Feedback WebApp V2

Surveys are created as Added table fields Added fields on the Feedback  Feedback table and summarised in a Group. After exporting the survey to the website,either integrate the URL into a website or an email to send directly. Surveys can be linked to records such as  VA Events or Adresse Accounts, or be completely free of context.
Example: customer surveys on the New Year's Eve ball, staff survey on the Christmas party

  • Create new Added fields

    Only users with the Gruppen User group "Feedback_V2 Bearbeiter" can create a new survey.
    Important: Decide on one type of rating for each survey. This is the only way to ensure a meaningful statistical analysis.

    1. Go to the  Configurations Configurations tab and select Added table fields Added fields > Feedback Feedback.
    2. Click in the "Typ" line and add the name of the new feedback form in the field Suggested values at the bottom right.
      Important: If the new survey is not added to the list, it will not be offered for selection!
      Example: Feedback_NewYearsEve
    3. Click on the „Auswahl Feedback“ line and add the name of the new feedback form in the field Suggested values at the bottom right.
      Important: If the new survey is not added to the selection list, it will not be offered for selection!
      Example: Feedback_NewYearsEve
    4. Click on neuexpand Add to add a new question to this feedback form.
    5. Select a Rating type (thumbs, stars, grades, etc.) from the selection list. The field star Further settings is automatically pre-assigned with the appropriate parameters and explanations. These parameters must be adjusted for the new question and deleted if necessary!
    6. Customise the added field for your feedback form:
      1. Enter either the question itself or an internal name as the Field label .
        Example: "How many stars would you assign our service team?" or "Service rating"
        Note: If the label is too long, it may not be displayed fully in the desktop application. Keep the label short and use the parameter Label in the field Further settings (see below) for longer texts.
        Important: If you want to use the field label, be sure to delete the "Label" and "Label with HTML formatting" parameters in the star Additional settings !
      2. Enter the name of the feedback form as Group .
      3. Select the Data type "Number" to enable statistical evaluation.
      4. Do not use any special characters in the Field name .
    7. In the starFurther settings field, all possible parameters are already available.
      Important: Only keep the parameters that are either mandatory or that you want to use optionally. Delete all parameters that you do not want to use.
      1. The following parameters are mandatory : Name of the survey, page number, index, CSS class
      2. All other parameters are optional and are partially mutually exclusive: Labelling, Labelling with HTML formatting, languages, help texts, placeholders. 
      3. Adjust the following parameters:
        1. Name of the survey as the first parameter
          Important: Individual questions can be integrated into several surveys. To do this, enter additional "Names:Page numbers" one below the other.
          Example: Demo_1:1
          Demo_2:1
          Index: 20
        2. Page number: for multi-page feedback forms
        3. Index: Sequence for multiple questions
          Important: Assign multi-digit numbers as an index (10,20,30,..) to facilitate the subsequent insertion of other questions.
        4. Label: only if you don't want to use the field label
          Important: In this case, be sure to delete the "Label with HTML formatting"!
        5. Label with HTML formatting: only if HTML formatting (links etc.) is to be inserted. 
          Important: In this case, be sure to delete the "Label" without formatting!
        6. Additional languages, help texts, placeholders, etc. as required
    8. Insert an additional table detail field for each additional question. To ensure that the questions all appear in the same survey, the name of the survey must be set as the first parameter in each individual question.
    9. save Save your input.
  • Configure the server query

    The server query is configured in an index file. Only users with the "WebFolder" authorisation can create a new index file for the survey. 

    1. Go to the Basis Home tab and click on Job Start job, then select the export job „WebApp_Feedback_V2_Export_00_Start“ to generate the .js files for the new feedback form.
    2. Go to the Configurations Configurations tab and select Html Web > Web Ordner Web Folder Administration, then open the folder Ordner Bestellung Feedback_V2 >Ordner Bestellung  Templates. The export job has created a new JavaScript file with the name of the new survey in this folder.
      Note: All template files must begin with the prefix "Feedback_Template_".
      Example: Feedback_Template_Feedback_NewYearsEve.js
    3. In the Ordner Bestellung Feedback_V2 folder, select the Html HTML-file "Demo_Single-Language", click on export festplatte Save to hard drive in the toolbar and select a filing location.
    4. Copy the file and Save it under a new name.
      Example: Feedback_NewYearsEve.html
    5. Open the new file in the editor Notepad++ to see the line numbers.
    6. Replace the name of the old JavaScript file with the name of the new JavaScript file in three places in the HTML file. The prefix remains the same, it is sufficient to replace the name of the new feedback.
      Example: the old survey is called "Demo_Einsprachig", the new survey is called "Feedback_Silvesterball" 
      1. in line 44: document.getElementById("Sprache").setAttribute("data-bpWebApp-templateDataSrc", "templates/Feedback_Template_Feedback_Silvesterball.js");
      2. in line 48: document.getElementById("Sprache").setAttribute("data-bpWebApp-templateDataSrc", "templates/Feedback_Template_Feedback_Silvesterball_"+lang+".js");
      3. in line 94: document.getElementById("Sprache").setAttribute("data-bpWebApp-templateDataSrc", "templates/Feedback_Template_Feedback_Silvesterball_"+lang+".js");
    7. Replace the number of the logon ticket in three places in the HTML file (Create a web logon ticket):
      1. in line 45: data-bpWebApp-templateDataSrc="templates/Feedback_Silvesterball.js" data-bpWebApp-queryString="&logon_ticket=D24CF964983443CC9C07DDF4E48695AB">
      2. in line 49: data-bpWebApp-templateDataSrc="templates/Feedback_Silvesterball.js" data-bpWebApp-queryString="&logon_ticket=D24CF964983443CC9C07DDF4E48695AB"+lang)>
      3. in line 95: data-bpWebApp-templateDataSrc="templates/Feedback_Silvesterball.js" data-bpWebApp-queryString="&logon_ticket=D24CF964983443CC9C07DDF4E48695AB"+lang)>
    8. Speichern Save the new index file locally under the name" Feedback_Silvesterball.html".
    9. Click on neu Add in the Ordner Bestellung Web Folder and select import festplatte Upload files, then select the new HTML file.
    10. ok Confirm the new file and close the Ordner Bestellung Web Folder.
  • Create additional languages for surveys

    Surveys can be offered in multiple languages; in the WebApp, the user then switches to the other language by clicking on an icon (flag). First enter the parameters in the questions (Added fields) accordingly, create individual JavaScript files for each language and integrate these into the index file.

    The language codes "en" and "fr" are preset. Other languages can be added via additional transaction steps in the export job.

    1. Go to the  ConfigurationsConfigurations tab and click on JobJobs, then select "WebApp_Feedback_V2_Export_00_Start".
    2. Click on Transaction step > neu New and add a copy of the job "WebApp_Feedback_V2_Export_01_Template_Types" for each language individually.
      Important: Assign only one language per line (transaction step).
    3. Enter a code for each language as Parameter Default setting . The language does not have to be created in the full client beforehand.
      Example: JobParameter:Language=pt
    4. save Save and close the job.
  • Create multi-language surveys

    Surveys can be published in multiple languages; in the WebApp, the user then switches to the other language by clicking on an icon (flag). First enter the parameters in the questions (Added fields) accordingly, create individual JavaScript files for each language and integrate these into the index file.

    1. Go to the Configurations Configurations tab and select Added fields >  Feedbackand filter for the Group (= name of the feedback/survey). 
    2. Double-click to open each question (Added field) of the survey and maintain the corresponding parameters in the field Further settings .
      Important: Replace the placeholder <Sprache> with the language code and enter an appropriate text
      1. Label-<Sprache>:
      2. LabelHtml-<Sprache>:
      3. Tooltip-<Sprache>:
      4. Options-<Sprache>:

    Example:

     Demo_Mehrsprachig:1
    Index:3
    CssClass:bp-fb-default

    Options:1//Value 1;2//Value 2;3//Value 3;4//Value 4;5//Value 5;6//Value 6;7//Value 7;8//Value 8;9//Value 9;10//Value 10
    Options-fr:1//Value 1;2//Value 2;3//Value 3;4//Value 4;5//Value 5;6//Value 6;7//Value 7;8//Value 8;9//Value 9;10//Value 10
    Options-en:1//Value 1;2//Value 2;3//Value 3;4//Value 4;5//Value 5;6//Value 6;7//Value 7;8//Value 8;9//Value 9;10//Value 10
    Tooltip:Die volle Punktzahl (10 von 10) entspricht der besten Leistung.
    Tooltip-en:The full score (10 out of 10) corresponds to the best performance.
    Tooltip-fr:La note maximale (10 sur 10) correspond à la meilleure performance.
    LabelHtml:<strong></strong><p>... die Planung und Organisation Ihrer Veranstaltung?</p>
    Hidelabel:
    LabelHtml-en:<strong></strong>...<p> the planning and organisation of your event?</p>
    LabelHtml-fr:<strong></strong><p>La planification et l'organisation de votre évènement</p>

  • Configure the query for multi-language surveys

    The individual JavaScript files must be correctly integrated into the index file so that the survey can be displayed correctly in the WebApp in all languages created. Additional icons may also need to be integrated for newly created languages.

    1. Go to the  Basis Home tab and click on Job Start job, then select the export job „Feedback_V2_Export_00_Start“ to generate the .js files for the new feedback form. This creates another file with the new language code for each existing JavaScript file.
      Example: "Feedback_Template_Feedback_NewYearsEve.js" is supplemented by "Feedback_Template_Feedback_NewYearsEve-pt.js"
    2. Go to the Configurations Configurations tab and select Html Web > Web Ordner Web Folder Administration, then open the folder Ordner Bestellung Feedback_V2 > Ordner Bestellung Templates. All existing JS files should be stored in this folder.
    3. In the Ordner Bestellung Feedback_V2 folder, select the Html HTML-file "Demo_Mulit-Lanuage", click on export festplatte Save to hard drive in the toolbar and select a filing location.
    4. Copy the file and Save it under a new name.
      Example: Feedback_NewYearsEve.html
    5. Open the new file in the editor Notepad++ to see the line numbers.
    6. Replace the name of the old JavaScript file with the name of the new JavaScript file in three places in the HTML file. The prefix remains the same, it is sufficient to replace the name of the new feedback.
      Example: the old survey is called "Demo_Mehrsprachig", the new survey is called "Feedback_NewYearsEve" 
      1. in line 44: document.getElementById("Language").setAttribute("data-bpWebApp-templateDataSrc", "templates/Feedback_Template_Feedback_Silvesterball.js")
      2. in Zeile 48: document.getElementById("Sprache").setAttribute("data-bpWebApp-templateDataSrc", "templates/Feedback_Template_Feedback_NewYearsEve_"+lang+".js");
    7. All settings are included for the standard languages English and French. For newly created languages, some of the buttons, flags, IDs, classes or HTML tags must be added individually.
      1. button, e.g. <button title="Portuguese" onclick="startBpWebApp('pt');" id="PT"><img src="/images/portugal_24.png" alt=""></button>
        Note: Save the new icon to a suitable location and reference it correctly in the HTML or Css file.

      2. document.getElementById("PT").setAttribute("title", bpWebApp.localeObj[locale].Portuguese)

    8. In order NOT to use languages that have already been created in a survey, the corresponding lines in the HTML file MUST be deleted or commented out (<! -->).
    9. save Save the new index file locally under the name "Feedback_NewYearsEve.html".
    10. Click on neu Add in the Ordner Bestellung Web Folder and select import festplatte Upload files, then select the new HTML file.
    11. ok Confirm the new file and close the Ordner Bestellung Web Folder.
  • Configure the language of the web interface

    The sample file "Demo_Mehrsprachig.html" already contains the configuration in DE, EN and FR. If you require another language, please make the following adjustments:

    1. In the HTML document, copy the lines 59 and 90 and then adapt them to the desired language:
      Example:
      Original: document.getElementById("FR").setAttribute("title", bpWebApp.localeObj[locale].French)
       document.getElementById("PT").setAttribute("title", bpWebApp.localeObj[locale].Portuguese)
      Original: <button title="Französisch" onclick="startBpWebApp('fr');" id="FR"><img src="/images/france_24.png" alt=""></button>-
      New: <button title="Portugiesisch" onclick="startBpWebApp('pt');" id="PT"><img src="/images/Portugal_24.png" alt=""></button>-
    2. Create another "locale" file in the folder Server >Data > Web Folder > Feedback_V2\locale.  Select one of the existing files, copy it and adapt the file name with the abbreviation of the desired language.
      Example:
      Original: bpLocale.fr.json
      New: bpLocale.pt.json
    3. Open the new document and only translate the words in the right-hand column.
      IMPORTANT:
      Pay close attention to the colons (:), double inverted commas (" ") and the comma (,). If this structure is not adhered to, an error will occur when loading the application. Take particular care with the last line: There must be no comma (,) at the end, as opposed to the previous lines!
      Example:  

    {
    "Button_Send" : "Send",
    "Deutsch" : "German",
    "Englisch" : "English",
    "Franzoesisch" : "French",
    "Msg_Danke" : "Thank you for your feedback.",
    "Button_Weiter" : "Forward",
    "Msg_Senden" :"The data was sent successfully.",
    "Button_Zurueck" : "Back"

    }

  • Export the new survey

    Export the new feedback form via the preconfigured job.

    1. Go to the  Basis Home tab and click on  abspielen Start job, then select „WebApp_Feedback_V2_Export_00_Start“.
    2. Enter the URL of the feedback form in the browser. The URL is made up of the port of the service client (from Administration Administration > Monitor Service Clients > HTTP Port/HTTPs Port), the name of the WebApp (Feedback_V2) and the name of the index file.
      Example: <a href="https://<Your server address>/Feedback_V2/Feedback_NewYearsEve.html">
  • Send a new survey

    To target the new survey to your customers, send emails with an embedded link. The incoming responses can optionally be linked to the customer's account and a specific event. Some suitable text templates are included in the scenario (Feedback_V2 Mustervorlage, Feedback_V2 Mustervorlagevorlage_Reservierungen (für Tischreservierungen)).

    1. Go to the  Templates Templates tab and select vorlage brief Text templates > Event template "Feedback_V2 Sample template".
    2. Copy the template and save Save under a new name.
    3. Click on bezug Show 4D expressions in the toolbar.
      Important: Not all references are always visible! Be sure to display the references before you make any changes to avoid unknowingly deleting important references!
    4. Customise the link for your survey and your event:
      1. Enter the corresponding URL of the feedback form.
        The URL is made up of the port of the service client (from Administration Administration > Monitor Service Clients > HTTP Port/HTTPs Port), the name of the WebApp (Feedback_V2) and the name of the index file (HTML file).
        Example: https://<Your server address>/Feedback_V2/Feedback_Silvesterball.html
      2. Enter an Event ID as "VA_DatensatzID=".
      3. Enter an Account ID as "AdrUUID=", if applicable a Contact person ID as "Asp_UUID=" or a Reservation ID as "Gast_UUI=".
        The UUID of the record in question can be found in the record by right-clicking on Data record ID in the top right-hand corner of the title bar of the window. Left-click on this Record ID to copy the number to the clipboard and insert it elsewhere.
        Example: https://<Your server address>/Feedback_V2/Feedback_Silvesterball.html?VA_DatensatzID=4711&Adr_UUID=1066&Asp_UUID=333&Gast_UUI=7654 contains references to event no. 4711, account no. 1066, contact no. 333 and reservation no. 7654.
    5. To send the survey automatically, e.g. after the end of an event, set up a corresponding Job Job. (Creating jobs)
  • Integrate a new survey into your website

    To address the new survey to all customers who come to your website, integrate the link into the website, e.g. via an iFrame. The incoming responses will not be linked to an account (anonymous).

    1. Go to your website and insert a link to the URL of the feedback form.
      The URL is made up of the port of the service client (from Administration Administration > Monitor Service Clients > HTTP Port/HTTPs Port), the name of the WebApp (Feedback_V2) and the name of the index file (HTML file).
      Example: <a href="https://<Your server address>/Feedback_V2/Feedback_Silvesterball.html">
    2. Add an Event ID to the URL to obtain feedback on this specific event.
      Example: <a href="https://<Your server address>/Feedback_V2/Feedback_Silvesterball.html?VA_DatensatzID=4711">
  • Hits: 53

Setting up the Feedback WebApp

Only a few settings are required when importing the scenario WebApp_Feedback_V2. If an older version of the WebApp was previously installed, individual settings may need to be adjusted.

  • Assign a real user

    A Gruppen User group with the relevant authorisations for editing surveys is included in the scenario. The real user is responsible for creating and analysing surveys via the Feedback WebApp.

    1. Go to the Administration Administration tab and click on Benutzer Users, then select the user who is to be responsible for editing the feedback.
      Example: Events Office, Carolin Fixit
    2. Assign the user group  Gruppen „Feedback_V2_Bearbeiter“ as   or give the user authorisation to write   in the table Feedback Feedback .
    3. save Save your input.
  • Set up two technical users

    Two Gruppen User groups with the relevant authorisations are included in the scenario.

    1. Go to the  Administration Administration tab and click on  Users Users.
    2. The technical user "Feedback_V2_Import" is only required for importing the data. Create this Users User with the following login name, name and first name:
      1. Login name: "Feedback_V2_Import", Name: "Feedback_V2_Import", First name: "WebAppUser"
      2. Do not give any access rights.
      3. Assign the Gruppen User group "Feedback_V2_Import".
    3. The technical user "Feedback_V2_Technik" is required to create the web login ticket. Create this Users User with the following login name, name and first name:
      1. Login name: "Feedback_V2_Technik", Name: "Feedback_V2_Technik", First name: "WebAppUser"
      2. Give  Access  Web Client "via web server"
      3. Assign the Gruppen User group "Feedback_V2_Technik".
    4. save Save your input.
  • Create a web login ticket

    Create a web login ticket for the user who is to be responsible for the Feedback WebApp. The ticket is need when configuring the server query for new surveys (Configure the server query).

    1. Go to the Configurations Configurations tab and click on Html Web > Web Logon Ticket Web logon tickets > neu New.
    2. Select the Users User "Feedback_V2_Technik" from the picklist.
    3. Enable multi-use for the ticket and set the Validity to a high value.
    4. Copy the web logon ticket to the clipboard when prompted.
    5. save Save your input.
  • Export the demo feedback forms

    The scenario contains three sample surveys:
    - "Demo_Bewertungsarten": The feedback is only used to illustrate all available types of rating and should NOT be used as a copy template.
    - "Demo_Einsprachig": The feedback serves as a simple example of a survey that is output in one language.
    - "Demo_Mehrsprachig": The feedback serves as a simple example of a survey that is output in several languages.

    1. Go to the  Basis Home tab and click on  abspielen Start job, then select „WebApp_Feedback_V2_Export_00_Start“.
    2. Open a browser (http for local, https for external).
      a. Under the URL "http://<Ihre Serveradresse>/Feedback_V2/Demo_Bewertungsarten.html?" you will find a sample page with all available evaluation types and text examples.
      b. Under the URL "http://<Ihre Serveradresse>/Feedback_V2/Demo_Einsprachig.html?" you will find a sample page with several questions on different topics but with the same evaluation type. The same evaluation type should always be used within a survey in order to enable a statistical evaluation.
      c. Under the URL "http://<Ihre Serveradresse>/Feedback_V2/Demo_Mehrsprachig.html?" you will find a sample page with several questions on different topics but with the same assessment type. On this page you can also switch between the languages German - English - French.
  • Adjust settings from older versions

    If an older version of the Feedback WebApp was previously installed on the selected server, additional settings may need to be adjusted.

    1. Go to the  Configurations Configurations tab and select Added table fields Added fields > Feedback Feedback.
    2. If this has not happened automatically, add the name of the feedback („Demo_Bewertungsarten“) to the lists of suggested values:
      a. in added field Auswahl Feedback
      b. in added field Typ 
    3. Check whether the field Typ > Further settings contains the entry "All types:X" and add it if necessary.
    4. Check the Visibility rule in record for the Table settings and adjust if necessary.
  • Test changes and export

    The individual questions of the feedback forms are created as  Added table fields Added fields for the Feedback  Feedback table. These fields can be changed and re-exported as required. Use the "Demo_Bewertungsarten" to check whether the data export works as desired.
    IMPORTANT: The survey MUST be re-exported after every change!

    1. Go to the  Configurations Configurations  tab and select  Added table fields Added fields > Feedback Feedback and filter for the Group "Demo_Bewertungsarten".
    2. Select one Added table fields  Added field and enlarge the text field star Further settings for editing.
    3. Change a text or a rating type and confirm by clicking OK.
      Example: Change a "label" or change the rating type.
    4.   Save your input.
    5. Go back to the  Basis Home tab and click on  abspielen Start job, then select „WebApp_Feedback_V2_Export_00_Start“.
    6. Clear your browser cache and reload the above link. Your changes should now appear on the website.
  • Hits: 49

Evaluating a survey

    • View individual survey results
      1. Individual survey results are filed in the records to which the surveys were linked.
        1. Under  VA Events > Feedback Feedback
        2. Under Adresse Account > Feedback Feedback
        3. Under Adresse Account > Contact > Feedback Feedback
        4. Under tischreservierung Reservation > Feedback Feedback
      2. Find all survey results for a selected period under  Briefe Communication > Feedback Feedback.
    • Access evaluations from the Info Centre

      The evaluation data for surveys can be accessed either as Liste List  or as  Datenblatt Datasheet from the  infocenterInfo Centre.

      1. Call up the evaluation by clicking on the dropdown triangle next to infocenterexpand Info Centre   in the open Feedback folder.
      2. Open the new data sheet by clicking on the dropdown triangle next to infocenterexpand Info Centre and selecting  Datenblatt Data sheets.
  • Hits: 51