[Settings] settings

Applies to the following products: 
Questionmark OnDemand
Questionmark Perception
Questionmark OnPremise
Applies to the following Perception versions: 
Perception 5.7
Perception 5.4
Perception 5.2
Perception 5.1

This section defines any configuration settings to be used by the PIP file. The following settings are possible:

Control settings

Control settings are described in the following table.

Setting Description Possible values
NOTIFY

This specifies a URL of a program to be called (notified) at end of the assessment and/or when session.php needs to perform a callback. If a URL is passed on the command line, the URL specified here will not be used.

If no NOTIFY parameter is passed on the command line and this entry is omitted or blank in the PIP file, then no program is called at the end of the assessment. If a NOTIFY parameter is used, then this URL is called at the end of the assessment and/or when session.php needs to perform a callback.

The call to the URL is configured by the parameters in the rest of the [Settings] section. The actual parameter values that are passed to the URL when it is called are defined in the [Output] section when the call is made at the end of the assessment or in the [Callback] section when the call is made at the start of the assessment as a callback.

URL
METHOD

This specifies the HTTP method to be used when calling the notification URL. This may be either GET or POST.

If this is not set, the default value of POST will be used. You are recommended not to change this unless you are an expert user.

GET or POST
HEADER

This specifies the HTTP header to be used when calling the notification URL. If this is not set, the default value of

Content-Type: application/x-www-form-urlencoded

will be used. You are recommended not to change this unless you are an expert user.

 
OUTPUTFORMAT This specifies the format used to pass the parameters and values when calling the notification URL. The first %s is replaced by the parameter name and the second %s is replaced by the parameter value. If this is not set, the default value of %s=%s& will be used. You are recommended not to change this unless you are an expert user. %s=%s&
CALLBACK

If this is set to yes or 1, PIP will call the notify URL when the initial PIP call is made, passing the information as defined in the [Callback] section and adding any information received to the parameters used to start the assessment.

This provides a secure mechanism for starting assessments; the calling program can simply send an ID on the command line, PIP will then call the notify URL to receive extra information such as the ID of the assessment to be run and the participant's name.

Yes/1

No/0

USENOTIFY If this is set to no or 0, the notify URL is prevented from being called when the assessment is finished. This may be used in conjunction with the callback protocol when PIP is only used to start an assessment and the results of the assessment are not required.

No/0

Yes/1

USEHOME If this is set to 1 or Yes the Home button will display at the end of an assessment. If USEHOME is used in conjunction with CLOSEHOME the assessment window will close when a participant clicks the Home button. For more information see the Home button settings section below.

Yes/1

No/0

CLOSEHOME If this is set to 1 or Yes the Home button will close the assessment at the end of an assessment. The CLOSEHOME setting can only be used if USEHOME is set to 1 or yes. For more information see the Home button settings section below.

Yes/1

No/0

DISABLE COOKIES If set to 0 no cookie information is sent in the callback and notify HTTP calls. 0/1

Topic scoring settings

You can include topic scoring information in the PIP.

Setting Description Possible value
TOPICSCORES You can include topic scoring information in the PIP output with the settings TopicScores and TopicPercent. The TopicScores and TopicPercent need to be defined if they are enabled.

Yes/1

No/0

TOPICPERCENT

If the setting: TopicScores=yes is made, a series of parameters of the form shown below will be included in the output.

Parameter Description
TOPICS The number of topics in the assessment
TOPIC_n The topic description of topic number n, unless the topic description is blank in which case the topic name is used
SCORE_n The actual score for topic number n
MAXSCORE_n The maximum possible score for topic number n

If the setting: TopicPercent=yes is made, a series of parameters of the form shown below will be included in the output.

Parameter Description
TOPICS The number of topics in the assessment
TOPIC_n The topic description of topic number n, unless the topic description is blank in which case the topic name is used
PERCENT_n The percentage score for topic number n

If both TopicScores and TopicPercent are set to yes, these parameters are consolidated as follows.

  • TOPICS
  • TOPIC_n
  • SCORE_n
  • MAXSCORE_n
  • PERCENT_n

For example, if both TopicScores and TopicPercent are set to yes, an assessment that contains three topics might generate these output parameters:

?TOPICS=3&TOPIC_1=Math1&SCORE_1=5&MAXSCORE_1=10&PERCENT_1=50 &TOPIC_2=Math2&SCORE_2=10&MAXSCORE_2=10&PERCENT_2=100 &TOPIC_3=Math3&SCORE_3=7&MAXSCORE_3=10&PERCENT_3=70

Home button settings

You can control what happens when a participant clicks the Home button at the end of an assessment that is launched from PIP. This means that if a Learning Management System (LMS) calls Questionmark, the Home button can be used to return from Questionmark to the LMS when the participant completes the assessment. This is done with the Home button settings described below.

Setting Description
HOME

Specifies what the HOME button does at the end of an assessment. This setting can be a URL:

HOME=http://www.questionmark.com/resources/Parameters.html

It can be a file reference:

HOME=file:///C:/Perception5/resources/Parameters.html

Or it can be a Javascript command (However, this will only work if the assessment window was opened via javascript to begin with.):

HOME=javascript:self.close();

This setting can also be made with the session.php command line parameter home, for example:

session.php?call=perception.pip&home=http://www.questionmark.com/results.html

If this command line parameter is used, it takes precedence over the HOME setting in the PIP file. If the HOME setting is used in the PIP file, or the command line parameter is used, when a participant clicks the HOME they are directed to a URL that is composed of the specified home URL plus all data as defined in the [Output] section, for example:

http://www.questionmark.com/results.html/?assessment_id=4749119486591492 &details=Perception%20Integration%20Protocol

USEHOME

Used to enable or disable the URL for the HOME button even if it is set in the PIP file or passed as a command line parameter.

If UseHome is set to no or 0 (or the setting UseHome is not present in the PIP file), a participant will not be directed to the home URL when they click the HOME button.

Using the HOME and NOTIFY settings together the HOME setting is used independently of the NOTIFY setting, which means that: These settings can be used together and with different URLs. Notification takes place before the final page is displayed a participant will be directed to the home URL when they click the HOME button.

CLOSEHOME If USEHOME is enabled the CLOSEHOME setting can be used to close the assessment window when the Home button is clicked. The NOTIFY parameter can be used independently of this setting as well. If enabled, along with USEHOME and NOTIFY, the defined URLs for these settings are processed before the command to close the window.

Questionmark Secure settings

If you are calling a Questionmark assessment via PIP you can require Questionmark Secure to be used by participants taking the assessment with the setting:

Require QS=yes

If you make the settings:

UseHome=yes

CloseHome=yes

...this makes the Home button on the final page of the assessment close Questionmark Secure.