Skip to main content

How can we help?

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

AskiaSurf

In this article

    Using AskiaSurf via the Command Line

    Summary This article describes how to automate a task by command line in AskiaSurf.
    Applies to AskiaSurf
    Written for Data Processor
    Keywords command line; automate; task; surf; askiasurf; commandline; tags

    AskiaSurf can be used via the command line, which is extremely useful when used in combination with AskiaVista's scheduled tasks.

    Definition

    Here are the list of arguments which can appear in the command line to start AskiaSurf:

    Argument Description
    /source:"path" Specifies the source QES file(s) to add to the campaign
    /target:"path" Specifies the QEW to add the new wave to. If one is not specified, a new QEW will be created.
    /output:"path" Specifies the file where results of the (attempted) reconciliation will be saved.
    /LINKQ:"shortcut" Identifies the link question for the volumes.
    /A: Specifies that new questions and/or responses may be added to the campaign.
    Q
    		 Allow new questions.
    R
    		 Allow new responses.
    /X: Specifies that existing question and/or response matchings may be broken.
    Q
    		 Break question matchings.
    R
    		 Break response matchings.
    /I: Ignore unmatched source questions and/or responses.
    Q
    		 Ignore unmatched questions.
    R
    		 Ignore unmatched responses.
    /M: Specify question matching methods, in order.
    I
    		 Internal code.
    S
    		 Shortcut.
    C
    		 Short caption.
    L
    		 Long caption.
    U
    		 User data.
    /N: Specify response matching methods, in order.
    I
    		 Internal code.
    E
    		 Entry code.
    C
    		 Short caption.
    O
    		 Response order.
    U
    		 User data.
    /R Do not save changes to the QEW, generate a report only.
    Since Surf 5.6.0.0  
    /VOLUME_NAME:"" Override the default volume name.
    /WAVE_NAME:"" Override the default wave name.

    /CASE_SENSITIVE

    		 The default behaviour is now changed to be case insensitive. If you want to go back to case sensitivity you can use this new parameter.

    /IgnoreTaggedSourceQuestions

    /IgnoreTaggedSourceResponses

    		 When the source .QES file added to the existing .QEW/campaign has tags on its questions or responses, you can choose to ignore matching these during reconciliation.

    /IgnoreTaggedCampaignQuestions

    /IgnoreTaggedCampaignResponses

    		 When the campaign .QEW file has tags on its questions or responses, you can choose to ignore matching these during reconciliation.

    /TagMatchingMethods:""

    Specify the question matching methods by tags in the source .QES file. You need to list the name of the tag and the letter code for the question matching method in JSON format (see codes listed under /M: above).

    One tag, one method format:

    /TagMatchingMethods:"[{""tags"": [""tagName1""], ""methods"": ""methodCodeLetter1""}]"

    Two tags, one method:

    /TagMatchingMethods:"[{""tags"": [""tagName1"", ""tagName2""], ""methods"": ""methodCodeLetter1""}]"

    Three tags across two methods:

    /TagMatchingMethods:"[{""tags"": [""tagName1"", ""tagName2""], ""methods"": ""methodCodeLetter1""}, {""tags"": [""tagName3""], ""methods"": ""methodCodeLetter2""}]"

    /MATCH_STRICTLY

    The default matching is done on first letter code it has success matching on. This new parameter allows you to specify that all matching methods listed must be satisfied for a match to be made.

     

    Examples

    Merge & publish an HTML report

    "C:\Program Files (x86)\Askia\AskiaSuite\Surf.exe" /target:"\\Data\Sample\Sales.qew" /source:"\\Data\McDonalds\June.qes" /output:"\\Data\McDonalds\Report.html" /A:QR

    Theoretical command sample

    Without specifying any real files, the above commands & arguments can be laid out as follows:

    "C:\Program Files (x86)\Askia\AskiaSuite\Surf.exe" /source:"path" /target:"path" /output:"path" /LINKQ:"shortcut" /A:QR /X:QR

     

     

    Since AskiaSurf 5.6.0.0:

    Create a new AskiaSurf file and specify the wave & volume names:

    "C:\Program Files (x86)\Askia\AskiaSuite\Surf.exe" /source:"Wave 1.qes" /target:"MergeWaves.qew" /output:"REPORT.html" /WAVE_NAME:"Custom wave 1 name" /VOLUME_NAME:"Custom volume 1 name" /A:QR /I:QR /M:SCLIU /N:CEOIU /A:QR /X:QR

     

    Create a new AskiaSurf file and specify case sensitivity when matching:

    "Surf.exe" /source:"Wave 2.qes" /target:"MergeWaves.qew" /output:"REPORT.html" /CASE_SENSITIVE /A:QR /I:QR /M:S /N:CEOIUR

     

    Create a new AskiaSurf file and specify questions for reconciliation by tag:

    "Surf.exe" /target:"Test-A-ISBT.qew" /source:"WAVE-1.qes" /output:"Report.html" /A:QR /I:QR /M:SCLIU /N:CEOIU /A:QR

    "Surf.exe" /target:"Test-A-ISBT.qew" /source:"WAVE-2.qes" /output:"Report.html" /A:QR /I:QR /M:SCLIU

     

    Create a new AskiaSurf file and specify question matching methods (strict) by tag:

    "Surf.exe" /target:"mergeAB-RED.qew" /source:"WAVE-A.qes" /output:"Report.html" /A:QR /I:QR /M:SCLIU /N:CEOIU /A:QR

    "Surf.exe" /target:"mergeAB-RED.qew" /source:"WAVE-B.qes" /output:"Report.html" /A:QR /I:QR /MATCH_STRICTLY /TagMatchingMethods:"[{""tags"": [""white"", ""pink""], ""methods"": ""SC""}, {""tags"": [""red""], ""methods"": ""SL""}]" /N:CEOIU /A:QR

     

    Related articles