Module Agenda

From Dolibarr ERP CRM Wiki
Revision as of 16:30, 7 December 2016 by Bgenere (talk | contribs)
Jump to navigation Jump to search
Agenda
Numero/ID of module 2400
User doc. of module This page
Developer doc. of module Module Agenda (developer)

Introduction

The Agenda Module is a core Dolibarr module. It is optional and part of the Projects/Collaborative work group in module list.

The Agenda module is used to add a calendar into Dolibarr and manage things like events and rendez-vous.

Installation

This module is included with the Dolibarr distribution, so there is no need to install it.

Configuration

To use this module, you must first enable it using an administrator account, via the menu option "Home - Setup - Modules".

Choose the tab where the module is listed. Then click on "Activate".

The module is now activated.

If a cog icon appears Cog circle.svg on module thumb or at end of the line of the module, click on it to access the setup page specific to the module.

To know how to setup the module to export Dolibarr agenda events it into the Google agenda, see FAQ Agenda EN.

Definitions

Before to read next chapters, it is important to know the meanings of each terms « Events / Tasks / Journals ». This 3 words often misunderstood are used for different meanings, so it is important to be familiar with them as this words are now used by nearly all ERP. For this, a definition is provided into page Events-Todo-Journal.

The events (event)

In Dolibarr, we also call this events the actions. There is some automatic actions (created automatically by Dolibarr) and manual actions (created explicitly by users). This is the role of Agenda module to manage this kind of events.

Automatic events

We can setup in the Agenda module, which event we want to create automatically into the calendar. Events chosen (invoice creation, order validation...) are then created automatically into the calendar. So such events are business actions that has just been done. They are created with status realized (percentage of accomplishment = 100%). Duration of such events are in general 0 seconds (end date = start date)

Manual events and rendez-vous

You can also create yourself events from Agenda menus. So you create, modify, delete an event (named action into Dolibarr). Such events will have a start date, an end date, an accomplishment percentage, all chosen by user. This properties can also be modified later.

Life cycle / Business rules

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

Example of use case

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

UCAG01:
Situation
Actions