Dolibarr ERP CRM Wiki - User contributions [en]

Module Lot / Serial

2019-11-24T13:33:56Z

Bgenere: /* Introduction */ Orthography

[[fr:Module_ProductBatch_FR]]


[[Category:Stock]][[Category:Product]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Module ProductBatch|
num=39000|
devdoc=[[Module ProductBatch (developer)]]|
userdoc=This page|}}

= Introduction =
ProductBatch module allow user to manage the following fields:
* Serial number
* Sell-by date = Shelf life expiration date = Use by (foods must be removed from store after this date)
* Eat-by date = Best Before date = Best if Used By = Best by (eat-by-date is often > sell-by-date)
This module extends [[Module Stocks En]].

= Installation =
{{NoInstallModuleEn}}

= Configuration =
{{ActivationModuleEn}}

There is no setup for this module but you will need at least to configure decreasing / increasing option in stock module for good operation.
* Stock decrease : on shipment validation
* Stock increase : on manual dispatch

= Examples of use cases =
{{ToComplete}}
{{ExamplesCaseEn
|name=UCMS01:
|situation=
|actions=
}}

Module Comptabilité en Partie Double

2019-04-17T08:51:37Z

Bgenere: /* Configuration */

[[Category:Compta]]
{{TemplateDocUtil}}
{{TemplateModFR}}
{{BasculeDevUser|
nom=Comptabilité Avancée|
num=50400|
devdoc=[[Module Comptabilité Avancée (développeur)]]|
userdoc=Cette page|}}

= Introduction =
Ce module offre des fonctions comptables plus évolués que le module comptabilité et permet de générer des écritures comptables.

= Installation =
{{NoInstallModuleFr}}

= Configuration =
{{ActivationModuleFr}}

= Cycle de vie / Règles de gestion =

L'utilisation du module de comptabilité se fait en plusieurs étapes:

Les actions suivantes sont habituellement exécutées une seule fois, ou une fois par an ...

Etape 1: Créer un modèle de plan de compte depuis le menu Compta/Tréso-Comptabilité-Configuration-Modèle de plan de compte

Etape 2: Créer ou vérifier le contenu de votre plan de compte depuis le menu Compta/Tréso-Comptabilité-Configuration-Plan comptable

Les prochaines étapes doivent être faites pour vous faire gagner du temps à l'avenir en vous proposant le bon compte comptable par défaut lors de la journalisation (écrire des enregistrements dans les journaux et Grand Livre)

Etape 3: Vérifier que la liaison par défaut entre les lignes de transactions diverses et le compte comptable est faite. Compléter les liaisons manquantes. Pour cela, vous pouvez utiliser l'entrée de menu Compta/Tréso-Comptabilité-Configuration-Comptes par défaut.

Etape 4: Vérifiez que la liaison entre le paiement de la TVA et le compte comptable est faite. Compléter les liaisons manquantes. Vous pouvez définir les comptes comptables à utiliser pour chaque taux de TVA sur la page Compta/Tréso-Comptabilité-Configuration-Compte TVA.

Etape 5: Vérifier que la liaison entre les dépenses spéciales (cotisations sociales ou fiscales) et le compte comptable est faite. Compléter les liaisons manquantes. Pour cela, vous pouvez utiliser l'entrée de menu Compta/Tréso-Comptabilité-Configuration-Comptes charges.

Etape 6: Vérifiez que la liaison entre le type de notes de frais et le compte comptable est faite. Compléter les liaisons manquantes. Vous pouvez définir les comptes comptables à utiliser pour chaque type de ligne de note de frais sur la page Compta/Tréso-Comptabilité-Configuration-Comptes notes de frais.

Etape 7: Vérifier que la liaison entre les paiements de prêts et les comptes comptables est faite. Compléter les liaisons manquantes. Pour cela, vous pouvez utiliser l'entrée de menu Compta/Tréso-Dépenses spéciales-Emprunts ou Compta/Tréso-Comptabilité-Configuration-Comptes par défaut.

Etape 8: Vérifier que la liaison entre les comptes bancaires et le compte comptable est faite. Compléter les liaisons manquantes. Pour cela, rendez-vous sur la fiche de chaque compte financier. Vous pouvez commencer à partir de la page Accueil-Banques/Caisses.

Etape 9: Vérifier que la liaison entre les produits/services et le compte comptable est faite. Compléter les liaisons manquantes. Pour cela, vous pouvez utiliser l'entrée de menu Compta/Tréso-Comptabilité-Configuration-Comptes produits.

Les actions suivantes sont habituellement exécutées chaque mois, semaine, ou jour pour les très grandes entreprises ...

Etape 1: Vérifier que la liaison entre les lignes de factures client existantes et le compte comptable est faite. Compléter les liaisons manquantes. Pour cela, vous pouvez utiliser l'entrée de menu Compta/Tréso-Comptabilité-Liaison factures client.

Etape 2: Vérifier que la liaison entre les lignes de factures fournisseurs existantes et le compte comptable est faite. Compléter les liaisons manquantes. Pour cela, vous pouvez utiliser l'entrée de menu Compta/Tréso-Comptabilité-Liaison factures fournisseur.

Etape 3: Vérifiez que la liaison entre le type de notes de frais et le compte comptable est faite. Compléter les liaisons manquantes. Vous pouvez définir les comptes comptables à utiliser pour chaque type de ligne de note de frais sur la page Compta/Tréso-Comptabilité-Liaison notes de frais.

Etape 4: Ecrire les transactions dans le Grand Livre. Pour cela, aller sur chaque Journal, et cliquer sur le bouton "Enregistrer les opérations dans le Grand Livre".

Etape 5: Ajouter ou modifier les opérations existantes et générer des rapports et des exportations.

= Plan comptable =

= Exports =

Voici un exemple des formats d'export disponibles. L'expert se fait depuis le grand livre:

{{AccountingExpertExportExamples}}

Module Comptabilité en Partie Double

2019-04-17T08:51:15Z

Bgenere: /* Installation */

[[Category:Compta]]
{{TemplateDocUtil}}
{{TemplateModFR}}
{{BasculeDevUser|
nom=Comptabilité Avancée|
num=50400|
devdoc=[[Module Comptabilité Avancée (développeur)]]|
userdoc=Cette page|}}

= Introduction =
Ce module offre des fonctions comptables plus évolués que le module comptabilité et permet de générer des écritures comptables.

= Installation =
{{NoInstallModuleFr}}

= Configuration =
Ce module ayant un statut développement, celui ci n'est accessible qu'en mettant la valeur "2" à la constante MAIN_FEATURES_LEVEL disponible dans Configuration => Divers
{{ActivationModuleFr}}

= Cycle de vie / Règles de gestion =

L'utilisation du module de comptabilité se fait en plusieurs étapes:

Les actions suivantes sont habituellement exécutées une seule fois, ou une fois par an ...

Etape 1: Créer un modèle de plan de compte depuis le menu Compta/Tréso-Comptabilité-Configuration-Modèle de plan de compte

Etape 2: Créer ou vérifier le contenu de votre plan de compte depuis le menu Compta/Tréso-Comptabilité-Configuration-Plan comptable

Les prochaines étapes doivent être faites pour vous faire gagner du temps à l'avenir en vous proposant le bon compte comptable par défaut lors de la journalisation (écrire des enregistrements dans les journaux et Grand Livre)

Etape 3: Vérifier que la liaison par défaut entre les lignes de transactions diverses et le compte comptable est faite. Compléter les liaisons manquantes. Pour cela, vous pouvez utiliser l'entrée de menu Compta/Tréso-Comptabilité-Configuration-Comptes par défaut.

Etape 4: Vérifiez que la liaison entre le paiement de la TVA et le compte comptable est faite. Compléter les liaisons manquantes. Vous pouvez définir les comptes comptables à utiliser pour chaque taux de TVA sur la page Compta/Tréso-Comptabilité-Configuration-Compte TVA.

Etape 5: Vérifier que la liaison entre les dépenses spéciales (cotisations sociales ou fiscales) et le compte comptable est faite. Compléter les liaisons manquantes. Pour cela, vous pouvez utiliser l'entrée de menu Compta/Tréso-Comptabilité-Configuration-Comptes charges.

Etape 6: Vérifiez que la liaison entre le type de notes de frais et le compte comptable est faite. Compléter les liaisons manquantes. Vous pouvez définir les comptes comptables à utiliser pour chaque type de ligne de note de frais sur la page Compta/Tréso-Comptabilité-Configuration-Comptes notes de frais.

Etape 7: Vérifier que la liaison entre les paiements de prêts et les comptes comptables est faite. Compléter les liaisons manquantes. Pour cela, vous pouvez utiliser l'entrée de menu Compta/Tréso-Dépenses spéciales-Emprunts ou Compta/Tréso-Comptabilité-Configuration-Comptes par défaut.

Etape 8: Vérifier que la liaison entre les comptes bancaires et le compte comptable est faite. Compléter les liaisons manquantes. Pour cela, rendez-vous sur la fiche de chaque compte financier. Vous pouvez commencer à partir de la page Accueil-Banques/Caisses.

Etape 9: Vérifier que la liaison entre les produits/services et le compte comptable est faite. Compléter les liaisons manquantes. Pour cela, vous pouvez utiliser l'entrée de menu Compta/Tréso-Comptabilité-Configuration-Comptes produits.

Les actions suivantes sont habituellement exécutées chaque mois, semaine, ou jour pour les très grandes entreprises ...

Etape 1: Vérifier que la liaison entre les lignes de factures client existantes et le compte comptable est faite. Compléter les liaisons manquantes. Pour cela, vous pouvez utiliser l'entrée de menu Compta/Tréso-Comptabilité-Liaison factures client.

Etape 2: Vérifier que la liaison entre les lignes de factures fournisseurs existantes et le compte comptable est faite. Compléter les liaisons manquantes. Pour cela, vous pouvez utiliser l'entrée de menu Compta/Tréso-Comptabilité-Liaison factures fournisseur.

Etape 3: Vérifiez que la liaison entre le type de notes de frais et le compte comptable est faite. Compléter les liaisons manquantes. Vous pouvez définir les comptes comptables à utiliser pour chaque type de ligne de note de frais sur la page Compta/Tréso-Comptabilité-Liaison notes de frais.

Etape 4: Ecrire les transactions dans le Grand Livre. Pour cela, aller sur chaque Journal, et cliquer sur le bouton "Enregistrer les opérations dans le Grand Livre".

Etape 5: Ajouter ou modifier les opérations existantes et générer des rapports et des exportations.

= Plan comptable =

= Exports =

Voici un exemple des formats d'export disponibles. L'expert se fait depuis le grand livre:

{{AccountingExpertExportExamples}}

Documentation utilisateur

2019-04-17T07:26:36Z

Bgenere: /* Utilisation (modules) */ orthographe

<keywords content="utilisateur, documentation, guide, doc, tutorial, utilisation, aide" />
Cette page est l'index des articles en rapport avec la documentation utilisateur.
Pour la documentation développeur, [[Documentation Développeur|voir ici]].

= Dolibarr et ses modules =

== Fonctionnalités ==
* [[Ce que fait Dolibarr]]
* [[Ce que ne fait pas Dolibarr]]

== Installation/Démarrage/Mise à jour ==
* [[Prérequis]]
* [[Installation / Mise a jour]]
* [[Premiers paramétrages|Configuration / Paramétrage]]
La documentation sur l'utilisation de Dolibarr est décrite dans le chapitres suivants.

== Administrations/Imports/Exports ==
* [[Imports_de_masse|Imports de mes données]] / [[Exports]]
* [[Sauvegardes]] / [[Restaurations]]

== Utilisation (modules) ==
Les '''fonctionnalités''' de Dolibarr sont réparties en '''modules'''. Savoir utiliser Dolibarr, c'est connaitre les menus et fonctions des modules qui ont été activés.

Les modules dit "standards" sont ceux disponibles avec la version de base.

Les modules dit "externes" sont des modules non inclus en standard dans Dolibarr. Ils peuvent être téléchargés via de nombreux moyens différents dont le téléchargement depuis la place de marché des modules externe comme https://www.dolistore.com

Mais voyons dans un premier temps les concepts généraux:
* [[Utilisation générale de Dolibarr|Utilisation générale de Dolibarr]]

Une fois la maitrise générale acquise, il convient d'apprendre à utiliser un module en particulier. Pour cela, se référer à la documentation de ce module:
* La liste des modules standards est définie sur la page [[:Category:Liste des Modules|Liste des Modules]]
* La liste des modules externes complémentaires est définie sur la page [[:Category:Modules_complémentaires|Modules complémentaires]]

= Autres sources de documentation =
* Guide d'utilisation (Dolibarr the Book 7.0) [https://www.dolistore.com/fr/documentation/959-Dolibarr-The-Book-7-0--version-fran--aise-.html]
* Le livre Dolibarr [http://www.d-booker.fr/213-dolibarr]
* [http://doc.ubuntu-fr.org/dolibarr#dolibarr Ubuntu doc]

= Glossaire =
Voir la page [[Glossaire]]

= FAQ =
Toutes les FAQ (Foires Aux Questions) sont disponibles via la page d'index [[:Category:FAQ FR|FAQ FR]]

Table llx subscription

2018-10-02T09:04:44Z

Bgenere: /* Table */ changed cotisation to subscription

[[Category:Table SQL]]
[[Category:Foundations]]
[[Category:Adhérent]]
[[Category:Miembros]]

{{ListOfTables}}

= Content/Contenu/Contenido =
{{flag en}} Contains the afiliations of members of the association module. In version 7.xx of dolibarr, the table is now called llx_subscription

{{flag fr}} Contient les cotisations des adhérents du module association. Dans la version 7.xx de dolibarr, la table s'appelle désormais llx_subscription

{{flag sp}} Contiene las cotizaciones de los miembros del módulo miembros. En la versión 7.xx de dolibarr, la tabla se llama ahora llx_subscription

= Structure =
== Table ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| Field
|style="background-color: #e9e9ef"| Type
|style="background-color: #e9e9ef"| Null
|style="background-color: #e9e9ef"| Key
|style="background-color: #e9e9ef"| Default
|style="background-color: #e9e9ef"| Extra
|style="background-color: #e9e9ef"| Description
|-
| rowid
| int(11)
| NO
| PRI
|
| auto_increment
| technical index
{{FieldTms}}
|-
| datec
| datetime
| YES
|
| NULL
|
| date of creation
|-
| fk_adherent
| int(11)
| YES
| UNI
| NULL
|
| ID of member ([[Table llx_adherent|llx_adherent]]->rowid)
|-
| dateadh
| datetime
| YES
| UNI
| NULL
|
| date of affiliation
|-
| datef
| date
| YES
|
| NULL
|
| date of end affiliation
|-
| subscription
| double
| YES
|
| NULL
|
| amount of affiliation
|-
| fk_bank
| int(11)
| YES
|
| NULL
|
| ID of bank to pay ([[Table llx_bank_account|llx_bank_account]]->rowid)
|-
| note
| text
| YES
|
| NULL
|
| notes
|} 

== Keys ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| Key
|style="background-color: #e9e9ef"| Type
|style="background-color: #e9e9ef"| Fields
|-
| PRIMARY
| PRIMARY
| rowid
|-
| uk_cotisation
| UNIQUE
| fk_adherent,dateadh
|}

Table llx cotisation

2018-10-02T09:02:40Z

Bgenere: moved Table llx cotisation to Table llx subscription: table has been renamed some time ago and does not exists in v7.

#REDIRECT [[Table llx subscription]]

Table llx subscription

2018-10-02T09:02:40Z

Bgenere: moved Table llx cotisation to Table llx subscription: table has been renamed some time ago and does not exists in v7.

[[Category:Table SQL]]
[[Category:Foundations]]
[[Category:Adhérent]]
[[Category:Miembros]]

{{ListOfTables}}

= Content/Contenu/Contenido =
{{flag en}} Contains the afiliations of members of the association module. In version 7.xx of dolibarr, the table is now called llx_subscription

{{flag fr}} Contient les cotisations des adhérents du module association. Dans la version 7.xx de dolibarr, la table s'appelle désormais llx_subscription

{{flag sp}} Contiene las cotizaciones de los miembros del módulo miembros. En la versión 7.xx de dolibarr, la tabla se llama ahora llx_subscription

= Structure =
== Table ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| Field
|style="background-color: #e9e9ef"| Type
|style="background-color: #e9e9ef"| Null
|style="background-color: #e9e9ef"| Key
|style="background-color: #e9e9ef"| Default
|style="background-color: #e9e9ef"| Extra
|style="background-color: #e9e9ef"| Description
|-
| rowid
| int(11)
| NO
| PRI
|
| auto_increment
| technical index
{{FieldTms}}
|-
| datec
| datetime
| YES
|
| NULL
|
| date of creation
|-
| fk_adherent
| int(11)
| YES
| UNI
| NULL
|
| ID of member ([[Table llx_adherent|llx_adherent]]->rowid)
|-
| dateadh
| datetime
| YES
| UNI
| NULL
|
| date of afiliation
|-
| datef
| date
| YES
|
| NULL
|
| date of end afiliation
|-
| cotisation
| double
| YES
|
| NULL
|
| amount of afiliation
|-
| fk_bank
| int(11)
| YES
|
| NULL
|
| ID of bank to pay ([[Table llx_bank_account|llx_bank_account]]->rowid)
|-
| note
| text
| YES
|
| NULL
|
| notes
|} 

== Keys ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| Key
|style="background-color: #e9e9ef"| Type
|style="background-color: #e9e9ef"| Fields
|-
| PRIMARY
| PRIMARY
| rowid
|-
| uk_cotisation
| UNIQUE
| fk_adherent,dateadh
|}

Table llx ecm documents

2018-07-10T09:20:21Z

Bgenere: moved Table llx ecm documents to Table llx ecm files: Table llx_ecm_documents has been renamed

#REDIRECT [[Table llx ecm files]]

Table llx ecm files

2018-07-10T09:20:21Z

Bgenere: moved Table llx ecm documents to Table llx ecm files: Table llx_ecm_documents has been renamed

[[Category:Table SQL]]
{{ListOfTables}}

= Content/Contenu/Contenido =
{{flag en}} contains the list of the documents of Electronic Content Management. The directories are in the [[Table llx ecm directories]]

{{flag fr}} contient la liste des documents du Gestion Electronique de Documents. Les répertoires sont a la [[Table llx ecm directories]]

{{flag sp}} Contiene la lista de los documentos de la Gestión Electrónica de Documentos. Los directorios se encuentran en [[Table llx ecm directories]]

= Structure =
== Table ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| Field
|style="background-color: #e9e9ef"| Type
|style="background-color: #e9e9ef"| Null
|style="background-color: #e9e9ef"| Key
|style="background-color: #e9e9ef"| Default
|style="background-color: #e9e9ef"| Extra
|style="background-color: #e9e9ef"| Description
|-
| rowid
| int(11)
| NO
| PRI
|
| auto_increment
| technical index
|-
| ref
| varchar(16)
| NO
|
|
|
| ref. of document
|-
| entity
| int(11)
| NO
|
| 1
|
| multi company id
|-
| filename
| varchar(255)
| NO
|
|
|
| file name of document
|-
| filesize
| int(11)
| NO
|
|
|
| file size of document
|-
| filenime
| varchar(32)
| NO
|
|
|
| file nime of document
|-
| fullpath_dol
| varchar(255)
| NO
|
|
|
| dolibarr path of file
|-
| fullpath_orig
| varchar(255)
| NO
|
|
|
| orig. path of file
|-
| description
| text
| YES
|
| NULL
|
| description about document
|-
| manualkeyword
| text
| YES
|
| NULL
|
| keyword for document
|-
| fk_create
| int(11)
| NO
|
|
|
| ID of creator user ([[Table llx_user|llx_user]]->rowid)
|-
| fk_update
| int(11)
| YES
|
| NULL
|
| ID of last updater user ([[Table llx_user|llx_user]]->rowid)
|-
| date_c
| datetime
| NO
|
|
|
| creation date
|-
| date_u
| timestamp
| NO
|
| CURRENT_TIMESTAMP
|
| last update date
|-
| fk_directory
| int(11)
| YES
|
| NULL
|
| ID of related directory ([[Table llx ecm directories|llx ecm directories]]->rowid)
|-
| fk_status
| smallint(6)
| YES
|
| 0
|
| ID of status
|-
| private
| smallint(6)
| YES
|
| 0
|
| is the document private to user (0=no,1=yes)?
|-
| crc
| varchar(32)
| NO
|
|
|
| checksum
|-
| cryptkey
| varchar(50)
| NO
|
|
|
| crypt key
|-
| cipher
| varchar(50)
| NO
|
| twofish
|
| crypt cipher
|} 

== Keys ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| Key
|style="background-color: #e9e9ef"| Type
|style="background-color: #e9e9ef"| Fields
|-
| PRIMARY
| PRIMARY
| rowid
|}

Module Factures Clients

2018-07-10T08:57:09Z

Bgenere: /* Création de facture */ suppression de la mention concernant la non existence d'une comptabilité

{{TemplateDocUtil}}
{{TemplateModFR}}
[[Category:Facture]]
{{BasculeDevUser|
nom=Factures|
num=30|
devdoc=[[Module Factures Clients (développeur)]]|
userdoc=Cette page|}}

= Introduction =
Le module Factures Clients permet de saisir, modifier ou créer une facture composée de lignes de factures.
C'est également ce module qui permet de saisir les paiements réalisés sur une facture.
Il inclut également les fonctions de génération d'une facture dans un format de document comme un PDF.

Les factures fournisseurs sont gérées par le [[Module Fournisseurs Factures]].

= Installation =
{{NoInstallModuleFr}}

= Configuration =
{{ActivationModuleFr}}

La page [[Configuration module facture]] vous explique comment configurer le module Facturation et donne quelques exemples de modèles de factures.

= Création de facture =

Dolibarr vous permet d'établir des factures aux clients que vous avez préalablement saisis (voir [[Module Tiers]]).

Vous pouvez créer une facture directement à partir d'une fiche client, depuis une proposition commerciale classée acceptée, ou à partir d'une commande clôturée à l'état "accepté", ou encore depuis un contrat de service.

'''Types de factures'''

Si vous créez une facture depuis une fiche client, vous pouvez choisir 4 types de factures:

* Les factures de "doit"
Il s'agit d'une facture standard.
Il n'y a aucun prérequis.

* Les factures de "doit" de remplacement
Une facture de remplacement permet de refaire une facture sur laquelle il y aurait des erreurs et sur laquelle rien n'aurait été fait (aucun paiement saisi).

On ne peut créer qu'une seule facture de remplacement pour une facture de "doit" donnée. Quand on créé une facture de remplacement R, on choisit la facture de doit F qui doit être remplacée. Il n'est alors plus possible de faire d'actions sur la facture F, bien que cette dernière ne change pas de statut après que la facture de remplacement R ait été créée au statut '''brouillon'''.

Si la facture de remplacement R est supprimée, la facture F reprends son état initial et le cycle de vie de la facture F peut reprendre.

Si la facture de remplacement R est '''validée''', la facture F passe alors au statut '''abandonnée''' automatiquement. Le cycle de vie continue sur la facture R.

* Les factures d'avoir
On crée une facture d'avoir sur une facture de "doit".
On peut créer plusieurs factures d'avoir sur une facture donnée. La facture d'avoir est transformée en réduction qui sert à réduire le paiement de n'importe quelle autre facture en attente de paiement.

* Les factures d'acomptes
Vous pouvez créer autant de facture d'acompte que désiré. Une facture d'acompte sera ensuite convertie en réduction (déjà payé) pour une autre facture (la facture définitive) sur laquelle porte l'acompte.

'''Procédure'''

Une fois une facture créée (en mode ''brouillon''), vous devez intégrer, dans la facture, des Produits ou Services déjà définis dans Dolibarr ou bien dont vous saisissez directement l'intitulé, le taux de TVA, le prix unitaire.
Pour chaque ligne de la facture vous définissez aussi une quantité et éventuellement une remise (pourcentage).

Une fois la facture prête vous devez la valider. Quand vous validez la facture un numéro lui est attribué selon le modèle de numérotation que vous avez choisi dans la configuration du module Facture.
Si une erreur est détectée après avoir validé la facture, vous pouvez modifier la facture en cliquant sur le bouton '''modifier''' en bas de la fiche facture ( si la facture n'a pas atteint le status Payé), ou ré-ouvrir le facture pour la modification avec le bouton '''réouvrir''' en bas de la fiche facture( si la facture a atteint le statut Payé).

'''Règles de calcul de la TVA'''

* Les règles de calculs de la TVA sont expliquées sur la page: [[Règles de calcul et arrondi de TVA]].

'''Timbre fiscal'''

* Certains pays (comme la tunisie) sont soumis à un timbre fiscal (montant d'une taxe fixe pour chaque facture produite). La liste des pays et montants concernés se paramètre dans la [[Table_llx_c_revenuestamp]]. Si le pays de la société fait partie de cette configuration, alors un champ "Timbre fiscal" apparait sur les écrans et documents de facture.

= Réduire le montant total et/ou le solde à payer =
Il est possible de réduire le montant total et/ou le solde à payer d'une facture, mais il convient de faire une distinction entre une remise et une réduction, bien que ces deux termes soient un peu amalgamés par endroits.
== Réduction ==
Une '''réduction''' est une réduction relative (pourcentage) du prix de vente d'un ou de plusieurs produits ou services détaillés dans la facture. Cette réduction doit être définie ligne par ligne lors de l'édition de la facture et être comprise entre 0% et 100% (NB : le pourcentage de remise est remplacé dans le cas 100% de réduction par la mention ''offert'').

== Remise ==
Une '''remise''' est une réduction du prix total de la facture. Elle peut être définie de deux manières selon qu'elle est ou non associée à une autre facture, c'est-à-dire à un versement déjà perçus ou non.
=== Remise associée à un trop perçu ===
Les factures d'avoir et factures d'acompte, qui sont saisies pour tracer des versements perçus (en trop pour la facture avoir ou en avance pour l'acompte), peuvent être ''converties en réduction future''. Après conversion en réduction, elles apparaissent dans la section ''Remises fixes'' du tiers. Il sera alors possible de l'attribuer à une autre facture pour en réduire le montant.

Le trop-perçu, lié au règlement d'une facture supérieur au montant de la facture, apparaît également dans les remises.

Lorsque le montant de la remise est supérieur à celui de la facture à régler, depuis la liste des remises, on sépare la remise en deux (bouton à droite de la ligne) avec un premier montant correspondant à la facture, puis le solde. On peut alors utiliser une partie de cette remise pour l'appliquer au règlement de la facture qui peut alors être classer "Réglée".

Dans le cas de l'utilisation d'une remise dans une nouvelle facture, elle sera mentionnée soit sous forme de paiement réduisant le reste à payer, soit sous forme d'une ligne de détail de la facture.
Par défaut, il s'agit d'une ligne de détail ajouté à la facture et donc réduisant le montant total de cette nouvelle facture.

Rem: L'option cachée FACTURE_DEPOSITS_ARE_JUST_PAYMENTS permet d'avoir cette déduction qui apparaît comme montant déjà payé et non comme diminution du montant total de la facture finale. Dans ce cas, les factures acomptes ne sont pas incluses dans les calculs de chiffre d'affaires (puisqu'inclut dans le montant total de la facture finale). Le bon choix de cette option dépendra des règles comptable de votre pays, mais les 2 sont en général acceptés.

=== Remise non associée à un versement déjà perçu ===
Il est aussi possible de définir une remise qui n'est pas relative à un versement déjà perçu. Dans ce cas, il faut aller sur la fiche du client, onglet ''client'', et définir la ou les remises fixes (montant) ou relatives (pourcentage) qu'on attribue à ce client, et pourquoi (geste commercial, compensation suite à retard de livraison, etc). Une fois ces remises attribuées au client, elles seront disponibles lors de l'édition de n'importe quelle facture de ce client, dans la rubrique '''Remises''' en haut de page. A l'inverse des remises consécutives à des versements déjà perçus, celles-ci seront mentionnées comme des lignes négatives dans le détail de la facture, et réduiront donc le montant total de celle-ci, avant déduction des versements éventuellement déjà perçus. Mais ces remises ne sont PAS associées à une facture avoir ou d'acompte.

== Rabais ==
A compléter

== Escompte ==
A compléter

== Résumé ==
Il y a donc 3 possibilités pour réduire le prix d'une facture :
* attribuer une '''réduction''' en pourcentage sur certains produits/service détaillés dans la facture, ce qui aura pour effet de définir un '''montant total''' plus bas que normalement prévu;
* attribuer au client une '''remise globale''', non associée à une facture avoir ou d'acompte, et qui sera alors ajoutée comme une ligne de montant négatif qui réduira le '''montant total''' de la facture;
* mentionner, via des '''factures avoir ou d'acompte''' transformées en réduction future, que des versements anticipés ont déjà été perçus, ce qui réduira le '''solde à payer''' mais pas le montant total de la facture;

= Génération PDF, Impression, Envoi =
Lorsqu'un document est généré, il est fabriqué suivant un modèle choisi parmi une liste activée dans les écrans Accueil - Configuration - Modules - Facture

Pour que le document intègre le numéro de compte bancaire de votre société ou l'adresse de paiement par chèque (ou les 2), il convient de :
# activer le module Banques/Caisses
# Créer le compte de votre société
# Paramétrer le module Factures et Avoirs en allant dans '''Configuration - Modules - Factures et Avoirs''' puis cliquer sur l’icône configuration, choisir dans la rubrique "Mode de règlement" le compte créé à l'étape 2 ci-dessus, où l'adresse à utiliser pour le paiement par chèque, et valider le changement en cliquant sur le bouton "Modifier" de la rubrique.
Vous pouvez maintenant régénérer votre facture, et vous verrez, pour le modèle crabe, le RIB ou les coordonnées s'afficher sous les conditions de paiement.

Si vous avez activé l'envoi par e-mail, un bouton spécifique "Envoyer par email" est disponible. Il fait apparaître en bas de la fenêtre un formulaire d'envoi, avec la facture en pièce jointe. Vous pouvez également définir un modèle de rappel pour les factures impayées.

Dans le cas d'une ligne provenant d'un produit ou d'un service enregistré, la référence, le libellé et la description sont affichés par défaut. Si vous souhaitez masquer la référence ou la description, vous pouvez le faire en passant par '''Accueil - Configuration - PDF'''.

Vous avez deux options que vous pouvez modifier :
* Cacher la description des produits sur les PDF générés
* Cacher la référence des produits sur les PDF générés

Ce paramétrage s'applique aussi aux propositions commerciales et aux commandes
==Impression en nombre==
Si vous souhaitez imprimer plusieurs factures en une seule fois, vous pouvez générer un document PDF rassemblant les documents à imprimer, puis ouvrir et imprimer ce document.

Pour cela, à partir de '''Facturation|Paiement - Factures clients - Liste''',
* appliquer un filtre qui vous convient pour faire apparaître toutes les factures à imprimer ensemble,
* cocher globalement (case à cocher en haut de colonne à droite) ou individuellement les documents souhaités,
* '''-- Sélectionner l'action-- - Fusion PDF''' dans la liste déroulante qui apparaît à partir de la coche d'au moins une case, et
* appuyer sur '''Confirmer'''.
Un lien vers un document PDF est ajouté dans une liste qui se trouve sous le tableau (appuyer sur '''Afficher la liste des fichiers générés en masse''' si nécessaire).

= Saisir les paiements =
Les paiements ne peuvent s'effectuer que sur des factures validées.

Si un avoir est disponible, il pourra être imputé sur une facture d'un montant total inférieur à celui de l'avoir.

Après la saisie du paiement, il est possible de régénérer le PDF de la facture pour y faire apparaître le règlement effectué et le solde à payer.

= Clore une facture =

Une facture validée peut être définitivement classée à l'état:
* Payé (Si la somme des paiements est supérieure ou égale au montant réclamé).
* Payé partiellement (Si la somme des paiements est supérieure à 0 mais strictement inférieure au montant réclamé).
* Abandonné (Si aucun paiement n'a eu lieu).

= Exporter les factures =

Dolibarr fournit un outil générique vous permettant d'exporter les données de vos factures.
Pour cela, il faut utiliser l'assistant Export qui se trouve dans le menu '''Outils - Nouvel export''' (Si le [[Module Exports]] a été activé).

Voir la page [[Module Exports]] pour plus d'informations.

= Factures pré-définies =
Dans Dolibarr, une facture désignée comme pré-définie est simplement une facture dont on réutilise la plupart des données pour émettre d'autres factures sur base de ces informations, ce qui permet un gain de temps non-négligeable à la saisie

Dans le cas de la mise en oeuvre des contrats, une facture prédéfinies peut être définie et correspondant aux éléments récurrents du contrat. Ceci est très intéressant.
Le seul bémol, la période indiquée pour chaque élément de la facture résultante couvre toute la période du contrat. Elle ne devrait porter que sur le mois de facturation.

= Exemples de cas d'utilisations =
== Acomptes ==
{{ExamplesCaseFr
|nom=UCIN01: Réception acompte de 10 pour une commande de 100 puis facture finale
|situation=Réception acompte à commande puis facture finale
|actions=Je reçois un règlement d'acompte de mon client.
Je crée '''de zéro''' pour ce client une '''facture d'acompte''' du montant effectivement '''reçu''' de 10 avec, par exemple, le libellé "''Acompte sur prestation/produit/facture/commande/... n° XXXX''".

Je '''convertis''' ensuite cette facture en '''réduction future'''.

La facture de doit, complète, éventuellement créée à partir de la proposition ou de la commande précédente, peut avoir été générée avant ou après, cela est indépendant.

Dans cette facture de doit, j'inclus la réduction de l'acompte, ce qui réduit le reste à payer. La facture de doit se retrouve à un total de 90.

Rem: si l'option cachée FACTURE_DEPOSITS_ARE_JUST_PAYMENTS est définie, elle vaudra 100 mais dans ce cas, les factures acomptes ne seront pas incluses dans le calcul des chiffres d'affaire.

J'envoie ou réenvoie la facture de doit générée qui indique qu'un (ou plusieurs) acompte a déjà été reçu.
}} 

== Facturation et paiements ==
{{ExamplesCaseFr
|nom=UCIN02: Facturation et paiement intégral'''
|situation=Je crée une facture.
Je reçois l'intégralité des paiements.
|actions=Je saisis tous les paiement sur la facture. Le solde devient à 0.
Je peux classer la facture à '''Payée'''.
}}

{{ExamplesCaseFr
|nom=UCIN03: Facturation et paiement supérieur reçu
|situation=Je crée une facture.
Je reçois un paiement supérieur au montant réclamé.
|actions=Je saisis le montant reçu.
Je clos la facture à l'état '''Payé'''.
Je crée un avoir du trop perçu.
Rem: L'action reste à étudier car ne semble pas ok: Voir http://www.dolibarr.fr/forum/12-howto--aide/35761-trop-percu/post?do=reply avec proposition de solution.
}}

{{ExamplesCaseFr
|nom=UCIN04: Facturation et paiement intégral puis produit retourné
|situation=Je crée une facture.
Je reçois l'intégralité des paiements. Je les saisis et le solde devient 0.
Je clos la facture à l'état '''Payé'''.
Plus tard, je reçois un retour de produit suite à rétractation légale.
|actions=Je saisis un avoir sur cette facture.
Cet avoir peut etre converti en réduction pour la prochaine facture ou remboursé en monétaire.
}}

{{ExamplesCaseFr
|nom=UCIN05: Facturation et paiement intégral puis erreur détecté sur la ligne produit'''
|situation=Je crée une facture.
Je reçois l'intégralité des paiements. Je les saisis et le solde devient 0.
Je clos la facture à l'état '''Payé'''.
Plus tard, je découvre une erreur de produit.
|actions=Je saisis un avoir sur cette facture qui contient le produit en erreur.
Je convertis cet avoir en réduction.
Je crée une nouvelle facture avec le bon produit. J'intègre l'avoir dans cette nouvelle facture.
Eventuellement si j'utilise le module stock, je corrige le stock en manuel.
}}

{{ExamplesCaseFr
|nom=UCIN06: Facturation et paiement partiel car anticipé (escompte)
|situation=Je crée une facture.
Je reçois un paiement du montant de la facture moins un escompte accordé pour paiement anticipé.
|actions=Je saisis le paiment reçu de la valeur reçue.
Je classe la facture à '''Payé partiellement''' et renseigne le motif "Le manque est un '''Escompte'''".
}}

{{ExamplesCaseFr
|nom=UCIN07: Facturation et paiement partiel ou nul puis retour produit et attente correction anomalie ou erreur infine tolerable'''
|situation=Je crée une facture.
Si je reçois un paiement partiel, je le saisis.
Je reçois un retour d'une partie des produits (retractation du client) ou ne reçois plus les quelques centimes manquant.
Eventuellement, le client attend un avoir pour payer la fin de la facture.
|actions=Je saisis un avoir sur la facture.
J'envoie l'avoir.
Ensuite, je convertis cet avoir en reduction pour le client.
Je saisis eventuellement la suite des paiements reçus.
Eventuellement j'inclus l'avoir dans la liste des paiements de la facture (sinon il pourra être inclu dans une autre facture).
Je classe la facture à l'état '''Payé'''.

'''TODO''' Contrôle a inclure en plus : Quand l'avoir est fait sur une facture au statut 'Réglement commencé', il faut mettre un message disant "Attention, ne créer un avoir sur une facture en cours de paiement que si le client a cessé le paiement et attend cet avoir pour poursuivre la suite ou parce que vous fermez la facture".
Ensuite il faut vérifier que le montant de l'avoir est inférieur au montant de la facture auquel il s'applique - montant déja reçu. Sinon, refuser création avoir.
}}

{{ExamplesCaseFr
|nom=UCIN08: Facturation et paiement partiel car mauvais payeur
|situation=Je crée une facture.
Je reçois un paiement partiel, je le saisis.
Après une longue attente, la suite des paiements n'est pas reçue et j'abandonne tout espoir.
|actions=Je classe la facture à l'état '''Payé partiellement''' et renseigne le motif '''Mauvais payeur'''.
}}

{{ExamplesCaseFr
|nom=UCIN09: Facturation et aucun paiement reçu car mauvais payeur'''
|situation=Je crée une facture.
Après une longue attente, la suite des paiements n'est pas reçu et j'abandonne tout espoir.
|actions=Je classe la facture à l'état '''Abandonnée''' et renseigne le motif '''Mauvais payeur'''.
}} 

== Correction des erreurs de facturation ==
{{ExamplesCaseFr
|nom=UCIN00: Erreur sur le contenu de la facture corrigée par facture remplacement
|situation=Je crée une facture.
Je valide.
Je me rend compte de l'erreur sur le contenu (montant, descriptif) après validation (voir use case UCIN10 en cas d'erreur sur client).
|actions=Je classe la facture abandonnée pour motif 'Autre' (opération non obligatoire car automatique avec étape suivante).
Je crée une nouvelle facture en choisissant '''Facture de remplacement''' et en selectionnant la facture remplacée comme facture.
}}

{{ExamplesCaseFr
|nom=UCIN10: Erreur sur le client détecté après validation mais avant paiement
|situation=Je crée une facture.
Je valide.
Je me rend compte que la facture a été crée sur le mauvais client.
|actions=Je classe la facture abandonnée pour motif 'Autre' et je renseigne le motif "Erreur saisie sur mauvais client".
Je crée une nouvelle facture sur le bon client.

'''TODO''': Faire confirmer par expert que possible si c'est fait avant envoi.
Si pas possible, interdire la possibilité et utiliser le cas suivant.
}}

{{ExamplesCaseFr
|nom=UCIN10: Erreur sur le client (ou facture saisie 2 fois) détecté après envoi facture mais avant paiement
|situation=Je crée une facture.
Je valide et l'envoie au client.
Je me rend compte que la facture a été crée sur le mauvais client ou facture en doublon avec une autre deja envoyée.
|actions=Je crée un avoir sur la facture qui n'a pas encore de paiement, du montant inverse exacte.
Je convertit l'avoir en réduction. L'avoir se retrouve ainsi "traité", je peux l'envoyer au client si je le désire.
Je retourne sur la fiche facture en erreur et j'applique la réduction issue de l'avoir.
Le du devient alors zéro et je la classe à '''Payée complètement''' (paiement de 0).
Que le client ait reçu ou non la facture initiale, cette dernière a été annulée et fermé par l'avoir.
Je resaisi la facture sur le bon client.
}}

{{ExamplesCaseFr
|nom=UCIN10: Erreur sur le libellé client détecté après saisie de paiement'''
|situation=Je crée une facture sur le client de libellé X.
Je valide.
Je saisi les paiements.
Je classe la facture payée.
Je me rend compte que la facture a été crée sur le mauvais client et le client me demande une contrefacture sur l'ancien nom X et une nouvelle sur le nouveau nom Y.
|actions=Je crée un avoir sur la facture en erreur avec toutes les lignes en inverse.
Je transforme l'avoir en réduction. L'avoir se retrouve ainsi "traité".
J'édite la fiche client pour corriger le libellé client X par Y.
Je crée la nouvelle facture sur le nouveau client Y en incluant toutes les lignes.
Je la valide.
J'inclut le paiement issue de l'avoir.
Le solde passe alors à 0 (aucun du).
Je peux classer la facture à '''Payée''' sans saisir d'autres réglements (le client a déjà payé).
}} 

== Factures pré-définies ==

{{ExamplesCaseFr
|nom=UCRIN01: Création d'une facture pré-définie
|situation=Création d'une facture pré-définie
|actions=Il n'est pas possible de créer une facture récurrente en partant de rien. Il s'agit d'une facture standard de doit que l'on convertie et réutilise par la suite. Voir cas d'utilisation suivant donc.
}}

{{ExamplesCaseFr
|nom=UCRIN02: Transformation d'une facture standard en facture prédéfinie
|situation=Transformation d'une facture standard en facture prédéfinie
|actions=Je crée ou ouvre une facture brouillon. Je clique sur le bouton "Convertir en récurrente". J'entre un titre (par exemple, "Mise-à-jour trimestrielle") et éventuellement une note, qui pourrait être une explication de la raison de la répétition de cette facture. Ma facture est à présent une facture récurrente. Cela ne sera visible que si je demande l'affichage des factures récurrentes ou que je crée une nouvelle facture.
}}

{{ExamplesCaseFr
|nom=UCRIN03: Utilisation d'une facture prédéfinie pour la création d'une nouvelle facture
|situation=Utilisation d'une facture prédéfinie pour la création d'une nouvelle facture
|actions=Je crée une nouvelle facture ("Créer facture"), et j'utilise la boîte de sélection en bas de page pour sélectionner la facture récurrente que je veux utiliser comme gabarit (template). Ma nouvelle facture est pré-remplie, les modifications à apporter sont mineures.
}}

Module Web Services API REST (développeur)

2017-10-12T11:20:29Z

Bgenere: /* Seveur de Web services REST Dolibarr */ orthographe

{{TemplateDocDevEn}}
{{TemplateModEN}}
[[Category:List of Modules]]
{{BasculeDevUserEn|
name=Web services|
num=2610|
devdoc=Cette page|
userdoc=Non applicable|}}

= Fonction =
Quand ce module est activé, vous activez l'utilisation des Webservices fournis par Dolibarr. Vous pouvez alors faire des appels REST sur différents Webservices fournis par Dolibarr.

= Serveur de Web services REST Dolibarr =
Une fois que le module webservices REST est activé, Dolibarr devient également un serveur de Web services REST. Vous pouvez alors envoyer vos propres requêtes sur l'url relative :
'''/api/index.php'''

= Liste des services fournis =
Seuls quelques services sont disponibles. À compter de la version 5.0 de Dolibarr, vous pouvez consulter la liste complète des web services proposés en appelant l'explorer à cette adresse :

'''http://yourdolibarrurl/api/index.php/explorer'''.

Vous devez au préalable faire un premier appel au service '''login''' pour obtenir une clé API.
Vous entrez alors la clé pour obtenir la liste des services proposés

Par exemple, vous pouvez essayer l'explorateur sur l'instance de démonstration à l'adresse suivante :

'''https://demo.dolibarr.org/api/index.php/explorer'''

= Ajouter un nouveau service =
Ajouter un nouveau service est aussi facile qu'ajouter un fichier nommé '''api_monmoduleobject.class.php''' dans le dossier '''htdocs/module/class'''.
Vous trouverez des exemples dans '''htdocs/commande/class/api_orders.class.php'''

Le framework détecte automatiquement les API et elle devrait être visible dans l'explorateur.

Les méthodes et paramètres sont détectées en fonction de l'introspection réalisée dans les classes PHP de l'objet ('''htdocs/module/class/object.class.php''') en utilisant les '''annotations''' trouvées dans la classe.

Pour une documentation à propos des annotations : https://github.com/Luracast/Restler/blob/master/ANNOTATIONS.md

= Installation =

Pour installer, aller dans la page des modules et activer le module API REST. Dans la page de configuration du module, il y a 2 liens. Pas la peine de cliquer sur le premier, il ne fonctionne pas en l'état.

Le lien a cette forme : <nowiki>http://<mon serveur>/api/index.php/login?login=<mon login utilisateur>&password=yourpassword</nowiki> 
copiez le lien, remplacez yourpassword par votre mot de passe utilisateur. Normalement, <mon serveur> et <mon login utilisateur> sont déjà remplacés. collez le lien dans votre navigateur pour générer votre <token>. ce dernier est lié à votre compte utilisateur.

Notez bien ce <Token> dans un coin !!!

Maintenant, vous pouvez aller sur le 2nd lien de la page de configuration du module. En haut a droite, coller le <token> puis cliquez sur explore. Normalement, vous allez voir apparaître toutes les actions accessibles avec ce <token>. Si vous n'avez pas beaucoup d'actions, c'est certainement que les modules ne sont pas activés. Par exemple, si vous voulez voir les factures (invoices), il faut activer le module adéquat dans votre configuration Dolibarr. Idem pour produits, etc. Pour information, Thirdparties, ce sont les Tiers. 
Sur cette page d'exploration de l'API, vous pouvez faire pas mal de tests. aussi bien en lecture qu'en écriture, modification ou suppression

= Utilisation =

Grosso modo, pour utiliser REST, il faut appeler une url du genre suivant <nowiki>http://<mon_serveur>/api/index.php/<action></nowiki> 
avec une des 4 méthodes : GET, POST, PUT, DELETE, en remplaçant <action> par l'action sur laquelle vous voulez intervenir. Ex : <nowiki>http://<mon_serveur>/api/index.php/invoices</nowiki>

Pour ce faire, il existe plusieurs méthodes. Voici un morceau de code mais il existe également des librairies telles que phphttpclient.com/

<source lang="php">
function CallAPI($method, $apikey, $url, $data = false)
{
$curl = curl_init();
$httpheader = ['DOLAPIKEY: '.$apikey];

switch ($method)
{
case "POST":
curl_setopt($curl, CURLOPT_POST, 1);
$httpheader[] = "Content-Type:application/json";

if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

break;
case "PUT":

curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT');
$httpheader[] = "Content-Type:application/json";

if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

break;
default:
if ($data)
$url = sprintf("%s?%s", $url, http_build_query($data));
}

// Optional Authentication:
// curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
// curl_setopt($curl, CURLOPT_USERPWD, "username:password");

curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $httpheader);

$result = curl_exec($curl);

curl_close($curl);

return $result;
}
</source>

Ce n'est qu'un exemple, ce n'est pas sécurisé, cela ne prend pas en compte les codes erreurs mais vous pouvez le modifier et l'adapter à vos besoins.
la fonction prend 4 paramètres :
* $method : string "GET", "POST", "PUT", "DELETE"
* $apikey : string "votre <token> généré plus haut"
* $url : string l'url à appeler. Ex : "<nowiki>http://<mon_serveur>/api/index.php/invoices</nowiki>"
* $data : string flux au format json. Ce champ est requis pour les appels POST ou PUT.

= Exemples =

Maintenant, quelques exemples. 
dans tous les cas :
* $apiKey = "mon <token>";
* $apiUrl = "<nowiki>http://<mon_serveur>/api/index.php/</nowiki>";

<source lang="php">
// Récupérer la liste des produits
$listProduits = [];
$produitParam = ["limit" => 10000, "sortfield" => "rowid"];
$listProduitsResult = CallAPI("GET", $apiKey, $apiUrl."products", $produitParam);
$listProduitsResult = json_decode($listProduitsResult, true);

if (isset($listProduitsResult["error"]) && $listProduitsResult["error"]["code"] >= "300") {
} else {
foreach ($listProduitsResult as $produit) {
$listProduits[intval($produit["id"])] = html_entity_decode($produit["ref"], ENT_QUOTES);
}
}
</source>
Commentaires :
* récupérer les 10'000 premiers produits triés par leur id dans la base
* html_entity_decode est nécessaire car les apostrophes sont encodés
* il est facile d'utiliser la même méthode (en remplaçant products par dictionnarycountries) pour récupérer la liste des pays

<source lang="php">
// Créer un produit
$ref = "ma_reference_produit_X203ZZ";
$newProduct = [
"ref" => $ref,
"label" => $ref
];
$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
$newProductResult = json_decode($newProductResult, true);
</source>
Commentaires :
* avant de créer un produit, il peut être sage de vérifier qu'il existe. En reprenant le premier exemple, cela fait :

<source lang="php">
// ma référence
$ref = "ma_reference_produit_X203ZZ";
// existe-t-elle dans mon tableau
$produitKey = array_search($ref, $listProduits);
if ($produitKey) {
// oui
$fk_product = $produitKey;
} else {
// non
// Créer un produit
$newProduct = [
"ref" => $ref,
"label" => $ref
];
$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
$newProductResult = json_decode($newProductResult, true);
if (isset($newProductResult["error"]) && $newProductResult["error"]["code"] >= "300") {
// il y a eu une erreur
echo "<pre>ERROR", var_dump($newProductResult), "</pre>";
exit;
} else {
// tout va bien
$fk_product = $newProductResult;
$listProduits[$fk_product] = $ref;
}
}
</source>
Commentaires :
* je regarde si la référence de mon article existe dans le tableau créé dans le premier exemple.
* si elle existe, j'utilise sa clé dans le tableau comme id
* si elle n'existe pas, je crée l'article puis le j'ajoute à mon tableau pour les prochaines fois et je récupère l'id créé
* cette méthode permet de limiter les appels API quand on doit importer 500 commandes par exemple. Récupérer une fois la liste des produits au début au lieu de chercher à chaque fois dans Dolibarr.

<source lang="php">
// créer une commande avec 2 articles

// le tableau qui contiendra toutes les lignes d'articles de la commande
$newCommandeLine = [];

// article 1
$ref1 = "ma_reference_produit_X203ZZ";
$prix1 = 10;
$qtt1 = 100;
$tva1 = 20;
$fk_product1
// article 2
$ref2 = "ma_reference_produit_B707FD";
$prix2 = 13;
$qtt2 = 37;
$tva2 = 20;

$newCommandeLine[] = [
"desc" => $ref1,
"subprice" => $prix1,
"qty" => $qtt1,
"tva_tx" => floatval($tva1),
"fk_product"=> $fk_product1
];

$newCommandeLine[] = [
"desc" => $ref2,
"subprice" => $prix2,
"qty" => $qtt2,
"tva_tx" => floatval($tva2),
"fk_product"=> $fk_product2
];

if (count($newCommandeLine) > 0) {
$newCommande = [
"socid" => $clientDoliId,
"type" => "0",
"lines" => $newCommandeLine,
"note_private" => "Commande importée automatiquement depuis l'application",
];
$newCommandeResult = CallAPI("POST", $apiKey, $apiUrl."orders", json_encode($newCommande));
$newCommandeResult = json_decode($newCommandeResult, true);
}
</source>
Commentaires :
* $clientDoliId vaut l'id du client dans la base doli. Soit vous le connaissez, soit vous pouvez le chercher auparavant
* type => 0, c'est une commande client (par opposition à 1 = commande fournisseur)

<source lang="php">
// Valider une commande
$newCommandeValider = [
"idwarehouse" => "0",
"notrigger" => "0"
];
$newCommandeValiderResult = CallAPI("POST", $apiKey, $apiUrl."orders/".$newCommandeResult."/validate", json_encode($newCommandeValider));
$newCommandeValiderResult = json_decode($newCommandeValiderResult, true);
</source>
Commentaires :
* on voit dans cet exemple, en avant dernière lignes, on a : $apiUrl."orders/".$newCommandeResult."/validate". 
$newCommandeResult est l'id de la commande crée (récupéré dans l'exemple précédent)

<source lang="php">
// chercher si le client existe dans la base
$clientSearch = json_decode(CallAPI("GET", $apiKey, $apiUrl."thirdparties", array(
"sortfield" => "t.rowid",
"sortorder" => "ASC",
"limit" => "1",
"mode" => "1",
"sqlfilters" => "(t.nom:=:'".$nom_client."')"
)
), true);
</source>
Commentaires :
* limit => 1 pour ne renvoyer que 1 client
* mode => 1 car on cherche un client (on aurait aussi pu chercher un fournisseur qui est aussi un tiers mais avec un statut différent)
* sqlfilters syntaxe un peu particulière mais il y a qq autres exemples sur la page d'explorer d'API

<source lang="php">
//client n'existe pas. le crée puis on récupère son id
$newClient = [
"name" => "nom société client",
"email" => "email société client",
"client" => "1",
"code_client" => "-1"
];
$newClientResult = CallAPI("POST", $apiKey, $apiUrl."thirdparties", json_encode($newClient));
$newClientResult = json_decode($newClientResult, true);
$clientDoliId = $newClientResult;
</source>
Commentaires :
* client => 1 car c'est un client (et pas un fournisseur)
* code_client => -1 pour que le code client soit généré automatiquement.
* on récupère l'id du client dans $clientDoliId

= Conclusion =

Vous trouverez pas mal d'autres informations dans le code de Dolibarr, en regardant dans '''htdocs/<dossier>/class/api_xxx_class.php''' 
Ex pour les tiers: htdocs/societe/class/api_thirdparties.class.php pour les tiers. 
Ex pour les factures: htdocs/compta/facture/class/api_invoices.class.php 
...

Module Projects

2017-02-02T14:04:21Z

Bgenere: /* Project visibility and user actions */

[[Category:Project]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Project|
num=400|
devdoc=[[Module Projects (developer)]]|
userdoc=This page|}}

= 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 [[Module Commercial Proposals|commercial proposals]], [[Module Customers Orders|customers orders]] or [[Module Customers Invoices|customers invoices]]).

Current documentation applies to 4.0.4 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 =
{{NoInstallModuleEn}}

= Configuration =
{{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.

= Usage =
The module is available from the '''Projects''' icon available in Dolibarr top menu.

Note that the left menu display two sets of options :
# to access your own projects and tasks. These are projects and task you have been assigned to.
# to access shared projects and tasks. These are projects and task readable by you (even if you are not assigned to). Depending on your permission, access to this view may be restricted.

= Entities and Business rules =
== Project entity ==
This is the root object added by the module.
=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the project.
|
|-
! scope="row" | Visibility
| This property define the users permissions.
|
*''Project Contacts'', the project is only available to users associated.
*''Everybody'', the project is shared (public).
|-
! scope="row" | Status
| Current status of the project, updated by the project workflow.
|
* Draft
* Open
* Closed
|-
! scope="row" | Start date
| Starting date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | End date
| Ending date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | Opportunity status
| Value selected from the "Opportunity status for project/lead" dictionary.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity probability
| The percentage associated to the Opportunity status, could be updated manually.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity amount
| Amount of the opportunity in default currency.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Budget
| Amount of the budget required for the project in default currency (if any).
|
|-
! scope="row" | Description
| A text to describe your project.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the project.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the project.
|
|}
=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%"| Description
! scope="Note" | Notes
|-
! scope="row" | Users
| You could allocate multiple users to a project, specifying a role. Two roles are defined by default, but you could extend it if needed.
| There is no limitation to number of users linked, even with the same role.
|-
! scope="row" | Contacts
| You could allocate multiple contacts - from different third parties - to a project, specifying a role. Two roles are defined by default, but you could extend it if needed
| There is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
|-
! scope="row" | Documents
| You could upload multiple document files and link them to a project.
| Document could also be generated using templates, see [[Module_Projects#Set-up_options | Set-up Options]] to activate the templates.
|-
! scope="row" | URL
| You could attach multiple URL links to a project.
|-
! scope="row" | Commercial proposal
| You could attach multiple proposals to a project.
| You could create the proposal from the project overview tab.
|-
! scope="row" | Customer order
| You could attach multiple customer orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Customer invoice
| You could attach multiple customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Customer template invoice
| You could attach multiple template customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Supplier order
| You could attach multiple supplier orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Supplier invoice
| You could attach multiple supplier invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Contract
| You could attach multiple contracts to a project.
| You could create the contract from the project overview tab.
|-
! scope="row" | Expense report
| You could attach multiple expense report to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Event
| You could attach multiple events to a project.
| You could create the event from the project overview tab. The Agenda module should be activated.
|-
! scope="row" | Task
| You could attach multiple tasks to a project. See below the tasks properties.
| The option to manage tasks in a project should be properly activated, see [[Module_Projects#Set-up_options | Set-up Options]]
|}

== Task entity ==
This is the child entity of the project entity. It is possible to create a hierarchy of tasks, the project being the root of the tree.

=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the task.
|
|-
! scope="row" | Child of project/task
| By default the current project but could be changed to an other project task to create a tasks hierarchy.
|
|-
! scope="row" | Assigned to
| The user responsible of the task.
| By default the task creator.
|-
! scope="row" | Start date
| Starting date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | End date
| Ending date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | Planned workload
| Planned workload to complete the task in hours and minutes.
|
|-
! scope="row" | Declared progress
| A percentage to be updated manually.
| Could also be updated when capturing time spend on task.
|-
! scope="row" | Description
| A text to describe your task.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the task.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the task.
|
|}

=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%"| Description
! scope="Note" | Notes
|-
! scope="row" | Users
| You could allocate multiple users to a task, specifying a role. Two roles are defined by default, but you could extend it if needed.
| There is no limitation to number of users linked, even with the same role.
|-
! scope="row" | Contacts
| You could allocate multiple contacts - from different third parties - to a task, specifying a role. Two roles are defined by default, but you could extend it if needed
| There is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
|-
! scope="row" | Documents
| You could upload multiple document files and link them to a project.
| Document could also be generated using ODT templates, see [[Module_Projects#Set-up_options | Set-up Options]] to activate the templates.
|-
! scope="row" | URL
| You could attach multiple URL links to a project.
|-
! scope="row" | Time spent
| You could attach multiple time spent slot to a task.
| See the entity attributes below for more details.
|-
! scope="row" | Task
| You could attach multiple tasks to a task by using it as a parent task.
|
|}

== Time spent record ==
These records allows to capture the time spent by a user on a task at a given time.

The time spent could be entered from different points:
* using the tab dedicated in the task form
* using the "New time spent" option in the module left menu.

In both cases you could enter time spend by day, but the menu option allows also to enter time spend by week. In this case you could only enter one time slot by day.
=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Start Date and Time
| Define when the time has been spent.
| Time is not available when you enter the data by weeks.
|-
! scope="row" | Duration
| Hours and minutes spent on the task.
| This is mandatory to create a record
|-
! scope="row" | Note
| A small text to comment what was done or how time was spent.
| Note is not available when you enter the data by weeks.
|-
! scope="row" | Done by
| The user who has spent time on the task.
| The user should be assigned to the task to enter a time spent record
|}

=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%" class="unsortable" | Description
! scope="Note" class="unsortable" | Notes
|-
! scope="row" | Users
| One and only one user is linked to a time spent record
| The user should be linked to the task, to create the record.
|-
! scope="row" | Task
| One and only one task is linked to a time spent record
|
|}

== Project visibility and user actions ==
This module allow to share projects and task across users. Each user could interact based on :
*Permissions allowed
*Project visibility
*Assignment to project

The following table summarizes actions available based on these factors.

{| class="wikitable"
! rowspan="2" colspan="2" style="text-align: center;" | User
! colspan="4" style="text-align: center;" | Project
|-
| colspan="2" style="text-align: center;" | Not Shared
| colspan="2" style="text-align: center;" | Shared
|-
| colspan="2" | Status
| not a project user
| is a project user
| not a project user
| is a project user
|-
| rowspan="6" | Permission
| Read
| rowspan="3" style="text-align: center;" | Project hidden
| style="text-align: center;" | read project & tasks
add time spent on owned tasks
| rowspan="3" style="text-align: center;" | Project hidden
| style="text-align: center;" | read project & tasks
add time spent on tasks
|-
| Create/Modify
| style="text-align: center;" | modify close project
create modify tasks
| style="text-align: center;" | modify close project
create modify tasks
|-
| Delete
| style="text-align: center;" | delete projects & tasks
| style="text-align: center;" | delete projects & tasks
|-
| Read All
(require Read*)
| colspan="4" style="text-align: center;" | read projects & tasks
add time spent on owned tasks
|-
| Create/Modify All
(require Create/Modify*)
| colspan="4" style="text-align: center;" | modify close project
create modify tasks
|-
| Delete All
(require Delete*)
| colspan="4" style="text-align: center;" | delete projects and tasks
|}

* the All permissions work only when the standard corresponding permission is given, else an error message will be displayed when attempting the action.

== Project Workflow ==

Project status follows this workflow sequence : draft, open , closed.

Previously , the page was providing the following informations regarding actions :
See file [[File:Project.odg]] that describe different conditions to realize different actions of module.
[[File:Project_right_access.png|200px]]
== Create a project ==
Creation of a new project is done from menu "New project" on main menu "Project"
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.
However this information needs to be double checked and completed using the table above.

{{ToComplete}}

= Examples of use cases =
{{ToComplete}}
{{ExamplesCaseEn
|name=UCMP01:
|situation=
|actions=
}} 

Module Projects

2017-02-02T13:59:20Z

Bgenere: /* Project visibility and user actions */ permissions tested and table completed

[[Category:Project]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Project|
num=400|
devdoc=[[Module Projects (developer)]]|
userdoc=This page|}}

= 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 [[Module Commercial Proposals|commercial proposals]], [[Module Customers Orders|customers orders]] or [[Module Customers Invoices|customers invoices]]).

Current documentation applies to 4.0.4 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 =
{{NoInstallModuleEn}}

= Configuration =
{{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.

= Usage =
The module is available from the '''Projects''' icon available in Dolibarr top menu.

Note that the left menu display two sets of options :
# to access your own projects and tasks. These are projects and task you have been assigned to.
# to access shared projects and tasks. These are projects and task readable by you (even if you are not assigned to). Depending on your permission, access to this view may be restricted.

= Entities and Business rules =
== Project entity ==
This is the root object added by the module.
=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the project.
|
|-
! scope="row" | Visibility
| This property define the users permissions.
|
*''Project Contacts'', the project is only available to users associated.
*''Everybody'', the project is shared (public).
|-
! scope="row" | Status
| Current status of the project, updated by the project workflow.
|
* Draft
* Open
* Closed
|-
! scope="row" | Start date
| Starting date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | End date
| Ending date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | Opportunity status
| Value selected from the "Opportunity status for project/lead" dictionary.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity probability
| The percentage associated to the Opportunity status, could be updated manually.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity amount
| Amount of the opportunity in default currency.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Budget
| Amount of the budget required for the project in default currency (if any).
|
|-
! scope="row" | Description
| A text to describe your project.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the project.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the project.
|
|}
=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%"| Description
! scope="Note" | Notes
|-
! scope="row" | Users
| You could allocate multiple users to a project, specifying a role. Two roles are defined by default, but you could extend it if needed.
| There is no limitation to number of users linked, even with the same role.
|-
! scope="row" | Contacts
| You could allocate multiple contacts - from different third parties - to a project, specifying a role. Two roles are defined by default, but you could extend it if needed
| There is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
|-
! scope="row" | Documents
| You could upload multiple document files and link them to a project.
| Document could also be generated using templates, see [[Module_Projects#Set-up_options | Set-up Options]] to activate the templates.
|-
! scope="row" | URL
| You could attach multiple URL links to a project.
|-
! scope="row" | Commercial proposal
| You could attach multiple proposals to a project.
| You could create the proposal from the project overview tab.
|-
! scope="row" | Customer order
| You could attach multiple customer orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Customer invoice
| You could attach multiple customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Customer template invoice
| You could attach multiple template customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Supplier order
| You could attach multiple supplier orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Supplier invoice
| You could attach multiple supplier invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Contract
| You could attach multiple contracts to a project.
| You could create the contract from the project overview tab.
|-
! scope="row" | Expense report
| You could attach multiple expense report to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Event
| You could attach multiple events to a project.
| You could create the event from the project overview tab. The Agenda module should be activated.
|-
! scope="row" | Task
| You could attach multiple tasks to a project. See below the tasks properties.
| The option to manage tasks in a project should be properly activated, see [[Module_Projects#Set-up_options | Set-up Options]]
|}

== Task entity ==
This is the child entity of the project entity. It is possible to create a hierarchy of tasks, the project being the root of the tree.

=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the task.
|
|-
! scope="row" | Child of project/task
| By default the current project but could be changed to an other project task to create a tasks hierarchy.
|
|-
! scope="row" | Assigned to
| The user responsible of the task.
| By default the task creator.
|-
! scope="row" | Start date
| Starting date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | End date
| Ending date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | Planned workload
| Planned workload to complete the task in hours and minutes.
|
|-
! scope="row" | Declared progress
| A percentage to be updated manually.
| Could also be updated when capturing time spend on task.
|-
! scope="row" | Description
| A text to describe your task.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the task.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the task.
|
|}

=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%"| Description
! scope="Note" | Notes
|-
! scope="row" | Users
| You could allocate multiple users to a task, specifying a role. Two roles are defined by default, but you could extend it if needed.
| There is no limitation to number of users linked, even with the same role.
|-
! scope="row" | Contacts
| You could allocate multiple contacts - from different third parties - to a task, specifying a role. Two roles are defined by default, but you could extend it if needed
| There is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
|-
! scope="row" | Documents
| You could upload multiple document files and link them to a project.
| Document could also be generated using ODT templates, see [[Module_Projects#Set-up_options | Set-up Options]] to activate the templates.
|-
! scope="row" | URL
| You could attach multiple URL links to a project.
|-
! scope="row" | Time spent
| You could attach multiple time spent slot to a task.
| See the entity attributes below for more details.
|-
! scope="row" | Task
| You could attach multiple tasks to a task by using it as a parent task.
|
|}

== Time spent record ==
These records allows to capture the time spent by a user on a task at a given time.

The time spent could be entered from different points:
* using the tab dedicated in the task form
* using the "New time spent" option in the module left menu.

In both cases you could enter time spend by day, but the menu option allows also to enter time spend by week. In this case you could only enter one time slot by day.
=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Start Date and Time
| Define when the time has been spent.
| Time is not available when you enter the data by weeks.
|-
! scope="row" | Duration
| Hours and minutes spent on the task.
| This is mandatory to create a record
|-
! scope="row" | Note
| A small text to comment what was done or how time was spent.
| Note is not available when you enter the data by weeks.
|-
! scope="row" | Done by
| The user who has spent time on the task.
| The user should be assigned to the task to enter a time spent record
|}

=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%" class="unsortable" | Description
! scope="Note" class="unsortable" | Notes
|-
! scope="row" | Users
| One and only one user is linked to a time spent record
| The user should be linked to the task, to create the record.
|-
! scope="row" | Task
| One and only one task is linked to a time spent record
|
|}

== Project visibility and user actions ==
This module allow to share projects and task across users. Each user could interact based on :
*Permissions allowed
*Project visibility
*Assignment to project

The following table try to summarize actions available based on these factors.

{| class="wikitable"
! rowspan="2" colspan="2" style="text-align: center;" | User
! colspan="4" style="text-align: center;" | Project
|-
| colspan="2" style="text-align: center;" | Not Shared
| colspan="2" style="text-align: center;" | Shared
|-
| colspan="2" | Status
| not a project user
| is a project user
| not a project user
| is a project user
|-
| rowspan="6" | Permission
| Read
| rowspan="3" style="text-align: center;" | Project hidden
| style="text-align: center;" | read project & tasks
add time spent on owned tasks
| rowspan="3" style="text-align: center;" | Project hidden
| style="text-align: center;" | read project & tasks
add time spent on tasks
|-
| Create/Modify
| style="text-align: center;" | modify close project
create modify tasks
| style="text-align: center;" | modify close project
create modify tasks
|-
| Delete
| style="text-align: center;" | delete projects & tasks
| style="text-align: center;" | delete projects & tasks
|-
| Read all
(require Read*)
| colspan="4" style="text-align: center;" | read projects & tasks
add time spent on owned tasks
|-
| Create/Modify All
(require Create/Modify*)
| colspan="4" style="text-align: center;" | modify close project
create modify tasks
|-
| Delete All
(require Delete)
| colspan="4" style="text-align: center;" | delete projects and tasks
|}

* the All permissions work only when the standard corresponding permission is given, else an error message will be display when attempting the action.

Previously , the page was providing the following informations regarding actions :
See file [[File:Project.odg]] that describe different conditions to realize different actions of module.
[[File:Project_right_access.png|200px]]
== Create a project ==
Creation of a new project is done from menu "New project" on main menu "Project"
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.
However this information needs to be double checked and completed using the table above.

{{ToComplete}}

= Examples of use cases =
{{ToComplete}}
{{ExamplesCaseEn
|name=UCMP01:
|situation=
|actions=
}} 

Module Projects

2017-02-02T12:58:49Z

Bgenere: /* Project visibility and user actions */

[[Category:Project]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Project|
num=400|
devdoc=[[Module Projects (developer)]]|
userdoc=This page|}}

= 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 [[Module Commercial Proposals|commercial proposals]], [[Module Customers Orders|customers orders]] or [[Module Customers Invoices|customers invoices]]).

Current documentation applies to 4.0.4 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 =
{{NoInstallModuleEn}}

= Configuration =
{{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.

= Usage =
The module is available from the '''Projects''' icon available in Dolibarr top menu.

Note that the left menu display two sets of options :
# to access your own projects and tasks. These are projects and task you have been assigned to.
# to access shared projects and tasks. These are projects and task readable by you (even if you are not assigned to). Depending on your permission, access to this view may be restricted.

= Entities and Business rules =
== Project entity ==
This is the root object added by the module.
=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the project.
|
|-
! scope="row" | Visibility
| This property define the users permissions.
|
*''Project Contacts'', the project is only available to users associated.
*''Everybody'', the project is shared (public).
|-
! scope="row" | Status
| Current status of the project, updated by the project workflow.
|
* Draft
* Open
* Closed
|-
! scope="row" | Start date
| Starting date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | End date
| Ending date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | Opportunity status
| Value selected from the "Opportunity status for project/lead" dictionary.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity probability
| The percentage associated to the Opportunity status, could be updated manually.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity amount
| Amount of the opportunity in default currency.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Budget
| Amount of the budget required for the project in default currency (if any).
|
|-
! scope="row" | Description
| A text to describe your project.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the project.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the project.
|
|}
=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%"| Description
! scope="Note" | Notes
|-
! scope="row" | Users
| You could allocate multiple users to a project, specifying a role. Two roles are defined by default, but you could extend it if needed.
| There is no limitation to number of users linked, even with the same role.
|-
! scope="row" | Contacts
| You could allocate multiple contacts - from different third parties - to a project, specifying a role. Two roles are defined by default, but you could extend it if needed
| There is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
|-
! scope="row" | Documents
| You could upload multiple document files and link them to a project.
| Document could also be generated using templates, see [[Module_Projects#Set-up_options | Set-up Options]] to activate the templates.
|-
! scope="row" | URL
| You could attach multiple URL links to a project.
|-
! scope="row" | Commercial proposal
| You could attach multiple proposals to a project.
| You could create the proposal from the project overview tab.
|-
! scope="row" | Customer order
| You could attach multiple customer orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Customer invoice
| You could attach multiple customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Customer template invoice
| You could attach multiple template customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Supplier order
| You could attach multiple supplier orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Supplier invoice
| You could attach multiple supplier invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Contract
| You could attach multiple contracts to a project.
| You could create the contract from the project overview tab.
|-
! scope="row" | Expense report
| You could attach multiple expense report to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Event
| You could attach multiple events to a project.
| You could create the event from the project overview tab. The Agenda module should be activated.
|-
! scope="row" | Task
| You could attach multiple tasks to a project. See below the tasks properties.
| The option to manage tasks in a project should be properly activated, see [[Module_Projects#Set-up_options | Set-up Options]]
|}

== Task entity ==
This is the child entity of the project entity. It is possible to create a hierarchy of tasks, the project being the root of the tree.

=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the task.
|
|-
! scope="row" | Child of project/task
| By default the current project but could be changed to an other project task to create a tasks hierarchy.
|
|-
! scope="row" | Assigned to
| The user responsible of the task.
| By default the task creator.
|-
! scope="row" | Start date
| Starting date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | End date
| Ending date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | Planned workload
| Planned workload to complete the task in hours and minutes.
|
|-
! scope="row" | Declared progress
| A percentage to be updated manually.
| Could also be updated when capturing time spend on task.
|-
! scope="row" | Description
| A text to describe your task.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the task.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the task.
|
|}

=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%"| Description
! scope="Note" | Notes
|-
! scope="row" | Users
| You could allocate multiple users to a task, specifying a role. Two roles are defined by default, but you could extend it if needed.
| There is no limitation to number of users linked, even with the same role.
|-
! scope="row" | Contacts
| You could allocate multiple contacts - from different third parties - to a task, specifying a role. Two roles are defined by default, but you could extend it if needed
| There is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
|-
! scope="row" | Documents
| You could upload multiple document files and link them to a project.
| Document could also be generated using ODT templates, see [[Module_Projects#Set-up_options | Set-up Options]] to activate the templates.
|-
! scope="row" | URL
| You could attach multiple URL links to a project.
|-
! scope="row" | Time spent
| You could attach multiple time spent slot to a task.
| See the entity attributes below for more details.
|-
! scope="row" | Task
| You could attach multiple tasks to a task by using it as a parent task.
|
|}

== Time spent record ==
These records allows to capture the time spent by a user on a task at a given time.

The time spent could be entered from different points:
* using the tab dedicated in the task form
* using the "New time spent" option in the module left menu.

In both cases you could enter time spend by day, but the menu option allows also to enter time spend by week. In this case you could only enter one time slot by day.
=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Start Date and Time
| Define when the time has been spent.
| Time is not available when you enter the data by weeks.
|-
! scope="row" | Duration
| Hours and minutes spent on the task.
| This is mandatory to create a record
|-
! scope="row" | Note
| A small text to comment what was done or how time was spent.
| Note is not available when you enter the data by weeks.
|-
! scope="row" | Done by
| The user who has spent time on the task.
| The user should be assigned to the task to enter a time spent record
|}

=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%" class="unsortable" | Description
! scope="Note" class="unsortable" | Notes
|-
! scope="row" | Users
| One and only one user is linked to a time spent record
| The user should be linked to the task, to create the record.
|-
! scope="row" | Task
| One and only one task is linked to a time spent record
|
|}

== Project visibility and user actions ==
This module allow to share projects and task across users. Each user could interact based on :
*Permissions allowed
*Project visibility
*Assignment to project

The following table try to summarize actions available based on these factors.

{| class="wikitable"
! rowspan="2" colspan="2" style="text-align: center;" | User
! colspan="4" style="text-align: center;" | Project
|-
| colspan="2" style="text-align: center;" | Not Shared
| colspan="2" style="text-align: center;" | Shared
|-
| colspan="2" style="text-align: center;" | Status
| style="text-align: center;" | user not assigned to project
| style="text-align: center;" | user assigned to project
| style="text-align: center;" | user not assigned to project
| style="text-align: center;" | user assigned to project
|-
| rowspan="6" | Permission
| Read
| rowspan="3" style="text-align: center;" | Project hidden
| style="text-align: center;" | read project & tasks
add time on assigned tasks

| style="text-align: center;" | read project
tasks hidden
| style="text-align: center;" | read project & task
add time on assigned tasks
|-
| Create/Modify
| style="text-align: center;" | able to create new task
could not see it
| style="text-align: center;" | able to create new task
but impossible to allocate to me
could not see it
| style="text-align: center;" | able to create new task
could not see it
|-
| Delete
| style="text-align: center;" | to be tested
| style="text-align: center;" | to be tested
| style="text-align: center;" | to be tested
|-
| Read all
| colspan="4" style="text-align: center;" | to be tested
|-
| Create/Modify All
| colspan="4" style="text-align: center;" | to be tested
|-
| Delete All
| colspan="4" style="text-align: center;" | to be tested
|}

I have made tests for all cells which contains information and I think this module needs to be fully reviewed regarding the permissions.
Previously , the page was providing the following informations regarding actions :
See file [[File:Project.odg]] that describe different conditions to realize different actions of module.
[[File:Project_right_access.png|200px]]
== Create a project ==
Creation of a new project is done from menu "New project" on main menu "Project"
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.
However this information needs to be double checked and completed using the table above.

{{ToComplete}}

= Examples of use cases =
{{ToComplete}}
{{ExamplesCaseEn
|name=UCMP01:
|situation=
|actions=
}} 

Module Projects

2017-02-02T12:52:55Z

Bgenere: /* Introduction */

[[Category:Project]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Project|
num=400|
devdoc=[[Module Projects (developer)]]|
userdoc=This page|}}

= 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 [[Module Commercial Proposals|commercial proposals]], [[Module Customers Orders|customers orders]] or [[Module Customers Invoices|customers invoices]]).

Current documentation applies to 4.0.4 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 =
{{NoInstallModuleEn}}

= Configuration =
{{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.

= Usage =
The module is available from the '''Projects''' icon available in Dolibarr top menu.

Note that the left menu display two sets of options :
# to access your own projects and tasks. These are projects and task you have been assigned to.
# to access shared projects and tasks. These are projects and task readable by you (even if you are not assigned to). Depending on your permission, access to this view may be restricted.

= Entities and Business rules =
== Project entity ==
This is the root object added by the module.
=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the project.
|
|-
! scope="row" | Visibility
| This property define the users permissions.
|
*''Project Contacts'', the project is only available to users associated.
*''Everybody'', the project is shared (public).
|-
! scope="row" | Status
| Current status of the project, updated by the project workflow.
|
* Draft
* Open
* Closed
|-
! scope="row" | Start date
| Starting date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | End date
| Ending date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | Opportunity status
| Value selected from the "Opportunity status for project/lead" dictionary.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity probability
| The percentage associated to the Opportunity status, could be updated manually.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity amount
| Amount of the opportunity in default currency.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Budget
| Amount of the budget required for the project in default currency (if any).
|
|-
! scope="row" | Description
| A text to describe your project.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the project.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the project.
|
|}
=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%"| Description
! scope="Note" | Notes
|-
! scope="row" | Users
| You could allocate multiple users to a project, specifying a role. Two roles are defined by default, but you could extend it if needed.
| There is no limitation to number of users linked, even with the same role.
|-
! scope="row" | Contacts
| You could allocate multiple contacts - from different third parties - to a project, specifying a role. Two roles are defined by default, but you could extend it if needed
| There is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
|-
! scope="row" | Documents
| You could upload multiple document files and link them to a project.
| Document could also be generated using templates, see [[Module_Projects#Set-up_options | Set-up Options]] to activate the templates.
|-
! scope="row" | URL
| You could attach multiple URL links to a project.
|-
! scope="row" | Commercial proposal
| You could attach multiple proposals to a project.
| You could create the proposal from the project overview tab.
|-
! scope="row" | Customer order
| You could attach multiple customer orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Customer invoice
| You could attach multiple customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Customer template invoice
| You could attach multiple template customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Supplier order
| You could attach multiple supplier orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Supplier invoice
| You could attach multiple supplier invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Contract
| You could attach multiple contracts to a project.
| You could create the contract from the project overview tab.
|-
! scope="row" | Expense report
| You could attach multiple expense report to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Event
| You could attach multiple events to a project.
| You could create the event from the project overview tab. The Agenda module should be activated.
|-
! scope="row" | Task
| You could attach multiple tasks to a project. See below the tasks properties.
| The option to manage tasks in a project should be properly activated, see [[Module_Projects#Set-up_options | Set-up Options]]
|}

== Task entity ==
This is the child entity of the project entity. It is possible to create a hierarchy of tasks, the project being the root of the tree.

=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the task.
|
|-
! scope="row" | Child of project/task
| By default the current project but could be changed to an other project task to create a tasks hierarchy.
|
|-
! scope="row" | Assigned to
| The user responsible of the task.
| By default the task creator.
|-
! scope="row" | Start date
| Starting date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | End date
| Ending date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | Planned workload
| Planned workload to complete the task in hours and minutes.
|
|-
! scope="row" | Declared progress
| A percentage to be updated manually.
| Could also be updated when capturing time spend on task.
|-
! scope="row" | Description
| A text to describe your task.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the task.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the task.
|
|}

=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%"| Description
! scope="Note" | Notes
|-
! scope="row" | Users
| You could allocate multiple users to a task, specifying a role. Two roles are defined by default, but you could extend it if needed.
| There is no limitation to number of users linked, even with the same role.
|-
! scope="row" | Contacts
| You could allocate multiple contacts - from different third parties - to a task, specifying a role. Two roles are defined by default, but you could extend it if needed
| There is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
|-
! scope="row" | Documents
| You could upload multiple document files and link them to a project.
| Document could also be generated using ODT templates, see [[Module_Projects#Set-up_options | Set-up Options]] to activate the templates.
|-
! scope="row" | URL
| You could attach multiple URL links to a project.
|-
! scope="row" | Time spent
| You could attach multiple time spent slot to a task.
| See the entity attributes below for more details.
|-
! scope="row" | Task
| You could attach multiple tasks to a task by using it as a parent task.
|
|}

== Time spent record ==
These records allows to capture the time spent by a user on a task at a given time.

The time spent could be entered from different points:
* using the tab dedicated in the task form
* using the "New time spent" option in the module left menu.

In both cases you could enter time spend by day, but the menu option allows also to enter time spend by week. In this case you could only enter one time slot by day.
=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Start Date and Time
| Define when the time has been spent.
| Time is not available when you enter the data by weeks.
|-
! scope="row" | Duration
| Hours and minutes spent on the task.
| This is mandatory to create a record
|-
! scope="row" | Note
| A small text to comment what was done or how time was spent.
| Note is not available when you enter the data by weeks.
|-
! scope="row" | Done by
| The user who has spent time on the task.
| The user should be assigned to the task to enter a time spent record
|}

=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%" class="unsortable" | Description
! scope="Note" class="unsortable" | Notes
|-
! scope="row" | Users
| One and only one user is linked to a time spent record
| The user should be linked to the task, to create the record.
|-
! scope="row" | Task
| One and only one task is linked to a time spent record
|
|}

== Project visibility and user actions ==
This module allow to share projects and task across users. Each user could interact based on :
*Permissions allowed
*Project visibility
*Assignment to project

The following table try to summarize actions available based on these factors.

{| class="wikitable"
! rowspan="2" colspan="2" style="text-align: center;" | User
! colspan="4" style="text-align: center;" | Project
|-
| colspan="2" style="text-align: center;" | Not Shared
| colspan="2" style="text-align: center;" | Shared
|-
| colspan="2" style="text-align: center;" | Status
| style="text-align: center;" | user not assigned to project
| style="text-align: center;" | user assigned to project
| style="text-align: center;" | user not assigned to project
| style="text-align: center;" | user assigned to project
|-
| rowspan="6" | Permission
| Read
| rowspan="3" style="text-align: center;" | Project hidden
| style="text-align: center;" | read project
tasks hidden
could not add time spent
| style="text-align: center;" | read project
tasks hidden
| style="text-align: center;" | read project
tasks hidden
could not add time spent
|-
| Create/Modify
| style="text-align: center;" | able to create new task
could not see it
| style="text-align: center;" | able to create new task
but impossible to allocate to me
could not see it
| style="text-align: center;" | able to create new task
could not see it
|-
| Delete
| style="text-align: center;" | to be tested
| style="text-align: center;" | to be tested
| style="text-align: center;" | to be tested
|-
| Read all
| colspan="4" style="text-align: center;" | to be tested
|-
| Create/Modify All
| colspan="4" style="text-align: center;" | to be tested
|-
| Delete All
| colspan="4" style="text-align: center;" | to be tested
|}

I have made tests for all cells which contains information and I think this module needs to be fully reviewed regarding the permissions.
Previously , the page was providing the following informations regarding actions :
See file [[File:Project.odg]] that describe different conditions to realize different actions of module.
[[File:Project_right_access.png|200px]]
== Create a project ==
Creation of a new project is done from menu "New project" on main menu "Project"
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.
However this information needs to be double checked and completed using the table above.

{{ToComplete}}

= Examples of use cases =
{{ToComplete}}
{{ExamplesCaseEn
|name=UCMP01:
|situation=
|actions=
}} 

Module Projects

2017-01-09T09:59:23Z

Bgenere: /* Project visibility and user actions */ center text

[[Category:Project]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Project|
num=400|
devdoc=[[Module Projects (developer)]]|
userdoc=This page|}}

= 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 [[Module Commercial Proposals|commercial proposals]], [[Module Customers Orders|customers orders]] or [[Module Customers Invoices|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 =
{{NoInstallModuleEn}}

= Configuration =
{{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.

= Usage =
The module is available from the '''Projects''' icon available in Dolibarr top menu.

Note that the left menu display two sets of options :
# to access your own projects and tasks. These are projects and task you have been assigned to.
# to access shared projects and tasks. These are projects and task readable by you (even if you are not assigned to). Depending on your permission, access to this view may be restricted.

= Entities and Business rules =
== Project entity ==
This is the root object added by the module.
=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the project.
|
|-
! scope="row" | Visibility
| This property define the users permissions.
|
*''Project Contacts'', the project is only available to users associated.
*''Everybody'', the project is shared (public).
|-
! scope="row" | Status
| Current status of the project, updated by the project workflow.
|
* Draft
* Open
* Closed
|-
! scope="row" | Start date
| Starting date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | End date
| Ending date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | Opportunity status
| Value selected from the "Opportunity status for project/lead" dictionary.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity probability
| The percentage associated to the Opportunity status, could be updated manually.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity amount
| Amount of the opportunity in default currency.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Budget
| Amount of the budget required for the project in default currency (if any).
|
|-
! scope="row" | Description
| A text to describe your project.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the project.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the project.
|
|}
=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%"| Description
! scope="Note" | Notes
|-
! scope="row" | Users
| You could allocate multiple users to a project, specifying a role. Two roles are defined by default, but you could extend it if needed.
| There is no limitation to number of users linked, even with the same role.
|-
! scope="row" | Contacts
| You could allocate multiple contacts - from different third parties - to a project, specifying a role. Two roles are defined by default, but you could extend it if needed
| There is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
|-
! scope="row" | Documents
| You could upload multiple document files and link them to a project.
| Document could also be generated using templates, see [[Module_Projects#Set-up_options | Set-up Options]] to activate the templates.
|-
! scope="row" | URL
| You could attach multiple URL links to a project.
|-
! scope="row" | Commercial proposal
| You could attach multiple proposals to a project.
| You could create the proposal from the project overview tab.
|-
! scope="row" | Customer order
| You could attach multiple customer orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Customer invoice
| You could attach multiple customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Customer template invoice
| You could attach multiple template customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Supplier order
| You could attach multiple supplier orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Supplier invoice
| You could attach multiple supplier invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Contract
| You could attach multiple contracts to a project.
| You could create the contract from the project overview tab.
|-
! scope="row" | Expense report
| You could attach multiple expense report to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Event
| You could attach multiple events to a project.
| You could create the event from the project overview tab. The Agenda module should be activated.
|-
! scope="row" | Task
| You could attach multiple tasks to a project. See below the tasks properties.
| The option to manage tasks in a project should be properly activated, see [[Module_Projects#Set-up_options | Set-up Options]]
|}

== Task entity ==
This is the child entity of the project entity. It is possible to create a hierarchy of tasks, the project being the root of the tree.

=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the task.
|
|-
! scope="row" | Child of project/task
| By default the current project but could be changed to an other project task to create a tasks hierarchy.
|
|-
! scope="row" | Assigned to
| The user responsible of the task.
| By default the task creator.
|-
! scope="row" | Start date
| Starting date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | End date
| Ending date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | Planned workload
| Planned workload to complete the task in hours and minutes.
|
|-
! scope="row" | Declared progress
| A percentage to be updated manually.
| Could also be updated when capturing time spend on task.
|-
! scope="row" | Description
| A text to describe your task.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the task.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the task.
|
|}

=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%"| Description
! scope="Note" | Notes
|-
! scope="row" | Users
| You could allocate multiple users to a task, specifying a role. Two roles are defined by default, but you could extend it if needed.
| There is no limitation to number of users linked, even with the same role.
|-
! scope="row" | Contacts
| You could allocate multiple contacts - from different third parties - to a task, specifying a role. Two roles are defined by default, but you could extend it if needed
| There is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
|-
! scope="row" | Documents
| You could upload multiple document files and link them to a project.
| Document could also be generated using ODT templates, see [[Module_Projects#Set-up_options | Set-up Options]] to activate the templates.
|-
! scope="row" | URL
| You could attach multiple URL links to a project.
|-
! scope="row" | Time spent
| You could attach multiple time spent slot to a task.
| See the entity attributes below for more details.
|-
! scope="row" | Task
| You could attach multiple tasks to a task by using it as a parent task.
|
|}

== Time spent record ==
These records allows to capture the time spent by a user on a task at a given time.

The time spent could be entered from different points:
* using the tab dedicated in the task form
* using the "New time spent" option in the module left menu.

In both cases you could enter time spend by day, but the menu option allows also to enter time spend by week. In this case you could only enter one time slot by day.
=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Start Date and Time
| Define when the time has been spent.
| Time is not available when you enter the data by weeks.
|-
! scope="row" | Duration
| Hours and minutes spent on the task.
| This is mandatory to create a record
|-
! scope="row" | Note
| A small text to comment what was done or how time was spent.
| Note is not available when you enter the data by weeks.
|-
! scope="row" | Done by
| The user who has spent time on the task.
| The user should be assigned to the task to enter a time spent record
|}

=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%" class="unsortable" | Description
! scope="Note" class="unsortable" | Notes
|-
! scope="row" | Users
| One and only one user is linked to a time spent record
| The user should be linked to the task, to create the record.
|-
! scope="row" | Task
| One and only one task is linked to a time spent record
|
|}

== Project visibility and user actions ==
This module allow to share projects and task across users. Each user could interact based on :
*Permissions allowed
*Project visibility
*Assignment to project

The following table try to summarize actions available based on these factors.

{| class="wikitable"
! rowspan="2" colspan="2" style="text-align: center;" | User
! colspan="4" style="text-align: center;" | Project
|-
| colspan="2" style="text-align: center;" | Not Shared
| colspan="2" style="text-align: center;" | Shared
|-
| colspan="2" style="text-align: center;" | Status
| style="text-align: center;" | not a project user
| style="text-align: center;" | is a project user
| style="text-align: center;" | not a project user
| style="text-align: center;" | is a project user
|-
| rowspan="6" | Permission
| Read
| rowspan="3" style="text-align: center;" | Project hidden
| style="text-align: center;" | read project
tasks hidden
could not add time spent
| style="text-align: center;" | read project
tasks hidden
| style="text-align: center;" | read project
tasks hidden
could not add time spent
|-
| Create/Modify
| style="text-align: center;" | able to create new task
could not see it
| style="text-align: center;" | able to create new task
but impossible to allocate to me
could not see it
| style="text-align: center;" | able to create new task
could not see it
|-
| Delete
| style="text-align: center;" | to be tested
| style="text-align: center;" | to be tested
| style="text-align: center;" | to be tested
|-
| Read all
| colspan="4" style="text-align: center;" | to be tested
|-
| Create/Modify All
| colspan="4" style="text-align: center;" | to be tested
|-
| Delete All
| colspan="4" style="text-align: center;" | to be tested
|}

I have made tests for all cells which contains information and I think this module needs to be fully reviewed regarding the permissions.
Previously , the page was providing the following informations regarding actions :
See file [[File:Project.odg]] that describe different conditions to realize different actions of module.
[[File:Project_right_access.png|200px]]
== Create a project ==
Creation of a new project is done from menu "New project" on main menu "Project"
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.
However this information needs to be double checked and completed using the table above.

{{ToComplete}}

= Examples of use cases =
{{ToComplete}}
{{ExamplesCaseEn
|name=UCMP01:
|situation=
|actions=
}} 

Module Projects

2017-01-05T17:24:34Z

Bgenere: /* Project visibility and user actions */

[[Category:Project]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Project|
num=400|
devdoc=[[Module Projects (developer)]]|
userdoc=This page|}}

= 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 [[Module Commercial Proposals|commercial proposals]], [[Module Customers Orders|customers orders]] or [[Module Customers Invoices|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 =
{{NoInstallModuleEn}}

= Configuration =
{{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.

= Usage =
The module is available from the '''Projects''' icon available in Dolibarr top menu.

Note that the left menu display two sets of options :
# to access your own projects and tasks. These are projects and task you have been assigned to.
# to access shared projects and tasks. These are projects and task readable by you (even if you are not assigned to). Depending on your permission, access to this view may be restricted.

= Entities and Business rules =
== Project entity ==
This is the root object added by the module.
=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the project.
|
|-
! scope="row" | Visibility
| This property define the users permissions.
|
*''Project Contacts'', the project is only available to users associated.
*''Everybody'', the project is shared (public).
|-
! scope="row" | Status
| Current status of the project, updated by the project workflow.
|
* Draft
* Open
* Closed
|-
! scope="row" | Start date
| Starting date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | End date
| Ending date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | Opportunity status
| Value selected from the "Opportunity status for project/lead" dictionary.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity probability
| The percentage associated to the Opportunity status, could be updated manually.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity amount
| Amount of the opportunity in default currency.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Budget
| Amount of the budget required for the project in default currency (if any).
|
|-
! scope="row" | Description
| A text to describe your project.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the project.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the project.
|
|}
=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%"| Description
! scope="Note" | Notes
|-
! scope="row" | Users
| You could allocate multiple users to a project, specifying a role. Two roles are defined by default, but you could extend it if needed.
| There is no limitation to number of users linked, even with the same role.
|-
! scope="row" | Contacts
| You could allocate multiple contacts - from different third parties - to a project, specifying a role. Two roles are defined by default, but you could extend it if needed
| There is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
|-
! scope="row" | Documents
| You could upload multiple document files and link them to a project.
| Document could also be generated using templates, see [[Module_Projects#Set-up_options | Set-up Options]] to activate the templates.
|-
! scope="row" | URL
| You could attach multiple URL links to a project.
|-
! scope="row" | Commercial proposal
| You could attach multiple proposals to a project.
| You could create the proposal from the project overview tab.
|-
! scope="row" | Customer order
| You could attach multiple customer orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Customer invoice
| You could attach multiple customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Customer template invoice
| You could attach multiple template customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Supplier order
| You could attach multiple supplier orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Supplier invoice
| You could attach multiple supplier invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Contract
| You could attach multiple contracts to a project.
| You could create the contract from the project overview tab.
|-
! scope="row" | Expense report
| You could attach multiple expense report to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Event
| You could attach multiple events to a project.
| You could create the event from the project overview tab. The Agenda module should be activated.
|-
! scope="row" | Task
| You could attach multiple tasks to a project. See below the tasks properties.
| The option to manage tasks in a project should be properly activated, see [[Module_Projects#Set-up_options | Set-up Options]]
|}

== Task entity ==
This is the child entity of the project entity. It is possible to create a hierarchy of tasks, the project being the root of the tree.

=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the task.
|
|-
! scope="row" | Child of project/task
| By default the current project but could be changed to an other project task to create a tasks hierarchy.
|
|-
! scope="row" | Assigned to
| The user responsible of the task.
| By default the task creator.
|-
! scope="row" | Start date
| Starting date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | End date
| Ending date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | Planned workload
| Planned workload to complete the task in hours and minutes.
|
|-
! scope="row" | Declared progress
| A percentage to be updated manually.
| Could also be updated when capturing time spend on task.
|-
! scope="row" | Description
| A text to describe your task.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the task.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the task.
|
|}

=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%"| Description
! scope="Note" | Notes
|-
! scope="row" | Users
| You could allocate multiple users to a task, specifying a role. Two roles are defined by default, but you could extend it if needed.
| There is no limitation to number of users linked, even with the same role.
|-
! scope="row" | Contacts
| You could allocate multiple contacts - from different third parties - to a task, specifying a role. Two roles are defined by default, but you could extend it if needed
| There is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
|-
! scope="row" | Documents
| You could upload multiple document files and link them to a project.
| Document could also be generated using ODT templates, see [[Module_Projects#Set-up_options | Set-up Options]] to activate the templates.
|-
! scope="row" | URL
| You could attach multiple URL links to a project.
|-
! scope="row" | Time spent
| You could attach multiple time spent slot to a task.
| See the entity attributes below for more details.
|-
! scope="row" | Task
| You could attach multiple tasks to a task by using it as a parent task.
|
|}

== Time spent record ==
These records allows to capture the time spent by a user on a task at a given time.

The time spent could be entered from different points:
* using the tab dedicated in the task form
* using the "New time spent" option in the module left menu.

In both cases you could enter time spend by day, but the menu option allows also to enter time spend by week. In this case you could only enter one time slot by day.
=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Start Date and Time
| Define when the time has been spent.
| Time is not available when you enter the data by weeks.
|-
! scope="row" | Duration
| Hours and minutes spent on the task.
| This is mandatory to create a record
|-
! scope="row" | Note
| A small text to comment what was done or how time was spent.
| Note is not available when you enter the data by weeks.
|-
! scope="row" | Done by
| The user who has spent time on the task.
| The user should be assigned to the task to enter a time spent record
|}

=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%" class="unsortable" | Description
! scope="Note" class="unsortable" | Notes
|-
! scope="row" | Users
| One and only one user is linked to a time spent record
| The user should be linked to the task, to create the record.
|-
! scope="row" | Task
| One and only one task is linked to a time spent record
|
|}

== Project visibility and user actions ==
This module allow to share projects and task across users. Each user could interact based on :
*Permissions allowed
*Project visibility
*Assignment to project

The following table try to summarize actions available based on these factors.

{| class="wikitable"
! rowspan="2" colspan="2" style="text-align: center;" | User
! colspan="4" style="text-align: center;" | Project
|-
| colspan="2" style="text-align: center;" | Not Shared
| colspan="2" style="text-align: center;" | Shared
|-
| colspan="2" | Status
| not a project user
| is a project user
| not a project user
| is a project user
|-
| rowspan="6" | Permission
| Read
| rowspan="3" style="text-align: center;" | Project hidden
| style="text-align: center;" | read project
tasks hidden
could not add time spent
| style="text-align: center;" | read project
tasks hidden
| style="text-align: center;" | read project
tasks hidden
could not add time spent
|-
| Create/Modify
| style="text-align: center;" | able to create new task
could not see it
| style="text-align: center;" | able to create new task
but impossible to allocate to me
could not see it
| style="text-align: center;" | able to create new task
could not see it
|-
| Delete
| style="text-align: center;" | to be tested
| style="text-align: center;" | to be tested
| style="text-align: center;" | to be tested
|-
| Read all
| colspan="4" style="text-align: center;" | to be tested
|-
| Create/Modify All
| colspan="4" style="text-align: center;" | to be tested
|-
| Delete All
| colspan="4" style="text-align: center;" | to be tested
|}

I have made tests for all cells which contains information and I think this module needs to be fully reviewed regarding the permissions.
Previously , the page was providing the following informations regarding actions :
See file [[File:Project.odg]] that describe different conditions to realize different actions of module.
[[File:Project_right_access.png|200px]]
== Create a project ==
Creation of a new project is done from menu "New project" on main menu "Project"
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.
However this information needs to be double checked and completed using the table above.

{{ToComplete}}

= Examples of use cases =
{{ToComplete}}
{{ExamplesCaseEn
|name=UCMP01:
|situation=
|actions=
}} 

Module Projects

2017-01-05T17:11:40Z

Bgenere: /* Workflow */ The information is not up to date with code behaviour. Need to define rules and fix the code according to the rules.

[[Category:Project]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Project|
num=400|
devdoc=[[Module Projects (developer)]]|
userdoc=This page|}}

= 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 [[Module Commercial Proposals|commercial proposals]], [[Module Customers Orders|customers orders]] or [[Module Customers Invoices|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 =
{{NoInstallModuleEn}}

= Configuration =
{{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.

= Usage =
The module is available from the '''Projects''' icon available in Dolibarr top menu.

Note that the left menu display two sets of options :
# to access your own projects and tasks. These are projects and task you have been assigned to.
# to access shared projects and tasks. These are projects and task readable by you (even if you are not assigned to). Depending on your permission, access to this view may be restricted.

= Entities and Business rules =
== Project entity ==
This is the root object added by the module.
=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the project.
|
|-
! scope="row" | Visibility
| This property define the users permissions.
|
*''Project Contacts'', the project is only available to users associated.
*''Everybody'', the project is shared (public).
|-
! scope="row" | Status
| Current status of the project, updated by the project workflow.
|
* Draft
* Open
* Closed
|-
! scope="row" | Start date
| Starting date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | End date
| Ending date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | Opportunity status
| Value selected from the "Opportunity status for project/lead" dictionary.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity probability
| The percentage associated to the Opportunity status, could be updated manually.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity amount
| Amount of the opportunity in default currency.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Budget
| Amount of the budget required for the project in default currency (if any).
|
|-
! scope="row" | Description
| A text to describe your project.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the project.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the project.
|
|}
=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%"| Description
! scope="Note" | Notes
|-
! scope="row" | Users
| You could allocate multiple users to a project, specifying a role. Two roles are defined by default, but you could extend it if needed.
| There is no limitation to number of users linked, even with the same role.
|-
! scope="row" | Contacts
| You could allocate multiple contacts - from different third parties - to a project, specifying a role. Two roles are defined by default, but you could extend it if needed
| There is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
|-
! scope="row" | Documents
| You could upload multiple document files and link them to a project.
| Document could also be generated using templates, see [[Module_Projects#Set-up_options | Set-up Options]] to activate the templates.
|-
! scope="row" | URL
| You could attach multiple URL links to a project.
|-
! scope="row" | Commercial proposal
| You could attach multiple proposals to a project.
| You could create the proposal from the project overview tab.
|-
! scope="row" | Customer order
| You could attach multiple customer orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Customer invoice
| You could attach multiple customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Customer template invoice
| You could attach multiple template customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Supplier order
| You could attach multiple supplier orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Supplier invoice
| You could attach multiple supplier invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Contract
| You could attach multiple contracts to a project.
| You could create the contract from the project overview tab.
|-
! scope="row" | Expense report
| You could attach multiple expense report to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Event
| You could attach multiple events to a project.
| You could create the event from the project overview tab. The Agenda module should be activated.
|-
! scope="row" | Task
| You could attach multiple tasks to a project. See below the tasks properties.
| The option to manage tasks in a project should be properly activated, see [[Module_Projects#Set-up_options | Set-up Options]]
|}

== Task entity ==
This is the child entity of the project entity. It is possible to create a hierarchy of tasks, the project being the root of the tree.

=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the task.
|
|-
! scope="row" | Child of project/task
| By default the current project but could be changed to an other project task to create a tasks hierarchy.
|
|-
! scope="row" | Assigned to
| The user responsible of the task.
| By default the task creator.
|-
! scope="row" | Start date
| Starting date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | End date
| Ending date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | Planned workload
| Planned workload to complete the task in hours and minutes.
|
|-
! scope="row" | Declared progress
| A percentage to be updated manually.
| Could also be updated when capturing time spend on task.
|-
! scope="row" | Description
| A text to describe your task.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the task.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the task.
|
|}

=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%"| Description
! scope="Note" | Notes
|-
! scope="row" | Users
| You could allocate multiple users to a task, specifying a role. Two roles are defined by default, but you could extend it if needed.
| There is no limitation to number of users linked, even with the same role.
|-
! scope="row" | Contacts
| You could allocate multiple contacts - from different third parties - to a task, specifying a role. Two roles are defined by default, but you could extend it if needed
| There is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
|-
! scope="row" | Documents
| You could upload multiple document files and link them to a project.
| Document could also be generated using ODT templates, see [[Module_Projects#Set-up_options | Set-up Options]] to activate the templates.
|-
! scope="row" | URL
| You could attach multiple URL links to a project.
|-
! scope="row" | Time spent
| You could attach multiple time spent slot to a task.
| See the entity attributes below for more details.
|-
! scope="row" | Task
| You could attach multiple tasks to a task by using it as a parent task.
|
|}

== Time spent record ==
These records allows to capture the time spent by a user on a task at a given time.

The time spent could be entered from different points:
* using the tab dedicated in the task form
* using the "New time spent" option in the module left menu.

In both cases you could enter time spend by day, but the menu option allows also to enter time spend by week. In this case you could only enter one time slot by day.
=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Start Date and Time
| Define when the time has been spent.
| Time is not available when you enter the data by weeks.
|-
! scope="row" | Duration
| Hours and minutes spent on the task.
| This is mandatory to create a record
|-
! scope="row" | Note
| A small text to comment what was done or how time was spent.
| Note is not available when you enter the data by weeks.
|-
! scope="row" | Done by
| The user who has spent time on the task.
| The user should be assigned to the task to enter a time spent record
|}

=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%" class="unsortable" | Description
! scope="Note" class="unsortable" | Notes
|-
! scope="row" | Users
| One and only one user is linked to a time spent record
| The user should be linked to the task, to create the record.
|-
! scope="row" | Task
| One and only one task is linked to a time spent record
|
|}

== Project visibility and user actions ==
This module allow to share projects and task across users. Each user could interact based on :
*Permissions allowed
*Project visibility
*Assignment to project

The following table try to summarize actions available based on these factors.

{| class="wikitable"
! rowspan="2" colspan="2" style="text-align: center;" | User
! colspan="4" style="text-align: center;" | Project
|-
| colspan="2" style="text-align: center;" | Not Shared
| colspan="2" style="text-align: center;" | Shared
|-
| colspan="2" | Status
| not a project user
| is a project user
| not a project user
| is a project user
|-
| rowspan="6" | Permission
| Read
| rowspan="3" style="text-align: center;" | Project hidden
| style="text-align: center;" | read project
tasks hidden
could not add time spent
| style="text-align: center;" | read project
tasks hidden
| style="text-align: center;" | read project
tasks hidden
could not add time spen
|-
| Create/Modify
| style="text-align: center;" | able to create new task
but could not see it
| style="text-align: center;" | able to create new task
but impossible to allocate to me
could not see it
| style="text-align: center;" | able to create new task
but could not see it
|-
| Delete
| style="text-align: center;" | to be tested
| style="text-align: center;" | to be tested
| style="text-align: center;" | to be tested
|-
| Read all
| colspan="4" style="text-align: center;" | to be tested
|-
| Create/Modify All
| colspan="4" style="text-align: center;" | to be tested
|-
| Delete All
| colspan="4" style="text-align: center;" | to be tested
|}

I have made tests for all cells which contains information and I think this module needs to be fully reviewed regarding the permissions.

{{ToComplete}}

The page was providing the following information regardind actions :
See file [[File:Project.odg]] that describe different conditions to realize different actions of module.
[[File:Project_right_access.png|200px]]
== Create a project ==
Creation of a new project is done from menu "New project" on main menu "Project"
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.
However this information needs to be double checked and completed using the table above.

{{ToComplete}}

= Examples of use cases =
{{ToComplete}}
{{ExamplesCaseEn
|name=UCMP01:
|situation=
|actions=
}} 

Module Projects

2017-01-05T17:04:16Z

Bgenere: /* Project visibility and user actions */

[[Category:Project]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Project|
num=400|
devdoc=[[Module Projects (developer)]]|
userdoc=This page|}}

= 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 [[Module Commercial Proposals|commercial proposals]], [[Module Customers Orders|customers orders]] or [[Module Customers Invoices|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 =
{{NoInstallModuleEn}}

= Configuration =
{{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.

= Usage =
The module is available from the '''Projects''' icon available in Dolibarr top menu.

Note that the left menu display two sets of options :
# to access your own projects and tasks. These are projects and task you have been assigned to.
# to access shared projects and tasks. These are projects and task readable by you (even if you are not assigned to). Depending on your permission, access to this view may be restricted.

= Entities and Business rules =
== Project entity ==
This is the root object added by the module.
=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the project.
|
|-
! scope="row" | Visibility
| This property define the users permissions.
|
*''Project Contacts'', the project is only available to users associated.
*''Everybody'', the project is shared (public).
|-
! scope="row" | Status
| Current status of the project, updated by the project workflow.
|
* Draft
* Open
* Closed
|-
! scope="row" | Start date
| Starting date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | End date
| Ending date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | Opportunity status
| Value selected from the "Opportunity status for project/lead" dictionary.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity probability
| The percentage associated to the Opportunity status, could be updated manually.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity amount
| Amount of the opportunity in default currency.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Budget
| Amount of the budget required for the project in default currency (if any).
|
|-
! scope="row" | Description
| A text to describe your project.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the project.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the project.
|
|}
=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%"| Description
! scope="Note" | Notes
|-
! scope="row" | Users
| You could allocate multiple users to a project, specifying a role. Two roles are defined by default, but you could extend it if needed.
| There is no limitation to number of users linked, even with the same role.
|-
! scope="row" | Contacts
| You could allocate multiple contacts - from different third parties - to a project, specifying a role. Two roles are defined by default, but you could extend it if needed
| There is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
|-
! scope="row" | Documents
| You could upload multiple document files and link them to a project.
| Document could also be generated using templates, see [[Module_Projects#Set-up_options | Set-up Options]] to activate the templates.
|-
! scope="row" | URL
| You could attach multiple URL links to a project.
|-
! scope="row" | Commercial proposal
| You could attach multiple proposals to a project.
| You could create the proposal from the project overview tab.
|-
! scope="row" | Customer order
| You could attach multiple customer orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Customer invoice
| You could attach multiple customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Customer template invoice
| You could attach multiple template customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Supplier order
| You could attach multiple supplier orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Supplier invoice
| You could attach multiple supplier invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Contract
| You could attach multiple contracts to a project.
| You could create the contract from the project overview tab.
|-
! scope="row" | Expense report
| You could attach multiple expense report to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Event
| You could attach multiple events to a project.
| You could create the event from the project overview tab. The Agenda module should be activated.
|-
! scope="row" | Task
| You could attach multiple tasks to a project. See below the tasks properties.
| The option to manage tasks in a project should be properly activated, see [[Module_Projects#Set-up_options | Set-up Options]]
|}

== Task entity ==
This is the child entity of the project entity. It is possible to create a hierarchy of tasks, the project being the root of the tree.

=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the task.
|
|-
! scope="row" | Child of project/task
| By default the current project but could be changed to an other project task to create a tasks hierarchy.
|
|-
! scope="row" | Assigned to
| The user responsible of the task.
| By default the task creator.
|-
! scope="row" | Start date
| Starting date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | End date
| Ending date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | Planned workload
| Planned workload to complete the task in hours and minutes.
|
|-
! scope="row" | Declared progress
| A percentage to be updated manually.
| Could also be updated when capturing time spend on task.
|-
! scope="row" | Description
| A text to describe your task.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the task.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the task.
|
|}

=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%"| Description
! scope="Note" | Notes
|-
! scope="row" | Users
| You could allocate multiple users to a task, specifying a role. Two roles are defined by default, but you could extend it if needed.
| There is no limitation to number of users linked, even with the same role.
|-
! scope="row" | Contacts
| You could allocate multiple contacts - from different third parties - to a task, specifying a role. Two roles are defined by default, but you could extend it if needed
| There is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
|-
! scope="row" | Documents
| You could upload multiple document files and link them to a project.
| Document could also be generated using ODT templates, see [[Module_Projects#Set-up_options | Set-up Options]] to activate the templates.
|-
! scope="row" | URL
| You could attach multiple URL links to a project.
|-
! scope="row" | Time spent
| You could attach multiple time spent slot to a task.
| See the entity attributes below for more details.
|-
! scope="row" | Task
| You could attach multiple tasks to a task by using it as a parent task.
|
|}

== Time spent record ==
These records allows to capture the time spent by a user on a task at a given time.

The time spent could be entered from different points:
* using the tab dedicated in the task form
* using the "New time spent" option in the module left menu.

In both cases you could enter time spend by day, but the menu option allows also to enter time spend by week. In this case you could only enter one time slot by day.
=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Start Date and Time
| Define when the time has been spent.
| Time is not available when you enter the data by weeks.
|-
! scope="row" | Duration
| Hours and minutes spent on the task.
| This is mandatory to create a record
|-
! scope="row" | Note
| A small text to comment what was done or how time was spent.
| Note is not available when you enter the data by weeks.
|-
! scope="row" | Done by
| The user who has spent time on the task.
| The user should be assigned to the task to enter a time spent record
|}

=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%" class="unsortable" | Description
! scope="Note" class="unsortable" | Notes
|-
! scope="row" | Users
| One and only one user is linked to a time spent record
| The user should be linked to the task, to create the record.
|-
! scope="row" | Task
| One and only one task is linked to a time spent record
|
|}

== Project visibility and user actions ==
This module allow to share projects and task across users. Each user could interact based on :
*Permissions allowed
*Project visibility
*Assignment to project

The following table try to summarize actions available based on these factors.

{| class="wikitable"
! rowspan="2" colspan="2" style="text-align: center;" | User
! colspan="4" style="text-align: center;" | Project
|-
| colspan="2" style="text-align: center;" | Not Shared
| colspan="2" style="text-align: center;" | Shared
|-
| colspan="2" | Status
| not a project user
| is a project user
| not a project user
| is a project user
|-
| rowspan="6" | Permission
| Read
| rowspan="3" style="text-align: center;" | Project hidden
| style="text-align: center;" | read project
tasks hidden
could not add time spent
| style="text-align: center;" | read project
tasks hidden
| style="text-align: center;" | read project
tasks hidden
could not add time spen
|-
| Create/Modify
| style="text-align: center;" | able to create new task
but could not see it
| style="text-align: center;" | able to create new task
but impossible to allocate to me
could not see it
| style="text-align: center;" | able to create new task
but could not see it
|-
| Delete
| style="text-align: center;" | to be tested
| style="text-align: center;" | to be tested
| style="text-align: center;" | to be tested
|-
| Read all
| colspan="4" style="text-align: center;" | to be tested
|-
| Create/Modify All
| colspan="4" style="text-align: center;" | to be tested
|-
| Delete All
| colspan="4" style="text-align: center;" | to be tested
|}

I have made tests for all cells which contains information and I think this module needs to be fully reviewed regarding the permissions.

{{ToComplete}}

= Workflow =

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

[[File:Project_right_access.png|200px]]

== 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 ==
{{ToComplete}}

== Remove a task ==
{{ToComplete}}

== Activity ==
Activities are time spent to work on tasks.

= Examples of use cases =
{{ToComplete}}
{{ExamplesCaseEn
|name=UCMP01:
|situation=
|actions=
}} 

Module Projects

2017-01-05T15:59:56Z

Bgenere: /* Workflow */

[[Category:Project]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Project|
num=400|
devdoc=[[Module Projects (developer)]]|
userdoc=This page|}}

= 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 [[Module Commercial Proposals|commercial proposals]], [[Module Customers Orders|customers orders]] or [[Module Customers Invoices|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 =
{{NoInstallModuleEn}}

= Configuration =
{{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.

= Usage =
The module is available from the '''Projects''' icon available in Dolibarr top menu.

Note that the left menu display two sets of options :
# to access your own projects and tasks. These are projects and task you have been assigned to.
# to access shared projects and tasks. These are projects and task readable by you (even if you are not assigned to). Depending on your permission, access to this view may be restricted.

= Entities and Business rules =
== Project entity ==
This is the root object added by the module.
=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the project.
|
|-
! scope="row" | Visibility
| This property define the users permissions.
|
*''Project Contacts'', the project is only available to users associated.
*''Everybody'', the project is shared (public).
|-
! scope="row" | Status
| Current status of the project, updated by the project workflow.
|
* Draft
* Open
* Closed
|-
! scope="row" | Start date
| Starting date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | End date
| Ending date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | Opportunity status
| Value selected from the "Opportunity status for project/lead" dictionary.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity probability
| The percentage associated to the Opportunity status, could be updated manually.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity amount
| Amount of the opportunity in default currency.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Budget
| Amount of the budget required for the project in default currency (if any).
|
|-
! scope="row" | Description
| A text to describe your project.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the project.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the project.
|
|}
=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%"| Description
! scope="Note" | Notes
|-
! scope="row" | Users
| You could allocate multiple users to a project, specifying a role. Two roles are defined by default, but you could extend it if needed.
| There is no limitation to number of users linked, even with the same role.
|-
! scope="row" | Contacts
| You could allocate multiple contacts - from different third parties - to a project, specifying a role. Two roles are defined by default, but you could extend it if needed
| There is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
|-
! scope="row" | Documents
| You could upload multiple document files and link them to a project.
| Document could also be generated using templates, see [[Module_Projects#Set-up_options | Set-up Options]] to activate the templates.
|-
! scope="row" | URL
| You could attach multiple URL links to a project.
|-
! scope="row" | Commercial proposal
| You could attach multiple proposals to a project.
| You could create the proposal from the project overview tab.
|-
! scope="row" | Customer order
| You could attach multiple customer orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Customer invoice
| You could attach multiple customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Customer template invoice
| You could attach multiple template customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Supplier order
| You could attach multiple supplier orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Supplier invoice
| You could attach multiple supplier invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Contract
| You could attach multiple contracts to a project.
| You could create the contract from the project overview tab.
|-
! scope="row" | Expense report
| You could attach multiple expense report to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Event
| You could attach multiple events to a project.
| You could create the event from the project overview tab. The Agenda module should be activated.
|-
! scope="row" | Task
| You could attach multiple tasks to a project. See below the tasks properties.
| The option to manage tasks in a project should be properly activated, see [[Module_Projects#Set-up_options | Set-up Options]]
|}

== Task entity ==
This is the child entity of the project entity. It is possible to create a hierarchy of tasks, the project being the root of the tree.

=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the task.
|
|-
! scope="row" | Child of project/task
| By default the current project but could be changed to an other project task to create a tasks hierarchy.
|
|-
! scope="row" | Assigned to
| The user responsible of the task.
| By default the task creator.
|-
! scope="row" | Start date
| Starting date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | End date
| Ending date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | Planned workload
| Planned workload to complete the task in hours and minutes.
|
|-
! scope="row" | Declared progress
| A percentage to be updated manually.
| Could also be updated when capturing time spend on task.
|-
! scope="row" | Description
| A text to describe your task.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the task.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the task.
|
|}

=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%"| Description
! scope="Note" | Notes
|-
! scope="row" | Users
| You could allocate multiple users to a task, specifying a role. Two roles are defined by default, but you could extend it if needed.
| There is no limitation to number of users linked, even with the same role.
|-
! scope="row" | Contacts
| You could allocate multiple contacts - from different third parties - to a task, specifying a role. Two roles are defined by default, but you could extend it if needed
| There is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
|-
! scope="row" | Documents
| You could upload multiple document files and link them to a project.
| Document could also be generated using ODT templates, see [[Module_Projects#Set-up_options | Set-up Options]] to activate the templates.
|-
! scope="row" | URL
| You could attach multiple URL links to a project.
|-
! scope="row" | Time spent
| You could attach multiple time spent slot to a task.
| See the entity attributes below for more details.
|-
! scope="row" | Task
| You could attach multiple tasks to a task by using it as a parent task.
|
|}

== Time spent record ==
These records allows to capture the time spent by a user on a task at a given time.

The time spent could be entered from different points:
* using the tab dedicated in the task form
* using the "New time spent" option in the module left menu.

In both cases you could enter time spend by day, but the menu option allows also to enter time spend by week. In this case you could only enter one time slot by day.
=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Start Date and Time
| Define when the time has been spent.
| Time is not available when you enter the data by weeks.
|-
! scope="row" | Duration
| Hours and minutes spent on the task.
| This is mandatory to create a record
|-
! scope="row" | Note
| A small text to comment what was done or how time was spent.
| Note is not available when you enter the data by weeks.
|-
! scope="row" | Done by
| The user who has spent time on the task.
| The user should be assigned to the task to enter a time spent record
|}

=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%" class="unsortable" | Description
! scope="Note" class="unsortable" | Notes
|-
! scope="row" | Users
| One and only one user is linked to a time spent record
| The user should be linked to the task, to create the record.
|-
! scope="row" | Task
| One and only one task is linked to a time spent record
|
|}

== Project visibility and user actions ==
This module allow to share projects and task across users. Each user could interact based on :
*Permissions allowed
*Project visibility
*Assignment to project

The following table try to summarize actions available based on these factors.

{{ToComplete}}
= Workflow =

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

[[File:Project_right_access.png|200px]]

== 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 ==
{{ToComplete}}

== Remove a task ==
{{ToComplete}}

== Activity ==
Activities are time spent to work on tasks.

= Examples of use cases =
{{ToComplete}}
{{ExamplesCaseEn
|name=UCMP01:
|situation=
|actions=
}} 

Module Projects

2017-01-05T15:41:08Z

Bgenere: /* Links */

[[Category:Project]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Project|
num=400|
devdoc=[[Module Projects (developer)]]|
userdoc=This page|}}

= 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 [[Module Commercial Proposals|commercial proposals]], [[Module Customers Orders|customers orders]] or [[Module Customers Invoices|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 =
{{NoInstallModuleEn}}

= Configuration =
{{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.

= Usage =
The module is available from the '''Projects''' icon available in Dolibarr top menu.

Note that the left menu display two sets of options :
# to access your own projects and tasks. These are projects and task you have been assigned to.
# to access shared projects and tasks. These are projects and task readable by you (even if you are not assigned to). Depending on your permission, access to this view may be restricted.

= Entities and Business rules =
== Project entity ==
This is the root object added by the module.
=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the project.
|
|-
! scope="row" | Visibility
| This property define the users permissions.
|
*''Project Contacts'', the project is only available to users associated.
*''Everybody'', the project is shared (public).
|-
! scope="row" | Status
| Current status of the project, updated by the project workflow.
|
* Draft
* Open
* Closed
|-
! scope="row" | Start date
| Starting date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | End date
| Ending date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | Opportunity status
| Value selected from the "Opportunity status for project/lead" dictionary.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity probability
| The percentage associated to the Opportunity status, could be updated manually.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity amount
| Amount of the opportunity in default currency.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Budget
| Amount of the budget required for the project in default currency (if any).
|
|-
! scope="row" | Description
| A text to describe your project.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the project.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the project.
|
|}
=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%"| Description
! scope="Note" | Notes
|-
! scope="row" | Users
| You could allocate multiple users to a project, specifying a role. Two roles are defined by default, but you could extend it if needed.
| There is no limitation to number of users linked, even with the same role.
|-
! scope="row" | Contacts
| You could allocate multiple contacts - from different third parties - to a project, specifying a role. Two roles are defined by default, but you could extend it if needed
| There is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
|-
! scope="row" | Documents
| You could upload multiple document files and link them to a project.
| Document could also be generated using templates, see [[Module_Projects#Set-up_options | Set-up Options]] to activate the templates.
|-
! scope="row" | URL
| You could attach multiple URL links to a project.
|-
! scope="row" | Commercial proposal
| You could attach multiple proposals to a project.
| You could create the proposal from the project overview tab.
|-
! scope="row" | Customer order
| You could attach multiple customer orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Customer invoice
| You could attach multiple customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Customer template invoice
| You could attach multiple template customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Supplier order
| You could attach multiple supplier orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Supplier invoice
| You could attach multiple supplier invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Contract
| You could attach multiple contracts to a project.
| You could create the contract from the project overview tab.
|-
! scope="row" | Expense report
| You could attach multiple expense report to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Event
| You could attach multiple events to a project.
| You could create the event from the project overview tab. The Agenda module should be activated.
|-
! scope="row" | Task
| You could attach multiple tasks to a project. See below the tasks properties.
| The option to manage tasks in a project should be properly activated, see [[Module_Projects#Set-up_options | Set-up Options]]
|}

== Task entity ==
This is the child entity of the project entity. It is possible to create a hierarchy of tasks, the project being the root of the tree.

=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the task.
|
|-
! scope="row" | Child of project/task
| By default the current project but could be changed to an other project task to create a tasks hierarchy.
|
|-
! scope="row" | Assigned to
| The user responsible of the task.
| By default the task creator.
|-
! scope="row" | Start date
| Starting date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | End date
| Ending date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | Planned workload
| Planned workload to complete the task in hours and minutes.
|
|-
! scope="row" | Declared progress
| A percentage to be updated manually.
| Could also be updated when capturing time spend on task.
|-
! scope="row" | Description
| A text to describe your task.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the task.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the task.
|
|}

=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%"| Description
! scope="Note" | Notes
|-
! scope="row" | Users
| You could allocate multiple users to a task, specifying a role. Two roles are defined by default, but you could extend it if needed.
| There is no limitation to number of users linked, even with the same role.
|-
! scope="row" | Contacts
| You could allocate multiple contacts - from different third parties - to a task, specifying a role. Two roles are defined by default, but you could extend it if needed
| There is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
|-
! scope="row" | Documents
| You could upload multiple document files and link them to a project.
| Document could also be generated using ODT templates, see [[Module_Projects#Set-up_options | Set-up Options]] to activate the templates.
|-
! scope="row" | URL
| You could attach multiple URL links to a project.
|-
! scope="row" | Time spent
| You could attach multiple time spent slot to a task.
| See the entity attributes below for more details.
|-
! scope="row" | Task
| You could attach multiple tasks to a task by using it as a parent task.
|
|}

== Time spent record ==
These records allows to capture the time spent by a user on a task at a given time.

The time spent could be entered from different points:
* using the tab dedicated in the task form
* using the "New time spent" option in the module left menu.

In both cases you could enter time spend by day, but the menu option allows also to enter time spend by week. In this case you could only enter one time slot by day.
=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Start Date and Time
| Define when the time has been spent.
| Time is not available when you enter the data by weeks.
|-
! scope="row" | Duration
| Hours and minutes spent on the task.
| This is mandatory to create a record
|-
! scope="row" | Note
| A small text to comment what was done or how time was spent.
| Note is not available when you enter the data by weeks.
|-
! scope="row" | Done by
| The user who has spent time on the task.
| The user should be assigned to the task to enter a time spent record
|}

=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%" class="unsortable" | Description
! scope="Note" class="unsortable" | Notes
|-
! scope="row" | Users
| One and only one user is linked to a time spent record
| The user should be linked to the task, to create the record.
|-
! scope="row" | Task
| One and only one task is linked to a time spent record
|
|}

= Workflow =

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

[[File:Project_right_access.png|200px]]

== 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 ==
{{ToComplete}}

== Remove a task ==
{{ToComplete}}

== Activity ==
Activities are time spent to work on tasks.

= Examples of use cases =
{{ToComplete}}
{{ExamplesCaseEn
|name=UCMP01:
|situation=
|actions=
}} 

Module Projects

2017-01-05T15:35:01Z

Bgenere: /* Properties */

[[Category:Project]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Project|
num=400|
devdoc=[[Module Projects (developer)]]|
userdoc=This page|}}

= 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 [[Module Commercial Proposals|commercial proposals]], [[Module Customers Orders|customers orders]] or [[Module Customers Invoices|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 =
{{NoInstallModuleEn}}

= Configuration =
{{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.

= Usage =
The module is available from the '''Projects''' icon available in Dolibarr top menu.

Note that the left menu display two sets of options :
# to access your own projects and tasks. These are projects and task you have been assigned to.
# to access shared projects and tasks. These are projects and task readable by you (even if you are not assigned to). Depending on your permission, access to this view may be restricted.

= Entities and Business rules =
== Project entity ==
This is the root object added by the module.
=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the project.
|
|-
! scope="row" | Visibility
| This property define the users permissions.
|
*''Project Contacts'', the project is only available to users associated.
*''Everybody'', the project is shared (public).
|-
! scope="row" | Status
| Current status of the project, updated by the project workflow.
|
* Draft
* Open
* Closed
|-
! scope="row" | Start date
| Starting date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | End date
| Ending date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | Opportunity status
| Value selected from the "Opportunity status for project/lead" dictionary.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity probability
| The percentage associated to the Opportunity status, could be updated manually.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity amount
| Amount of the opportunity in default currency.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Budget
| Amount of the budget required for the project in default currency (if any).
|
|-
! scope="row" | Description
| A text to describe your project.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the project.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the project.
|
|}
=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%"| Description
! scope="Note" | Notes
|-
! scope="row" | Users
| You could allocate multiple users to a project, specifying a role. Two roles are defined by default, but you could extend it if needed.
| There is no limitation to number of users linked, even with the same role.
|-
! scope="row" | Contacts
| You could allocate multiple contacts - from different third parties - to a project, specifying a role. Two roles are defined by default, but you could extend it if needed
| There is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
|-
! scope="row" | Documents
| You could upload multiple document files and link them to a project.
| Document could also be generated using templates, see [[Module_Projects#Set-up_options | Set-up Options]] to activate the templates.
|-
! scope="row" | URL
| You could attach multiple URL links to a project.
|-
! scope="row" | Commercial proposal
| You could attach multiple proposals to a project.
| You could create the proposal from the project overview tab.
|-
! scope="row" | Customer order
| You could attach multiple customer orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Customer invoice
| You could attach multiple customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Customer template invoice
| You could attach multiple template customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Supplier order
| You could attach multiple supplier orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Supplier invoice
| You could attach multiple supplier invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Contract
| You could attach multiple contracts to a project.
| You could create the contract from the project overview tab.
|-
! scope="row" | Expense report
| You could attach multiple expense report to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Event
| You could attach multiple events to a project.
| You could create the event from the project overview tab. The Agenda module should be activated.
|-
! scope="row" | Task
| You could attach multiple tasks to a project. See below the tasks properties.
| The option to manage tasks in a project should be properly activated, see [[Module_Projects#Set-up_options | Set-up Options]]
|}

== Task entity ==
This is the child entity of the project entity. It is possible to create a hierarchy of tasks, the project being the root of the tree.

=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the task.
|
|-
! scope="row" | Child of project/task
| By default the current project but could be changed to an other project task to create a tasks hierarchy.
|
|-
! scope="row" | Assigned to
| The user responsible of the task.
| By default the task creator.
|-
! scope="row" | Start date
| Starting date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | End date
| Ending date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | Planned workload
| Planned workload to complete the task in hours and minutes.
|
|-
! scope="row" | Declared progress
| A percentage to be updated manually.
| Could also be updated when capturing time spend on task.
|-
! scope="row" | Description
| A text to describe your task.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the task.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the task.
|
|}

=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%"| Description
! scope="Note" | Notes
|-
! scope="row" | Users
| You could allocate multiple users to a task, specifying a role. Two roles are defined by default, but you could extend it if needed.
| There is no limitation to number of users linked, even with the same role.
|-
! scope="row" | Contacts
| You could allocate multiple contacts - from different third parties - to a task, specifying a role. Two roles are defined by default, but you could extend it if needed
| There is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
|-
! scope="row" | Documents
| You could upload multiple document files and link them to a project.
| Document could also be generated using ODT templates, see [[Module_Projects#Set-up_options | Set-up Options]] to activate the templates.
|-
! scope="row" | URL
| You could attach multiple URL links to a project.
|-
! scope="row" | Time spent
| You could attach multiple time spent slot to a task.
| See the entity attributes below for more details.
|-
! scope="row" | Task
| You could attach multiple tasks to a task by using it as a parent task.
|
|}

== Time spent record ==
These records allows to capture the time spent by a user on a task at a given time.

The time spent could be entered from different points:
* using the tab dedicated in the task form
* using the "New time spent" option in the module left menu.

In both cases you could enter time spend by day, but the menu option allows also to enter time spend by week. In this case you could only enter one time slot by day.
=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Start Date and Time
| Define when the time has been spent.
| Time is not available when you enter the data by weeks.
|-
! scope="row" | Duration
| Hours and minutes spent on the task.
| This is mandatory to create a record
|-
! scope="row" | Note
| A small text to comment what was done or how time was spent.
| Note is not available when you enter the data by weeks.
|-
! scope="row" | Done by
| The user who has spent time on the task.
| The user should be assigned to the task to enter a time spent record
|}

=== Links ===

= Workflow =

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

[[File:Project_right_access.png|200px]]

== 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 ==
{{ToComplete}}

== Remove a task ==
{{ToComplete}}

== Activity ==
Activities are time spent to work on tasks.

= Examples of use cases =
{{ToComplete}}
{{ExamplesCaseEn
|name=UCMP01:
|situation=
|actions=
}} 

Module Projects

2017-01-05T15:25:26Z

Bgenere: /* Time spent record */

[[Category:Project]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Project|
num=400|
devdoc=[[Module Projects (developer)]]|
userdoc=This page|}}

= 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 [[Module Commercial Proposals|commercial proposals]], [[Module Customers Orders|customers orders]] or [[Module Customers Invoices|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 =
{{NoInstallModuleEn}}

= Configuration =
{{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.

= Usage =
The module is available from the '''Projects''' icon available in Dolibarr top menu.

Note that the left menu display two sets of options :
# to access your own projects and tasks. These are projects and task you have been assigned to.
# to access shared projects and tasks. These are projects and task readable by you (even if you are not assigned to). Depending on your permission, access to this view may be restricted.

= Entities and Business rules =
== Project entity ==
This is the root object added by the module.
=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the project.
|
|-
! scope="row" | Visibility
| This property define the users permissions.
|
*''Project Contacts'', the project is only available to users associated.
*''Everybody'', the project is shared (public).
|-
! scope="row" | Status
| Current status of the project, updated by the project workflow.
|
* Draft
* Open
* Closed
|-
! scope="row" | Start date
| Starting date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | End date
| Ending date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | Opportunity status
| Value selected from the "Opportunity status for project/lead" dictionary.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity probability
| The percentage associated to the Opportunity status, could be updated manually.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity amount
| Amount of the opportunity in default currency.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Budget
| Amount of the budget required for the project in default currency (if any).
|
|-
! scope="row" | Description
| A text to describe your project.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the project.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the project.
|
|}
=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%"| Description
! scope="Note" | Notes
|-
! scope="row" | Users
| You could allocate multiple users to a project, specifying a role. Two roles are defined by default, but you could extend it if needed.
| There is no limitation to number of users linked, even with the same role.
|-
! scope="row" | Contacts
| You could allocate multiple contacts - from different third parties - to a project, specifying a role. Two roles are defined by default, but you could extend it if needed
| There is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
|-
! scope="row" | Documents
| You could upload multiple document files and link them to a project.
| Document could also be generated using templates, see [[Module_Projects#Set-up_options | Set-up Options]] to activate the templates.
|-
! scope="row" | URL
| You could attach multiple URL links to a project.
|-
! scope="row" | Commercial proposal
| You could attach multiple proposals to a project.
| You could create the proposal from the project overview tab.
|-
! scope="row" | Customer order
| You could attach multiple customer orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Customer invoice
| You could attach multiple customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Customer template invoice
| You could attach multiple template customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Supplier order
| You could attach multiple supplier orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Supplier invoice
| You could attach multiple supplier invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Contract
| You could attach multiple contracts to a project.
| You could create the contract from the project overview tab.
|-
! scope="row" | Expense report
| You could attach multiple expense report to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Event
| You could attach multiple events to a project.
| You could create the event from the project overview tab. The Agenda module should be activated.
|-
! scope="row" | Task
| You could attach multiple tasks to a project. See below the tasks properties.
| The option to manage tasks in a project should be properly activated, see [[Module_Projects#Set-up_options | Set-up Options]]
|}

== Task entity ==
This is the child entity of the project entity. It is possible to create a hierarchy of tasks, the project being the root of the tree.

=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the task.
|
|-
! scope="row" | Child of project/task
| By default the current project but could be changed to an other project task to create a tasks hierarchy.
|
|-
! scope="row" | Assigned to
| The user responsible of the task.
| By default the task creator.
|-
! scope="row" | Start date
| Starting date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | End date
| Ending date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | Planned workload
| Planned workload to complete the task in hours and minutes.
|
|-
! scope="row" | Declared progress
| A percentage to be updated manually.
| Could also be updated when capturing time spend on task.
|-
! scope="row" | Description
| A text to describe your task.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the task.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the task.
|
|}

=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%"| Description
! scope="Note" | Notes
|-
! scope="row" | Users
| You could allocate multiple users to a task, specifying a role. Two roles are defined by default, but you could extend it if needed.
| There is no limitation to number of users linked, even with the same role.
|-
! scope="row" | Contacts
| You could allocate multiple contacts - from different third parties - to a task, specifying a role. Two roles are defined by default, but you could extend it if needed
| There is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
|-
! scope="row" | Documents
| You could upload multiple document files and link them to a project.
| Document could also be generated using ODT templates, see [[Module_Projects#Set-up_options | Set-up Options]] to activate the templates.
|-
! scope="row" | URL
| You could attach multiple URL links to a project.
|-
! scope="row" | Time spent
| You could attach multiple time spent slot to a task.
| See the entity attributes below for more details.
|-
! scope="row" | Task
| You could attach multiple tasks to a task by using it as a parent task.
|
|}

== Time spent record ==
These records allows to capture the time spent by a user on a task at a given time.

The time spent could be entered from different points:
* using the tab dedicated in the task form
* using the "New time spent" option in the module left menu.

In both cases you could enter time spend by day, but the menu option allows also to enter time spend by week. In this case you could only enter one time slot by day.
=== Properties ===

=== Links ===

= Workflow =

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

[[File:Project_right_access.png|200px]]

== 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 ==
{{ToComplete}}

== Remove a task ==
{{ToComplete}}

== Activity ==
Activities are time spent to work on tasks.

= Examples of use cases =
{{ToComplete}}
{{ExamplesCaseEn
|name=UCMP01:
|situation=
|actions=
}} 

Module Projects

2017-01-05T15:17:02Z

Bgenere: /* Task entity */

[[Category:Project]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Project|
num=400|
devdoc=[[Module Projects (developer)]]|
userdoc=This page|}}

= 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 [[Module Commercial Proposals|commercial proposals]], [[Module Customers Orders|customers orders]] or [[Module Customers Invoices|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 =
{{NoInstallModuleEn}}

= Configuration =
{{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.

= Usage =
The module is available from the '''Projects''' icon available in Dolibarr top menu.

Note that the left menu display two sets of options :
# to access your own projects and tasks. These are projects and task you have been assigned to.
# to access shared projects and tasks. These are projects and task readable by you (even if you are not assigned to). Depending on your permission, access to this view may be restricted.

= Entities and Business rules =
== Project entity ==
This is the root object added by the module.
=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the project.
|
|-
! scope="row" | Visibility
| This property define the users permissions.
|
*''Project Contacts'', the project is only available to users associated.
*''Everybody'', the project is shared (public).
|-
! scope="row" | Status
| Current status of the project, updated by the project workflow.
|
* Draft
* Open
* Closed
|-
! scope="row" | Start date
| Starting date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | End date
| Ending date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | Opportunity status
| Value selected from the "Opportunity status for project/lead" dictionary.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity probability
| The percentage associated to the Opportunity status, could be updated manually.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity amount
| Amount of the opportunity in default currency.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Budget
| Amount of the budget required for the project in default currency (if any).
|
|-
! scope="row" | Description
| A text to describe your project.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the project.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the project.
|
|}
=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%"| Description
! scope="Note" | Notes
|-
! scope="row" | Users
| You could allocate multiple users to a project, specifying a role. Two roles are defined by default, but you could extend it if needed.
| There is no limitation to number of users linked, even with the same role.
|-
! scope="row" | Contacts
| You could allocate multiple contacts - from different third parties - to a project, specifying a role. Two roles are defined by default, but you could extend it if needed
| There is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
|-
! scope="row" | Documents
| You could upload multiple document files and link them to a project.
| Document could also be generated using templates, see [[Module_Projects#Set-up_options | Set-up Options]] to activate the templates.
|-
! scope="row" | URL
| You could attach multiple URL links to a project.
|-
! scope="row" | Commercial proposal
| You could attach multiple proposals to a project.
| You could create the proposal from the project overview tab.
|-
! scope="row" | Customer order
| You could attach multiple customer orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Customer invoice
| You could attach multiple customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Customer template invoice
| You could attach multiple template customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Supplier order
| You could attach multiple supplier orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Supplier invoice
| You could attach multiple supplier invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Contract
| You could attach multiple contracts to a project.
| You could create the contract from the project overview tab.
|-
! scope="row" | Expense report
| You could attach multiple expense report to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Event
| You could attach multiple events to a project.
| You could create the event from the project overview tab. The Agenda module should be activated.
|-
! scope="row" | Task
| You could attach multiple tasks to a project. See below the tasks properties.
| The option to manage tasks in a project should be properly activated, see [[Module_Projects#Set-up_options | Set-up Options]]
|}

== Task entity ==
This is the child entity of the project entity. It is possible to create a hierarchy of tasks, the project being the root of the tree.

=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the task.
|
|-
! scope="row" | Child of project/task
| By default the current project but could be changed to an other project task to create a tasks hierarchy.
|
|-
! scope="row" | Assigned to
| The user responsible of the task.
| By default the task creator.
|-
! scope="row" | Start date
| Starting date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | End date
| Ending date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | Planned workload
| Planned workload to complete the task in hours and minutes.
|
|-
! scope="row" | Declared progress
| A percentage to be updated manually.
| Could also be updated when capturing time spend on task.
|-
! scope="row" | Description
| A text to describe your task.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the task.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the task.
|
|}

=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%"| Description
! scope="Note" | Notes
|-
! scope="row" | Users
| You could allocate multiple users to a task, specifying a role. Two roles are defined by default, but you could extend it if needed.
| There is no limitation to number of users linked, even with the same role.
|-
! scope="row" | Contacts
| You could allocate multiple contacts - from different third parties - to a task, specifying a role. Two roles are defined by default, but you could extend it if needed
| There is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
|-
! scope="row" | Documents
| You could upload multiple document files and link them to a project.
| Document could also be generated using ODT templates, see [[Module_Projects#Set-up_options | Set-up Options]] to activate the templates.
|-
! scope="row" | URL
| You could attach multiple URL links to a project.
|-
! scope="row" | Time spent
| You could attach multiple time spent slot to a task.
| See the entity attributes below for more details.
|-
! scope="row" | Task
| You could attach multiple tasks to a task by using it as a parent task.
|
|}

== Time spent record ==

=== Properties ===

=== Links ===

= Workflow =

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

[[File:Project_right_access.png|200px]]

== 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 ==
{{ToComplete}}

== Remove a task ==
{{ToComplete}}

== Activity ==
Activities are time spent to work on tasks.

= Examples of use cases =
{{ToComplete}}
{{ExamplesCaseEn
|name=UCMP01:
|situation=
|actions=
}} 

Module Projects

2017-01-04T17:52:07Z

Bgenere: /* Links */ added to tasks

[[Category:Project]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Project|
num=400|
devdoc=[[Module Projects (developer)]]|
userdoc=This page|}}

= 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 [[Module Commercial Proposals|commercial proposals]], [[Module Customers Orders|customers orders]] or [[Module Customers Invoices|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 =
{{NoInstallModuleEn}}

= Configuration =
{{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.

= Usage =
The module is available from the '''Projects''' icon available in Dolibarr top menu.

Note that the left menu display two sets of options :
# to access your own projects and tasks. These are projects and task you have been assigned to.
# to access shared projects and tasks. These are projects and task readable by all users.

= Entities and Business rules =
== Project entity ==
This is the root object added by the module.
=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the project.
|
|-
! scope="row" | Visibility
| This property define the users permissions.
|
*''Project Contacts'', the project is only available to users associated.
*''Everybody'', the project is shared (public).
|-
! scope="row" | Status
| Current status of the project, updated by the project workflow.
|
* Draft
* Open
* Closed
|-
! scope="row" | Start date
| Starting date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | End date
| Ending date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | Opportunity status
| Value selected from the "Opportunity status for project/lead" dictionary.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity probability
| The percentage associated to the Opportunity status, could be updated manually.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity amount
| Amount of the opportunity in default currency.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Budget
| Amount of the budget required for the project in default currency (if any).
|
|-
! scope="row" | Description
| A text to describe your project.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the project.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the project.
|
|}
=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%"| Description
! scope="Note" | Notes
|-
! scope="row" | Users
| You could allocate multiple users to a project, specifying a role. Two roles are defined by default, but you could extend it if needed.
| There is no limitation to number of users linked, even with the same role.
|-
! scope="row" | Contacts
| You could allocate multiple contacts - from different third parties - to a project, specifying a role. Two roles are defined by default, but you could extend it if needed
| There is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
|-
! scope="row" | Documents
| You could upload multiple document files and link them to a project.
| Document could also be generated using templates, see [[Module_Projects#Set-up_options | Set-up Options]] to activate the templates.
|-
! scope="row" | URL
| You could attach multiple URL links to a project.
|-
! scope="row" | Commercial proposal
| You could attach multiple proposals to a project.
| You could create the proposal from the project overview tab.
|-
! scope="row" | Customer order
| You could attach multiple customer orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Customer invoice
| You could attach multiple customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Customer template invoice
| You could attach multiple template customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Supplier order
| You could attach multiple supplier orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Supplier invoice
| You could attach multiple supplier invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Contract
| You could attach multiple contracts to a project.
| You could create the contract from the project overview tab.
|-
! scope="row" | Expense report
| You could attach multiple expense report to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Event
| You could attach multiple events to a project.
| You could create the event from the project overview tab. The Agenda module should be activated.
|-
! scope="row" | Task
| You could attach multiple tasks to a project. See below the tasks properties.
| The option to manage tasks in a project should be properly activated, see [[Module_Projects#Set-up_options | Set-up Options]]
|}

== Task entity ==
This is the child entity of the project entity. It is possible to create a hierarchy of tasks, the project being the root of the tree.

=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the task.
|
|-
! scope="row" | Child of project/task
| By default the current project but could be changed to an other project task to create a tasks hierarchy.
|
|-
! scope="row" | Assigned to
| The user responsible of the task.
| By default the task creator.
|-
! scope="row" | Start date
| Starting date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | End date
| Ending date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | Planned workload
| Planned workload to complete the task in hours and minutes.
|
|-
! scope="row" | Declared progress
| A percentage to be updated manually.
| Could also be updated when capturing time spend on task.
|-
! scope="row" | Description
| A text to describe your task.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the task.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the task.
|
|}

=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%"| Description
! scope="Note" | Notes
|-
! scope="row" | Users
| You could allocate multiple users to a task, specifying a role. Two roles are defined by default, but you could extend it if needed.
| There is no limitation to number of users linked, even with the same role.
|-
! scope="row" | Contacts
| You could allocate multiple contacts - from different third parties - to a task, specifying a role. Two roles are defined by default, but you could extend it if needed
| There is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
|-
! scope="row" | Documents
| You could upload multiple document files and link them to a project.
| Document could also be generated using ODT templates, see [[Module_Projects#Set-up_options | Set-up Options]] to activate the templates.
|-
! scope="row" | URL
| You could attach multiple URL links to a project.
|-
! scope="row" | Time spent
| You could attach multiple time spent slot to a task.
| See the entity attributes below for more details.
|-
! scope="row" | Task
| You could attach multiple tasks to a task by using it as a parent task.
|
|}

= Workflow =

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

[[File:Project_right_access.png|200px]]

== 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 ==
{{ToComplete}}

== Remove a task ==
{{ToComplete}}

== Activity ==
Activities are time spent to work on tasks.

= Examples of use cases =
{{ToComplete}}
{{ExamplesCaseEn
|name=UCMP01:
|situation=
|actions=
}} 

Module Projects

2017-01-04T17:45:04Z

Bgenere: /* Properties */ added for task

[[Category:Project]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Project|
num=400|
devdoc=[[Module Projects (developer)]]|
userdoc=This page|}}

= 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 [[Module Commercial Proposals|commercial proposals]], [[Module Customers Orders|customers orders]] or [[Module Customers Invoices|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 =
{{NoInstallModuleEn}}

= Configuration =
{{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.

= Usage =
The module is available from the '''Projects''' icon available in Dolibarr top menu.

Note that the left menu display two sets of options :
# to access your own projects and tasks. These are projects and task you have been assigned to.
# to access shared projects and tasks. These are projects and task readable by all users.

= Entities and Business rules =
== Project entity ==
This is the root object added by the module.
=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the project.
|
|-
! scope="row" | Visibility
| This property define the users permissions.
|
*''Project Contacts'', the project is only available to users associated.
*''Everybody'', the project is shared (public).
|-
! scope="row" | Status
| Current status of the project, updated by the project workflow.
|
* Draft
* Open
* Closed
|-
! scope="row" | Start date
| Starting date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | End date
| Ending date for the project
| Could be any valid date in past or future. Note that no control is made between start and end date.
|-
! scope="row" | Opportunity status
| Value selected from the "Opportunity status for project/lead" dictionary.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity probability
| The percentage associated to the Opportunity status, could be updated manually.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Opportunity amount
| Amount of the opportunity in default currency.
| Only displayed when "Use projects to follow leads/opportunities" option is set-up.
|-
! scope="row" | Budget
| Amount of the budget required for the project in default currency (if any).
|
|-
! scope="row" | Description
| A text to describe your project.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the project.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the project.
|
|}
=== Links ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%"| Entity linked
! scope="Description" width="45%"| Description
! scope="Note" | Notes
|-
! scope="row" | Users
| You could allocate multiple users to a project, specifying a role. Two roles are defined by default, but you could extend it if needed.
| There is no limitation to number of users linked, even with the same role.
|-
! scope="row" | Contacts
| You could allocate multiple contacts - from different third parties - to a project, specifying a role. Two roles are defined by default, but you could extend it if needed
| There is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
|-
! scope="row" | Documents
| You could upload multiple document files and link them to a project.
| Document could also be generated using templates, see [[Module_Projects#Set-up_options | Set-up Options]] to activate the templates.
|-
! scope="row" | URL
| You could attach multiple URL links to a project.
|-
! scope="row" | Commercial proposal
| You could attach multiple proposals to a project.
| You could create the proposal from the project overview tab.
|-
! scope="row" | Customer order
| You could attach multiple customer orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Customer invoice
| You could attach multiple customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Customer template invoice
| You could attach multiple template customer invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Supplier order
| You could attach multiple supplier orders to a project.
| You could create the order from the project overview tab.
|-
! scope="row" | Supplier invoice
| You could attach multiple supplier invoices to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Contract
| You could attach multiple contracts to a project.
| You could create the contract from the project overview tab.
|-
! scope="row" | Expense report
| You could attach multiple expense report to a project.
| You could create the invoice from the project overview tab.
|-
! scope="row" | Event
| You could attach multiple events to a project.
| You could create the event from the project overview tab. The Agenda module should be activated.
|-
! scope="row" | Task
| You could attach multiple tasks to a project. See below the tasks properties.
| The option to manage tasks in a project should be properly activated, see [[Module_Projects#Set-up_options | Set-up Options]]
|}

== Task entity ==
This is the child entity of the project entity. It is possible to create a hierarchy of tasks, the project being the root of the tree.

=== Properties ===
{| class="wikitable sortable"
|-
! scope="Name" width="25%" | Property
! scope="Description" width="45%" | Description
! scope="Note" | Note / Values
|-
! scope="row" | Reference
| Generated automatically by a template. It is unique.
| See [[Module_Projects#Set-up_options | Set-up Options]] to customize the template.
|-
! scope="row" | Label
| The full name of the task.
|
|-
! scope="row" | Child of project/task
| By default the current project but could be changed to an other project task to create a tasks hierarchy.
|
|-
! scope="row" | Assigned to
| The user responsible of the task.
| By default the task creator.
|-
! scope="row" | Start date
| Starting date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | End date
| Ending date for the task
| Could be any valid date in past or future. Note that no control is made between start and end date neither with project dates.
|-
! scope="row" | Planned workload
| Planned workload to complete the task in hours and minutes.
|
|-
! scope="row" | Declared progress
| A percentage to be updated manually.
| Could also be updated when capturing time spend on task.
|-
! scope="row" | Description
| A text to describe your task.
|
|-
! scope="row" | Public Notes
| A text area (html) to store public notes on the task.
|
|-
! scope="row" | Private Notes
| A text area (html) to store private notes on the task.
|
|}

=== Links ===

= Workflow =

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

[[File:Project_right_access.png|200px]]

== 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 ==
{{ToComplete}}

== Remove a task ==
{{ToComplete}}

== Activity ==
Activities are time spent to work on tasks.

= Examples of use cases =
{{ToComplete}}
{{ExamplesCaseEn
|name=UCMP01:
|situation=
|actions=
}} 

Module Projects

2017-01-04T17:31:17Z

Bgenere: /* Project */ added Task headers

Module Projects

2017-01-04T16:55:30Z

Bgenere: /* Links */

Module Projects

2017-01-04T16:40:53Z

Bgenere: /* Project */ Added properties and some links, to be continued soon

Module Projects

2017-01-04T16:18:55Z

Bgenere: /* Project */

Module Projects

2017-01-04T16:18:03Z

Bgenere: /* Usage */ Started entities and business rules

Module Projects

2017-01-04T15:27:34Z

Bgenere: /* Usage */

Module Projects

2017-01-04T15:24:19Z

Bgenere: /* Permissions */

Module Projects

2017-01-03T17:52:03Z

Bgenere: /* Configuration */

Module Projects

2017-01-03T17:03:12Z

Bgenere: Extended Introduction and normalized it as for the Agenda module.

Module Projects (developer)

2016-12-08T13:28:20Z

Bgenere: /* Feature */

[[Category:Project]]
{{TemplateDocDevEn}}
{{TemplateModEN Developer}}
{{BasculeDevUserEn|
name=Projects|
num=400|
devdoc=This page|
userdoc=[[Module Projects]]|}}

= Feature =
The Project module allows you to manage tasks and time consumed on tasks. You can also link Dolibarr entities to a project (like [[Commercial_Proposals|commercial proposals]], [[Customers_Orders|customers orders]] or [[Customers_Invoices|customers invoices]]).

= Entity Project =
{{TemplateDocDevEntityEn|
class=htdocs/projet/class/project.class.php}}

= Permissions =
*->project->lire
*->project->creer
*->project->supprimer

= Tables SQL =
* [[Table llx projet|llx projet]] Contains projects
* [[Table llx projet_task|llx projet_task]] Contains tasks
* [[Table llx projet_task_time|llx projet_task_time]] Contains time consumed on tasks
* [[Table_llx_element_contact|llx_element_contact ]] Tells which tasks is affected to which user or contact
* [[Table llx projet_task_actors|llx projet_task_actors]] is deprecated, replaced by [[Table_llx_element_contact|llx_element_contact ]]

Module Projects (developer)

2016-12-08T13:27:36Z

Bgenere: /* Tables SQL */

[[Category:Project]]
{{TemplateDocDevEn}}
{{TemplateModEN Developer}}
{{BasculeDevUserEn|
name=Projects|
num=400|
devdoc=This page|
userdoc=[[Module Projects]]|}}

= Feature =
The Project module allows you to manage tasks and time consuming on tasks. You can also link Dolibarr entities to a project (like [[Commercial_Proposals|commercial proposals]], [[Customers_Orders|customers orders]] or [[Customers_Invoices|customers invoices]]).

= Entity Project =
{{TemplateDocDevEntityEn|
class=htdocs/projet/class/project.class.php}}

= Permissions =
*->project->lire
*->project->creer
*->project->supprimer

= Tables SQL =
* [[Table llx projet|llx projet]] Contains projects
* [[Table llx projet_task|llx projet_task]] Contains tasks
* [[Table llx projet_task_time|llx projet_task_time]] Contains time consumed on tasks
* [[Table_llx_element_contact|llx_element_contact ]] Tells which tasks is affected to which user or contact
* [[Table llx projet_task_actors|llx projet_task_actors]] is deprecated, replaced by [[Table_llx_element_contact|llx_element_contact ]]

Table llx element time

2016-12-08T13:22:01Z

Bgenere: /* Table */

[[Category:Table SQL]]
[[Category:Projet]]
[[Category:Project]]
[[Category:Proyectos]]

{{ListOfTables}}

= Content/Contenu/Contenido =
{{flag en}} Contains the time spend by actors of a project task at a given time.

{{flag fr}} Contient le temps passé par acteurs et par date sur une tâche de projet.

{{flag sp}} Contiene los tiempos invertidos por los actores relacionados a un proyecto.

= Structure =
== Table ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| Field
|style="background-color: #e9e9ef"| Type
|style="background-color: #e9e9ef"| Null
|style="background-color: #e9e9ef"| Key
|style="background-color: #e9e9ef"| Default
|style="background-color: #e9e9ef"| Extra
|style="background-color: #e9e9ef"| Description
|-
| rowid
| int(11)
| NO
| PRI
|
| auto_increment
| technical index
|-
| fk_task
| int(11)
| NO
|
|
|
| ID of task ([[Table llx_projet_task|llx_projet_task]]->rowid)
|-
| task_date
| date
| YES
|
| NULL
|
| date time when the actor has spend time on the task (started to work)
|-
| task_duration
| double
| YES
|
| NULL
|
| time spend, duration from the date time above

|-
| fk_user
| int(11)
| YES
|
| NULL
|
| ID of user or contact having spend time ([[Table llx element contact]]->fk_socpeople)
|-
| note
| text
| YES
|
| NULL
|
| commentary notes
|} 

== Keys ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| Key
|style="background-color: #e9e9ef"| Type
|style="background-color: #e9e9ef"| Fields
|-
| PRIMARY
| PRIMARY
| rowid
|}

Table llx element time

2016-12-08T13:15:41Z

Bgenere: /* Content/Contenu/Contenido */

[[Category:Table SQL]]
[[Category:Projet]]
[[Category:Project]]
[[Category:Proyectos]]

{{ListOfTables}}

= Content/Contenu/Contenido =
{{flag en}} Contains the time spend by actors of a project task at a given time.

{{flag fr}} Contient le temps passé par acteurs et par date sur une tâche de projet.

{{flag sp}} Contiene los tiempos invertidos por los actores relacionados a un proyecto.

= Structure =
== Table ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| Field
|style="background-color: #e9e9ef"| Type
|style="background-color: #e9e9ef"| Null
|style="background-color: #e9e9ef"| Key
|style="background-color: #e9e9ef"| Default
|style="background-color: #e9e9ef"| Extra
|style="background-color: #e9e9ef"| Description
|-
| rowid
| int(11)
| NO
| PRI
|
| auto_increment
| technical index
|-
| fk_task
| int(11)
| NO
|
|
|
| ID of task ([[Table llx_projet_task|llx_projet_task]]->rowid)
|-
| task_date
| date
| YES
|
| NULL
|
| date of task time
|-
| task_duration
| double
| YES
|
| NULL
|
| duration of task

|-
| fk_user
| int(11)
| YES
|
| NULL
|
| ID of user made task ([[Table llx_user|llx_user]]->rowid)
|-
| note
| text
| YES
|
| NULL
|
| comentary notes
|} 
== Keys ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| Key
|style="background-color: #e9e9ef"| Type
|style="background-color: #e9e9ef"| Fields
|-
| PRIMARY
| PRIMARY
| rowid
|}

Table llx projet task actors

2016-12-08T13:09:20Z

Bgenere:

[[Category:Table SQL]]
[[Category:Projet]]
[[Category:Project]]
[[Category:Proyectos]]

{{ListOfTables}}

From Dolibarr version x.x this table is deprecated and replaced by [[table_llx_element_contact]]

= Content/Contenu/Contenido =
{{flag en}} Contains actors tasks related to a project.

{{flag fr}} Contient des actors des tâches liées à un projet.

{{flag sp}} Contiene los actores de tareas relacionadas a un proyecto.

= Structure =
== Table ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| Field
|style="background-color: #e9e9ef"| Type
|style="background-color: #e9e9ef"| Null
|style="background-color: #e9e9ef"| Key
|style="background-color: #e9e9ef"| Default
|style="background-color: #e9e9ef"| Extra
|style="background-color: #e9e9ef"| Description
|-
| fk_projet_task
| int(11)
| NO
| UNI
|
|
| ID of task ([[Table llx_projet_task|llx_projet_task]]->rowid)
|-
| fk_user
| int(11)
| NO
| UNI
|
|
| ID of user ([[Table llx_user|llx_user]]->rowid)
|-
| role
| varchar(5)
| YES
|
| admin
|
| user rol
|} 
== Keys ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| Key
|style="background-color: #e9e9ef"| Type
|style="background-color: #e9e9ef"| Fields
|-
| fk_projet_task
| UNIQUE
| fk_projet_task,fk_user
|}

Table llx projet task

2016-12-08T12:59:46Z

Bgenere: /* Table */ removed line in double

[[Category:Table SQL]]
[[Category:Projet]]
[[Category:Project]]
[[Category:Proyectos]]

{{ListOfTables}}

= Content/Contenu/Contenido =
{{flag en}} Contains tasks related to a project.

{{flag fr}} Contient des tâches liées à un projet.

{{flag sp}} Contiene las tareas relacionadas a un proyecto.

= Structure =
== Table ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| Field
|style="background-color: #e9e9ef"| Type
|style="background-color: #e9e9ef"| Null
|style="background-color: #e9e9ef"| Key
|style="background-color: #e9e9ef"| Default
|style="background-color: #e9e9ef"| Extra
|style="background-color: #e9e9ef"| Description
|-
| rowid
| int(11)
| NO
| PRI
|
| auto_increment
| technical index
|-
| fk_projet
| int(11)
| NO
| MUL
|
|
| ID of proyect ([[Table llx_projet|llx_projet]]->rowid)
|-
| fk_task_parent
| int(11)
| NO
|
| 0
|
| ID of task ([[Table llx_c_actioncomm|llx_c_actioncomm]]->id)
|-
| datec
| datetime
| YES
|
| NULL
|
| creation date
{{FieldTms}}
|-
| dateo
| datetime
| YES
|
| NULL
|
| date start task
|-
| datee
| datetime
| YES
|
| NULL
|
| date end task
|-
| datev
| datetime
| YES
|
| NULL
|
| date validation task
|-
| label
| varchar(255)
| NO
|
|
|
| task label
|-
| description
| text
| YES
|
| NULL
|
| task description
|-
| duration_effective
| real
| NO
|
| 0
|
| duration of task
|-
| progress
| int(11)
| YES
|
| 0
|
| progress of task
|-
| priority
| int(11)
| YES
|
| 0
|
| task priority
|-
| fk_user_creat
| int(11)
| YES
|
| NULL
|
| ID of creator user ([[Table llx_user|llx_user]]->rowid)
|-
| fk_user_modif
| int(11)
| YES
|
| NULL
|
| ID of modifier user ([[Table llx_user|llx_user]]->rowid)
|-
| fk_user_valid
| int(11)
| YES
|
| NULL
|
| ID of validator user ([[Table llx_user|llx_user]]->rowid)
|-
| fk_statut
| smallint(6)
| NO
|
| 0
|
| status
|-
| note_private
| text
| YES
|
| NULL
|
| comentary notes
|-
| note_public
| text
| YES
|
| NULL
|
| public comentary notes
|-
| rang
| int(11)
| YES
|
| 0
|
| rang
|} 

== Keys ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| Key
|style="background-color: #e9e9ef"| Type
|style="background-color: #e9e9ef"| Fields
|-
| PRIMARY
| PRIMARY
| rowid
|-
| fk_projet_task_fk_projet
| MULTIPLE
| fk_projet
|-
| idx_projet_task_fk_user_creat
| MULTIPLE
| fk_user_creat
|-
| idx_projet_task_fk_user_valid
| MULTIPLE
| fk_user_valid
|}

Module Resources

2016-12-08T12:23:00Z

Bgenere: /* Resource links */

[[Category:Resources]]
[[Category:List of Modules]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Resources|
num=0|
devdoc=[[Module Resources (developer)]]|
userdoc=This page|}}
= Introduction =
The Resource 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 register the resources of the organisation like rooms, materials, keys, ...

Current documentation applies to 4.0.2 Dolibarr release.

== What this module does ==

* Manage a list of resources.
* Support resource type.
* Support adding notes to resource (public, private)
* Support resource links with contacts/users
* Support resource links to documents and/or URL.
* If the event module is activated, you could link resources to an event.

== What this module does not ==

* Does not support tag/categories for resource.
* Does not support extra fields. (will do in 5.0)
* Does not support attaching a resource to a project task.

= Installation =
{{NoInstallModuleEn}}
You just need to enable it in the module list.

= Configuration =
Below are the options available to configure this module.
== Set-up options ==
There is currently no set-up options for the module.
== Dictionaries ==
The module comes with the the "Type of resources" dictionary.

By default this dictionary is empty.

Go to the '''Setup''' menu and select '''Dictionaries''' to enter a list of values to categorize your resources.

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

== Permissions ==

# Read resources
# Create/modify resources
# Delete resources
# Link resources to agenda events

By default there is no default permission.

Go to the '''Setup''' menu and select '''Security''' to define some ( 1 and 4 is a good choice).

= Usage =
The module is available from the '''Tools''' icon available in Dolibarr top menu.

= Entities and Business rules =
== Resource ==
This is the main and unique object added by this module.

=== Resource properties ===

;Name:Name of the resource. Mandatory. Does not need to be unique.
;Type:Value from "Type of Resource" dictionary. To categorize your resources, could be used to sort the resources list.
;Description:A text to describe your resource.
;Public Notes:A text area (html) to store public notes on the resource.
;Private Notes:A text area (html) to store private notes on the resource.

=== Resource links ===
;Users:You could allocate multiple users to a resource, specifying a role. Actually the only role defined by default is 'In charge of resource', but you could extend it if needed. Note there is no limitation to number of users linked, even with the same role.
;Contacts:You could allocate multiple contacts - from different third parties - to a resource, specifying a role. Actually the only role defined by default is 'In charge of resource', but you could extend it if needed. Note there is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
;Documents:You could upload multiple document files and link them to the Resource.
;URL:You could attach multiple URL link to a resource.
;Event:When the Agenda module is activated, it is possible to select resources needed on any event. You could define if the resource is mandatory or not for the event and is free or not. This means the system is not checking the actual resource availability you need to check it manually.

= Examples of use cases =
{{ExamplesCaseEn
|name=List Resources:
|situation=You want to get the full list of resources
|actions= Go to Tools -> Resources. The resources list opens. You could sort the list by Reference or Type.
Selection will be available on Dolibarr 5.0
}} 
{{ExamplesCaseEn
|name=Create Resource:
|situation=You get a new resource
|actions= Go to Tools -> New Resource. The resource card opens. Fill-it and save. It should now be available in list.
}} 
{{ExamplesCaseEn
|name=Modify Resource:
|situation=You need to update a resource property
|actions= Go to Tools -> List Resources. The resource list displays. Select the resource. The resource card opens. Click Modify. You could modify properties. Save. The card reflects the changes.
}} 
{{ExamplesCaseEn
|name=Delete Resource:
|situation=You need to remove a resource
|actions= Go to Tools -> List Resources. The resource list displays. Select the resource. The resource card opens. Click Delete. The resource will be deleted and confirmation message will shows up.
If you delete a resource allocated to an event, you will end up with a blank resource for this event. Delete is not checking if the resource is used or not.
}} 
{{ExamplesCaseEn
|name=Inactivate Resource:
|situation=You need to remove a resource that could not be used any more but keep it's history.
|actions= None
Not available yet will require an active or inactive status
}} 
{{ToComplete}}

Module Agenda

2016-12-07T17:17:46Z

Bgenere: /* Introduction */ put important notice first

[[Category:AgendaEn]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Agenda|
num=2400|
devdoc=[[Module Agenda (developer)]]|
userdoc=This page|}}

= Introduction =
The Agenda 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 add a calendar into Dolibarr and manage events.

Current documentation applies to 4.0.2 Dolibarr release.

== Important notice regarding definitions ==

The term '''Events''' is often confused with terms like "Tasks", "Action", "list of Tasks", "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 a calendar of events (also called Agenda).
* Support day, week, month view for calendar.
* Support displaying other external calendars in agenda using ical URL.
* Support also user and list view of events.
* Allow to define and use types for event categorization.
* Allow to link a project, a third party and a contact to an event.
* Allow to link documents and/or URL to an events.
* If the [[Module_Resources| Resources module]] is activated, you could link resources to an event.
* Support extra fields for event.
* Support the automatic agenda filling by Dolibarr workflow events.
* Support calendar events export using vcal, ical or rss.

== What this module does not ==

* Does not support updating external calendar. (see commercial modules for this).
* Does not support recurring events.

= Installation =
{{NoInstallModuleEn}}

= Configuration =
{{ActivationModuleEn}}

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

= 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 =
{{ToComplete}}

= Example of use case =
{{ToComplete}}
{{ExamplesCaseEn
|name=UCAG01:
|situation=
|actions=
}} 

Module Agenda

2016-12-07T17:15:12Z

Bgenere: Rewrite the important notice regarding definitions

[[Category:AgendaEn]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Agenda|
num=2400|
devdoc=[[Module Agenda (developer)]]|
userdoc=This page|}}

= Introduction =
The Agenda 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 add a calendar into Dolibarr and manage events.

Current documentation applies to 4.0.2 Dolibarr release.

== What this module does ==

* Manage a calendar of events (also called Agenda).
* Support day, week, month view for calendar.
* Support displaying other external calendars in agenda using ical URL.
* Support also user and list view of events.
* Allow to define and use types for event categorization.
* Allow to link a project, a third party and a contact to an event.
* Allow to link documents and/or URL to an events.
* If the [[Module_Resources| Resources module]] is activated, you could link resources to an event.
* Support extra fields for event.
* Support the automatic agenda filling by Dolibarr workflow events.
* Support calendar events export using vcal, ical or rss.

== What this module does not ==

* Does not support updating external calendar. (see commercial modules for this).
* Does not support recurring events.

== Important notice regarding definitions ==

The term '''Events''' is often confused with terms like "Tasks", "Action", "list of Tasks", "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]].

= Installation =
{{NoInstallModuleEn}}

= Configuration =
{{ActivationModuleEn}}

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

= 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 =
{{ToComplete}}

= Example of use case =
{{ToComplete}}
{{ExamplesCaseEn
|name=UCAG01:
|situation=
|actions=
}} 

Module Agenda

2016-12-07T17:00:03Z

Bgenere: /* Introduction */ added does and does not

[[Category:AgendaEn]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Agenda|
num=2400|
devdoc=[[Module Agenda (developer)]]|
userdoc=This page|}}

= Introduction =
The Agenda 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 add a calendar into Dolibarr and manage events.

Current documentation applies to 4.0.2 Dolibarr release.

== What this module does ==

* Manage a calendar of events (also called Agenda).
* Support day, week, month view for calendar.
* Support displaying other external calendars in agenda using ical URL.
* Support also user and list view of events.
* Allow to define and use types for event categorization.
* Allow to link a project, a third party and a contact to an event.
* Allow to link documents and/or URL to an events.
* If the [[Module_Resources| Resources module]] is activated, you could link resources to an event.
* Support extra fields for event.
* Support the automatic agenda filling by Dolibarr workflow events.
* Support calendar events export using vcal, ical or rss.

== What this module does not ==

* Does not support updating external calendar. (see commercial modules for this).
* Does not support recurring events.

= Installation =
{{NoInstallModuleEn}}

= Configuration =
{{ActivationModuleEn}}

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 =
{{ToComplete}}

= Example of use case =
{{ToComplete}}
{{ExamplesCaseEn
|name=UCAG01:
|situation=
|actions=
}} 

Module Agenda

2016-12-07T16:30:52Z

Bgenere:

[[Category:AgendaEn]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Agenda|
num=2400|
devdoc=[[Module Agenda (developer)]]|
userdoc=This page|}}

= 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 =
{{NoInstallModuleEn}}

= Configuration =
{{ActivationModuleEn}}

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 =
{{ToComplete}}

= Example of use case =
{{ToComplete}}
{{ExamplesCaseEn
|name=UCAG01:
|situation=
|actions=
}} 

Module Resources

2016-12-07T16:29:41Z

Bgenere:

[[Category:Resources]]
[[Category:List of Modules]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Resources|
num=0|
devdoc=[[Module Resources (developer)]]|
userdoc=This page|}}
= Introduction =
The Resource 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 register the resources of the organisation like rooms, materials, keys, ...

Current documentation applies to 4.0.2 Dolibarr release.

== What this module does ==

* Manage a list of resources.
* Support resource type.
* Support adding notes to resource (public, private)
* Support resource links with contacts/users
* Support resource links to documents and/or URL.
* If the event module is activated, you could link resources to an event.

== What this module does not ==

* Does not support tag/categories for resource.
* Does not support extra fields. (will do in 5.0)
* Does not support attaching a resource to a project task.

= Installation =
{{NoInstallModuleEn}}
You just need to enable it in the module list.

= Configuration =
Below are the options available to configure this module.
== Set-up options ==
There is currently no set-up options for the module.
== Dictionaries ==
The module comes with the the "Type of resources" dictionary.

By default this dictionary is empty.

Go to the '''Setup''' menu and select '''Dictionaries''' to enter a list of values to categorize your resources.

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

== Permissions ==

# Read resources
# Create/modify resources
# Delete resources
# Link resources to agenda events

By default there is no default permission.

Go to the '''Setup''' menu and select '''Security''' to define some ( 1 and 4 is a good choice).

= Usage =
The module is available from the '''Tools''' icon available in Dolibarr top menu.

= Entities and Business rules =
== Resource ==
This is the main and unique object added by this module.

=== Resource properties ===

;Name:Name of the resource. Mandatory. Does not need to be unique.
;Type:Value from "Type of Resource" dictionary. To categorize your resources, could be used to sort the resources list.
;Description:A text to describe your resource.
;Public Notes:A text area (html) to store public notes on the resource.
;Private Notes:A text area (html) to store private notes on the resource.

=== Resource links ===
;Users:You could allocate multiple users to a resource, specifying a rôle. Actually the only role defined by default is 'In charge of resource', but you could extend it if needed. Note there is no limitation to number of users linked, even with the same role.
;Contacts:You could allocate multiple contacts - from different third parties - to a resource, specifying a rôle. Actually the only role defined by default is 'In charge of resource', but you could extend it if needed. Note there is no limitation to number of contacts linked, even with the same role. Contact and User roles could be different if needed.
;Documents:You could upload multiple document files and link them to the Resource.
;URL:You could attach multiple URL link to a resource.
;Event:When the Agenda module is activated, it is possible to select resources needed on any event. You could define if the resource is mandatory or not for the event and is free or not. This means the system is not checking the actual resource availability you need to check it manually.

= Examples of use cases =
{{ExamplesCaseEn
|name=List Resources:
|situation=You want to get the full list of resources
|actions= Go to Tools -> Resources. The resources list opens. You could sort the list by Reference or Type.
Selection will be available on Dolibarr 5.0
}} 
{{ExamplesCaseEn
|name=Create Resource:
|situation=You get a new resource
|actions= Go to Tools -> New Resource. The resource card opens. Fill-it and save. It should now be available in list.
}} 
{{ExamplesCaseEn
|name=Modify Resource:
|situation=You need to update a resource property
|actions= Go to Tools -> List Resources. The resource list displays. Select the resource. The resource card opens. Click Modify. You could modify properties. Save. The card reflects the changes.
}} 
{{ExamplesCaseEn
|name=Delete Resource:
|situation=You need to remove a resource
|actions= Go to Tools -> List Resources. The resource list displays. Select the resource. The resource card opens. Click Delete. The resource will be deleted and confirmation message will shows up.
If you delete a resource allocated to an event, you will end up with a blank resource for this event. Delete is not checking if the resource is used or not.
}} 
{{ExamplesCaseEn
|name=Inactivate Resource:
|situation=You need to remove a resource that could not be used any more but keep it's history.
|actions= None
Not available yet will require an active or inactive status
}} 
{{ToComplete}}

Events-Todo-Journal

2016-12-06T18:01:20Z

Bgenere: /* Introduction */

{{TemplateDocUser}}
[[Category:AgendaEn]]
= Introduction =
Software used to manage tasks/plannings/agenda (like Outlook, Lightning, Webcalendar, etc) can manage 3 different notions (normalized in norm RFC2445) that are:
* Event ('''event''' in the norm)
* Task ('''to-do''' in the norm)
* Journal ('''journal''' in the norm)
This 3 definitions are nearly similar but they are different terms and are used for different goals. This page describe the differences between each of them.

( If you are curious, you could access the full norm at www.ietf.org/rfc/rfc2445.txt ).

= Event and rendez-vous (event) =
An event (event in the norm), is something to define an action (a instant action or an action with a long duration that is in past or future).

Events has the folowwing properties:
* A label (In the norm ical: summary)
* A description (In the ical norm: description)
* A start date (In the ical norm: dtstart)
* An end date (In the ical norm: dtend) or a duration (In the ical norm: duration) but it's one or other not both.
* A location, like a meeting-room for example (In the ical norm: location)
* A priority (In the ical norm: priority)
* Transparency (In the ical norm: transp) that says if actors of event are available for this task.
* A status (try, confirmed or canceled), rarely used.
* Other less important informations.

'''Example of use case''':
This is same thing that what you can find into an Outlook calendar (tab Calendar), Evolution, Thunderbird/Lightning or into Google calendar.
We use the "events" to save rendez-vous for exemple, but you can also use them to save a work to do into a date range if you want.

'''Into Dolibarr''':
This concept is managed by [[Module Agenda En|Module Agenda]].
Dolibarr has added a percentage. There is also an option to add a type into Dolibarr.

= The tasks (to-do) =
A task has the following properties:
* A label (In the ical norm: summary)
* A description (In the ical norm: description)
* A start date (In the ical norm: dtstart)
* An end date (In the ical norm: due) or a duration (In the ical norm: duration) but one or other not both.
* A percentage of accomplishment (In the ical norm: percent-complete).
* A priority (In the ical norm: priority).
* A status (running, confirmed or canceled)
* Other informations less important.

'''Example of use case''':
This is same thing that you can found into Outlook Tasks feature (tab Tasks), Evolution or Thunderbird/Lightning.
We use then in most cases to manage projects.

'''Into Dolibarr''':
This concept is managed by [[Module Projects]].

= The journals (journal) =
A journal entry is an information. It has following properties:
* A label
* A description
* An information date
* A location
* A status (draft, confirmed, deleted).
* Other information less important.

'''Example of use case''':
Manage a personal diary.

'''Into Dolibarr''':
This concept does not exists in any standard module provided with Dolibarr.

Events-Todo-Journal

2016-12-06T17:58:21Z

Bgenere: /* Introduction */

{{TemplateDocUser}}
[[Category:AgendaEn]]
= Introduction =
Software used to manage tasks/plannings/agenda (like Outlook, Lightning, Webcalendar, etc) can manage 3 different notions (normalized in norm RFC2445) that are:
* Event ('''event''' in the norm)
* Task ('''to-do''' in the norm)
* Journal ('''journal''' in the norm)
This 3 definitions are nearly similar but they are different terms and are used for different goals. This page describe the differences between each of them.

See norm at www.ietf.org/rfc/rfc2445.txt

= Event and rendez-vous (event) =
An event (event in the norm), is something to define an action (a instant action or an action with a long duration that is in past or future).

Events has the folowwing properties:
* A label (In the norm ical: summary)
* A description (In the ical norm: description)
* A start date (In the ical norm: dtstart)
* An end date (In the ical norm: dtend) or a duration (In the ical norm: duration) but it's one or other not both.
* A location, like a meeting-room for example (In the ical norm: location)
* A priority (In the ical norm: priority)
* Transparency (In the ical norm: transp) that says if actors of event are available for this task.
* A status (try, confirmed or canceled), rarely used.
* Other less important informations.

'''Example of use case''':
This is same thing that what you can find into an Outlook calendar (tab Calendar), Evolution, Thunderbird/Lightning or into Google calendar.
We use the "events" to save rendez-vous for exemple, but you can also use them to save a work to do into a date range if you want.

'''Into Dolibarr''':
This concept is managed by [[Module Agenda En|Module Agenda]].
Dolibarr has added a percentage. There is also an option to add a type into Dolibarr.

= The tasks (to-do) =
A task has the following properties:
* A label (In the ical norm: summary)
* A description (In the ical norm: description)
* A start date (In the ical norm: dtstart)
* An end date (In the ical norm: due) or a duration (In the ical norm: duration) but one or other not both.
* A percentage of accomplishment (In the ical norm: percent-complete).
* A priority (In the ical norm: priority).
* A status (running, confirmed or canceled)
* Other informations less important.

'''Example of use case''':
This is same thing that you can found into Outlook Tasks feature (tab Tasks), Evolution or Thunderbird/Lightning.
We use then in most cases to manage projects.

'''Into Dolibarr''':
This concept is managed by [[Module Projects]].

= The journals (journal) =
A journal entry is an information. It has following properties:
* A label
* A description
* An information date
* A location
* A status (draft, confirmed, deleted).
* Other information less important.

'''Example of use case''':
Manage a personal diary.

'''Into Dolibarr''':
This concept does not exists in any standard module provided with Dolibarr.

Module Projects

2016-12-06T17:45:23Z

Bgenere:

[[Category:Project]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Project|
num=400|
devdoc=[[Module Projects (developer)]]|
userdoc=This page|}}

= Introduction =
The Project module allows you to manage tasks and time consuming on tasks. You can also link Dolibarr entities to a project (like [[Module Commercial Proposals|commercial proposals]], [[Module Customers Orders|customers orders]] or [[Module Customers Invoices|customers invoices]]).

= Installation =
{{NoInstallModuleEn}}

= Configuration =
{{ActivationModuleEn}}

= Definitions =
Before starting to use the Project module, it is important to understand the difference and meanings of following terms
Events / Tasks / Journals.
This terms are often misunderstood and they are used differently. So you should first know the real definitions of this terms as they are used by most ERP/CRM softwares. For this, you can read definitions on page [[Events-Todo-Journal]]

The project module is designed to manage Tasks.

= Workflow =

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

[[File:Project_right_access.png|200px]]

== 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 ==
{{ToComplete}}

== Remove a task ==
{{ToComplete}}

== Activity ==
Activities are time spent to work on tasks.

= Examples of use cases =
{{ToComplete}}
{{ExamplesCaseEn
|name=UCMP01:
|situation=
|actions=
}} 