Scroll

DOC : Invitation links

DOC : Invitation links

Follow
Summary This article details the possible askiaext links for askiaweb.
Applies to askiaweb
Written for Fieldwork manager
Keywords link; askiaext ; Webprod ; CAWI ; invitation

Documentation Note: add in the documentation

Table of contents:

StartSurvey

This will start a survey without resume capability.

Link

http://servername/webprod/cgi-bin/AskiaExt.dll?Action=StartSurvey&SurveyName=AskiaSurvey

Parameters

  • SurveyName - The external name of the survey as defined in WebProd
  • Test (optional) - If true, the survey will progress as normally, but will be deleted on completion or after a timeout of 1 hour. The completed survey won't be sent to CCA.
    Example link:
    http://servername/webprod/cgi-bin/AskiaExt.dll?Action=StartSurvey&SurveyName=AskiaSurvey&Test=True

Notes

Normally Cca will replace a link with Action=StartSurvey by a DoPanel link. To force Cca to generate a link with the StartSurvey keyword, include the &PanelId=askPanelId parameter in your mail template.
Example:

http://servername/webprod/cgi-bin/AskiaExt.dll?Action=StartSurvey&SurveyName=AskiaSurvey&PanelId=askPanelId

Note that you can also use the keyword ccaStartSurveyLink in your mail template ([ccaStartSurveyLink]) : instead of copying / pasting the start survey link generated by the CCA.

Generated interview file (if interviews are saved to disk)

Intvw<seed>[.dat]
Example: Intvw123.dat

DoPanel

This will start a survey with resume capability, it is possible to import panel data using the encrypted 'PanelId' parameter. You only need to specify at the right place into your email the following unique prefix (same for all surveys hosted on the same server).

Link

http://servername/webprod/cgi-bin/AskiaExt.dll?Action=StartSurvey

This link will be automatically updated by the CCA to transform it into a unique DoPanel link for each respondent within the sample list. DoPanel link should not be created manually.

Example:

http://servername/webprod/cgi-bin/AskiaExt.dll?Action=DoPanel&Survey=RYLZDLVLLBHLNJBL&PanelId=RYLZDLVLLBHLNJBL@FFFHPMPFHIGPKFBK

Parameters

  • Survey - The Askia-encoded Cca survey ID.
  • PanelId - Askia-encoded panel id. Format: ContactID@ListID. The Contact ID is the AskInterview field in the AskList table. 
  • Test (optional) - if true, the survey will progress as normally, but will be deleted on complete or after a timeout of 1 hour. The completed survey won't be sent to CCA.
  • FromStart (optional) - if 1, starts from the beginning without erasing answers

Note

Note that you can also use the keyword ccaDoPanelLink in your mail template ([ccaDoPanelLink]) : instead of copying / pasting the start survey link generated by the CCA.

Generated interview file (if interviews are saved to disk)

PIntvw-<surveyid>-<panelid>-<listid>[.dat]
Example: PIntvw-11-22-33.dat

DoExternalPanel

This will start a survey with resume capability. It is possible to import panel data using the encrypted 'PanelId' parameter.

Link

http://servername/webprod/cgi-bin/AskiaExt.dll?Action=DoExternalPanel&SurveyName=AskiaSurvey&Broker=SomeBroker&BrokerPanelId=RandomPanelId

Parameters

  • SurveyName - The external name of the survey as defined in the WebProd.
  • Broker - Alphanumerical characters to identify the email broker/external provider.
  • BrokerPanelId - Alphanumerical characters (generated by the email broker/external provider) to identify individually the panel members.
  • Test (optional) - if true, the survey will progress as normally, but will be deleted on complete or after a timeout of 1 hour. The completed survey won't be sent to CCA.

Generated interview file (if interviews are saved to disk)

XIntvw-<surveyid>-<broker>-<brokerpanelid>[.dat]
Example: XIntvw-11-AskiaBroker-BrokerPanelId.dat

SyncData

This will synchronize the SQL interviews with the interviews on disk. An ADO connection string has to be entered in the options page (but 'store dat files on SQL' doesn't have to be enabled).

Link

http://servername/webprod/cgi-bin/AskiaExt.dll?Action=SyncData&SurveyName=AskiaSurvey&Direction=ToSQL

Parameters

Note: Most of these parameters are only valid for version 5.1.11 and above!

  • SurveyName: The external name of the survey as defined in WebProd
  • Direction: The direction in which to synchronize
    Possible values:
    - ToSQL (since 5.3.3.21/5.3.5.2: DiskToSQL)  or 1: From Disk to SQL Server.
    - FromSQL (since 5.3.3.21/5.3.5.2: SQLtoDisk) or 2: From SQL Server to Disk.
  • Qex (optional): Determines if the Qex file stored in the WebProd database (if the 'store qex in database' is enabled) should also be synchronized to/from disk. The direction is determined by the Direction parameter.
    Possible values: 0/1/yes/no/true/false.
    Default:no
  • From and To (optional): Minimum and maximum activity date/time (YYYY-MM-NN HH:mm:ss). ex:
    http://127.0.0.1/Webprod/cgi-bin/askiaext.dll?Action=SyncData&SurveyName=XXX&Direction=FromSQL&From=2013-01-03&To=2013-01-04
  • Type (optional): The type of interviews to synchronize
    Possible values:
    - 0: All interviews (default)
    - 1: Only incompletes
    - 2: Only completes (note that the 'To Cca' flag is ignored)
  • Seed (since 5.3.3.21/5.3.5.2 - optional): indicates the seed wanted (&Seed=1234), or the range of seeds (&Seed=1234-5678). ex: 
http://127.0.0.1/webprod/cgi-bin/AskiaExt.dll?Action=SyncData&SurveyName=AskiaDemo&Direction=SQLtoDisk&Seed=2802
http://127.0.0.1/webprod/cgi-bin/AskiaExt.dll?Action=SyncData&SurveyName=AskiaDemo&Direction=SQLtoDisk&Seed=2504-2901
  • Broker (since 5.3.3.21/5.3.5.2 - optional): indicates the interviews from a specific broker (&Broker=toto). 
http://127.0.0.1/webprod/cgi-bin/AskiaExt.dll?Action=SyncData&SurveyName=AskiaDemo&Direction=SQLtoDisk&Broker=TOTO
  • ErrorPage (optional): page to redirect to after synchronization is done (note: relative to /cgi-bin)
    This is mainly used by WebProd to show the pgEditSurvey.asp again after synchronizing.
    If this parameter is missing (or empty) a result page will be shown with the number of synchronized interviews.

Notes

  • Test interviews are never synchronized
  • Synchronizing is a very resource-intensive operation. When you use this function, it is possible that other requests may see a response delay, or in extreme cases a time-out.
  • To test the survey without saving the data, you simply need to add the following text (case sensitive) at the end of your surveys' links:
    &Test=True
Have more questions? Submit a request

Comments