Tutorial

Open mSupply Tutorial

This tutorial is designed to guide you through the basics of using Open mSupply

Logging in

  1. For a start, you'll need to open your web browser. We like Firefox, but Chrome and its myriad children will also suffice.
  2. Enter the web address (URL) of your mSupply server. In our case we're using https://demo-open.msupply.org - our test web site.
  3. After pressing on your keyboard you'll be shown the login page

login!

  1. Enter your user name and password and press on your keyboard, or click the [Log in] button

All going well, you'll be redirected to the dashboard page. If there was a problem, you'll see an error message, like this:

login!

Try re-typing the username and password (note that both are case-sensitive). When you log in, the default store for your user is selected as the current store. If you have access to other stores, you'll be able to change stores after logging in (see below). If you have logged in previously, and changed stores, then the most recent store will be selected for you when you log in.

The main menu is on the left side of the screen. If you have a small screen size, then it will be collapsed by default - for larger screens it will instead be open by default. To open and close you can click on the logo at the top, as shown below. The menu remains either open or closed once you have selected an option.

If the menu is closed, simply hovering over the menu items will open it, in which case clicking on an item will let the menu close again. If you are on a tablet, clicking on a menu item will have the same effect.

Main navigation

On some screens you'll see that the header shows a heading, such as Outbound Shipment in the example above. Clicking on a specific shipment then changes that heading to Outbound Shipment/ #[the shipment number]. You are able to click on the Outbound Shipment part to return to the list - or use the main navigation on the left.

Keyboard shortcuts

There are keyboard shortcuts used throughout open mSupply. Rather than remember them all, to get started you simply have to remember the combination control (ctrl)+k (windows and linux) or cmd (⌘)+k (mac)

This will bring up the following window, no matter which page you are on:

CommandK

This shows you the list of globally available shortcuts, for example pressing d on your keyboard will take you to the dashboard (unless you are entering text into an input field!).

However, you can also click on an item in the list, or search available commands:

CommandK

In addition - there are various places where specific keyboard shortcuts are available. An example is the tab control used in both Stocktakes and Inbound Shipments. Here you can use control+1 to navigate to the first tab (Quantities) or control+2 for the second tab (Pricing) etc. If you press + on your keyboard, you can add a new batch.

Inbound tabs

The bottom of the screen contains some useful information and is shown on every screen

Footer

Some users have access to more than one store. To change the store which is currently selected, simply click on the store name in the footer:

Store switcher

You will see the notification and the store name in the footer will be updated. From now, all actions will be in the newly selected store.

Help!

If you get stuck at any time when using the site, click on the Docs menu item.

Docs

This will take you to the documentation page which relates to the current page you are viewing.