Module Resources

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search

Return to user
documentation index

File Doc user.png

Return to
list of modules index

Art.png

Resources
Numero/ID of module 0
User doc. of module This page
Developer doc. of module Module Resources (developer)

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

This module is included with the Dolibarr distribution, so there is no need to install it. 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

  1. Read resources
  2. Create/modify resources
  3. Delete resources
  4. 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

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

 

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.

 

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.

 

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.

 

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

 

En verysmall.png Page waiting to complete. To complete, create an account, go back and clic on "Modify".
Fr verysmall.png Page en attente d'être complété. Pour compléter, créez un compte, revenez et cliquez sur "Modifier".
Es verysmall.png Página a completar. Para completarla, cree una cuenta, vuelva a la página y haga clic en "editar"
Cn verysmall.png 待完成,欲帮助完成,注册帐号,点击“编辑"