Global Variables

MoneyWorks Manual

Global Variables

The information entered into the company dialog box of MoneyWorks (such as company name and address details) is available for use in any calculation (these are also listed in Report Variables).

Additionally MoneyWorks includes a set of system variables allowing you to enquire about the computer on which you are running and the file that is open. The variables are reasonably self explanatory. Where the result is platform dependent (as in a file path), examples are given. Mac users should note that there are forms for returning HFS and POSIX paths

Variable	Details/Results
`Address1...Address4`	the company postal address (in Show>Company Details). Address4 holds the Country value
`AgingCycle`	an integer representing the current aging cycle of transactions. It is incremented every time the Aging command is used.
`ApplicationPath`	Mac: `Macintosh HD:Applications:MoneyWorks Gold.app` Win: `C:\Program Files\ MoneyWorks Gold\ MoneyWorks Gold.exe`
`AppSerial`	Your 15 character serial number
`AutomationFilesFolderPath`	Path to the default directory for writing files from scripts
`BaseCurrency`	The base currency of file
`BuildNumber`	The MoneyWorks build number
`CacheFolderPath`	The directory used by File_Open to create "CACHE/" files
`CoRegName`	The prefix for the company registration number(determined by locale, e.g. IRD in NZ, ACN in Australia, IRS in USA)
`CurrentPer`	The current(i.e. most recently opened) period number
`CustomPlugInsPath`	Mac: `Macintosh HD:Users:guru:Documents:MoneyWorks Custom Plug-Ins` Win: `C:\Users\Public\ Documents\ MoneyWorks Custom Plug-Ins`
`Delivery1...Delivery4`	the company delivery address (in Show>Company Details)
`DeliveryPostcode`	postcode of company delivery address (in Show>Company Details)
`DeliveryState`	state of company delivery address (in Show>Company Details)
`DetailDateColumnEnabled`	Is the Show Date Column preference turned on
`DocumentName`	Mac: `Acme Widgets Gold.moneyworks` Win: `Acme Widgets Gold.moneyworks`
`DocumentPath`	Mac: `Macintosh HD:Users:guru:Documents:Acme Widgets Gold.moneyworks` Win: `C:\Users\Public\ Documents\Acme Widgets Gold.moneyworks`
`DocUUID`	A unique identifier for the document (UUID)
`Email`	general company email address (in Show>Company Details)
`ExtendedJobCosting`	true if Job Costing is turned on.
`Fax`	company fax (in Show>Company Details)
`GSTCycleEndDate`	the date the current GS/VAT/TAX ends on
`GSTCycleMonths`	the number of months in the current GST/VAT/TAX
`GSTCycleNum`	the current GST/VAT/TAX Cycle number (incremented by GST/VAT/TAX report finalisation)
`GSTExpensesInvoiceBasis`	True if GST/VAT/TAX reporting is set to invoice basis for expenses
`GSTGuideName`	The name of the GST/VAT/TAX guide report to us (determined by locale).
`GSTIncomeInvoiceBasis`	True if GST/VAT/TAX reporting is set to invoice basis for income
`GstNum`	the company's GST/VAT/ABN number (in Show>Company Details)
`GSTProcessingSuppressed`	true if no GST/VAT/TAX processing
`GSTRegName`	the name of the GST/VAT/TAX registration (determined by locale)
`Have_Logo`	true if a logo has been stored (in Show>Company Details)
`Initials`	the initials of the current logged user.
`LastAgedDebtors`	the date the debtors were last aged
`LastBackup`	the date a backup was last taken (using File>Save a Backup)
`LastStocktake`	the date of the last stocktake
`Locale`	Indicates the software product, version/kind, and localisation (the first letter is a country indicator, which indicates the document locale). e.g. `N9G`
`LocaleFriendlyName`	Mac: `NZ` Win: `NZ`
`LogFilePath`	Mac: `/Users/guru/Library/Logs/MoneyWorks_Gold.log` Win: `C:\Users\Administrator\AppData\Roaming\Cognito\MoneyWorks Gold\MoneyWorks_Gold.log`
`Mobile`	the company's mobile contact (in Show>Company Details)
`MultiCurrencyEnabled`	true is the multi-currency option is on
`Name`	the company name (in Show>Company Details)
`NavigatorActive`	True if the navigator window is frontmost
`NetworkLatency`	for connected users, the network latency in milliseconds
`PeriodNames`	a comma separated list of the period names.
`PeriodsInYear`	the number of periods in the financial year
`Phone`	the company's general phone number (in Show>Company Details)
`Platform`	Mac: `Mac` Win: `Windows`
`PlatformApplicationPath`	Mac: `/Applications/MoneyWorks Gold.app` Win: `C:\Program Files\MoneyWorks Gold\MoneyWorks Gold.exe`
`PlatformDocumentPath¹`	Mac: `/Users/guru/Documents/Acme Widgets Gold.moneyworks` Win: `C:\Users\Public\Documents\Acme Widgets Gold.moneyworks`
`PlatformPlugInsPathString`	Mac: `/Users/guru/Documents/MoneyWorks Custom Plug-Ins` Win: `C:\Users\Public\Documents\MoneyWorks Custom Plug-Ins`
`PlatformStandardPlugInsPath`	Mac: `/Users/guru/Library/Application Support/Cognito/MoneyWorks Gold/MoneyWorks 7 Standard Plug-Ins` Win: `C:\Users\Administrator\AppData\Roaming\Cognito\MoneyWorks Gold\MoneyWorks 7 Standard Plug-Ins`
`PostCode`	(in Show>Company Details)
`preferredContactRole`	the last role(s) chosen when last emailing
`Print_Address`	true if the Print Address option is on the Logo section of Show>Company Details
`RegNum`	the company's IRD/ACN/IRS number (in Show>Company Details)
`RemittanceMessage`	text to appear on invoices and statements for direct credit details (in Show>Company Details)
`RemoteHost`	The name of the server the client is connected to
`SerialTrackingEnabled`	Is Serial Number Tracking turned on
`ServerMaxConcurrent`	For connected users, the maximum number of permitted concurrent users
`ServerRego`	The serial number of the MoneyWorks server
`StandardPlugInsPath`	Mac: `Macintosh HD:Applications:MoneyWorks Gold.app` Win: `C:\Users\Administrator\AppData\Roaming\Cognito\MoneyWorks Gold\MoneyWorks 8 Standard Plug-Ins`
`StartupSequenceNumJob` `StartupSequenceNumJobSheet` `StartupSequenceNumName` `StartupSequenceNumProduct` `StartupSequenceNumTransaction` `StartupSequenceNumUser`	The next sequence number for each of the files at the start of the session (i.e. file opened in single user mode, or client logged in). Can be used to implement session filters or reports. For example, `SequenceNumber >= StartupSequenceNumTransaction` would find all transactions entered since the current user logged in.
`State`	the state/province of the postal address (in Show>Company Details)
`stockLocationTracking`	true if stock location tracking is turned on
`stocktakeLocation`	the current location for a stock take as selected in your product list toolbar Location icon
`StocktakeModeActive`	true if a stock take has been started by not finalised
`TaxName`	The name of the main tax (e.g. GST, HST, VAT -- locale dependent)
`TaxName2`	The name of the secondary tax (e.g. PST -- locale dependent)
`UserMaxConcurrent`	The maximum number of users than can connect the MoneyWorks server at any one time
`UserIsReadOnly`	user is logged in with read-only privileges
`UserName`	The logged in name of the user
`Version`	the version number of the MoneyWorks being used (e.g. 7.0)
`WebURL`	the URL of your website; if this is a complete URL (i.e. includes the http://) it will be hot-linked to your website in pdf reports and forms(in Show>Company Details)

¹ PlatformDocumentPath returns an empty string if document is not local ↩

Field References and Identifiers Fields in Reports