Вы находитесь на странице: 1из 44

Sparq Administration Panel Settings

Scripting Guide Vision Critical Documentation -2-

Introduction
This document describes the configurable settings found in the Panel Settings Manager of Sparq. A VCAdmin user can access these settings by selecting Panel Settings Manager from the System menu on the Sparq console. Note Only a user with VCAdmin privileges can access these settings. The tables in this document contain four columns: Setting Name Description Configurable Default Value The Configure column contains one of three possible values: Yes: the setting can be modified by the VCAdmin account No: the setting is restricted Advanced: changes to this setting should be approved by the IT or Development team

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation -3-

Contexts
Communication Dashboard
Setting Name Datetime Message Description Configurable Default Value 4/21/09 11:00 Sparq Updates New Features added to Sparq 9CFD2850-444D4f4e-A8AE0494699EDB50 See (i) below

Displays the Date and Time when the Yes notification message was added Shows the Message displayed in the Yes Notification area Yes

NotificationID

Tooltip

Shows the text displayed when the Yes mouse hovers over the notification New features have been added to your panel. For more information, click the i. above link or contact Technical Support

Contact Information
Setting Name ReturnEmailAddress Description Configurable Default Value Email address used for sending survey Yes vcadmin@ visioninvitations critical.com ReturnEmailName Name shown in the mail address bar Yes supportpanel for survey invitations ReturnEmailPassword Password used when configuring Boog- Yes Password1 iePop TechSupportEmail Email address used to contact TechYes vcadmin@ visionnical Support critical.com TechSupportPhone Phone number used to contact Tech- Yes 604-111-1111 nical Support TechSupportStudyLink URLassociated with 'Technical SupYes port' link found at the bottom of the Sparq webpage. If empty, the link defaults to the value found in TechSupportEmail.

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation -4-

General
Setting Name Configurable Default Value Culture Context Language: language of the por-Yes en-CA tal based on panelist's context Environment Default environment of the Panel; Yes DEFAULT panel context disregarding panelist's culture Name The name of the Panel Yes Panel_supportpanel LongDateFormat Shows the Complete Date format in Yes dddd, text MMMM, yyyy ShortDateFormat Shows the Date format Yes MMM-ddyyyy ShortTimeFormat Shows the Time format Yes hh:mm tt PrivacyPolicyLink URLfor link to Privacy Policy. Link is dis-Yes played only if respondent uses a mobile device to access survey and the value is not empty. DecimalDelimiterOverride Passes delimiter value through C# to Yes None javascript to convert values before and after calculation from string to float and float to string. IsHidden Yes False Description

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation -5-

Incentives
Setting Name IncentivesPingEnabled Description Configurable Default Value Yes True

Enables the Incentives diagnostics task. Incentives feature must be enabled and IncentivesPingIntervalSeconds must be greater than 0. IncentivesPingIntervalSeconds The number of seconds to wait before Yes sending a successive diagnostics message. IncentivesPingService The number of seconds to wait before Yes CheckDelaySecondss making a direct call to the service to check whether a message has reached the service. Wait time initiates after a diagnostics message has been sent. IncentivesMonitoringLogging The location of the diagnostics mes- Yes ConfigFile sage log4net logging configuration file. i. %PanelRootDirectory%\IncentivesMonitorLogging.config

300 seconds (5 minutes) 10

See (i) below.

Media
Setting Description Name MediaServer Folder location to which the Rad Editor uploads media content Configurable Default Value No /MediaServer

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation -6-

Paths
Setting Name AdminBaseUrl AdminJavascriptPath Description Configurable Default Value SparqAdmin page base URL Advanced %URL%/Admin/ Relative path of Sparq's JavaAdvanced %VersionNumber% Script AdminSkinPath Relative path of Sparq's skin ele- Advanced %VersionNumber% ments OpenPortalLiveBaseUrl Portal page URL Advanced %URL%/Portal/ OpenPortalSkinFolder Relative path of the Portal's skin Advanced OpenPortalTestBaseUrl Portal page test or staging URL Advanced %URL%/PortalStaging PortalBaseUrl Portal page base URL Advanced %URL% PortalFlashPath Relative path of Portal's Flash ele- Advanced %VersionNumber% ments PortalJavascriptPath Relative path of Portal's JavaAdvanced %VersionNumber% script PortalSkinPath Relative path of a portal's skin ele-Advanced skin/ ments. This path generally changes for each context ReportingBaseUrl Report Builder base URL Advanced %URL%/Reporting/ ShelfsetBuilderBaseUrl Shelfset Builder base URL Advanced %URL%/ShelfsetBuilder/ TranslationBaseUrl Base URL of Translator's URL. Advanced This is located on the Languages tab of a study when a new language is added. Relative path of a translated por- Advanced tal's skin elements. This setting generally changes for each context %URL%/Translation

TranslationSkinPath

skin/

Note The default value for %URL% is www.supportpanel.bostaff.com

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation -7-

PointsManagement
Setting Name PointsFormatString Description Used to convert points format from Integer to a string in the DB The number of months of points history Configurable Default Value Yes 0 3

PointTransaction Yes HistoryMonths PerPage StudyPointsDescription The word or string used to describe points Yes in the portal

points

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation -8-

Portal
Setting Name CommunityTerms andInstructions Description Configurable Default Value Message instruction for Yes panelists to join the Community Community String used to describe the Yes UsernameLabel Username in the Community Community String used to describe the Yes Username Submit button in the ComSubmitButtonLabel munity ConfirmUnsubscribe Message received by pan- Yes Please click the button elists when they unsubbelow to confirm that scribe from a panel you want to unsubscribe the following email address: ForgotPassword Label on the button that Yes Forgot Password? appears on the Sparq login screen. InvalidPassword Message received by pan- Yes Please enter an alphaFormatMessage elists when their password numeric password does not meet the passbetween 6 and 12 charword criteria acters including at least one number. NowAPanelist Message received by new Yes Congratulations, you are panelists upon enrollment now a panelist. PanelistPortalLogin Text that appears with the Yes Login to the Panelist Porportal link on Contal firmation, Email Change and Unauthorized pages PostPanel Text of the panelist Thank Yes Thank you for your parNameWelcome You message ticipation. Please select from the following options: Welcome to the Thank you, your email address has been removed from the panel. To unsubscribe, click here

Text of the Panelist WelYes come message Unsubscribed Sets the message panelists Yes SuccessfullyMessage receive when they have been removed from a panel UnsubscribeMessage Label on the Unsubscribe Yes button
The Strategic Interactive Research Company

PrePanelName Welcome

Scripting Guide Vision Critical Documentation -9-

Best Practices The UnsubscribeMessage appears as a hyperlink. We recommend a short single line for this message. Example To unsubscribe from PCWPulse, click here. This will not affect your other PC World email preferences. Since the ConfirmUnsubscribe and UnsubscribedMessages do not appear in any emails, HTML markup can be used to alter these messages. Examples Please click below to confirm that you wish to unsubscribe the following email address from PCWPulse. <p>Unsubscribing from PCW Pulse will not affect your other PC World email preferences or your newsletter subscriptions</p> <p>Thank you, your email address has been removed from PCW Pulse.</p><p>If you want to update your PC World email marketing preferences, please visit us at <a href = http:// www.pcworld.com/newsletters/updateoptin> http:// www.pcworld.com/newsletters/updateoptin </a></p>

Security Requirements
Setting Name PanelistPasswordRegex Description Panelist password pattern PanelPlusUserPasswordRegex Admin password pattern Configurable Default Value Advanced ^(?=[^ ]*\d)(?=[^ ]*[a-zAZ]).{6,12}$ Advanced ^(?=[^ ]*\d)(?=[^ ]*[AZ])(?=[^ ]*[a-z]).{6,12}$

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 10 -

Diagnostics
Logging
Setting Description Name Category Category in which an action is stored Level Type of item being logged. Values include: Error, Warning, Info or Off Name Area of Sparq being logged. Values include: Task Manager, Export, Forum or Import Configurable Default Value Advanced TaskManager Advanced Error No Task Manager

Monitoring
Setting Name AdminEnabled PortalEnabled ReportEnabled RespondingEnabled ShelfsetEnabled Description Enables auditing Enables auditing Enables auditing Enables auditing Enables auditing Configurable Default Value on Admin pages Yes TRUE on Sparq Portal Yes TRUE on Reporting Yes TRUE on Responding Yes TRUE on Shelfset Builder Yes TRUE Yes Yes TRUE TRUE

StudyEnabled Enables auditing on Studies TaskManagerEnabled Enables auditing on Task Manager

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 11 -

General

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 12 -

Admin
Setting Name BatchAnswerText ToolsList BieksaMigrationDate CommunityAnalysis PageSize CompressJavascript Description Configureable Default Value List of tools for batch answers in Advanced InsertSnippet Rad Editor Date migrated to version 4.3 Advanced Number of posts to display on Advanced TRUE one page in Community Analysis Whether compressed javascript Advanced TRUE is used. This setting is used for panel optimization. Whether exporting private infor-Yes False mation is limited to VCAdmin Whether the panel has forums Yes FALSE enabled Whther the Fusion Integration Advanced Kit is enabled Sets what fields you can import Advanced PanelistIdQuestion PanelistEmail into the Participation Study PanelistAlternateId Yes TRUE Sets the list of tools for Instruc- Advanced tions in the Rad Editor Pipes, Undo, Bold, Italic, Underline, LinkManager, ImageManager, FlashManager, MediaManager, DocumentManager, InsertSymbol see (i) below see (ii) below 50

ExportPrivate Information Forums FusionIntegration Enabled ImportParticipation Questions IncludeClientShared Editor InstructionText ToolsList

IssuesURL LiveHelpUrl MinimumPointsFor Redemption PanelistManagement Visible PanelSettingsBackup Folder ProgressBarPath Algorithm

URLfor page displayed when a URL can not be loaded URL for Sparq Technical Support site Minimum number of points required before a panelist can redeem Whether Panelist Management is visible Name of the backup folder for panel settings Whether to use the shortest

Advanced Yes Yes

Yes Advanced Yes

True Panel Settings Backups ShortestPath

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 13 -

Setting Name

QuestionDefaults

QuestionPicker NodePageSize

QuestionTextToolsList

ReportingManualUrl SampleRequest DestinationEmail ServerSideViewState SelfCheckAllowableIPRange

Description Configureable Default Value path or longest path for calculating progress for responding to surveys Defines the following values Yes Culture: en-CA Required: TRUE for each question type: Height, in px, of verbatim The rest vary by question text box question type. Width, in px, of verbatim question text box Instruction Text: instructions displayed with given question type Culture: culture of the question Text: Instruction text that is displayed QuestionSubType: Question type to which these default values apply Required: whether a response is required How many questions are shown Yes 500 on the question picker tree before creating separate folders. This can affect performance when dealing with many questions. Sets the list of tools for all ques- Advanced Pipes, Undo, Bold, Italic, Undertions in the Rad Editor line, LinkManager, ImageManager, FlashManager, MediaManager, DocumentManager, InsertSymbol Advanced The email address to which addi-Yes tional sample requests are sent Whether the server side view Advanced TRUE state is enabled When SysNo See (iii) below temCheckFeatureState is enabled, configure the IP range for

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 14 -

Setting Name

Description Configureable Default Value it to function properly ShowSampleRequest Whether to show the sample Advanced FALSE Form request for in the Admin view of Sparq SingleAnswerText List of tools for single answers Advanced Pipes, Undo, Bold, ToolsList in the Rad Editor Italic, Underline, ImageManager UserManualUrl URL for the User Manual Advanced SecuredParticipationQuestions QuestionName Advanced PanelistPassword i. http://help.visioncriticalpanels.com/Issues ii. https://support.visioncritical.com/ics/support/security.asp?deptID=5389 iii. 76.77.75.0/25;216.191.179.224/28;149.7.36.40/29;184.73.228.111/32;10.0.0.0/8

Asset Manager
Setting Name Configurable Default Value MaxSingleUploadSizeKb Maximum single file upload size for Asset Advanced 5120 Manager MaxTotalUploadSizeKb Maximum total file upload size for Asset Advanced 10240 Manager SupportFileTypes List of file types that can be uploaded using the Asset Manager Advanced see below Description

File Types Supported by Asset Manager


Web files: .html, .htm, .css, .js, .xsl, .xslt Image files: .bmp, .gif, .ico, .jpg, .jpeg, .png, .xbml, .xpml, .ief, .fif, .ras, .pict, .xwd, .rgb Flash files: .swf, .flv Archive files: .zip Media files: .asx, .mov, .avi, .mpeg, .mpg, .mp3, .wav, .aiff, .ra, .ram, .wma, .wmf, .wmv, .dcr Document files: .doc, .rtf, .txt, .pef, .xml, .htm, .html, .xsl, .xslt

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 15 -

Authentication
Setting Name Configurable Default Value RequireAdminAuthentication Whether the user needs to be logged on No TRUE as Administrator to use Dynamic Reporting Description

Branding Manager
Setting Name BrandingManager FeatureState Description This feature is not supported Configurable Yes Default Value Hidden

Capscan Settings
Setting Name AccessCode AllowLookup ClientId Url Configurable Default Value The access code supplied by Capscan Advanced Whether address lookups are allowed Advanced FALSE ClientID supplied by Capscan Advanced The URL to Capscan's OnDemand web serv- Advanced See (i)below ice i. http://www.capscanondemand.com/capscanondemand/capscanondemand.asmx Description

Cell Limitation (Report Builder)


Setting Name Configurable Default Value MaxCellCount Max cells allowed in a crosstab Advanced 10000 MaxColumnCellCount Max columns allowed in a crosstab Advanced 100 MaxDynamicAnswerCount Max answers allowed in a calculated Advanced 100 question MaxNestedLevelCount Max items that can be nested in a Advanced 4 crosstab MaxRowCellCount Max rows allowed in a crosstab Advanced 200 Description

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 16 -

Community
Setting Name CommunityControl PanelAccess Description Configurable Default Value Yes AllAdmins Yes Yes Yes Advanced 40 50 3 ^]a-zAZ0-9_\@\.]+$ 500

Identifies the groups with access to the Control Panel in this community CommunityAnalysisPageSize Max number of posts to show on a page CSUsername Max number of characters allowed in MaximumLength Community usernames CSUsername Min number of characters allowed in MinimumLength Community usernames CSUserNameRegex Pattern allowed for Community usernames DiscussionAnalysis BookmarkAll WarningLimit

Max number of posts in a group for Yes users to bookmark the group without system warning

Data Transfer
Setting Name DatabaseServer SampleFileFolder Description Configurable Default Value Advanced No No See (i) below See (ii)below See (iii) below See (iv) below

Location of sample files on the DB server DataTransferFilesFolder Folder location of data files ReportFilesFolder Location of stored reports SampleFileFolder

i. ii. iii. iv.

Folder location of external sample No files D:\Customer\SampleFiles\LOCALUSER\visc-datalink D:\qa\panels\Clients\Panel_supportpanel\DataTransferFiles D:\qa\panels\Clients\Panel_supportpanel\ReportFiles D:\qa\panels\Clients\Panel_supportpanel\SampleFiles

Display Settings
Setting Name Description Configurable Default Value Initial Answer List Size Sets number of Answers displayed Advanced 32

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 17 -

Feature Management
Setting Name BrowserDetectionFeatureState Description Configurable Default Value Yes Enabled False True False False False

Enables or disables browser detection DecryptUrlDataFeatureEnabled Determines whether RSA URL data Yes encryption is on DeleteLiveQuestionEnabled Determines whether questions on a Yes Live study can be deleted EnableEmailTracking Enables inserting of an image into a Yes mail message for tracking click rates EnablePasswordChangePolicy Determines whether the password Yes change policy is enabled EnablePasswordAudit Determines whether password audit- Yes ing is enabled. This setting is dependent on MaximumPasswordAudit found in Password Change Policy Settings in General Settings EnableLoginFailureLockOut Determines whether login failures Yes locks out users or not. This setting is dependent on MaximumConsecutiveLoginFailure found in Password Change Policy Settings in General Settings. EnableLockPasswordChange Determines whether password must Yes age prior to allowing password change. This setting is dependent on MaximumPasswordAgeInHours found in Password Change Policy Settings in General Settings. EnableParticipationStatisticsAudit Enables Participation Statistics Audit-Yes ing, and enables debugging when futures issues were found when Participation Statistics is off synch EnableResponseBasePanelFilterRepair Enables on-demand filter repair in Yes responding. When false, responding will simply fail when a filter is broken. When true, broken filters will repair on the fly EnableUnsubscribeReasonStudy If UnsubscribeReasonStudyId is con- Yes figured and this is enabled, it enables the Unsubscribe Reason feature

False

False

False

True

False

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 18 -

Setting Name

Description

Configurable Default Value

which redirects to the unsubscribe reason study that is configured ImageQuestionFeatureState Determines whether image question Advanced types are enabled. OpenPortalFeatureState Determines whether custom portal is Yes enabled for the panel MobileBitlyFeatureState Enables the mobile bitly links Yes MobileFeatureState Enables the mobile feature Yes PointsRedemptionFeatureState Determines whether the points Yes redemption is available, hidden or unavailable QuestionExtensionSettings Name: Question name Yes Visible: determines whether the Yes Question Extension is visible RelevantIdFeatureState Controls whether Relevant Id page Yes (only used by National Panels) executes Relevant Id check. When set to Hidden or Disabled Relevant Id check is bypassed ReportBuilderFeatureState Determines whether Report Builder Advanced is enabled RestrictExternalSamplesToRole Determines whether running studies Advanced with external samples is restricted by role (ie, PanelAdministrator) SalesforceIntegrationFeatureState Enables Salesforce Integration, allow-Yes ing synchronization of panel plus users with Salesforce SampleRequestButtonFeatureState Determines whether Admins viewing Yes the Sampling & Deployments page can request a sample from Vision Critical for their study. The button will pass the Panel name, user's display name and user's email address and will redirect the user to a contact page. ShelfSetBuilderFeatureState Determines whether the ShelfYes SetBuilder feature is on for the panel SimpleWeightCategoriesFeatureState Determines whether Simple Weight Yes feature is available under the Panel's Manage tools

Hidden Disabled Enabled Enabled Hidden

Clickmap False

Enabled Panel Admin Disabled

Hidden

Disabled Hidden

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 19 -

Setting Name StaticContentManagerFeatureState

Description

Determines whether the static content feature for open portal is on for the panel. StudyPointsFeatureState Determines whether or not a points program is enabled and visible on a study. Sv2DiscussionFeatureState Enables VC Discussions, thus allowing redirectio to Forums. SystemCheckFeatureState Enables System Check feature SystemHealthDashboardFeatureState Not yet supported TestModeToolbarFeatureState Enables test mode toolbar when responding in test mode

Configurable Default Value Yes Enabled

Advanced

Disabled

Yes Yes Yes Yes

Disabled Disabled Hidden Enabled

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 20 -

General
Setting Name Announcement Description Configurable Default Value Sets an announcement which Yes is displayed on the admin login page. ConfirmPanelistWithSecureId Determines whether SecureID Yes False used to confirm panelists DefaultAdminEnvironment Sets the default environment Advanced Default used when you log on to the Admin page DefaultPortalEnvironment Sets the default environment Advanced Default used when panelists log on to the Sparq portal DefaultRespondentAccessMode Sets the default survey access Yes MobileAndDesktop mode for respondents. Survey access controls which devices respondents may use to complete a study. DefaultTranslationEnvironment Sets the default environment Yes Default of the Translation Portal. This is usually the same as the Admin Environment EnableHideInMobilePage When MobileFeatureState is Yes enabled, it relies on this setting to allow or disallow removing answers from hidden questions PreventClickJacking Enables prevention of click jackYes True ing vulnerability UseSslForOffloading Whether or not always uses Yes False SSL for Flash Gateway Requests (The flag should be set to True when SSL Offloading turned on, and False when off.)

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 21 -

Global Variables
Setting Name Description Configurable Default Value No Enabled

GlobalVariablesFeatureState Controls whether the panel can use Global variables feature. When disabled, or hidden, all scripting methods for Global Variables will generate an error GlobalVariablesPanelId Identifies a panel for Global Variables No GlobalVariablesUrl URL for the global variables to web serv- No ice

Image Question Settings


Setting Name Configurable Default Value ImageQuestionAllowedFileTypes Sets the image types that responYes jpg, gif, dents can upload png, tiff, jpeg, bmp ImageQuestionMaxHeightPixels Sets the maximum height, in pix-Advanced 600 els, that an image can be in an image question ImageQuestionMaxSizeKb Sets the maximum size, in kilAdvanced obytes, that an image can be in an image question ImageQuestionMaxWidthPixels The maximum width, in pixels, Advanced that an image can be in an image question ImageQuestionThumbnailHeight Sets the maximum height, in pix-Advanced els, that thumbnails can be in an image question ImageQuestionThumbnailWidth Sets the maximum width, in pix- Advanced els, that thumbnails can be in an image question 500 Description

800

50

50

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 22 -

Licensing
Setting Name LaunchDate Description Date that the panel was launched Configurable Default Value No 1/9/2006 0:00 No 11/1/2030 0:00 No 1/9/2006 0:00

LicenseExpiryDate Date on which the panel license expires MigrationDate Date on which the panel was migrated to version 3.9

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 23 -

Locale
Setting Name DefaultAdminLanguage Description Default language of the Panel Admin site Default language of the Panel A list of languages with spell-check support in the text editor Configurable Default Value No en-CA

DefaultPanelLanguage

Yes

en-CA

RadSpellCheckLanguage

No

RadSpellEditDistanceProviderCompatibleCultures An algorithm No that assists in calculating string matches for languages that are not phonetic. This setting identifies languages that require the

en-CA, en-GB, English, frCA,French, esES, es-EU, Spanish, deDE, German, fi-FI, Finnish, pt-BR,Portuguese (BR), pt-PT,Portuguese (PT), it-IT, Italian, nl-NL, Dutch, pl-PL, Polish, cs-CZ, Czech, ru-RU, Russian, svSE,Swedish, da-DK, Danish, sk-SK, Slovak, nb-NO, Norwegian cs-CZ,pl-PL,ruRU,sk-SK,nbNO

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 24 -

Setting Name

Description Configurable Default Value use of the Edit Distance algorithm. Any languages that are not in this list are considered phonetic

Mail
Setting Name EmailBatchSize Description Configurable Default Value Sets the maximum number of Advanced 1000000 emails that can be sent out simultaneously in a deployment GlobalErrorsEmailAddress Sets the email address to which Yes vcadmin@ visionSparq sends global error details critical.com MailPickupDirectory Location to which emails are No \\starla\pickup saved MailServer Sets the mail server No starla PanelistPasswordResetEmailId Sets the ID of the action of reset-No 1 ting a particular panelists email address SendNotifications Determines whether to send Advanced True notifications when emails are approved in sampling

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 25 -

Misc
Setting Name AnswerSetsPath Description Configurable Default Value Yes See (i) below

CommunityConfigurations

HostConfigurations

ExtensionFolder Languages

NewsLettersSettings

NumericMaximumDecimalPlace

OnlineHelpUrl

Path to the custom set of canned answer sets that show up in batch answer editing. Culture: Shows the Community Advanced Advanced Culture Name: Sets the name of the Community Configuration settings for the Advanced panel host Culture: Sets the culture. Environment: Sets the default Environment. HostName: Sets the name of the host. ie, sandbox.visioncritical.com Sets the folder location where Yes Extensions are saved Sets the list of supported lanAdvanced guages and details CommunityCulture Culture: Sets the culture for that language. (ie, en-CA.) Enabled Index: Sets the index number of the language. IsMultiByte: Sets whether or not the language is multibyte. Name: Sets the name of the language. (ie, English) Determines whether to show news-Yes letter text on the panel login page and/or the homepage ShowOnHomePage ShowOnLoginPage Sets the maximum number of dec- Yes imal places allowed in a a numeric question The URLpath of the Online Help Yes

en-CA Default See (ii) below

See (iii) below en-US en-CA True 1 False English(US)

True True 4

See (iv) below

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 26 -

Setting Name ParatureSettings

Description

PointsRedemptionComments

Configurable Default Value Shows the identity or credentials Yes used in Parature when submitting VC-ARS_ a ticket to Technical Support Employees AmName Client SupCSlaName SessionEmail port SessionId See (v) below See (vi) below Defines the messages that are dis- Yes played when a point redemption See (vii) error occurs below Comment: Text that is presented to the respondent.

Culture: Culture of the environment. Description: Description of the error. QuickPollSettings Shows whether the Quick poll settings are visible on the panel login page and/or home page ShowOnHomePage ShowOnLoginPage RequireReportBuilderAuthentication Debugging setting that allows developers use Dynamic Reporting without logging on to Sparq. This is for internal use only ResponseLinkMappings Sets the mappings used in migrations from older versions of Sparq where the response link is different in the new version. These mappings indicate how Sparq should interpret an old link. RestrictExternalSampleToRole SampleRequestUrl The SampleRequestUrl is used in the SampleRequestButtonFeatureState and is the URL to which the Author will be redirected when requesting further information for obtaining a sample from Vision Critical.

en-CA Missing Name Yes True True No True

Advanced

Yes

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 27 -

Setting Name ScriptsFolder

Description

StudiesExcludedFromStudyReport

StudyLinksSettings

Sv2DiscussionUrlRegexes

Configurable Default Value Determines the folder location No See (viii) where batch files for branding tasks below are saved Sets the Studies that should not be Yes included in the Reports using the Study Ids Shows whether the Study links Yes are visible on the panel login page True and/or home page True ShowOnHomePage ShowOnLoginPage This regex value validates redirect Yes None URLs to VC Discussions forums. Invalid URLs cause an "Incorrect Forum Link URL" warning.

i. ii. iii. iv. v. vi. vii. viii.

/ToolBars/AnswerSets.xml supportpanel. bostaff.test.com D:\qa\panels\Clients\Panel_supportpanel\Extensions http://webhelp.visioncriticalpanels.com/Default.htm#StartTopic=Content/ systemuser@visioncritical.com b8300a6cddfeab0cfb6b56bd5187c862 We need to refuse your request because you forgot your name. D:\Customer\Cores\4.5.10.52880\Scripts

OpenPortal Settings
Setting Name Configurable Default Value OpenPortalApplicationBackupsPath Sets the folder location where Yes See (i) the Portal Backups are saved below OpenPortalCacheExpirationPeriod Sets the time when the open por- Yes 30 tal cache will expire OpenPortalLivePhysicalPath Sets the folder location where Yes See (ii) the Live Portal is saved below OpenPortalTestPhysicalPath Sets the folder location where Yes See (iii) the Test Portal is saved below StudiesContentFilePath Sets the folder location where Yes See (iv) Studies are stores below i. D:\qa\panels\Clients\Panel_supportpanel\Portal\Backups ii. D:\qa\panels\Clients\Panel_supportpanel\Portal\Live iii. D:\qa\panels\Clients\Panel_supportpanel\Portal\Test iv. D:\qa\panels\Clients\Panel_supportpanel\Portal\Test\Configuration\StaticContentBlocks.xml Description

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 28 -

Panel Filter Template IDs


Setting Name ConditionalTemplateId Description Configurable Default Value No 10

Sets the ID of the panel filter to be used as a template for creating conditions in a study ExportTemplateId Sets the ID of the export template InvitationTemplateId ID of the panel filter ID to use for invitations Reminder1TemplateId Sets the ID of the template used for the first reminder email Reminder2TemplateId Sets the ID of the template used for the second reminder email Reminder3TemplateId Sets the ID of the template used for the third reminder email ReportTemplateId Sets the ID of the panel filter used as a template for reports SampleTemplateId Sets the ID of the panel filter used as a template for samples SendInvitationEmailTemplateId Sets the ID of the template used to create invitation emails

No No No No No No No No

12 2 3 4 5 11 1 6 7 8 9

SendReminder1EmailTemplateId Sets the ID of the template used to Yes create the first reminder emails SendReminder2EmailTemplateId Sets the ID of the template used to No create the second reminder emails SendReminder3EmailTemplateId Sets the ID of the template used to No create the third reminder emails

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 29 -

Panelist Forum Permission


Setting Name Configurable Default Value CreatePoll Determines whether panelists can create polls in Advanced False Community Server Ink Determines whether freehand drawing is enaAdvanced True bled in Community Server LocalAttachment Determines whether panelists can make attach- No True ments in Community Server posts RemoteAttachment Determines whether panelists can make attaAdvanced True chements in Community Server posts from a computer other than their own local machine Video Determines whether video capabilities are ena- Advanced True bled in Community Server Description

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 30 -

Password Change Policy Settings


Setting Name MaximumConsecutiveLoginFailure Description Configurable Default Value Yes 6

MaximumPasswordAgeInHours

MaximumPasswordAudit

Determines the number of consecutive login failures before a user gets locked out. To enable this feature, set EnableLoginFailureLockOut in Feature Management. Determines the number of Yes hours a password must age before a password change is enabled. To enable this feature, set EnableLockPasswordChange in Feature Management. Determines the number of Yes password audits per user. To enable this feature, set EnablePasswordAudit in Feature Management.

48

PasswordChangeExpireIntervalInDays

Determines the number of Yes days before users are required to change their password PasswordChangeReminderIntervalInDays Sets the number of days Yes users are prompted before the password are required to change the password PasswordEmailResendBlockTimeInMinutes Time in minute interval Yes where a panelist email password resend is allowed PasswordLinkExpirationTimeInMinutes Time out expiration for pan- Yes elist reset password page

30

10

2880

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 31 -

PXML Import Limitation


Setting Name Description Configurable Default Value Yes True

EventBaseExportDateFormated Explicitly sets the date/time formatting to eliminate inconsistencies in Exports. MaxExpression Count Sets the maximum expressions allowed in a panel filter MaxGridQuestionCount Sets the maximum number of grid questions allowed MaxLoopSize Sets the maximum number of loops allowed in a questionnaire MaxPageItemCount Sets the maximum number of items that can exist in a page sequence MaxQuestionAnswerCount Sets the maximum number of answers allowed in a choice question MaxStudyAnswerCount Sets the maximum number of answers allowed in PXML exports PXML Timeout Sets the length of time (secs) before a PXML import of a study will timeout

Advanced Yes Advanced Advanced Advanced Advanced No

200 991 500 500 1000 20000 300000

Relevant ID Settings
Setting Name CountryCodes Description Configurable Default Value Yes

A comma separated list of country codes that is used for a geo-location check (normally respondents that are not from one of the listed countries get disqualified) PanelShort A string identifier used by Relevant Id to identify Yes the panel TimeoutInSeconds The maximum amount of time Relevant Id script Yes is allowed for execution. Ensures that respondents are not blocked if Relevant Id did not execute properly

TEST 10

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 32 -

Report Output
Setting Name Configurable Default Value ConversionServiceCultureName Sets the culture used for report Advanced en-US exports in Report Builder ConversionServiceQueuePath Sets the path of the conversion Advanced service for ReportBuilder exports MaxReportOutputTaskPendingSeconds Sets the maximum time (secs)a Advanced 600 ReportBuiler export can be pending before fail MaxReportOutpuTaskRunningSeconds Sets the maximum number of Advanced 720 seconds that a ReportBuilder export can be in running status before it fails MaxSlides Sets the maximum number of Advanced 1000 slides allowed in a Report Builder ReportExcelStyleSettingsPath Sets the folder location of the No See (i) Excel styling configuration file below for Report Builder exports i. D:\qa\panels\Clients\Panel_supportpanel\Portal\Test\Configuration\StaticContentBlocks.xml Description

Reporting
Setting Name Description

EnableSparqTwoReportingAvailabilityDetection Performs a test to determine if SparqTwoReportingBaseUrl is available IncludePanelistInAdHocReport Sets whether to include panelists Yes in AdHoc reports ReportingServices ReportFolder Yes WebFolder Yes ReportExecutionWebServiceUrl No Timeout No SparqTwoReportingServiceUrl Adds Sparq2 service url to enable No data import web service used by Quick Reports i. http://latest-services-reporting.lkg.deploy1test.local/DataImportService.svc

Configurable Defau Value Yes TRUE

FALSE

Star 3000

See (i below

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 33 -

Salesforce Integration
Setting Name Description Configurable Default Value No

SalesforceProxyUrl URL proxy for sales force integration. Only used when SalesforceIntegrationFeatureState setting is enabled

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 34 -

Shelfset Builder
Setting Name DeploymentEmailBody Description Configurable Default Value Yes See (i) below

DeploymentEmailBodyEncodingName

DeploymentEmailSubject

DeploymentFromEmail

Sets the email text sent when a Shelfset project is launched Sets the encoding of Yes the email text that gets sent when a Shelfset project is launched Sets the email subject Yes text of the email that gets sent when a Shelfset project is launched Sets the email Yes address from which the email is set when a Shelfset project is launched

utf-8

Shelfset Project Deployment: {0} See (ii) below

ImageExportCleanupIntervalSeconds

IsDeploymentEmailBodyHtml

MaxImageExportFileAgeSeconds

MaxPlanogramExportFileAgeSeconds

MaxProductImageExportFileAgeSeconds

Specifies when Advanced exported images from Shelfset builder can be deleted Sets the Shelfset Yes Builder email text that is sent after Shelfset Builder is deployed Sets the maximum Advanced age (secs) of image exports for they are deleted in Shelfset Builder Sets the age (secs) of Advanced planogram exports before they can be deleted Sets the age (secs) of Advanced product images before they can be deleted

3600

TRUE

1800

1800

1800

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 35 -

Setting Name

Configurable Default Value NeoSwiffImageQuality Advanced 20 NeoSwiffSccExePath Folder location of the Advanced See (iii) scc.exe file below NeoSwiffImageSize Advanced 100100 PlanogramExportsCleanupIntervalSeconds Set the interval (secs) Advanced 3600 at which point planogram exports are deleted in Shelfset Builder ProductImageExportFileLengthBytes Sets the maximum Advanced 52428800 file size for product image exports in Shelfset Builder ProductImageExportsCleanupIntervalSeconds Sets the interval Advanced 3600 (secs) at which product image exports are deleted RequireShelfsetBuilderAuthentication Whether login is Advanced TRUE required for Shelfset Builder SccTimeOutSeconds Sets the maximum Advanced number of seconds allowed to generate Flash before the action times out ShelfsetDesignerSessionLeepAlivePingSeconds Sets the number of No seconds to keep Shelfset Designer alive 120

Description

600

i. Hi, <br/> <br/>Please find the attached {0} shelfset project POGSand PDL export files. To access the image for this project, please click on the link below: <br/>{1}<br/><br/>ShelfsetBuilder ii. shelfsetbuilder@visioncritical.com iii. D:\Program Files\NeoSwiff\scc.exe

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 36 -

SPSS 14 Export Limits


Setting Name Configurable Default Value Spss14ExportMaxVerbatimFieldSize SPSS Verbatim export maximum Yes 2500 field size SpssMultiByteFactor Setting required to calculate Yes 2 SPSS file column widths for SPSS file size reduction. SpssSingleByteFactor Setting required to calculate Yes 1 SPSS file column widths for SPSS file size reduction. Description

SQL TimeoutSettings
Setting Name SqlCommandTimeouts BounceProcess Description Configurable Default Value 600 240 600 30 300 120

Sets time (secs) before Boogie Pop query Yes times out CommunityAnalysis Sets time (secs) before Community Anal- Yes ysis query times out CompileDatabases Sets time (secs) before a query times out Yes for creating response tables Default Sets time (secs) before a query times out Yes for default operations DefaultLongTimeout Sets time (secs) before a query times out Yes for long default operations DeleteStudy Property Delete Study command time out, No (unless where default is 20. VcAdmin users should directed by never change this unless directed by Devel-Development) opment ExportExecution Sets time (secs) before a query times out Yes for exports PanelFilterGetPanelist Sets time (secs) before a query times out Yes for getting panelists via panelfilter SynchronizePanelistData Sets time (secs) before a query times out Yes for synchronizing panelist data with participation study UnreserveSample Sets time (secs) before a query times out Yes for unreserving a sample

300 600 10000

180

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 37 -

SSLManager
Setting Name CertificateRequestIntervalMinutes Description Configurable Default Value Advanced 3600

Sets the interval at which the Branding Manager requests SSL certificates MaxCertificateRequestFileAgeSeconds Sets the duration of a Branding Advanced ManagerSSL certificate request file before it is deleted SslManagerFeatureState Sets whether the SSL Manager Yes tool is Enabled, Disabled, or Hidden

1800

Hidden

Study Compilation
Setting Name CompiledStudiesFolder Description Configurable Default Value No See (i) below Advanced FALSE No FALSE See (ii) below

Sets the folder location for compiled studies DebugCompile Dev only. For Debugging. KeepTempCompilationFiles Sets whether to keep the temporary study compilation files

ResponseAssemblyKeysFile Sets the location of the key file used for No generating response assemblies i. D:\qa\panels\Clients\Panel_support\panel\CompiledStudies ii. D:\qa\panels\Clients\Panel_support\panel\vcKey.snk

Study XMLs
Setting Name Configurable Default Value PointRedemptionStudyXmlFile Sets where PointRedemption Study is No See (i) stored in XML format below VCProfilingStudyXmlFile When SystemCheckFeatureState is No enabled, it requires a test profiling study file to enable importing and responding automated for the System Check feature VCTemplateStudyXmlFile PXML filed used for creating the Tem- No See (ii) plate Library study below VCSystemTestStudyXmlFile When SystemCheckFeatureState is No enabled, it requires a test study file to enable importing and responding automated for the System Check feature
The Strategic Interactive Research Company

Description

Scripting Guide Vision Critical Documentation - 38 -

i. D:\Customer\Cores\4.5.10.52880\StudyXmls\PointRedemptionStudy.xml ii. D:\Customer\Cores\4.5.10.52880\StudyXmls\VCTemplateStudy.xml

Support Request
Setting Name Description Configurable TopicsFile Yes UserSupportRequestPage Yes i. D:\qa\panels\Clients\Panel_support\panel\skins\Default\Portal\xml\SupportTopics.xml Default Value See (i) below TRUE

System Settings
Setting Name Configurable Default Value EndTimeForAppPoolRecycling End time for AppPool Yes 11:00 UTC Recycles (24-hr clock) (see i below) StartTimeForAppPoolRecycling Start time for AppPool Yes 14:00 UTC Recycles (24-hour clock) (see ii below) i. For panels installed after May 13, 2013, the default value is 10:00 UTC. ii. For panels installed after May 13, 2013, the default value is 13:00 UTC. Description

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 39 -

System Study and QuestionGroud IDs


Setting Name CommunicationStudyId PanelDemographicQuestionGroupId ParticipationStudyId PointsApprovalFormQuestionGroupId Description Configurable Default Value No 3 6 1 7

PointsRedemptionLinkId

PointsRedemptionStudyId ProfilingQuestionGroupId ProfilingStudyId

Sets the Communications Study ID Sets the demographic ques- No tion group ID Sets the Participation Study No ID Sets the ID of the question No group used for tracking points Sets the anonymous link ID No of the Points Redemption Study Sets the ID of the Points No Redemption Study Sets the group ID of the Pro- No filing Study Sets the ID of the Profiling No Study No

7 2 2 8

QuestionPickerQuickSelectQuestionGroupId Sets which question group to show by default on the left of the question picker QuickPollsStudyId Sets the study ID of the QuickPollsStudy ShelftSetPanelPlusGroupId Sets the ID of the Sparq user group for Shelfset Builder WeightSetStudyId Sets the ID of the Weight Set Study

No No

4 1

Yes

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 40 -

Task Manager
Setting Name BounceProcessBatchIntervalMinutes BounceProcessMaxEmailToEvaluate Description

Configurable

Sets the email polling interval (mins) Advanced Performance setting that identifies how Yes many maximum bounce email addresses to perform when the process begins. This prevents the process from monopolizing resources. EnableTaskManagerOnStartUp Sets whether the Task Manager is enaNo bled on startup IncentivesMonitoringLoggingConfigFile Holds the path of the configuration file Yes that is required for Incentives Monitoring. Incentives Monitoring is a diagnostic that enables Sparq to send test message to ensure that Incentives can receive messages from Sparq IncentivesPingEnabled Enables or disables Incentives Ping for Yes diagnostic messages. The process determines if incentives diagnostic messages where successful. This process can be triggered from the Scheduled Task Manager in Sparq IncentivesPingIntervalSeconds When Incentives Ping is enabled, an inter- Yes val is used to begin the process to check if any incentives diagnostic messages should be reported to the user. IncentivesPingServiceCheckDelaySeconds When Incentives Ping is enabled and an Yes incentives diagnostic message has been sent, this setting value will put the process to sleep and then wake it up to determine if the message is successful InterruptRunningTasksonTaskManagerStartUp Sets whether to interrupt currently run- No ning tasks when the Task Manager starts MaximumAtrCount Sets the number of the Automated Test Yes Runs that can be done at one time SendInvitationBatchIntervalMinutes Sets the interval (mins) between tasks Advanced that require email to be sent (invitations, reminders, etc.) StatusIntervalMinutes Self-check feature checks the system for Yes any issues affecting features that are enabled on the panel. The interval minutes controls the time between checks
The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 41 -

Setting Name SystemCheckIntervalMinutes

Description

Configurable

TaskManagerCustomNowDate TaskManagerCustomeNowDateEnabled TaskManagerPollingIntervalMilliseconds

When SystemCheckFeatureState is ena- Yes bled, this setting ensures that the Stystem Check Feature is not triggered too soon. The System Check feature performs a test response to a test study, autoresponds to the browser detection, and attempts to click the next button to determine if responding has any issues Sets what date the Task Manager uses for No "the present" Sets whether the Custom Now date is ena-No bled Task Manager's polling interval (millisecs) Advanced for new tasks

Temporarily Customizable Features


Setting Name RecycleAppPoolsWhenPublishingPortal Description Configurable Default Value Yes True

Determines if application pools should be recycled when publishing portals. UseNewTicketsforBatchIncentivesProcessing Prevents extraneous colYes umns in Incentives Reports that occur when commas are placed in fields.

True

Testing Toolbar
Setting Name Description Configurable Default Value Yes Enabled

EnableTestModeToolbarContextDropdown Enables test mode toolbar when responding in test mode

Time Zone Settings


Setting Name Description Configurable Default Value PanelTimeZone Sets the time zone Yes (GMT-08:00 Pacific Time (USand for the panel Canada); Pacific Standard Time ServerTimeZone Sets the time zone No (GMT-08:00 Pacific Time (USand for the server Canada); Pacific Standard Time

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 42 -

Unsubscribe Reason Study


Setting Name Description Configurable Default Value Yes 0

UnsubscribeReasonStudyId Contains the study id of the Unsubscribe Reason study

WeightSet Limitation
Setting Name Configurable Default Value MaximumWeightSetIteration Sets the maximum number of times a Yes 100 weight set can be reused WeightSetIterationLimit Sets the number of Weight set repe- Yes 50 titions WeightSetReportRanges Sets the range used for a weight set: Yes see (i) WeightSetReportRanges Yes Name below WeightSetTraceState Yes Disabled WeightVariableDecimalPlace Sets the maximum number of places Yes for the weight set Percentage of sample with weight between 0.5 and 2 i. Description

Seed Emails Settings


Setting Name Description Configurable Default Value Yes TRUE Yes see (i) below

EnableSeedEmail Enables seed email functionality SeeEmailAddressList Seed email list; comma or semi-colon delimited i. testsend@visioncritical.com

Services
Setting Name Description Configurable Default Value Yes TRUE Yes TRUE Yes FALSE Yes 2 Yes 100 Yes Yes 30

AdminServiceEnabled Enables Administrative Service AuthenticationServiceEnabled Enables Authentication Service CommunityServiceEnabled Enables Community Service DefaultThrottlingDelay MaximumItemCount ThrottlingDelays Timeout Sets the length of idle time allowed before the user is logged out of Sparq

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 43 -

Services
Setting Name AdminServiceEnabled Description Configurable Default Value Yes True True False 2 100 30

Determines whether Administrative Service is enabled AuthenticationServiceEnabled Determines whether Authentication Yes Service is enabled CommunityServiceEnabled Determines whether Community Serv- Yes ice is enabled DefaultThrottlingDelay Yes MaximumItemCount Yes ThrottlingDelays Yes Timeout Determines the period of idle time Yes allowed before the user is logged out of Sparq

The Strategic Interactive Research Company

Scripting Guide Vision Critical Documentation - 44 -

New Reporting
FeatureManagement
Setting Name Configurable Default Value SparqTwoReportingFeatureState Enables Sparq2Reporting in the Yes Enabled top menu bar. Description

Reporting
Setting Name Description Configurable Default Value Yes See (i) below

PanelPlusPlatformServicesBaseUrl Sets base URL for Sparq 1.0 Platform services. Currently, this is needed for New Reporting Integration. SparqTwoReportingBaseUrl Sets base URL for New Reporting Yes instance. Used to initialize New Reporting using parameters passed into the URL i. http://gino2.com/PlatformServices/v1.0/ ii. http://tenant1.sparq1.qa.sparq2test.com/admin/Reporting.html

See (ii) below

The Strategic Interactive Research Company