Knowledgebase
[QXL-ALL] QXL shortcut commands and parameters
Posted by Jack - QODBC Support on 04 July 2017 11:53 AM

General QXL  shortcut commands and parameters 

Parameters available in the QXL

bullet Run = The parameter is used for running QXL in the foreground (i.e. QXL will be visible during execution).

example: QXL.EXE Run

bullet Silent = The parameter is used for running QXL in the background (i.e. QXL will not visible during execution).

example: QXL.EXE Silent

bullet DefaultPath = The parameter is used for setting up export folder path where the output will be placed.
Note:: Folder path should not end with the backslash ("\").

example: QXL.EXE Silent DefaultPath="C:\My Folder\QXL Output Folder"

bullet ExportType = The parameter is used for set-up format of exported file to XLSX or XLS or CSV or SQL or ODBC.

example: QXL.EXE Silent DefaultPath="C:\My Folder\QXL Output Folder" ExportType="CSV"

bullet ExportIn = The parameter is used for setting up exported file in Separate Files or single file - values True/False.

bullet UseOptimizer = The parameter is used for enable or disable Optimizer - values True/False

bullet OptimizerFilePath = The parameter is used for change Optimizer File location. If you want to store Optimizer file at the different location, then you can provide file path where Optimizer file will be created. - e.g "C:\QXL\Optimizer"
Note:: Folder path should not end with backslash ("\")

bullet CreateTableForExcel = The parameter is used for create table from the sheet (for Excel 2010 or above in [xlsx] format only.) - values True/False

bullet ExcelHeaderColor = The parameter is used for changing Excel Column Header Color (for Excel 2010 or above in [xlsx] format only.)- values Hex color codes without # - e.g 808080
Refer HTML Color Codes for more details about color code.

bullet ExcelTableStyles = The parameter is used for formatting excel cell by choosing pre defined styles (for Excel 2010 or above in [xlsx] format only.) - values
Dark1
Dark2
..
Dark10
Light1
Light2
...
Light21
Medium1
Medium2
...
Medium28

bullet TableSelection = The parameter is used for selecting table from different option (i.e. ALL/Selected Table/Excluding Selected Table). - Value 0=All, 1=Selected tables specified in TablesToExport, 2=other then the tables specified in TablesToExport

bullet TablesToExport = The parameter is used for specifying which table you want to export. values ="Table1,Table2" example -TablesToExport="Entity,Company,Class"
Note: You need to use "TableSelection" when you specify table using "TablesToExport" parameter. If you don't use "TableSelection", then QXL will ignore "TablesToExport" parameter value & export according config file set up.

bullet DefaultODBCConnectionName = The parameter is used for defining which ODBC Connection to be used (value is the index of ODBC connection list) Value = 0 or 1 or 2
For Example: You have created 4 connection as below image, then connection name "SQL" will used as "Value = 0", Same way connection name "MSA" will used as "Value = 1" & connection name "MYSQL" will used as "Value = 2".

bullet ConfigFile = The parameter is used for specifying which config file to be used. - e.g. "C:\Users\Dewani\config.xml"

bullet ReportQueries = The parameter is used for fetching specific report(s) to export. -
e.g. ReportQueries= "<ReportQueries><ReportQuery0><Name value="GeneralLedger" /><Value value="sp_report GeneralLedger show TxnType_Title, Date_Title, RefNumber_Title, Name_Title, Memo_Title, SplitAccount_Title, Debit_Title, Credit_Title, RunningBalance_Title, Blank, TxnType, Date, RefNumber, Name, Memo, SplitAccount, Debit, Credit, RunningBalance parameters DateMacro = 'ThisMonthToDate'" /> </ReportQuery0></ReportQueries>"

bullet CustomQueries = The parameter is used for fetching specific table data through your own custom query according to your requirement.
e.g. CustomQueries= "<CustomQueries><CustomQuery0><Name value="Txn June" /><Value value="Select * from Transaction where TxnDate >= {d'2017-06-01'} and TxnDate <= {d'2017-06-30'}" /></CustomQuery0></CustomQueries>"

Note: Value of ReportQueries & CustomQueries should not contain any line feed.

 

bullet SetExportFilesReadOnly = The parameter is used for protecting exported file for unwanted write. This option will set exported files to read only if you set the value to "True". - values True/False.

Additional Parameters for QuickBooks Desktop Edition

bullet CompanyFilePath = The parameter is used for setting up QuickBooks company file path in QXL OR You can use . (dot) to indicate currently open company file. If you don't specify company file path, then QXL will use company file specified in config file.
e.g. CompanyFilePath="C:\Users\Public\Documents\Intuit\QuickBooks\Sample Company Files\QuickBooks Enterprise Solutions 13.0\sample_product-based business.qbw"

Additional Parameters for QuickBooks Online Edition

bullet QBODefaultConnectionName = The parameter is used for defining which QuickBooks Online Company Connection to be used (value is the index of QuickBooks Online connection list) Value = 0 or 1 or 2
For Example: You have created 3 connection to QuickBooks Online company as below image, then connection name "Sandbox USA" will used as "Value = 0", Same way connection name "Sandbox CA" will used as "Value = 1" & connection name "Sandbox IN" will used as "Value = 2".

Export data using QXL Parameters

There is two way to export QuickBooks/QuickBooks Online data using QXL Desktop/QXL Online.
1. Using Parameter file.
2. Provide parameter using command line arguments.

Example of using parameters file with QXL

When you install QXL at that time sample parameter file is installed at "C:\Users\Your User Name\Documents\QXL\" folder.

 

QXL Desktop sample parameter file:

QXL Online sample parameter file:

Sample parameter file opened.

You can copy this file & rename like "My Company.txt" e.g. "ABC Company.txt".

You can write the parameters in a text file & use Parameter file with QXL.

The first step in configuration is to click on settings icon for QXL options details.


In General tab, You will find two buttons which will create the export shortcut on your desktop.

1. QXL - Silent Mode which will export data in silent mode (does not display QXL Window).

2. QXL - Direct Export Mode which will export data in direct mode (display QXL Window).

In this example, I am using the first option (i.e. QXL - Silent Mode).

By clicking on "Create a shortcut on desktop" button you will get below popup message & click "OK" it will create the shortcut on the desktop.

The shortcut is created on the desktop.

Now, We will modify shortcut by right-clicking on shortcut & click "Properties".

The shortcut property window is open navigate to "ShortCut" tab & add below text in "Target" box & save configuration by clicking "OK".

"C:\Program Files (x86)\FLEXquarters.com Limited\QXL for QuickBooks\QXL.exe" "C:\Users\Raj\Documents\QXL\ABC Company.txt"

The shortcut is saved on the desktop. You can run it by double-clicking shortcut.

You can use above shortcut in your scheduled application to export QuickBooks Data using QXL.

QXL will start exporting data as per provided parameters.


After the exporting data is completed, QXL application will close automatically.

Note: The shortcut support up to 260 characters in "Target" box, In which QXL path took 76 characters. So you can use the shortcut when command line argument limit under 260 characters. So please make sure that your parameter file path & QXL path character total does not exceed 260 characters. If it exceeds 260 characters, then please make parameter file path shorter.

Also Refer: How to use QXL with scheduler for multiple company files

 

Tags: Command line arguments, shortcuts, background, silent, parameters

(0 vote(s))
Helpful
Not helpful

Comments (0)
Post a new comment
 
 
Full Name:
Email:
Comments:
CAPTCHA Verification 
 
Please enter the text you see in the image into the textbox below (we use this to prevent automated submissions).