Command Line Launch Parameter Definitions

Parameter

Description

Value

Default Value

Note

Example

Alias Name

The 1st parameter (External Call only)

ACCDATA

User Name

The 2^nd parameter (External Call only)

sysdba

Password

The 3^rd parameter (External Call only)

masterkey

Report Name

Clarity report file name

The 4^th parameter (External and Internal Call)

PurchOrd.clr

/D or /d

Report Direct to destination

Printer, File, Viewer, Email, Grid

/d=Viewer

File & Email options require /F and /M params. Printer option requires a valid /P or /I parameter.

If not specified, the Viewer dialogue will pop up ignoring any inheritance (/I) direction value set. It is good practice to always have this in any Clarity command line call.

(External and Internal Call)

File

/F or /f

Output  Filename

A valid file name

The file extension must be the same as the Output file format parameter would expect.  Eg *.DOC or *.PDF

(External and Internal Call)

C:\TEST.PDF

/M or /m

Output file Mode

TextFile, LotusFile, QuattroFile, XLSReport, XLSData,  GraphicFile, HTMLLayerFile, HTMLFile, PDFFile, RTFFile, ReportTextFile

/m=RTFFile

TextFile – TXT
ReportTextFile – TXT
LotusFile - WK1
QuattroFile - WQ1
XLSReport, XLSData – XLS
GraphicFile – JPG, BMP, TIF
HTMLLayerFile – HTM
HTMLFile – HTM
PDFFile – PDF
RTFFile – RTF

(External and Internal Call)

PDFFile

/P or /p

Printer name with the network drive portion in UNC format

'Default' or Printer UNC

/p=Default

'Default' is the windows default printer;

Always used with /D=Printer.

Never used with /I=nn.

If the path is incorrectly entered Clarity will print to the default printer.

The name to use is not the name of the printer as it is called on the server sharing the printer. It needs to be name as it is known on your machine i.e. the printer name as displayed in the Control Panel / Printers and Faxes. 

The print server can be an IP address.

(External and Internal Call)

/P="\\PrinterServerName\HP LaserJet 8000 Series PCL 5e"

/C or /c

the number of Copies to print

1 or more

/c=1

Only used in association with Printer output. Copy counter and total copies are available for use on your document as pipeline Global variables.

(External and Internal Call)

1

/A or /a

Ask for any Parameter values using the parameter dialogue screen.

Y or y, N or n

Add /A=N if you wish skip the confirmation of any parameters that exist for the report you are running.  Otherwise the report will run on defaults or specified values (/S)

(External and Internal Call)

n

/L or /l

Show Logo

N or n

Don't show the splash screen on opening when using  /A parameter (External Call only)

n

/S or /s

Specified Parameter  Selection Values

Comma separated Text

Used internally for passing multiple parameters to a .CLF type file, but can also be used with a CLR file and associated CLS file. You must specify the parameter names as defined in the CLS file. If a parameter name is omitted or misspelled, then the parameter dialogue will appear at runtime, regardless of the /A parameter.

Double quote marks that are part of the string are repeated to distinguish them from the quotes that surround the entire launch parameter string. If /A (see above) and /S are used together, then any specified values will be pre-populated in the Clarity parameter dialog box.

(External and Internal Call)

Test1=1,Test2=33,Test3="String 1"

Where TestN is the exact name of the parameter.

If your parameter is a set of values then you must enclose the set with parenthesis eg.

Interbase1 ExoAdmin ExoAdmin  SalesOrd.CLF /s=Param1=3,{Param2=86,99,55} /i=22

/I or /i

Inherit profile settings of a similar CLF file.  Pass it a Report ID value based upon a predefined list of constants in the MYOB Exo Business code. Can be used instead of specifying each individually if a similar report exists within MYOB Exo Business that has profile controlled settings.

Valid Integer Value

0

Principally for EXO programmer use.

Current ReportIDs are
  0=riNone,  1=riBackord,
  2=riBRemittance,  3=riBStatement,
  4=riCRAccount, 5=riCRInvoice,
  6=riDocket, 7=riDRAccount,
  8=riInvoice, 9=riJobInvoice,
10=riJobPreview, 11=riJobQuote,
12=riJobSheet,13=riManifest,
14=riPackslip, 15=riPOLine,
16=riPOQuote, 17=riPosReciept,
18=riPurchOrd,19=riPurchrec,
20=riQuote,21=riRemittance,
22=riSalesOrd,23=riSOLine,
24=riStatement,25=riStockItem,
26=riStockReceipt,27=riWorksOrd,
28=riIGReceipt,29=riShipment,
30=riIGCosting,31=riInvLabel,
32=riGLAccSummary, 33=riCountSheets,
34=riStkVariance,35=riBomBatch,
36=riBillomat,37=riViewInv,
38=riChequeRepF, 39= riDDRepF,
40=riAMPurchases,41=riAMSales,
42=riAMBookValue, 43=riAMTaxValue,
44=riAMBookDepreciation, 45=riAMTaxDepreciation,
46=riAMServiceSchedule, 47=riAMListingByGroup,
48=riAMRevaluations, 49=riAmTransactionByAsset,
50=riPricePolicy, 51=riDRPaymentBatch,
52=riDrPmtReceipt, 53=riSupplyHist,
54=riBankBatchList 55=riPickingList, 56=riPickingRequisition,57=riStockRequest,
58=riSalesOrderLabel,59=riJobMisc, \
60=riExotrackJob, 61=riExotrackJobList, 62=riExotrackJobDetail, 63=riSubsSummary,
64=riSubsDetail, 65=riSubsBillRunRep, 66=riSubsStockGroupSummary, 67=riFinPPManCheqWr, 68=riFinPPChqPayment, 69=riFinPPChequeRep, 70=riFinPPManChequeRep, 71= riFinPPDoNotPay, 72=riFinPPChqRunRep, 73=riFinPPEftRmit, 74=riFinPPCheqWr, 75=riFinPPSeqChqRep, 76=riFinPPDCRep, 77=riFinBRAPExceptionRep, 78=riFinBRUnRecRep, 79=riFinBRCloseBalRep, 80=riFinBRGLUnRecRep, 81=riFinBRDishonDDRep, 
82=riFinBRRecAutoMatchRep, 83=riFinDDBatchRep, 84=riFinDDRemitance, 85=riShiftEnh, 86=riShiftSales,87=riShiftAudit, 
88=riSTSale, 89=riSTReceipt,  
90=riSTTfer, 91=riSTAdjustIn,  
92=riSTAdjustOUT, 93=riSTCostAdjust,  
94=riIGLabel, 95=riShift,  
96=riStockTrans, 97=riPOSBankBatch, 98=riBatchSalesOrderProcessing, 99=riGLBatch,
100=riSTKPricePolicy, 101=riACCPricePolicy, 102=riGLBatchTrans, 103=riBatchInvoice, 104=riCrPmtReceipt, 105=riPickSlip,  
106=riConfSlip, 107=riStockValInactive  
(External and Internal Call)

Note: /I should never be used in conjunction with any other output / destination type command line parameters like /P or /D as it gets overridden by them.

/I=22 would use the set of 4 computer  profile settings defined for the Salesord.CLF,  such as printer name, output file format. Email actions etc.