Available Parameters

The following tables list the parameters that are available.

1. General configuration parameters on the application level
2. General configuration parameters PULL configurations
3. Configuration parameters for a single feedback mechanism

For each parameter the following information is provided:

1. Name
2. Cmp: Front-end component (same annotation also used in other fields):
   • • = Android as well as the Web client
   • (A) = Android client specific
   • (W) = Web client specific
3. Req. (Required): If a parameter is required or not (Y/N)
4. Values: Values allowed for the parameter
5. Default: Default value if the parameter is not provided
6. Description

Remark for the Android client:

• Regardless of the representation of integer numbers in the database on the orchestrator, in the resulting JSON configuration file which is retrieved from the orchestrator, all integer numbers 'i' must be in the format 'i.0' as shown below (where maxLength = 200).
  "key": "maxLength",
"value": 200.0
• Regardless of the representation of boolean values in the database on the orchestrator, in the resulting JSON configuration file which is retrieved from the orchestrator, all boolean values must be in the format '1.0' for 'true' or '0.0' for 'false' as shown below (where mandatory = true).
  "key": "mandatory",
"value": 1.0
• Concerning the default values of some parameters, e.g., the default text size, they vary among the various devices running Android. So in cases where there are no unique default values covering all devices, no default value will be provided.

General Configuration

Application configuration

Name	Cmp	Req.	Values	Default	Description
closeDialogOnSuccess	(W)	N	0 or 1	0	Whether to close the dialog on successful feedback submission and show a separate success message
discardAsButton	(W)	N	0 or 1	0	Whether to display the discard action as a button or link
feedbackFormTitle	(W)	N	String	''	Title displayed above the form inside the dialog
labelFontColor	(W)	N	hex value	-	General label font color
labelFontSize	(W)	N	integer	-	General label font size
labelFontWeight	(W)	N	'bold', 'normal' or 100, 200, etc.	'normal'	General label font weight
mandatoryLabelStyle	(W)	N	String	'italic', 'bold', 'normal'	'normal'
mandatorySign	(W)	N	String e.g. '', '*'	''	Sign to denote mandatory fields/inputs
labelPositioning	(W)	N	'left', 'top'	'left'	Position of the mechanism's label/title
reviewActive	(W)	N	0 or 1	1	Whether or not to present a preview of the feedback to the end-user
reviewFontFamily	(W)	N	String	-	Font family of the review text
reviewFontType	(W)	N	'italic', 'bold', 'normal'	'normal'	Font type of the review text
submissionPageMessage	(W)	N	String	-	Message to show above the submission button to e.g. indicate who receives the feedback

PULL configuration

Name	Cmp	Req.	Values	Default	Description
actionName	(W)	N	'click', 'change', etc.	-	Subparameter of userAction that describes the event on which the pull should get triggered
actionElement	(W)	N	'#element', '.element', etc.	-	Subparameter of userAction that sets the element selector for the action
actionOnlyOncePerPageLoad	(W)	N	0 or 1	1	Subparameter of userAction that sets whether the action is maximally triggered once after page load
doNotDisturbTimeDuration	(W)	N			Seconds in which the user does not get shown a pull dialog again after one appeared. Stored in a cookie.
likelihood	*	N	Float [0,1]	-1.0 (A) ? (W)	Likelihood of a pull configuration to be chosen when a pull configuration is triggered randomly (triggerRandomPullFeedback)
onlyDisplayOnce	(W)	N	0 or 1		Once the pull dialog is shown to the user, a cookie is set that prevents displaying the same dialog again. The cookie stores the pull configuration ID to decide whether the dialog belonging to the pull configuration was already shown.
pullDelay	(W)	N			Seconds after page visits to wait with showing the dialog
showIntermediateDialog	*	N	0 or 1	1 (A) ? (W)	Show the user a pop up dialog if a pull feedback is triggered
userAction	(W)	N			Allows to define actions after which the pull feedback mechanisms should get shown

Mechanism configuration

Attachment Mechanism (only for Web)

Name	Cmp	Req.	Values	Default	Description
title	(W)	Y	String	-	Title of the attachment mechanism
maximumTotalFileSize	(W)	N	Number (Bytes)	0 (= no restriction)	Maximum total file size for the attachments (summed up) in bytes.

Audio Mechanism

Name	Cmp	Req.	Values	Default	Description
bitRate	(W)	N	Float [1,n]	10	Audio bit rate
maxTime	*	N	Integer [1,n]	10	Maximal possible recording time
title	*	Y	String	-	Title of the audio mechanism

Category Mechanism

Name	Cmp	Req.	Values	Default	Description
mandatory	*	N	0 or 1	0	If it is mandatory to select at least one category
mandatoryReminder	*	Y	String	-	Reminder shown to the user if no category is selected and it is mandatory
multiple	*	*	0 or 1	0	Single choice or multiple choice
options	*	Y	Array of parameters	-	Choices
ownAllowed	*	Y	0 or 1	-	Whether or not to display an 'other' option
title	*	Y	String	-	Title of the category mechanism

Rating Mechanism

Name	Cmp	Req.	Values	Default	Description
defaultRating	*	Y	Integer [0,maxRating]	-	Predefined rating
maxRating	*	Y	Integer [1,n]	-	Maximal possible rating
title	*	Y	String	-	Title of the rating mechanism

Screenshot Mechanism

Name	Cmp	Req.	Values	Default	Description
annotationExplanation	(W)	N	String	-	Explanation for the annotations
arrowMouseover	(W)	N	String	-	Mouseover for the arrow annotation
bitdepth	(W)	N	Integer, e.g. 8	-	Bit depth for screenshot
circleMouseover	(W)	N	String	-	Mouseover for the circle annotation
filledRectMouseover	(W)	N	String	-	Mouseover for the filled rectangle annotation
freehandMouseover	(W)	N	String	-	Mouseover for the freehand drawing
manipulationOnObject	(W)	N	0 or 1	1	Whether objects dragged on the screenshot can directly get modified on the screenshot itself with regard to color change and deletion
maxResolution	(W)	N	String. Format x, e.g. 100x200	0	Max resolution string
maxTextAnnotation	(A)	N (A)	Integer [0,n]	0	Maximal number of text annotations
title	*	N	String	-	Title of the screenshot mechanism
rectMouseover	(W)	N	String	-	Mouseover for the rectangle annotation
sentimentSatisfiedMouseover	(W)	N	String	-	Mouseover for the positive smiley annotation
sentimentDissatisfiedMouseover	(W)	N	String	-	Mouseover for the negative smiley annotation
textMouseover	(W)	N	String	-	Mouseover for the text annotation
thumbUpMouseover	(W)	N	String	-	Mouseover for the thumb up annotation
thumbDownMouseover	(W)	N	String	-	Mouseover for the thumb down annotation

Text Mechanism

Name	Cmp	Req.	Values	Default	Description
borderColor	(W)	N	hex value		Border color of the text input
borderWidth	(W)	N	Integer [1,n]		Border width of the text input
clearInput	(W)	N	0 or 1	0	Whether to display a button to clear the input field
fieldBackgroundColor	(W)	N	hex value	-	Background color of the text input field
fieldFontSize	*	N	Integer [0,n] Unit: SP (A) px (W)	-	Font size of the input text
fieldFontType	*	N	'italic', 'bold', 'normal'	'normal'	Font type of the input text
fieldHeight	(W)	N	Integer [1,n]		Height of the text input field
fieldTextAlignment	*	N	'center', 'right', 'left'	'left'	Text alignment of the input text
fieldWidth	(W)	N	Integer [1,n]		Width of the text input field
hint	*	N	String	-	Hint of the text input field
label	*	N	String	-	Label of the text input field
labelColor	(W)	N	String	#000000	Color of the label
labelFontSize	(W)	N	Integer [1,n]	15	Font size of the label
labelPositioning	(W)	N	'left', 'right'	left	Position of the label
mandatory	*	N	0 or 1	0	If it is mandatory to fill in some text
mandatoryReminder	*	N	String	'Default mandatory reminder text!' (A) ? (W)	Reminder shown to the user if no text is filled in and it is mandatory
maxLength	*	N	Integer [0,n]	-	Maximum number of characters allowed in the text input
maxLengthStrict	(W)	N	0 or 1	0	Whether to prevent typing if max length is reached
maxLengthVisible	*	N	0 or 1	0	If the maximum number of allowed characters is visible in the text input field
textareaFontColor	*	N	String [#RRGGBB or #AARRGGBB]	black (A) black (W)	Colour of the input text font
textLengthVisible	(A)	N	0 or 1	1	If the current characters counter is visible in the text input field
title	*	N	String	-	Title of the text input field