Support

 



MoneyWorks URL Scheme

The MoneyWorks URL scheme follows the pattern of the Common Internet Scheme syntax described in RFC 1738.

Where can I use it?

On both Mac OS X and Windows you can make a shortcut file that will connect you to a MoneyWorks server when you open it.

On Windows you can use a URL in place of a file path on the command line when starting MoneyWorks (usually using a shortcut) or as the parameter to the "open" command in a VB script.

On Mac and Windows you can type a moneyworks URL into your web browser, or use a bookmark to initiate a connect in MoneyWorks

You can create a standalone shortcut file containing the url that can be opened by double-clicking.

URL scheme

The syntax is as follows:

"moneyworks://"  [ user [ ":" pass ] "@" ] server [ ":" port ] [ "?doc=" documentname ]

user is the username to log in with

pass is the password to use (required if the document is password-protected)

server is the server IP address or domain name

port is the port to connect to. For a MoneyWorks Gold document this is usually 6674, and if you omit the port part, this is the port that is assumed. If you are connecting to a Datacentre, you will need to specify the Datacentre service port (usually 6699)

documentname is the name of the document on a Datacentre to connect to (as it appears in the Datacentre connection dialog box). This must be URL-encoded: i.e. characters such as spaces and other non-alphanumerics must be %hex encoded.A document name is only used when connecting to a Datacentre server. With a Gold server, you will be connected to whatever document the server has open (although the port must still be correct)./

examples

moneyworks://192.68.1.14

Connect to server on given IP address and default port (or the last port number you connected to). If password is required you will get login dialog box.

moneyworks://rowan:fred@prefect.cognito.co.nz

Connect to MoneyWorks Gold server running on prefect.cognito.co.nz running on default port (usually 6674) using supplied user name and password,

moneyworks://rowan:fred@prefect.cognito.co.nz:6699?doc=Acme%20Widgets%20Ltd

Connect to named document on a Datacentre server running on default DC port (6699) using supplied user name and password. Note that spaces and special characters in the document name must be escaped as hexadecimal according to standard URL rules. If the document is in a subfolder on the Datacentre, you must include the subfolder name and path separator appropriate to the platform the Datacentre is running on (/ for Mac, \ for Windows)

When MoneyWorks Datacentre is set up to require login itself (ASP user partitioning), you will need to pass the document username and password as part of the ?doc= part of the URL; the Datacentre login username and password come before the server in that case.

e.g.: moneyworks://UserA:userA_pass@server:6699?doc=Doc1User:Doc1Pass@UserA/Some%20Document.mwd5

Making a shortcut to a network document

Mac OS X

[v4.1.4 and later]

In Safari Bookmarks, click the + icon; Type the address for your shortcut in the form described above. This will most usefully be a Datacentre-style url, e.g. moneyworks://rowan:fred@prefect.cognito.co.nz:6699?doc=Acme%20Widgets%20Ltd Note that you can omit the password for the document if you have already stored the password in your Keychain.

Typing a MoneyWorks URL in Safari. The server address in this case is the localhost address, since this connection happens to rely on a previously established SSH tunnel to a remote server 1000 miles away.

You can now start a connection by clicking the bookmark. You can also drag this bookmark to the Finder to make a double-clickable shortcut document, however, Safari will create this document with a file extension of .inetloc, and this will not work due to a bug in the Mac OS X Finder (currently under investigation by Apple). You can make it work by simply renaming the file extension to .webloc. Double-click it to start a connection.

Windows

On Windows, you can use a regular shortcut (.LNK) file to pass the URL as the command line argument.

Make a New Shortcut by right clicking in Windows Exporer and choosing New -> Shortcut and typing the 2 arguments in quotes. The first argument is the path to the MoneyWorks .exe, the second is the URL to the network server.

E.g:

"C:\Program Files\MoneyWorks Gold\MoneyWorks Gold.exe" "moneyworks://Admin@Prefect.local:6699?doc=Play%20File"

Using URL from a script

Windows

You can pass the url as the argument to the COM/OLE open command, from Visual Basic etc.

Mac

Use open location "moneyworks://...."