Difference between revisions of "Module Projects"

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search
(Extended Introduction and normalized it as for the Agenda module.)
Line 48: Line 48:
 
= Configuration =
 
= Configuration =
 
{{ActivationModuleEn}}
 
{{ActivationModuleEn}}
 +
 +
Below are the options available to configure this module.
 +
== Set-up options ==
 +
=== Projects > Parameters ===
 +
;Use projects to follow leads/opportunities:If selected you could associate the project to a third party and follow the status of the proposal. This is required to manage external project.
 +
;Use projects to follow tasks and time: You need to select this option if you want to enter the detailed tasks of the projects and eventually follow time spend (this is not mandatory even if the option is selected). If not selected the module just allow to follow business opportunities (i.e. sales projects status).
 +
=== Projects > Projects numbering module ===
 +
Projects are numbered automatically using a simple model. You could change this model and define your own number template using the universal engine.   
 +
=== Projects > Tasks numbering module ===
 +
Tasks are numbered automatically using a simple model. You could change this model and define your own number template using the universal engine. The task numbering model is independent from the project one.
 +
=== Projects > Project reports document model ===
 +
You could select a template for linked objects overview and a report template for project tasks. It is also possible to generate documents from OpenDocuments templates, a simple one is provided.
 +
=== Projects > Task reports document model ===
 +
It is possible to generate documents from OpenDocuments templates, a simple one is provided.
 +
=== Projects > Other Parameters ===
 +
;Use auto-completion fields to choose project (instead of using a list box):This could be very useful if you track a large volume of opportunities as projects.
 +
;On document of a third-party, can choose a project linked to another third-party:By default only document of the third party attached to the project could be linked to the project, however you may have a sub-contractor that will provide documents related to the project. In this case you need the option activated.
 +
 +
=== Complementary attributes (project) ===
 +
Use this tab to define extra fields that will be available in the project card.
 +
 +
=== Complementary attributes (task) ===
 +
Use this tab to define extra fields that will be available in the task card.
 +
 +
== Dictionaries ==
 +
The module comes with the the "Opportunity status for project/lead" dictionary.
 +
 +
This dictionary is used when the module is used to follow leads/opportunities. It contains the probability to sign the opportunities.
 +
 +
Go to the '''Setup''' menu and select '''Dictionaries''' to customize the list of values to qualify your opportunities.
 +
 +
The module also use the "Contact/Address types" dictionary, and populate it by default to associate a contact or a user allocated to a project or a task.
 +
 +
== Permissions ==
 +
 +
#Read projects and tasks (shared project and projects i'm contact for). Can also enter time consumed on assigned tasks (timesheet)
 +
#Create/modify projects (shared project and projects i'm contact for)
 +
#Delete projects (shared project and projects i'm contact for)
 +
#Export projects
 +
#Read all projects and tasks (also private projects i am not contact for)
 +
#Create/modify all projects and tasks (also private projects i am not contact for)
 +
#Delete all projects and tasks (also private projects i am not contact for)
 +
 +
 +
By default 1 is the default permission.
 +
 +
Go to the '''Setup''' menu and select '''Security''' if you need to add some.
  
 
= Workflow =
 
= Workflow =

Revision as of 17:52, 3 January 2017

Project
Numero/ID of module 400
User doc. of module This page
Developer doc. of module Module Projects (developer)

Introduction

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

The main purpose of the module is to manage projects defined as a hierarchy of tasks and to track time consumed by users on these tasks. Projects could be used for internal projects, done for your organisation or for projects linked to Dolibarr entities (like commercial proposals, customers orders or customers invoices).

Current documentation applies to 4.0.2 Dolibarr release.

Important notice regarding definitions

The term Tasks is often confused with terms like "Events", "Action", "Journal".

Before you read this documentation, it is important to know the meanings of each terms which have been defined and normalized by the norm RFC2445.

If you are not familiar with these, read this summary page : Events-Todo-Journal.

What this module does

  • Manage project as a hierarchy of tasks.
  • Allow to define internal projects (done for your organization).
  • Allow to define external projects (done by your organization for a client).
  • Allow to allocate internal or external users on tasks.
  • Allow to share projects across users, providing to each assigned user the proper view of tasks and projects.
  • Allow to track time spend on task per working slot and user.
  • Allow to assign any element or document (invoice, order, proposal, intervention, ...) or URL to project and tasks.
  • Provide a full view of the project with time planned and spend, Gant view and all documents.
  • Support extra fields for projects and task.
  • Provide document models for projects and tasks reports.

What this module does not

  • Does not support automated planning based on user availability.
  • Does not calculate any critical path.
  • Does not support allocating resources other than users on tasks.

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.

Below are the options available to configure this module.

Set-up options

Projects > Parameters

Use projects to follow leads/opportunities
If selected you could associate the project to a third party and follow the status of the proposal. This is required to manage external project.
Use projects to follow tasks and time
You need to select this option if you want to enter the detailed tasks of the projects and eventually follow time spend (this is not mandatory even if the option is selected). If not selected the module just allow to follow business opportunities (i.e. sales projects status).

Projects > Projects numbering module

Projects are numbered automatically using a simple model. You could change this model and define your own number template using the universal engine.

Projects > Tasks numbering module

Tasks are numbered automatically using a simple model. You could change this model and define your own number template using the universal engine. The task numbering model is independent from the project one.

Projects > Project reports document model

You could select a template for linked objects overview and a report template for project tasks. It is also possible to generate documents from OpenDocuments templates, a simple one is provided.

Projects > Task reports document model

It is possible to generate documents from OpenDocuments templates, a simple one is provided.

Projects > Other Parameters

Use auto-completion fields to choose project (instead of using a list box)
This could be very useful if you track a large volume of opportunities as projects.
On document of a third-party, can choose a project linked to another third-party
By default only document of the third party attached to the project could be linked to the project, however you may have a sub-contractor that will provide documents related to the project. In this case you need the option activated.

Complementary attributes (project)

Use this tab to define extra fields that will be available in the project card.

Complementary attributes (task)

Use this tab to define extra fields that will be available in the task card.

Dictionaries

The module comes with the the "Opportunity status for project/lead" dictionary.

This dictionary is used when the module is used to follow leads/opportunities. It contains the probability to sign the opportunities.

Go to the Setup menu and select Dictionaries to customize the list of values to qualify your opportunities.

The module also use the "Contact/Address types" dictionary, and populate it by default to associate a contact or a user allocated to a project or a task.

Permissions

  1. Read projects and tasks (shared project and projects i'm contact for). Can also enter time consumed on assigned tasks (timesheet)
  2. Create/modify projects (shared project and projects i'm contact for)
  3. Delete projects (shared project and projects i'm contact for)
  4. Export projects
  5. Read all projects and tasks (also private projects i am not contact for)
  6. Create/modify all projects and tasks (also private projects i am not contact for)
  7. Delete all projects and tasks (also private projects i am not contact for)


By default 1 is the default permission.

Go to the Setup menu and select Security if you need to add some.

Workflow

Permissions

See file File:Project.odg that describe different conditions to realize different actions of module.

Project right access.png

Create a project

Creation of a new project is done from menu "New project" on main menu "Project"

A project can be public or private. Public projects (and all tasks) can be read/edited by anybody with read project permissions. Private project (and all tasks) can be read/edited only by users defined as contact/actors of project + the creator of project (if all contacts are removed, we must keep at least one user authorized on project. This is the creator).

Create a task

Creation of a task is done from button "Create Task" on the tab "Task" of a project or from menu "Projects -> New task".

  • A task can be created on all shared projects or on a project you are a contact for.
  • A task is on the root of a project or under another task of the project.

Remove a project

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 ページは未完成の状態です。完成させるにはアカウントを作成し、ページに戻って「編集」をクリックして下さい。

Remove a task

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 ページは未完成の状態です。完成させるにはアカウントを作成し、ページに戻って「編集」をクリックして下さい。

Activity

Activities are time spent to work on tasks.

Examples of use cases

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 ページは未完成の状態です。完成させるにはアカウントを作成し、ページに戻って「編集」をクリックして下さい。

UCMP01:
Situation
Actions