MYOB Exo Clarity

Hide NavigationShow Navigation
  • Contents
  • Index
  • Search
 
Display results with all search words

 

Available Parameters

The following parameters can be entered when running a report from the command line, a custom button, a menu or a dashboard widget. Some parameters are specific to only one or some of these scenarios.

Parameter

Description

Value

Default Value

Notes

Connection Name

The Exo Business database connection to use.

 

 

Only required when running a report from the command line, in which case this must be the first parameter specified.

Username

The login name of the Exo Business user to run the report as.

 

 

Only required when running a report from the command line, in which case this must be the second parameter specified.

Password

The specified user's password.

 

 

Only required when running a report from the command line, in which case this must be the third parameter specified.

Report Name

The file name of the Exo Clarity report to run.

 

 

When running from the command line, this must be the fourth parameter specified; in all other cases, it must be the first

/D or /d

The report destination to output to.

Printer, File, Viewer, Email, Grid

/d=Viewer

The File and Email options require the /F and /M parameters. The Printer option requires a valid /P or /I parameter.

If not specified, the Viewer (Print Preview) window will appear, ignoring any inheritance direction values set by the /I parameter. It is good practice to always have this in any Exo Clarity command line call.

/F or /f

The filename for the output file.

A valid file name

 

The file extension must match the format specified by the /M parameter e.g. *.DOC or *.PDF

/M or /m

The output file mode.

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

/m=RTFFile

Specifies the output format:

  • TextFile - TXT

  • ReportTextFile - TXT

  • XLSXData - XLSX

  • XLSReport, XLSData - XLS

  • GraphicFile - JPG, BMP or TIF

  • HTMLLayerFile - HTM

  • HTMLFile - HTM

  • PDFFile - PDF

  • RTFFile - RTF

/P or /p

The printer to print the report to.

'Default' or Printer name with the network drive portion in UNC format

/p=Default

This parameter is needed when the /D parameter is set to Printer.

It is not used if a /I parameter is specified.

"Default" is the Windows default printer. If the path is incorrectly entered, Exo 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.

/C or /c

The number of copies to print.

1 or more

/c=1

Only used when the /D parameter is set to Printer. The copy counter and total copies are available for use in the report as global variables in the plGlobalVars data source.

/A or /a

Open the Clarity Report Parameters window to ask for report parameter values.

Y or y, N or n

 

Add /A=N to skip the confirmation of any parameters that exist for the report. Otherwise the report will run on defaults or values specified by the /S parameter.

When used with a Clarity report dashboard widget, adding /A=Y will make the widget's Parameters tab appear by default when the widget first opens. If /A is set to N, or if it is not included, the Report tab is displayed when the widget opens.

/L or /l

Hide the Exo Clarity splash screen.

N or n

 

Only applies when running a report from the command line and asking for parameters (/A=Y). If this parameter is specified, the Exo Clarity splash screen will not appear when opening the report.

/S or /s

Specifies report parameter values.

Comma separated parameter=value pairs

 

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 they are 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 and /S are used together, any specified values will be pre-populated in the Clarity Report Parameters window.

/E or /e

Opens the report in the Clarity Report Designer for editing.

 

 

Other parameters are ignored.

/I or /i

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

Valid integer value

0

Principally for internal use by Exo Business developers. Current form IDs 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  

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