Extension Details

Click on a Name link in the Flex Extensions Overview page to open the Extension Details page for that extension.

Figure 1 - Example of the Extension Details page for an extension

This page is where you set up the various URLs to call the extension when required. The fields and buttons on this page are as follows:

• Validate URLs - click this button to run a check of the URLs that have been entered on the page.
• ID - the ID number for the extension. This number is allocated automatically when the extension is created and cannot be changed.
• Name - the name of the extension. This is the name that will be displayed in the various Forsta windows. It may be different from the actual name or title of the extension application.
• Consumer key - the Extensibility SDK uses Oauth (http://oauth.net/) to authorize Extensions to appear within Forsta Plus and to access specific REST web services that are part of the Extensions SDK. The Consumer Key and Consumer Secret are generated when an extension is registered in Forsta Plus.
• Consumer Secret - this code is created automatically when the extension is registered with Forsta - see also above.
• Status - the current status for the extension. The options are:
• Disabled - the extension is not available for use.
• Development - the extension is under development, and will only be available for the user specified as the "Contact Person". This will allow the developer to test the Extension in a survey without others being able to access or use it.
• Production - the extension is complete and may be used in production surveys.
• Project tab - the URL to a configuration page for the extension that will appear on a tab in the Project Overview page (see also the Forsta Authoring User Guide).
• Survey start - the URL to be called whenever the survey is entered by a respondent.
• Survey page complete - the URL specified here will be called every time the respondent completes a page in the survey. This could be used for example to log the time a respondent uses to answer the questions as part of a fraud detection program.
• Survey frontend - the URL to an alternative renderer for survey pages (for example, specific to iPhones).
• User Agent - if you wish respondents using specific browsers to be automatically redirected to the survey frontend extension (specified in the Survey Frontend field) then you must specify a value (regular expression) in the User Agent field. For example, if you want iPhone and iPod users to be automatically redirected to the extension URL, then you can specify the value Apple.*Mobile.*Safari. All other users will see the normal web survey. If this field is left empty then all users will see the normal web survey. You will then need to manually specify the extension URL in the browser to access the extension for a survey. If you specify just .* in the field, then all requests will be redirected to the extension URL.
• Information - the URL to the External Information page, which provides the Title, Created By, Version and Description information (go to Information XML for more information).
• Email - the URL that is called when an active email extension is encountered from the respondent emailing task.
• Scripting - Scripting Extension's URL, which is called when an extension is invoked through a script in a survey.
• Scripting Name - the name of the extension as referenced in the script.
• Panel Tab - the URL to the page that is displayed when an extension tab is clicked in the context of a Panel (basically the same as the Project tab, except that this is in the context of a Panel).
• Categories - depending on the state of the checkboxes, the extension is enabled for Projects, Panels or both.
• Contact person - the person responsible for the extension (the contact person in the event of problems with the extension).
• Description - a short description and/or comments concerning the extension.