| Summary | This article details the possible askiaext links for askiaweb. |
| Applies to | askiaweb |
| Written for | Fieldwork manager |
| Keywords | link; askiaext ; Webprod ; CAWI ; invitation ; ext ; links ; external |
Table of contents:
Links location
With Cca and Webprod, you have various kind of links that you can use, with or without resume capabilities. These links are accessible from various places on supervisor side:
- contextual menu on selected survey:
- On survey properties > WebProd tab > on contextual menu on selected webprod connection:
- On find/edit contact (in case of DoPanel survey) > contextual menu on selected contact:
- On Web Connections window > contextual menu on selected webprod:
StartSurvey link
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
- FromQuestion (optional) - indicates the Shortcut of the question where you want to start the interview from(ex &FromQuestion=Q2)
- 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&FromQuestion=Q2&Test=True
Shortcut in mail template: [ccaStartSurveyLink]
DoPanel link
This will start a survey with resume capability, linked to a contact from your sample list. All importations from your sample list must be set as "Askia Panel" on survey side, in importation settings for your questions.
Shortcut to add into your email template:
DoPanel: <a href="[ccaDoPanelLink]">[ccaDoPanelLink]>
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
- FromQuestion (optional) - indicates the Shortcut where you want to start the interview (ex &FromQuestion=Q2)
According to your IIS options, you can use pretty and encrypted links within your email template.
Pretty DoPanel link keyword :
<a href= "[ccaDoPanelPrettyLink]">[ccaDoPanelPrettyLink]</a><br><br>
How it's displayed on respondent side:
http://myWebServer.com/WebProd/Start/00005RI3T802JPIC/00029DWMCYCJJL9L00021KH3SW1QQP7P
Encrypted DoPanel link keyword:
<a href= "[ccaDoPanelEncryptedLink]">[ccaDoPanelEncryptedLink]
How it's displayed on respondent side:
http://MyWebServer.com/WebProd/~EggxryiKSaqe6q52EEa-CQ
If necessary, you can get the DoPanel link for a specific contact (or a group of contacts) in supervisor > find/edit contact on a DoPanel list > Select the contact > web > Copy Panel Link. But there is a method that allows you to write back the doPanel links into the sample list directly you can find here.
DoExternalPanel link
This will start a survey with resume capability.
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.
- FromStart (optional) - if 1, starts from the beginning without erasing answers
- FromQuestion (optional) - indicates the Shortcut where you want to start the interview (ex &FromQuestion=Q2)
http://MyWebserver/WebProd/cgi-bin/askiaext.dll?Action=DoExternalPanel&SurveyName=MySurvey&Broker=Askia&BrokerPanelId=thx1138&FromQuestion=Q2
Please note that the combination of the two parameters Broker and BrokerPanelId that set the survey link as unique.
According to your IIS options, you can use pretty links for DoExternalPanel links:
http://askia.com/WebProd/Start/MySurvey/Broker/BrokerPanelId
SyncData
This will synchronize the SQL interviews with the interviews on disk.
Link
http://servername/webprod/cgi-bin/AskiaExt.dll?Action=SyncData&SurveyName=AskiaSurvey&Direction=FromSQL
Parameters:
- 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 (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 (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.
Unsubscribe link
We have added an unsubscription feature in 5.5.2. Here the keywords you can add to your email template:
[ccaUnsubscribeLink] = unsubscribe link for a contact. Once added into your email template, it will be converted as this:
http://MyWebServer.com/WebProd/cgi-bin/askiaext.dll?Action=Unsubscribe&PanelId=00029DWMCYCJJL9L@00021KH3SW1QQP7P
[ccaUnsubscribeEncryptedLink] = encrypted unsubscribe link for a contact. Once added into your email template, it will be converted as this:
http://MyWebServer.com/WebProd/~IXGRzsJqAoM
Keywords
summary of all keywords that can be used in a mail template:
[ccaStartSurveyLink] = start survey link without resume capability
[ccaDoPanelLink] = Survey link with resume capability
[ccaDoPanelPrettyLink] = prettified survey link with resume capability
[ccaDoPanelEncryptedLink] = pretty survey link with resume capability
[ccaUnsubscribeLink] = unsubscribe link for a contact
[ccaUnsubscribeEncryptedLink] = encrypted unsubscribe link for a contact
[ccaWebProdUrl] = root url of webprod
[ccaAskiaExtUrl] = url to askiaext.dll
[ccaSurveyExternalName] = Survey name
Comments