General information on usage

Revision as of 23:37, 4 November 2013 by Eldy (talk | contribs) (→‎Features)

Starting the application:

To begin, launch the application, either by clicking on the icon installed on your desktop by the installation package or by typing appropriate URL in your web browser (The URL can be of the form http://localhost/dolibarr/ for local installation but can be different in the case of a manual installation, in that case it will depend on the configuration of your Web server).

After launching application, you should see the login page with at least 2 fields:

Login:

 login: the last step of the installation (eg admin)
 password: the last step of the installation (eg changeme)

 

Homepage

Once logged in, you see the home page. It contains menu bars (one horizontal bar and one vertical bar) and more informations in the center:

  • A box reminding your login account and the date of last access.
  • A box of statistics related to all activated modules.
  • A box showing 'tasks' table (table containing informations of tasks to be done and tasks behind schedule). A weather sums it up.
  • In the lower part, there may be other information boxes. The list depends upon boxes activated via the menu Home->Setup->Boxes.

Using the menus

Each menu in the horizontal bar is related to one module. When a module is activated its associated menu appears in the horizontal menu bar. The menu entry of a module does not appear in the menus until the module has been activated. To activate a module, see page First_setup.

To use a module, click the menu associated with the module, a menu appears in the vertical bar to perform various tasks related to that module.

For example, to list the products in stock (function provided by the Products and Stock modules, click on the menu / Products.

 

On the left you have the menu to perform various tasks related to the activated module Products and Stocks.

 

Note that the organization of the menus depends on the choice of menu manager configured in Home->Setup->Menus.

Objects

Dolibarr policy is to use a common way of working for each managed modules or objects. So, for each object, you will find a menu entry to Create (menu will be called "New Object") and a menu entry to list all objects (menu will be called "List"). Then when clicking on an object found into a list, you can read all properties of an object dispatched into several tabs. A button "Modify" is visible by allowed user to edit object.

For example, this is a view of left menu to manage third-parties and card of a selected third-party:

  Page waiting to complete. To complete, create an account, go back and clic on "Modify".
  Page en attente d'être complété. Pour compléter, créez un compte, revenez et cliquez sur "Modifier".
  Página a completar. Para completarla, cree una cuenta, vuelva a la página y haga clic en "editar"
  Seite wartet auf Vervollständigung. Um zu helfen, erstelle ein Konto, gehe zurück und klicke auf "Bearbeiten".
  待完成,欲帮助完成,注册帐号,点击“编辑"
  ページは未完成の状態です。完成させるにはアカウントを作成し、ページに戻って「編集」をクリックして下さい。

Add screenshot of third-party

Also, each object may have different status to define where object is in workflow. Status of object is always visible into last column of list of object. Number of status will depends on object and options defined into setup of module dedicated to object management. Current definition of status are used:

  •   Draft - Status when object is not yet validated.
  •   Validated - Some actions are expected for object (that's why color is yellow).
  •   Name of status will varies according to object. It is a more advanced status than Validated, but object still need action to do on it (that's why color is artially yellow)
  •   Processed - No more action are expected for object.
  •   Canceled - No more action are expected on object.
  •   Error - There is a problem. This status means there is a critical problem to fix on object.

Features

Each feature is provided by a module. All modules are documented in the module documentation. For a complete list of modules and their documentation, see the following pages: