Table of contents:

• Definition
• Examples

Since version 5.1.3.4, AskiaAnalyse can be used via the command line which is extremely useful with AskiaVista's automated & scheduled tasks.

You can invert data stored in SQL Server.
This feature is crucial when AskiaField surveys are initialized in SQL Server in the CCA.
This feature is used by AskiaVista to have retrieve live survey data in order to display up to date analysis results.
Note: We will add further functionality as requests are made.

This feature has been updated from version 5.3.1 to use a temporary directory during the inversion process, minimizing system downtime while running the inversion.

Definition

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

/url:"https://MyServer/CcaWebAPI"

/username:"Supervisor"

/password:"Supervisor pwd"

/parameters:"C:\Users\Admin\MyFilePath\,42"

Dim arrParm as StringArray = GetCommandParameters() 
Dim path = arrParm[1] ' "C:\Users\Admin\MyFilePath\" 
Dim info = arrParm[2] ' "42"

Examples

1. Recalculate and invert data of a QES file when data are stored in SQL server.

Analyse.exe "C:\MyQes\Ex.qes" /surveyconnection:"Provider=sqloledb; Data Source=XXXXXXX; Initial Catalog=Surveys;Trusted_Connection=no;User Id=XXXXXX;Password=XXXXX";" /surveyid:249 /type:5 /recalculatevariables /invert

2. Export to inverted format of a Surf file with calculated questions.

AnalyseU.exe "C:\My QEWs\Ex.qew" type:3 /exportsptoinv /"script:??Lang?? Has 1" /"calculated:Weighting" /"exclude:Wave" /"output:C:\My Qes\reduced.qes" 

3. Export of a portfolio to Excel on a sub-population.

AnalyseU.exe "C:\My QES\Ex.qes"  /exportexcel /"script:??Lang?? Has 1" /"portfolio:C:\My QES\MyAnalysis.xml" /"output:C:\My Qes\result.xls" 

4. Export multiple portfolios to multiple Excel files in a single command / session of Analyse:

(Only available from Analyse 64 bit 5.3.5.5 11/10/2016 onwards).

Analyse.exe "c:\qes\me\ex.qes" /exportexcel /portfolio:"c:\qes\me\p1.xml" /output:"c:\qes\me\p1.xlsx" /portfolio2:"c:\qes\me\portfolio.xml" /output2:"c:\qes\me\poorttfolio.xlsx"

5. Replace tab template before exporting: 

Analyse.exe "C:\Qes\ex.qes" /exportexcel /"portfolio:C:\Qes\JustCount.xml" /"output:C:\Qes\result.xls" /replacetabtemplate:"FlatCount|FlatCountAndPercentage" /"logfile:C:\Qes\Log.txt"

6. Set start sheet in Excel to be 5:

Analyse.exe "C:\Qes\ex.qes" /exportexcel /"portfolio:C:\Qes\JustCount.xml" /"output:C:\Qes\result.xls" /"logfile:C:\Qes\Log.txt" /startsheet:5

7. Generate Fast metadata from the command line:

Analyse.exe "C:\My qes\LatestVersion.qew" /fastmetadata

8. Run an automation script from the command line:

Analyse.exe "C:\Qes\ex.qes" /"automate:C:\Qes\CreateSummaryTabs.txt"

Analyse.exe "C:\Qes\ex.qes" /exportexcel /"portfolio:C:\Qes\CreatedSummaryTabs.xml" /"output:C:\Qes\SummaryTabs.xls"

From 5.6.1.0

9. Open live data from the command line:

"Analyse.exe" /url:"http://10.0.51.21/CcaWebAPI" /username:"!Askia_Seyf" /password:"*****" /surveyId:9999 /exportexcel /"portfolio:OpenLiveDataPortfolio.xml" /"output:myLiveData.xlsx"

10. Parameters given in the command line to be used by the automation script that it is running:

"Analyse.exe" "EX_NEW.qes" /"automate:V-1083-AutoScript.txt" /parameters:"C:\MyFilePath\,42"

Note:

1. Survey projects using QEM are no longer supported, as this file format has been deprecated since version 5.1.x in AskiaAnalyse, and version 5.3.0.0 in AskiaVista. The QEM format was made obsolete with the release of AskiaSurf and its much more modern, flexible & powerful QEW format.

Return error codes

Add this on a new line after your command has run to capture the error code in the command window:

cmd /k echo Exit Code is %errorlevel%

The process can return the values below. For more information, you may find this article useful.

#define AER_NO_ERROR                                  0
#define AER_LOGIN_REFUSED                            -1
#define AER_SURVEY_NOT_FOUND                         -2
#define AER_CANNOT_OPEN_SURVEY_FILE                  -3
#define AER_CANNOT_READ_FILE                         -4
#define AER_SURVEY_TYPE_NOT_SUPPORTED                -5
#define AER_INVALID_PORTFOLIO_FILE                   -6
#define AER_CANNOT_CREATE_OUTPUT                     -7