Skip to main content

How can we help?

Frequently searched: Android devices, cloning, ADC Gallery, Glossary,...

Contacting your respondents

In this article

    AskiaWeb Survey Links

    Links location

    With CCA and WebProd, you have many different kinds of links that you can use, with or without the capability to resume. These links are accessible from a few different places on the Supervisor side:


    - The contextual menu on a selected survey:

    - On survey properties > WebProd tab > on the contextual menu on a selected WebProd connection:

     

    - On Find/edit contact (in case of DoPanel survey) > contextual menu on selected contact:

     

    - On the Web Connections window > contextual menu on selected WebProd:

    StartSurvey link

    This will start a survey without the resume capability.

    Link:

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

    Parameters:

     

    Shortcut in a mail template: [ccaStartSurveyLink]

     

    DoPanel link

    This will start a survey with a capability to resume, linked to a contact from your sample list. All imports from your sample list must be set as "Askia Panel" on the survey side, in the import settings for your questions.

    Shortcut to add into your email template:

    DoPanel: <a href="[ccaDoPanelLink]">[ccaDoPanelLink]</a>

    This link will be automatically updated by the CCA to transform it into a unique DoPanel link for each respondent within the sample list. The 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 normally, but will be deleted on completion or after a timeout of one 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 from (e.g. &FromQuestion=Q2)

    According to your IIS options, you can use "prettified" and encrypted links in your email template.

     

    "Prettified" 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]</a>

    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 a 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 that here.

    DoExternalPanel link

    This will start a survey with the capability to resume.

    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 normally, but will be deleted on completion or after a timeout of one 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 from (e.g. &FromQuestion=Q2).
    http://MyWebserver/WebProd/cgi-bin/askiaext.dll?Action=DoExternalPanel&SurveyName=MySurvey&Broker=Askia&BrokerPanelId=thx1138&FromQuestion=Q2

    Please note that it is the combination of the two parameters Broker and BrokerPanelId that set the survey link as unique.

    According to your IIS options, you can use "prettified" 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 by WebProd.
    • Direction: The direction in which to synchronize.
      Possible values:
      1: From Disk to SQL Server - ToSQL (since 5.3.3.21/5.3.5.2: DiskToSQL).
      2: From SQL Server to Disk - FromSQL (since 5.3.3.21/5.3.5.2: SQLtoDisk).
    • 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 (above).
      Possible values: 0/1/yes/no/true/false. The default is no.
    • From and To (optional): Minimum and maximum activity date/time (YYYY-MM-NN HH:mm:ss). Example: 
      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 required (&Seed=1234), or the range of seeds (&Seed=1234-5678). Example:
    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). Example:
    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 are 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 to 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 to this:

    http://MyWebServer.com/WebProd/~IXGRzsJqAoM

    Keywords

    Here is a summary of all the keywords that can be used in a mail template:

    [ccaStartSurveyLink] = Start the survey link without a resume capability.
    [ccaDoPanelLink] = Survey link with a resume capability.
    [ccaDoPanelPrettyLink] = Prettified survey link with a resume capability.
    [ccaDoPanelEncryptedLink] = Prettified survey link with a 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.

    Related articles