Attempt to improve the help texts.
This commit is contained in:
Jeroen Baten
parent
928e83a301
commit
d9cd720599
27 changed files with 1312 additions and 1644 deletions
4
.gitignore
vendored
4
.gitignore
vendored
|
|
@ -37,4 +37,6 @@ doc/src/user/fr/html/
|
|||
doc/src/user/fr/index.rst
|
||||
doc/src/user/gl/html/
|
||||
doc/src/user/gl/index.rst
|
||||
libreplan-webapp/src/main/webapp/help/
|
||||
|
||||
#ignore files that need ignoring
|
||||
*.ignore
|
||||
|
|
@ -3,119 +3,105 @@ Introduction
|
|||
|
||||
.. contents::
|
||||
|
||||
The purpose of this document is to describe the features of LibrePlan and provide user information on how to configure and use the application.
|
||||
|
||||
LibrePlan is an opensource web application for project planning. Its main goal is to provide a complete solution for company project management.
|
||||
For any specific information you may need about this software, please contact the development team at http://www.libreplan.com/contact/
|
||||
This document describes the features of LibrePlan and provides user information on how to configure and use the application.
|
||||
|
||||
LibrePlan is an open-source web application for project planning. Its primary goal is to provide a comprehensive solution for company project management. For any specific information you may need about this software, please contact the development team at http://www.libreplan.com/contact/
|
||||
|
||||
.. figure:: images/company_view.png
|
||||
:scale: 50
|
||||
|
||||
Company overview
|
||||
Company Overview
|
||||
|
||||
Company overview and view management
|
||||
====================================================
|
||||
Company Overview and View Management
|
||||
====================================
|
||||
|
||||
As can be seen in the program's main screen (shot given previously) and the company overview, users can see the list of planned projects
|
||||
to find out about the company's overall situation in relation to orders and the use of resources. The company overview contains 3 views:
|
||||
As shown in the program's main screen (see the previous screenshot) and the company overview, users can view a list of planned projects. This allows them to understand the company's overall status regarding orders and resource utilization. The company overview offers three distinct views:
|
||||
|
||||
* Planning view: View that combines two points of view:
|
||||
* **Planning View:** This view combines two perspectives:
|
||||
|
||||
* View of orders and the time taken: Each project uses Gantt charts, which indicate the start and end date of the project. This information is combined with the chart showing the agreed deadline and then a comparison is made between a percentage of progress and time that is actually dedicated to each project. This information gives a clear picture of how the company is doing at a given time. This view is the program's opening page.
|
||||
* Graph showing the company's use of resources: Graph that searches for information on the allocation of resources to projects, which also gives a summary on the entire company's use of resources: Green indicates that the allocation of resources is under 100%, the black line shows the available load of resources and yellow indicates that allocation of resources is above 100%. It is possible for allocation to be less than available resources and to have over allocation for specific resources at the same time.
|
||||
|
||||
* Resource load view: Screen that shows the list of workers in the company and the load of specific allocation to tasks or generic allocation as the resource fulfils a list of criteria. See the following image. You need to click on *Overall load of resources* to access this view.
|
||||
* Orders administration view. Screen that shows the list of company orders, where the user can carry out the following operations: filter, edit, erase, visualise planning or create a new order. You need to click on *Order list* to access this view.
|
||||
* **Order and Time Tracking:** Each project is represented by a Gantt chart, indicating the project's start and end dates. This information is displayed alongside the agreed-upon deadline. A comparison is then made between the percentage of progress achieved and the actual time dedicated to each project. This provides a clear picture of the company's performance at any given time. This view is the program's default landing page.
|
||||
* **Company Resource Utilization Graph:** This graph displays information on resource allocation across projects, providing a summary of the entire company's resource usage. Green indicates that resource allocation is below 100% of capacity. The black line represents the total available resource capacity. Yellow indicates that resource allocation exceeds 100%. It's possible to have under-allocation overall while simultaneously experiencing over-allocation for specific resources.
|
||||
|
||||
* **Resource Load View:** This screen displays a list of the company's workers and their specific task allocations, or generic allocations based on defined criteria. To access this view, click on *Overall load of resources*. See the following image for an example.
|
||||
* **Orders Administration View:** This screen displays a list of company orders, allowing users to perform the following actions: filter, edit, delete, visualize planning, or create a new order. To access this view, click on *Order list*.
|
||||
|
||||
.. figure:: images/resources_global.png
|
||||
:scale: 50
|
||||
|
||||
Resource overview
|
||||
Resource Overview
|
||||
|
||||
.. figure:: images/order_list.png
|
||||
:scale: 50
|
||||
|
||||
Work Breakdown Structure
|
||||
|
||||
The view management described above for the company overview is very similar to the management available for a single project. A project can be accessed in several ways:
|
||||
|
||||
The view management commented on previously for the company overview is very similar to the management planned for a single project.
|
||||
A project can be accessed in several ways:
|
||||
* Right-click on the Gantt chart for the order and select *Plan*.
|
||||
* Access the order list and click on the Gantt diagram icon.
|
||||
* Create a new order and change the current order view.
|
||||
|
||||
* By right clicking on the Gantt chart for the order and then selecting *Plan*.
|
||||
* By accessing the order list and clicking on the icon for the Gantt diagrams.
|
||||
* By creating a new order and changing the current order view.
|
||||
The program offers the following views for an order:
|
||||
|
||||
The program has the following views for an order:
|
||||
* **Planning View:** This view allows users to visualize task planning, dependencies, milestones, and more. See the *Planning* section for further details.
|
||||
* **Resource Load View:** This view allows users to check the designated resource load for a project. The color code is consistent with the company overview: green for a load less than 100%, yellow for a load equal to 100%, and red for a load over 100%. The load may originate from a specific task or a set of criteria (generic allocation).
|
||||
* **Editing Order View:** This view allows users to modify the details of the order. See the *Orders* section for more information.
|
||||
* **Advanced Resource Allocation View:** This view allows users to allocate resources with advanced options, such as specifying hours per day or the allocated functions to be performed. See the *Resource allocation* section for more information.
|
||||
|
||||
* Planning view. View where the user can visualise the task planning, dependencies, milestones, etc. See the *Planning* section for more information.
|
||||
* Resource load view. View where the user can check the designated resource load for a project. The colour code is the same for the company overview: Green for a load less than 100%, yellow for a load equal to 100% and red for a load over 100%. The load may come from a task or a list of criteria (generic allocation).
|
||||
* Editing order view. View where the user can change the details of the order. See the *Orders* section for more information.
|
||||
* Advanced resource allocation view. View where the user can allocate resources including advanced options: choosing hours per day or the allocated functions to be carried out. See the *Resource allocation* section for more information.
|
||||
|
||||
What makes LibrePlan useful?
|
||||
What Makes LibrePlan Useful?
|
||||
============================
|
||||
|
||||
LibrePlan is an application that has been developed as a general purpose planning tool. It is based on a series of concepts discovered by analysing problems in industrial project planning that were not fully covered by any existing planning tool. Also the motivations for the development of LibrePlan were based on providing a free software alternative, and completely web, for existing privative plannig tools.
|
||||
LibrePlan is a general-purpose planning tool developed to address challenges in industrial project planning that were not adequately covered by existing tools. The development of LibrePlan was also motivated by the desire to provide a free, open-source, and entirely web-based alternative to proprietary planning tools.
|
||||
|
||||
The essential concepts used for the program are as follows:
|
||||
The core concepts underpinning the program are as follows:
|
||||
|
||||
* Company and multi-project overview: LibrePlan is a program that has been developed specifically to provide information about projects that are being carried out in a company to users, therefore it is a multi-project program. It was decided that the program's focus would not be individual to each project. However, it is also possible to have several specific views, individual projects among them.
|
||||
* View management: The company overview or multi-project view comes with the views on the information that is stored. For example, the company overview enables users to view orders and compare their status, view the company's general resource load and process orders. Users can also view the planning, the resource load, the advanced resource allocation view and the editing order view on the project view.
|
||||
* Criteria: Criteria are a system entity that enables resources (both humans and machines) and tasks to be classified. Resources must fulfil criteria and tasks require criteria to be fulfilled. These are one of the program's most important aspects, as criteria are the basis of generic allocation in the program and resolve one of the most important problems for the sector: the long time taken in human resources and the difficulty in having long-term company load estimations.
|
||||
* Resources: There are two different kinds: humans and machines. Human resources are workers in a company that are used to plan, monitor and control the company's load. On the other hand, machines, dependent on the people that manage them, are resources that act in a similar way to human resources.
|
||||
* Resource allocation: One of the key points of the program is having the possibility of two kinds of designation: specific and generic. Generic allocation is based on criteria that are required to carry out a task and must be fulfilled by resources that are capable of performing them. In order to understand generic allocation, the following case must be understood: John Smith is a welder. Generally, John Smith is allocated to the planned task, but "LibrePlan" offers the possibility of choosing a resource in general among welders in the company, not worrying if John Smith is the person who has been allocated the task.
|
||||
* Company load control: The program offers the possibility of controlling the company's resource load easily. The control is carried out in the mid and long term as current projects and future projects can be managed by the program. "LibrePlan" has graphics that indicate the use of resources.
|
||||
* Labels: These are elements that are used to label project tasks. With these labels, the user of the program can group tasks together according to concept, which can then be checked at a later date as a group or after being filtered.
|
||||
* Filters: As the system naturally has elements that label or characterise tasks and resources, criteria filters or labels can be used. This is very useful to check categorised information or to get specific reports based on criteria or labels.
|
||||
* Calendars: Calendars determine the available productive hours for different resources. The user may create general calendars for the company or input characteristics for more specific calendars, meaning that calendars for resources and tasks can be made.
|
||||
* Orders and order elements: Work requested by clients is treated by the application as an order, which is structured in order elements. The order and its elements adhere to a hierarchical structure of *x* levels. This element tree is the basis when planning work.
|
||||
* Progress: The program can manage several kinds of progress. A project can be measured in a percentage that indicates its progress and also in units, the agreed budget, etc. Deciding what kind of progress is to be used to compare progress at upper stages of the project is the responsibility of the person who is managing the planning.
|
||||
* Tasks: Tasks are the program's planning elements. They are used to programme works that are to be carried out. The most important characteristics of the tasks are: They have dependencies among themselves and may require criteria to be fulfilled in order to allocate resources.
|
||||
* Work reports: These are the reports of the companies' workers, which indicate the hours worked and also the tasks allocated to the hours a worker has worked. With this information, the system can calculate how many hours it took to complete a task in relation to the total number of hours that were budgeted. Progress can be compared with the use of actual hours.
|
||||
* **Company and Multi-Project Overview:** LibrePlan is specifically designed to provide users with information about multiple projects being carried out within a company. Therefore, it is inherently a multi-project program. The program's focus is not limited to individual projects, although specific views for individual projects are also available.
|
||||
* **View Management:** The company overview, or multi-project view, is accompanied by various views of the stored information. For example, the company overview allows users to view orders and compare their status, view the company's overall resource load, and manage orders. Users can also access the planning view, resource load view, advanced resource allocation view, and editing order view for individual projects.
|
||||
* **Criteria:** Criteria are a system entity that enables the classification of both resources (human and machine) and tasks. Resources must meet certain criteria, and tasks require specific criteria to be fulfilled. This is one of the program's most important features, as criteria form the basis of generic allocation and address a significant challenge in the industry: the time-consuming nature of human resource management and the difficulty of long-term company load estimations.
|
||||
* **Resources:** There are two types of resources: human and machine. Human resources are the company's workers, used for planning, monitoring, and controlling the company's workload. Machine resources, dependent on the people who operate them, function similarly to human resources.
|
||||
* **Resource Allocation:** A key feature of the program is the ability to designate resources in two ways: specifically and generically. Generic allocation is based on the criteria required to complete a task and must be fulfilled by resources capable of meeting those criteria. To understand generic allocation, consider this example: John Smith is a welder. Typically, John Smith would be specifically assigned to a planned task. However, LibrePlan offers the option of selecting any welder within the company, without needing to specify that John Smith is the assigned person.
|
||||
* **Company Load Control:** The program allows for easy control of the company's resource load. This control extends to both the mid-term and long-term, as current and future projects can be managed within the program. LibrePlan provides graphs that visually represent resource utilization.
|
||||
* **Labels:** Labels are used to categorize project tasks. With these labels, users can group tasks by concept, allowing for later review as a group or after filtering.
|
||||
* **Filters:** Because the system naturally includes elements that label or characterize tasks and resources, criteria filters or labels can be used. This is very useful for reviewing categorized information or generating specific reports based on criteria or labels.
|
||||
* **Calendars:** Calendars define the available productive hours for different resources. Users can create general company calendars or define more specific calendars, allowing for the creation of calendars for individual resources and tasks.
|
||||
* **Orders and Order Elements:** Work requested by clients is treated as an order within the application, structured into order elements. The order and its elements follow a hierarchical structure with *x* levels. This element tree forms the basis for work planning.
|
||||
* **Progress:** The program can manage various types of progress. A project's progress can be measured as a percentage, in units, against the agreed budget, and more. The responsibility for determining which type of progress to use for comparison at higher project levels lies with the planning manager.
|
||||
* **Tasks:** Tasks are the fundamental planning elements within the program. They are used to schedule work to be carried out. Key characteristics of tasks include: dependencies between tasks, and the potential requirement for specific criteria to be met before resources can be allocated.
|
||||
* **Work Reports:** These reports, submitted by the company's workers, detail the hours worked and the tasks associated with those hours. This information allows the system to calculate the actual time taken to complete a task compared to the budgeted time. Progress can then be compared against the actual hours used.
|
||||
|
||||
On top of the functions offered by the program, there are other features that make it stand out from similar programs:
|
||||
In addition to the core functions, LibrePlan offers other features that distinguish it from similar programs:
|
||||
|
||||
* Integration with ERP: The program imports information directly from companies' ERPs for orders, human resources, work reports and specific criteria.
|
||||
* Version management: The program can manage different planning versions and, at the same time, still allows users to check the information on every version.
|
||||
* History management: The program does not erase information, it only makes it invalid, so users can check older information using date filters.
|
||||
* **Integration with ERP:** The program can directly import information from company ERP systems, including orders, human resources, work reports, and specific criteria.
|
||||
* **Version Management:** The program can manage multiple planning versions, while still allowing users to review the information from each version.
|
||||
* **History Management:** The program does not delete information; it only marks it as invalid. This allows users to review historical information using date filters.
|
||||
|
||||
Usability conventions
|
||||
Usability Conventions
|
||||
=====================
|
||||
|
||||
Information about forms
|
||||
Information About Forms
|
||||
-----------------------
|
||||
Before describing the various functions associated with the most important modules, we need to give a general explanation on how to browse and the forms.
|
||||
Before describing the various functions associated with the most important modules, we need to explain the general navigation and form behavior.
|
||||
|
||||
Essentially, there are 3 kinds of editing forms:
|
||||
There are essentially three types of editing forms:
|
||||
|
||||
* Forms with a *Return* button. These forms are part of a wider picture and the changes that are made are stored in the memory. The changes are only applied when the user explicitly stores all the details on the screen from which the form came.
|
||||
* Forms with the *Save* and *Close* buttons. These forms enable 2 operations to take place. The first one stores and closes the current window and the second one closes without saving the changes.
|
||||
* Forms with the *Save and continue*, "Save" and "Close" buttons. These forms enable 3 operations to take place. The first one stores and continues the current form. The second one stores and closes the form. Lastly, the third one closes the window without storing changes.
|
||||
* **Forms with a *Return* button:** These forms are part of a larger context, and the changes made are stored in memory. The changes are only applied when the user explicitly saves all the details on the screen from which the form originated.
|
||||
* **Forms with *Save* and *Close* buttons:** These forms allow for two actions. The first saves the changes and closes the current window. The second closes the window without saving any changes.
|
||||
* **Forms with *Save and continue*, *Save*, and *Close* buttons:** These forms allow for three actions. The first saves the changes and keeps the current form open. The second saves the changes and closes the form. The third closes the window without saving any changes.
|
||||
|
||||
Standard icons and buttons
|
||||
Standard Icons and Buttons
|
||||
--------------------------
|
||||
|
||||
* Editing: In general, editing records in the program may be done by clicking on an icon consisting of a pencil on a white notebook.
|
||||
* Left indent: In general, these operations are needed for elements of a tree that intend to move into internal levels. This operation may be done by clicking the icon consisting of a green arrow pointing right.
|
||||
* Right indent: In general, these operations are needed for elements of a tree that intend to move from internal to external levels. This operation may be done by clicking the icon consisting of a green arrow pointing left.
|
||||
* Erasing: Users can erase information by clicking on the paper basket icon.
|
||||
* Search: The magnifying glass is the icon that indicates that the text entry to the left is intended for searching for elements.
|
||||
* **Editing:** In general, records in the program can be edited by clicking on an icon that looks like a pencil on a white notebook.
|
||||
* **Left Indent:** These operations are generally used for elements within a tree structure that need to be moved to a deeper level. This is done by clicking on the icon that looks like a green arrow pointing to the right.
|
||||
* **Right Indent:** These operations are generally used for elements within a tree structure that need to be moved to a higher level. This is done by clicking on the icon that looks like a green arrow pointing to the left.
|
||||
* **Deleting:** Users can delete information by clicking on the trash can icon.
|
||||
* **Search:** The magnifying glass icon indicates that the text field to its left is used for searching for elements.
|
||||
|
||||
Tabs
|
||||
----
|
||||
The program will have content editing and administration forms, which will be represented by graphic components based on tabs.
|
||||
This method is used to organise information from a comprehensive form into different sections that can be accessed by clicking on the
|
||||
names of the different tabs, the others keeping their status. In all cases, the save and cancel options affect the group of sub-forms on
|
||||
the different tabs.
|
||||
The program uses tabs to organize content editing and administration forms. This method is used to divide a comprehensive form into different sections, accessible by clicking on the tab names. The other tabs retain their current status. In all cases, the save and cancel options apply to all sub-forms within the different tabs.
|
||||
|
||||
Explicit actions and context help
|
||||
Explicit Actions and Context Help
|
||||
---------------------------------
|
||||
|
||||
The program contains components that provide additional descriptions about the element when hovering over them for one second.
|
||||
The actions the user may carry out in the program are stated on the button tabs and in the help texts about them, the browsing menu
|
||||
options and the options on the context menus that open out when right clicking on the planner area.
|
||||
Furthermore, short cuts are given for the main operations by double clicking the listed elements or by associating key events with
|
||||
cursors and the enter key, which is how to add elements when moving through the forms.
|
||||
|
||||
The program includes components that provide additional descriptions of elements when the mouse hovers over them for one second. The actions that the user can perform are indicated on the button labels, in the help texts associated with them, in the browsing menu options, and in the context menus that appear when right-clicking in the planner area. Furthermore, shortcuts are provided for the main operations, such as double-clicking on listed elements or using key events with the cursor and the Enter key to add elements when navigating through forms.
|
||||
|
|
|
|||
|
|
@ -3,66 +3,59 @@ Criteria
|
|||
|
||||
.. contents::
|
||||
|
||||
Criteria are elements that are used in the program to categorise resources and tasks. Tasks need criteria and the resources fulfil them.
|
||||
The following sequence is an example of how to use criteria:
|
||||
A resource is designated the criterion of "welder" (that is the resource fulfils the "welder" category) and a task requires the "welder"
|
||||
criterion to be carried out. As a result, when resources are allocated to tasks, workers with the "welder"
|
||||
criterion are used when allocating resources generically (not applicable to specific allocation).
|
||||
See the chapter on allocating resources to find out more about the different kinds of allocation.
|
||||
Criteria are elements used within the program to categorize both resources and tasks. Tasks require specific criteria, and resources must meet those criteria.
|
||||
|
||||
Several operations can be carried out with criteria in the program:
|
||||
Here's an example of how criteria are used: A resource is assigned the criterion "welder" (meaning the resource fulfills the "welder" category), and a task requires the "welder" criterion to be completed. Consequently, when resources are allocated to tasks using generic allocation (as opposed to specific allocation), workers with the "welder" criterion will be considered. For more information on the different types of allocation, refer to the chapter on resource allocation.
|
||||
|
||||
* Criteria administration
|
||||
* Allocation of criteria to resources.
|
||||
* Allocation of criteria to tasks.
|
||||
* Filtering entities according to criteria. Tasks and order items can be filtered according to criteria to carry out operations in the program.
|
||||
The program allows for several operations involving criteria:
|
||||
|
||||
Only the first function out of the three described above will be explained in this section. The two kinds of allocation will be dealt with later,
|
||||
the allocation of resources in the chapter on "Resource management" and the filtering function in the chapter on "Task planning".
|
||||
* Criteria administration
|
||||
* Assigning criteria to resources
|
||||
* Assigning criteria to tasks
|
||||
* Filtering entities based on criteria. Tasks and order items can be filtered by criteria to perform various operations within the program.
|
||||
|
||||
This section will only explain the first function, criteria administration. The two types of allocation will be covered later: resource allocation in the "Resource Management" chapter, and filtering in the "Task Planning" chapter.
|
||||
|
||||
Criteria administration
|
||||
Criteria Administration
|
||||
=======================
|
||||
Criteria administration can be accessed from the administration menu:
|
||||
|
||||
Criteria administration can be accessed through the administration menu:
|
||||
|
||||
.. figure:: images/menu.png
|
||||
:scale: 50
|
||||
|
||||
First level menu tabs
|
||||
First-Level Menu Tabs
|
||||
|
||||
The specific operation to manage criteria is *Manage criteria*. The criteria available in the system can be listed by using this operation.
|
||||
The specific operation for managing criteria is *Manage criteria*. This operation allows you to list the criteria available in the system.
|
||||
|
||||
.. figure:: images/lista-criterios.png
|
||||
:scale: 50
|
||||
|
||||
List of criteria
|
||||
List of Criteria
|
||||
|
||||
The create/edit criterion form can be accessed by clicking on the *Create* button. A criterion can be edited by clicking on the edit icon.
|
||||
You can access the create/edit criterion form by clicking the *Create* button. To edit an existing criterion, click the edit icon.
|
||||
|
||||
.. figure:: images/edicion-criterio.png
|
||||
:scale: 50
|
||||
|
||||
Editing criteria
|
||||
Editing Criteria
|
||||
|
||||
The following operations can be carried out using the criteria editing form shown in the previous image:
|
||||
The criteria editing form, as shown in the previous image, allows you to perform the following operations:
|
||||
|
||||
* Editing the name of the criterion
|
||||
* Indicating whether several values can be allocated at the same time or just one element for the kind of criterion selected. For example, a resource that fulfils two criteria, welder and lathe operator.
|
||||
* Indicating the kind of criteria:
|
||||
|
||||
* Generic kind: A criterion that may be used for machines or workers alike.
|
||||
* Worker kind: A criterion that may be used only for a worker.
|
||||
* Machine kind: A criterion that may be used only for a machine.
|
||||
|
||||
* Indicating whether the criterion is hierarchical or not. Sometimes criteria must be treated hierarchically, for example, the fact that a criterion has been allocated to an element does not mean that this criterion is automatically allocated to issues that stem from it. A clear example of criteria hierarchy is the location criterion as it is hierarchical, for example, a person who has designated Galicia as their location will belong to Spain.
|
||||
* Indicating whether the criterion is authorised or not. This is the way users erase criteria. As a criterion cannot be changed once it has been created and used in historic data, the criterion must be on the system. It can be invalidated to avoid the criterion from appearing in different selection elements.
|
||||
* Describing the criterion.
|
||||
* Adding new values. A text entry with the *New criterion* button is on the second part of the form.
|
||||
* Editing the name of existing criteria.
|
||||
* Moving the criteria up or down the list of current criteria.
|
||||
* Removing a criteria value from the list.
|
||||
|
||||
The criteria administration form responds to the characteristics of the forms described in the introduction as 3 operations (save, save and close, and close).
|
||||
* **Edit the criterion's name.**
|
||||
* **Specify whether multiple values can be assigned simultaneously or only one value for the selected criterion type.** For example, a resource could fulfill two criteria, "welder" and "lathe operator."
|
||||
* **Specify the criterion type:**
|
||||
|
||||
* **Generic:** A criterion that can be used for both machines and workers.
|
||||
* **Worker:** A criterion that can only be used for workers.
|
||||
* **Machine:** A criterion that can only be used for machines.
|
||||
|
||||
* **Indicate whether the criterion is hierarchical.** Sometimes, criteria need to be treated hierarchically. For example, assigning a criterion to an element does not automatically assign it to elements derived from it. A clear example of a hierarchical criterion is "location." For instance, a person designated with the location "Galicia" will also belong to "Spain."
|
||||
* **Indicate whether the criterion is authorized.** This is how users deactivate criteria. Once a criterion has been created and used in historical data, it cannot be changed. Instead, it can be deactivated to prevent it from appearing in selection lists.
|
||||
* **Describe the criterion.**
|
||||
* **Add new values.** A text entry field with the *New criterion* button is located in the second part of the form.
|
||||
* **Edit the names of existing criteria values.**
|
||||
* **Move criteria values up or down in the list of current criteria values.**
|
||||
* **Remove a criterion value from the list.**
|
||||
|
||||
The criteria administration form follows the form behavior described in the introduction, offering three actions: *Save*, *Save and Close*, and *Close*.
|
||||
|
|
|
|||
|
|
@ -3,195 +3,176 @@ Calendars
|
|||
|
||||
.. contents::
|
||||
|
||||
Calendars are the program entities that determine the load capacity of different resources.
|
||||
A calendar consists of a series of days in the year with each day divided into available working hours.
|
||||
Calendars are entities within the program that define the working capacity of resources. A calendar consists of a series of days throughout the year, with each day divided into available working hours.
|
||||
|
||||
For example, a public holiday may have 0 hours available and, if the working hours in a workday are 8,
|
||||
this is the number of hours that is designated as available time for that day.
|
||||
For example, a public holiday might have 0 available working hours. Conversely, a typical workday might have 8 hours designated as available working time.
|
||||
|
||||
There are two ways of informing the system of how many working hours there are in a day:
|
||||
There are two primary ways to define the number of working hours in a day:
|
||||
|
||||
* According to weekday. For example, on Mondays people generally work 8 hours.
|
||||
* According to exceptions. For example, 10 working hours on Monday 30 January.
|
||||
* **By Weekday:** This method sets a standard number of working hours for each day of the week. For example, Mondays might typically have 8 working hours.
|
||||
* **By Exception:** This method allows for specific deviations from the standard weekday schedule. For example, Monday, January 30th, might have 10 working hours, overriding the standard Monday schedule.
|
||||
|
||||
Administration of calendars
|
||||
===========================
|
||||
Calendar Administration
|
||||
=======================
|
||||
|
||||
The calendar system is hierarchical, meaning that base calendars or calendars based on them can be created, thus maintaining a tree structure.
|
||||
A calendar based on a calendar from a higher level of the tree will take on the daily duties and exceptions, providing that they have not
|
||||
been explicitly modified for the new calendar. The following concepts must be understood to manage calendars:
|
||||
The calendar system is hierarchical, allowing you to create base calendars and then derive new calendars from them, forming a tree structure. A calendar derived from a higher-level calendar will inherit its daily schedules and exceptions unless explicitly modified. To effectively manage calendars, it's important to understand the following concepts:
|
||||
|
||||
* Each day is independent in itself and each year has different days. For example, if 8 December 2009 is a public holiday, this does not mean that 2010 already has 8 December marked as a public holiday.
|
||||
* Working days are based on weekdays. For example, if it is normal to work 8 hours on Mondays, all the Mondays from all the weeks in the different years will have 8 hours available.
|
||||
* Exceptions or exception periods can be marked. For example, choosing a specific day or several days which have a different number of hours available than the general rule for those weekdays.
|
||||
* **Day Independence:** Each day is treated independently, and each year has its own set of days. For example, if December 8th, 2009, is a public holiday, this does not automatically mean that December 8th, 2010, is also a public holiday.
|
||||
* **Weekday-Based Working Days:** Standard working days are based on weekdays. For example, if Mondays typically have 8 working hours, then all Mondays in all weeks of all years will have 8 available hours unless an exception is defined.
|
||||
* **Exceptions and Exception Periods:** You can define exceptions or exception periods to deviate from the standard weekday schedule. For example, you can specify a single day or a range of days with a different number of available working hours than the general rule for those weekdays.
|
||||
|
||||
.. figure:: images/calendar-administration.png
|
||||
:scale: 50
|
||||
|
||||
Administration of calendars
|
||||
Calendar Administration
|
||||
|
||||
The administration of calendars can be accessed from the procedures on the "Administration" tab. Users can carry out the following procedures from here:
|
||||
Calendar administration is accessible through the "Administration" menu. From there, users can perform the following actions:
|
||||
|
||||
1. Creating a new calendar from scratch.
|
||||
2. Creating a calendar based on another one.
|
||||
3. Creating a calendar as a copy of another one.
|
||||
4. Editing an existing calendar.
|
||||
1. Create a new calendar from scratch.
|
||||
2. Create a calendar derived from an existing one.
|
||||
3. Create a calendar as a copy of an existing one.
|
||||
4. Edit an existing calendar.
|
||||
|
||||
Creating a new calendar
|
||||
Creating a New Calendar
|
||||
-----------------------
|
||||
|
||||
In order to create a new calendar, users need to click the "Create" button.
|
||||
The system then shows a form where users can carry out the following procedures:
|
||||
To create a new calendar, click the "Create" button. The system will display a form where you can configure the following:
|
||||
|
||||
* Choosing the tab they want to work on.
|
||||
* **Select the Tab:** Choose the tab you want to work on:
|
||||
|
||||
* Marking exceptions.
|
||||
* Choosing hours worked per day.
|
||||
* **Marking Exceptions:** Define exceptions to the standard schedule.
|
||||
* **Working Hours per Day:** Define the standard working hours for each weekday.
|
||||
|
||||
* If users select the marking exceptions option, they can:
|
||||
* Select a specific day on the calendar.
|
||||
* Select the type of exception. The types available are: holidays, illness, strike, public holiday, working holiday.
|
||||
* Select the end date of the exception period (this field does not need to be changed to mark exceptions that only last 1 day).
|
||||
* Mark the number of hours worked during the days of the exception period.
|
||||
* Delete previous exceptions.
|
||||
* **Marking Exceptions:** If you select the "Marking Exceptions" option, you can:
|
||||
|
||||
* If users choose to select the number of hours worked per day, they can:
|
||||
* Select a specific day on the calendar.
|
||||
* Select the type of exception. The available types are: holiday, illness, strike, public holiday, and working holiday.
|
||||
* Select the end date of the exception period. (This field does not need to be changed for single-day exceptions.)
|
||||
* Define the number of working hours during the days of the exception period.
|
||||
* Delete previously defined exceptions.
|
||||
|
||||
* Mark the hours available for each weekday (Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday).
|
||||
* Distribute different weekly hours for the future.
|
||||
* Delete previous hour distribution lists.
|
||||
* **Working Hours per Day:** If you select the "Working Hours per Day" option, you can:
|
||||
|
||||
With these procedures, users of the program can fully personalise the calendars according to their needs.
|
||||
Users need to click the "Save" button to store changes made to the form.
|
||||
* Define the available working hours for each weekday (Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, and Sunday).
|
||||
* Define different weekly hour distributions for future periods.
|
||||
* Delete previously defined hour distributions.
|
||||
|
||||
These options allow users to fully customize calendars according to their specific needs. Click the "Save" button to store any changes made to the form.
|
||||
|
||||
.. figure:: images/calendar-edition.png
|
||||
:scale: 50
|
||||
|
||||
Editing calendars
|
||||
Editing Calendars
|
||||
|
||||
.. figure:: images/calendar-exceptions.png
|
||||
:scale: 50
|
||||
|
||||
Adding an exception to calendars
|
||||
Adding an Exception to a Calendar
|
||||
|
||||
Creating derived calendars
|
||||
----------------------------------
|
||||
Creating Derived Calendars
|
||||
--------------------------
|
||||
|
||||
A derived calendar is a calendar created from another existing one. For example, it has all the features of the original one,
|
||||
but users can change it to contain other options.
|
||||
A derived calendar is created based on an existing calendar. It inherits all the features of the original calendar, but you can modify it to include different options.
|
||||
|
||||
An example of using derived calendars is when there is a general calendar for Spain, and the creation of a derived calendar
|
||||
to include public holidays in Galicia in additional to the ones defined in the general calendar.
|
||||
A common use case for derived calendars is when you have a general calendar for a country, such as Spain, and you need to create a derived calendar to include additional public holidays specific to a region, such as Galicia.
|
||||
|
||||
It is important to point out that any change made to the original calendar is made directly to the derived calendar,
|
||||
providing that a specific exception against this was not defined. For example, the calendar for Spain has an 8-hour working day on 17 May,
|
||||
but the calendar for Galicia (a derived calendar) has no working hours on the very same day, as it is a public holiday.
|
||||
If the Spanish calendar was changed to have 4 hours available per day for the week of 17 May, the Galician calendar would also
|
||||
change to have 4 hours available for every day on the same week, except 17 May, which would have no working hours for the reason stated above.
|
||||
It's important to note that any changes made to the original calendar will automatically propagate to the derived calendar, unless a specific exception has been defined in the derived calendar. For example, the calendar for Spain might have an 8-hour working day on May 17th. However, the calendar for Galicia (a derived calendar) might have no working hours on that same day because it's a regional public holiday. If the Spanish calendar is later changed to have 4 available working hours per day for the week of May 17th, the Galician calendar will also change to have 4 available working hours for every day in that week, except for May 17th, which will remain a non-working day due to the defined exception.
|
||||
|
||||
.. figure:: images/calendar-create-derived.png
|
||||
:scale: 50
|
||||
|
||||
Creating a derived calendar
|
||||
Creating a Derived Calendar
|
||||
|
||||
To create a derived calendar in the program, it is necessary to:
|
||||
To create a derived calendar:
|
||||
|
||||
* Go to the *Administration* menu.
|
||||
* Click the *Calendar administration* procedure.
|
||||
* Choose one of the calendars to be the basis for a derived calendar and click the "Create" button.
|
||||
* Once this procedure has been carried out, the system shows an editing form with the same characteristics as the forms used to create forms from scratch, with the difference that the proposed exceptions and the hours per weekday are based on the original calendar.
|
||||
* Go to the *Administration* menu.
|
||||
* Click the *Calendar administration* option.
|
||||
* Select the calendar you want to use as the basis for the derived calendar and click the "Create" button.
|
||||
* The system will display an editing form with the same characteristics as the form used to create a calendar from scratch, except that the proposed exceptions and the working hours per weekday will be based on the original calendar.
|
||||
|
||||
Creating a calendar by copying
|
||||
Creating a Calendar by Copying
|
||||
------------------------------
|
||||
|
||||
A copied calendar is a calendar created as an exact copy of another existing one. For example, it has all the features of the original one,
|
||||
but users can also change it to contain other options.
|
||||
A copied calendar is an exact duplicate of an existing calendar. It inherits all the features of the original calendar, but you can modify it independently.
|
||||
|
||||
The difference between a copied and a derived calendar is based on the changes in the original. In relation to copies, if the original
|
||||
is modified, the copy is not affected. However, derived calendars are affected by changes made to the original.
|
||||
The key difference between a copied calendar and a derived calendar is how they are affected by changes to the original. If the original calendar is modified, the copied calendar remains unchanged. However, derived calendars are affected by changes made to the original, unless an exception is defined.
|
||||
|
||||
An example of using a copied calendar is having a calendar for "Pontevedra" and needing a calendar for "A Coruña", for which most of
|
||||
the features would be the same. However, changes on one calendar should not be reflected in the other.
|
||||
A common use case for copied calendars is when you have a calendar for one location, such as "Pontevedra," and you need a similar calendar for another location, such as "A Coruña," where most of the features are the same. However, changes to one calendar should not affect the other.
|
||||
|
||||
To create a copied calendar in the program, it is necessary to do the following:
|
||||
To create a copied calendar:
|
||||
|
||||
* Go to the *Administration* menu.
|
||||
* Click the Calendar administration procedure.
|
||||
* Choose one of the calendars to be the basis for a derived calendar and click the "Create" button.
|
||||
* Once this procedure has been carried out, the system shows an editing form with the same characteristics as the forms used to create forms from scratch, with the difference that the proposed exceptions and the hours per weekday are based on the original calendar.
|
||||
* Go to the *Administration* menu.
|
||||
* Click the *Calendar administration* option.
|
||||
* Select the calendar you want to copy and click the "Create" button.
|
||||
* The system will display an editing form with the same characteristics as the form used to create a calendar from scratch, except that the proposed exceptions and the working hours per weekday will be based on the original calendar.
|
||||
|
||||
Default calendar
|
||||
Default Calendar
|
||||
----------------
|
||||
|
||||
One of the existing calendars in the system can be marked as the default calendar.
|
||||
This calendar is the one that will be designated to any entity in the system that is managed with calendars.
|
||||
One of the existing calendars can be designated as the default calendar. This calendar will be automatically assigned to any entity in the system that is managed with calendars unless a different calendar is specified.
|
||||
|
||||
The following must be carried out to set up a default calendar:
|
||||
To set up a default calendar:
|
||||
|
||||
* Go to the *Administration* menu.
|
||||
* Click the *Configuration* procedure.
|
||||
* Where *Default calendar* appears, select the calendar to be used as the program's default calendar.
|
||||
* Click *Save*.
|
||||
* Go to the *Administration* menu.
|
||||
* Click the *Configuration* option.
|
||||
* In the *Default calendar* field, select the calendar you want to use as the program's default calendar.
|
||||
* Click *Save*.
|
||||
|
||||
.. figure:: images/default-calendar.png
|
||||
:scale: 50
|
||||
|
||||
Creating a default calendar
|
||||
Setting a Default Calendar
|
||||
|
||||
Assigning a calendar to resources
|
||||
Assigning a Calendar to Resources
|
||||
---------------------------------
|
||||
|
||||
Resources can only be activated, i.e. available working hours, if they have an assigned calendar with a valid activation period.
|
||||
If no calendar is assigned to resources, the default calendar is assigned with an activation period that begins on the start
|
||||
date and does not have an expiry date.
|
||||
Resources can only be activated (i.e., have available working hours) if they have an assigned calendar with a valid activation period. If no calendar is assigned to a resource, the default calendar is assigned automatically, with an activation period that begins on the start date and has no expiry date.
|
||||
|
||||
.. figure:: images/resource-calendar.png
|
||||
:scale: 50
|
||||
|
||||
Calendar of resources
|
||||
Resource Calendar
|
||||
|
||||
However, users can delete the calendar that has been previously assigned to a resource and create a new calendar based on one that already exists.
|
||||
Consequently, resources can be fully personalised in relation to calendars.
|
||||
However, you can delete the calendar that has been previously assigned to a resource and create a new calendar based on an existing one. This allows for complete customization of calendars for individual resources.
|
||||
|
||||
The following steps have to be carried out to assign a calendar:
|
||||
To assign a calendar to a resource:
|
||||
|
||||
* Go to the Edit resources option.
|
||||
* Choose a resource and click edit.
|
||||
* Select the "Calendar" tab.
|
||||
* A calendar with the exceptions, workable hours per day and activation periods will then appear on the previous tab.
|
||||
* Each tab will have:
|
||||
* Go to the *Edit resources* option.
|
||||
* Select a resource and click *Edit*.
|
||||
* Select the "Calendar" tab.
|
||||
* The calendar, along with its exceptions, working hours per day, and activation periods, will be displayed.
|
||||
* Each tab will have the following options:
|
||||
|
||||
* Exceptions: Users can choose the kind of exception and a period to which it applies in order to include holidays, public holidays, different workdays, etc.
|
||||
* Working week: Users can change the hours worked during the different weekdays (Monday, Tuesday, etc.).
|
||||
* Activation periods: Users can create new activation periods that reflect the start and end dates of the contracts associated with the resource. See the following image.
|
||||
* **Exceptions:** Define exceptions and the period to which they apply, such as holidays, public holidays, or different workdays.
|
||||
* **Working Week:** Modify the working hours for each weekday (Monday, Tuesday, etc.).
|
||||
* **Activation Periods:** Create new activation periods to reflect the start and end dates of contracts associated with the resource. See the following image.
|
||||
|
||||
* Users need to click *Save* to store information.
|
||||
* Users can click *Delete* if they want to change the calendar assigned to a resource.
|
||||
* Click *Save* to store the information.
|
||||
* Click *Delete* if you want to change the calendar assigned to a resource.
|
||||
|
||||
.. figure:: images/new-resource-calendar.png
|
||||
:scale: 50
|
||||
|
||||
Assigning new calendars to resources
|
||||
Assigning a New Calendar to a Resource
|
||||
|
||||
Assigning calendars to orders
|
||||
Assigning Calendars to Orders
|
||||
-----------------------------
|
||||
|
||||
Projects can have a different calendar to the default calendar. Users need to do the following to change the calendar for the order:
|
||||
Projects can have a different calendar than the default calendar. To change the calendar for an order:
|
||||
|
||||
* Access the order list in the company overview.
|
||||
* Edit the order in question.
|
||||
* Access the "General information" tab.
|
||||
* Select the calendar to be assigned on the drop-down menu.
|
||||
* Click "Save" or "Save and continue".
|
||||
* Access the order list in the company overview.
|
||||
* Edit the order in question.
|
||||
* Access the "General information" tab.
|
||||
* Select the calendar to be assigned from the drop-down menu.
|
||||
* Click "Save" or "Save and continue."
|
||||
|
||||
Assigning calendars to tasks
|
||||
Assigning Calendars to Tasks
|
||||
----------------------------
|
||||
In the same way that calendars can be assigned to resources or orders, users can carry out the same procedure for planned tasks.
|
||||
This procedure allows specific calendars to be defined for specific stages of a project. To carry out this procedure, it is necessary to:
|
||||
|
||||
* Access the planning of a project.
|
||||
* Right click the task to which a calendar is to be assigned.
|
||||
* Select the "Assign calendar" procedure.
|
||||
* Select the calendar to be assigned to the task.
|
||||
* Click *Accept*.
|
||||
Similar to resources and orders, you can assign specific calendars to individual tasks. This allows you to define different calendars for specific stages of a project. To assign a calendar to a task:
|
||||
|
||||
* Access the planning view of a project.
|
||||
* Right-click the task to which you want to assign a calendar.
|
||||
* Select the "Assign calendar" option.
|
||||
* Select the calendar to be assigned to the task.
|
||||
* Click *Accept*.
|
||||
|
|
|
|||
|
|
@ -3,107 +3,86 @@ Progress
|
|||
|
||||
.. contents::
|
||||
|
||||
The progress of a project shows the degree to which the estimated time of completion of the project is being fulfilled,
|
||||
and the progress of a task indicates the degree to which it is being fulfilled in terms of estimated completion.
|
||||
Project progress indicates the degree to which the estimated completion time of the project is being met. Task progress indicates the degree to which the task is being completed according to its estimated completion.
|
||||
|
||||
In general, progress cannot be measured automatically; a member of staff with experience or a checklist has to determine the degree
|
||||
of completion of a task or project.
|
||||
Generally, progress cannot be measured automatically. A staff member with experience or a checklist must determine the degree of completion for a task or project.
|
||||
|
||||
It should be noted that there is a significant difference between the use of hours assigned to a task or project and the degree
|
||||
of progress of that task or project. While the number of used hours may be more or less than they should be, the project may be behind
|
||||
or ahead of its estimated completion on the day that is being monitored. Several possible situations may arise due to these two measurements:
|
||||
It's important to note the distinction between the hours assigned to a task or project and the progress of that task or project. While the number of hours used may be more or less than expected, the project may be ahead of or behind its estimated completion on the monitored day. Several situations can arise from these two measurements:
|
||||
|
||||
* Less hours are consumed than expected for the element that is to be measured and, at the same time, the project is more behind than expected because progress is lower than estimated for the day that is being monitored.
|
||||
* Less hours are consumed than expected for the element that is to be measured and, at the same time, the project is more ahead than expected because progress is lower than estimated for the day that is being monitored.
|
||||
* More hours are consumed than expected and, at the same time, the project is more behind than expected because progress is lower than estimated for the day that is being monitored.
|
||||
* More hours are consumed than expected and, at the same time, the project is more ahead than expected because progress is lower than expected for the day that is being monitored.
|
||||
* **Fewer hours consumed than expected, but the project is behind schedule:** Progress is lower than estimated for the monitored day.
|
||||
* **Fewer hours consumed than expected, and the project is ahead of schedule:** Progress is higher than estimated for the monitored day.
|
||||
* **More hours consumed than expected, and the project is behind schedule:** Progress is lower than estimated for the monitored day.
|
||||
* **More hours consumed than expected, but the project is ahead of schedule:** Progress is higher than estimated for the monitored day.
|
||||
|
||||
It is possible to compare these possible situations from the planning itself by using information relating to the degree of progress
|
||||
made and also the degree to which the hours have been used. This chapter will deal with the entering of information in order to carry out
|
||||
the monitoring of progress.
|
||||
The planning view allows you to compare these situations by using information about the progress made and the hours used. This chapter will explain how to enter information to monitor progress.
|
||||
|
||||
The philosophy of the project for monitoring progress is based on the users stating how far they want to monitor the progress of their projects.
|
||||
As a result, if users want to monitor orders, they only have to enter information for level-1 elements. If they want monitoring to be more precise
|
||||
in relation to tasks, they have to enter information about progress at lower levels, and it is the system that transmits all of the data upwards
|
||||
in the hierarchy.
|
||||
The philosophy behind progress monitoring is based on users defining the level at which they want to monitor their projects. For example, if users want to monitor orders, they only need to enter information for level-1 elements. If they want more precise monitoring at the task level, they must enter progress information at lower levels. The system will then aggregate the data upward through the hierarchy.
|
||||
|
||||
Managing types of progress
|
||||
==========================
|
||||
Managing Progress Types
|
||||
=======================
|
||||
|
||||
All companies have different needs when monitoring project progress, specifically the tasks they consist of. It was therefore necessary
|
||||
to consider the existence of entities in the system called “types of progress”. Users can register the different types of progress in the system
|
||||
to measure a task's progress. For example, a task can be measured in percentage terms, but at the same time, this percentage progress can be
|
||||
translated to progress in *Tonnes* on the agreed amount with the client.
|
||||
Companies have varying needs when monitoring project progress, particularly the tasks involved. Therefore, the system includes "progress types." Users can define different progress types to measure a task's progress. For example, a task can be measured as a percentage, but this percentage can also be translated into progress in *Tonnes* based on the agreement with the client.
|
||||
|
||||
A type of progress is given a name, a maximum value and a precision value:
|
||||
A progress type has a name, a maximum value, and a precision value:
|
||||
|
||||
* Name: This is a representative name that users must remember so that when selecting the progress designation, they understand what kind of progress is to be measured.
|
||||
* Maximum value: This is the maximum value that can be established for a task or project as the total progress measurement. For example, when working with *Tonnes*, if we take the normal maximum of tonnes to be 4000 and there are never going to be tasks that need more than 4000 tonnes of any material, this would be the maximum established amount.
|
||||
* Precision value: The value of the increases allowed for the type of progress created. For example, if progress in *Tonnes* is to be measured in rounded values, 1 could be the precision value. From that moment on, only progress measurements with whole numbers can be entered, for example 1, 2, 300, etc.
|
||||
* **Name:** A descriptive name that users will recognize when selecting the progress type. This name should clearly indicate what kind of progress is being measured.
|
||||
* **Maximum Value:** The maximum value that can be established for a task or project as the total progress measurement. For example, if you're working with *Tonnes* and the normal maximum is 4000 tonnes, and no task will ever require more than 4000 tonnes of any material, then 4000 would be the maximum value.
|
||||
* **Precision Value:** The increment value allowed for the progress type. For example, if progress in *Tonnes* is to be measured in whole numbers, the precision value would be 1. From that point on, only whole numbers can be entered as progress measurements (e.g., 1, 2, 300).
|
||||
|
||||
The system has two types of default progress:
|
||||
The system has two default progress types:
|
||||
|
||||
* Percentage: a type of general progress that enables the progress of a project or task to be measured based on an estimated completion percentage. For example, a task is 30% complete out of the 100% estimated for a specific day.
|
||||
* Units: a type of general progress that enables the progress to be measured in units without the need to state specific units. For example, a task consists of creating 3000 units and the progress is 500 units out of the total of 3000.
|
||||
* **Percentage:** A general progress type that measures the progress of a project or task based on an estimated completion percentage. For example, a task is 30% complete out of the 100% estimated for a specific day.
|
||||
* **Units:** A general progress type that measures progress in units without specifying the type of unit. For example, a task involves creating 3000 units, and the progress is 500 units out of the total of 3000.
|
||||
|
||||
.. figure:: images/tipos-avances.png
|
||||
:scale: 50
|
||||
|
||||
Administration of types of progress
|
||||
Administration of Progress Types
|
||||
|
||||
Users can create new types of progress in the following way:
|
||||
Users can create new progress types as follows:
|
||||
|
||||
* Go to the "Administration" section.
|
||||
* Click the second level menu option "Manage types of progress".
|
||||
* The system will then show a list of existing types of progress.
|
||||
* Users may do the following with each type of progress:
|
||||
* Go to the "Administration" section.
|
||||
* Click the "Manage types of progress" option in the second-level menu.
|
||||
* The system will display a list of existing progress types.
|
||||
* For each progress type, users can:
|
||||
|
||||
* Edit
|
||||
* Delete
|
||||
* Edit
|
||||
* Delete
|
||||
|
||||
* Then users can create a new type of progress.
|
||||
* When editing or creating, the system shows a form with the following information:
|
||||
* Users can then create a new progress type.
|
||||
* When editing or creating a progress type, the system displays a form with the following information:
|
||||
|
||||
* Name of the type of progress.
|
||||
* Maximum value accepted by the type of progress.
|
||||
* Precision value for the type of progress.
|
||||
* Name of the progress type.
|
||||
* Maximum value allowed for the progress type.
|
||||
* Precision value for the progress type.
|
||||
|
||||
Entering progress based on type
|
||||
Entering Progress Based on Type
|
||||
===============================
|
||||
|
||||
Entering progress is done on order elements, but it can also be done using a short cut from the planning tasks.
|
||||
The decision on what type of progress users want to associate with each order element is their own responsibility.
|
||||
Progress is entered for order elements, but it can also be entered using a shortcut from the planning tasks. Users are responsible for deciding which progress type to associate with each order element.
|
||||
|
||||
Users can enter a unique and default type of progress for the whole order.
|
||||
Users can enter a single, default progress type for the entire order.
|
||||
|
||||
Before carrying out progress measurements, users need to associate the chosen type with the order.
|
||||
For example, progress in percentage terms to measure progress made on the entire task or an agreed progress rate if progress
|
||||
measurements agreed with the client are to be entered in the future.
|
||||
Before measuring progress, users must associate the chosen progress type with the order. For example, they might choose percentage progress to measure progress on the entire task or an agreed progress rate if progress measurements agreed upon with the client will be entered in the future.
|
||||
|
||||
.. figure:: images/avance.png
|
||||
:scale: 40
|
||||
|
||||
Progress entering screen with graphic visualisation.
|
||||
Progress Entry Screen with Graphic Visualization
|
||||
|
||||
The following must be done to enter progress measurements:
|
||||
To enter progress measurements:
|
||||
|
||||
* Select the type of progress to which the progress is going to be added.
|
||||
* Select the progress type to which the progress will be added.
|
||||
* If no progress type exists, a new one must be created.
|
||||
* In the form that appears under the "Value" and "Date" fields, enter the absolute value of the measurement and the date of the measurement.
|
||||
* The system automatically stores the entered data.
|
||||
|
||||
* If there is no type of progress, a new type of progress must be added.
|
||||
Comparing Progress for an Order Element
|
||||
=======================================
|
||||
|
||||
* In the form that appears under the "Value" and "Date" fields, enter the absolute value of the measurement and the date that is to be given to the measurement taken.
|
||||
* The system automatically stores the entered data.
|
||||
|
||||
|
||||
Comparison of progress with an order element
|
||||
============================================
|
||||
|
||||
Users can compare graphically how much progress is being made on the orders with the measurements taken.
|
||||
All types of progress have a column with a check button (called "Show").
|
||||
When this is marked, the progress chart of measurements taken is shown on the order element.
|
||||
Users can graphically compare the progress made on orders with the measurements taken. All progress types have a column with a check button ("Show"). When this button is selected, the progress chart of measurements taken is displayed for the order element.
|
||||
|
||||
.. figure:: images/contraste-avance.png
|
||||
:scale: 40
|
||||
|
||||
Comparison of several kinds of progress.
|
||||
|
||||
Comparison of Several Progress Types
|
||||
|
|
|
|||
|
|
@ -1,177 +1,173 @@
|
|||
Management of resources
|
||||
#######################
|
||||
Resource Management
|
||||
####################
|
||||
|
||||
.. _recursos:
|
||||
.. contents::
|
||||
|
||||
The program manages two different types of resources: staff and machines.
|
||||
The program manages two distinct types of resources: staff and machines.
|
||||
|
||||
Staff resources are the workers of the companies. Their main characteristics are:
|
||||
Staff Resources
|
||||
---------------
|
||||
|
||||
* They fulfil one or several generic or worker criteria.
|
||||
* They can be specifically assigned to a task.
|
||||
* They can be assigned, as part of the generic assignment, to a task that requires a resource criterion.
|
||||
* They have a default or specific calendar if the user so decides.
|
||||
Staff resources represent the company's workers. Their key characteristics are:
|
||||
|
||||
Machine resources are the machines in the companies. Their main characteristics are:
|
||||
* They fulfill one or more generic or worker-specific criteria.
|
||||
* They can be specifically assigned to a task.
|
||||
* They can be assigned generically to a task that requires a resource criterion.
|
||||
* They can have a default or a specific calendar, as needed.
|
||||
|
||||
* They fulfil one or several generic or machine criteria.
|
||||
* They can be specifically assigned to a task.
|
||||
* They can be assigned, as part of the generic assignment, to a task that requires a machine criterion.
|
||||
* They have a default or specific calendar if the user so decides.
|
||||
* The program will have a configuration screen where an *alpha* value can be set up that represents the machine/worker ratio.
|
||||
Machine Resources
|
||||
-----------------
|
||||
|
||||
* The *alpha* value represents how much time a worker is needed to make the machine work. For example, an alpha value of 0.5 means that every 8 hours of machine work requires 4 hours of a worker’s time.
|
||||
* Users can assign an *alpha* value specifically to a worker, i.e. selecting the worker who will be assigned to the machine for this percentage of time.
|
||||
* Users can also make a generic assignment based on one criterion, so that a percentage of use is assigned to all the criteria that fulfil this criterion and have time available. Generic assignment works in the same way as generic assignment to tasks, which has already been explained.
|
||||
Machine resources represent the company's machinery. Their key characteristics are:
|
||||
|
||||
Users can create, edit and invalidate (never delete definitively) workers from the company by going to the "Resources" tab. This tab has the following features:
|
||||
* They fulfill one or more generic or machine-specific criteria.
|
||||
* They can be specifically assigned to a task.
|
||||
* They can be assigned generically to a task that requires a machine criterion.
|
||||
* They can have a default or a specific calendar, as needed.
|
||||
* The program includes a configuration screen where an *alpha* value can be defined to represent the machine/worker ratio.
|
||||
|
||||
* List of workers: Workers will be shown in lists and will be numbered. This is where their details can be managed.
|
||||
* List of machines: Machines will be shown in lists and will be numbered. This is where their details can be managed.
|
||||
* The *alpha* value indicates the amount of worker time required to operate the machine. For example, an alpha value of 0.5 means that every 8 hours of machine operation requires 4 hours of a worker's time.
|
||||
* Users can assign an *alpha* value specifically to a worker, designating that worker to operate the machine for that percentage of time.
|
||||
* Users can also make a generic assignment based on a criterion, so that a percentage of use is assigned to all resources that meet that criterion and have available time. Generic assignment works similarly to generic assignment for tasks, as described previously.
|
||||
|
||||
Management of workers
|
||||
Managing Resources
|
||||
------------------
|
||||
|
||||
Users can create, edit, and deactivate (but not permanently delete) workers and machines within the company by navigating to the "Resources" section. This section provides the following features:
|
||||
|
||||
* **List of Workers:** Displays a numbered list of workers, allowing users to manage their details.
|
||||
* **List of Machines:** Displays a numbered list of machines, allowing users to manage their details.
|
||||
|
||||
Managing Workers
|
||||
================
|
||||
|
||||
Worker management is accessed by going to the "Resources" section and then selecting "List of workers." Users can edit any worker in the list by clicking the standard edit icon.
|
||||
|
||||
When editing a worker, users can access the following tabs:
|
||||
|
||||
1. **Worker Details:** This tab allows users to edit the worker's basic identification details:
|
||||
|
||||
* Name
|
||||
* Surname(s)
|
||||
* National ID document (DNI)
|
||||
* Queue-based resource (see section on Queue-based Resources)
|
||||
|
||||
.. figure:: images/worker-personal-data.png
|
||||
:scale: 50
|
||||
|
||||
Editing Workers' Personal Details
|
||||
|
||||
2. **Criteria:** This tab is used to configure the criteria that a worker fulfills. Users can assign any worker or generic criteria they deem appropriate. It's crucial for workers to fulfill criteria to maximize the program's functionality. To assign criteria:
|
||||
|
||||
i. Click the "Add criteria" button.
|
||||
ii. Search for the criterion to be added and select the most appropriate one.
|
||||
iii. Click the "Add" button.
|
||||
iv. Select the start date when the criterion becomes applicable.
|
||||
v. Select the end date for applying the criterion to the resource. This date is optional if the criterion is considered indefinite.
|
||||
|
||||
.. figure:: images/worker-criterions.png
|
||||
:scale: 50
|
||||
|
||||
Associating Criteria with Workers
|
||||
|
||||
3. **Calendar:** This tab allows users to configure a specific calendar for the worker. All workers have a default calendar assigned; however, it's possible to assign a specific calendar to each worker based on an existing calendar.
|
||||
|
||||
.. figure:: images/worker-calendar.png
|
||||
:scale: 50
|
||||
|
||||
Calendar Tab for a Resource
|
||||
|
||||
4. **Cost Category:** This tab allows users to configure the cost category that a worker fulfills during a given period. This information is used to calculate the costs associated with a worker on a project.
|
||||
|
||||
.. figure:: images/worker-costcategory.png
|
||||
:scale: 50
|
||||
|
||||
Cost Category Tab for a Resource
|
||||
|
||||
Resource assignment is explained in the "Resource Assignment" section.
|
||||
|
||||
Managing Machines
|
||||
=================
|
||||
|
||||
Machines are treated as resources for all purposes. Therefore, similar to workers, machines can be managed and assigned to tasks. Resource assignment is covered in the "Resource Assignment" section, which will explain the specific features of machines.
|
||||
|
||||
Machines are managed from the "Resources" menu entry. This section has an operation called "Machine list," which displays the company's machines. Users can edit or delete a machine from this list.
|
||||
|
||||
When editing machines, the system displays a series of tabs for managing different details:
|
||||
|
||||
1. **Machine Details:** This tab allows users to edit the machine's identification details:
|
||||
|
||||
i. Name
|
||||
ii. Machine code
|
||||
iii. Description of the machine
|
||||
|
||||
.. figure:: images/machine-data.png
|
||||
:scale: 50
|
||||
|
||||
Editing Machine Details
|
||||
|
||||
2. **Criteria:** As with worker resources, this tab is used to add criteria that the machine fulfills. Two types of criteria can be assigned to machines: machine-specific or generic. Worker criteria cannot be assigned to machines. To assign criteria:
|
||||
|
||||
i. Click the "Add criteria" button.
|
||||
ii. Search for the criterion to be added and select the most appropriate one.
|
||||
iii. Select the start date when the criterion becomes applicable.
|
||||
iv. Select the end date for applying the criterion to the resource. This date is optional if the criterion is considered indefinite.
|
||||
v. Click the "Save and continue" button.
|
||||
|
||||
.. figure:: images/machine-criterions.png
|
||||
:scale: 50
|
||||
|
||||
Assigning Criteria to Machines
|
||||
|
||||
3. **Calendar:** This tab allows users to configure a specific calendar for the machine. All machines have a default calendar assigned; however, it's possible to assign a specific calendar to each machine based on an existing calendar.
|
||||
|
||||
.. figure:: images/machine-calendar.png
|
||||
:scale: 50
|
||||
|
||||
Assigning Calendars to Machines
|
||||
|
||||
4. **Machine Configuration:** This tab allows users to configure the ratio of machines to worker resources. A machine has an alpha value that indicates the machine/worker ratio. As mentioned previously, an alpha value of 0.5 indicates that 0.5 people are required for each full day of machine operation. Based on the alpha value, the system automatically assigns workers who are associated with the machine once the machine is assigned to a task. Associating a worker with a machine can be done in two ways:
|
||||
|
||||
i. **Specific Assignment:** Assign a range of dates during which the worker is assigned to the machine. This is a specific assignment, as the system automatically assigns hours to the worker when the machine is scheduled.
|
||||
ii. **Generic Assignment:** Assign criteria that must be fulfilled by workers assigned to the machine. This creates a generic assignment of workers who meet the criteria.
|
||||
|
||||
.. figure:: images/machine-configuration.png
|
||||
:scale: 50
|
||||
|
||||
Configuration of Machines
|
||||
|
||||
5. **Cost Category:** This tab allows users to configure the cost category that a machine fulfills during a given period. This information is used to calculate the costs associated with a machine on a project.
|
||||
|
||||
.. figure:: images/machine-costcategory.png
|
||||
:scale: 50
|
||||
|
||||
Assigning Cost Categories to Machines
|
||||
|
||||
Virtual Worker Groups
|
||||
=====================
|
||||
|
||||
The management of workers is carried out by going to the "Resources" tab and then the feature "List of workers". Users can edit all of the workers on the resource list by clicking the standard editing icon.
|
||||
The program allows users to create virtual worker groups, which are not real workers but simulated staff. These groups enable users to model increased production capacity at specific times, based on the calendar settings.
|
||||
|
||||
When users are in the editing option of a resource, they can access the following tabs:
|
||||
Virtual worker groups allow users to assess how project planning would be affected by hiring and assigning staff who meet specific criteria, thus aiding in the decision-making process.
|
||||
|
||||
1) Worker details tab. This tab lets users edit the basic ID details of workers.
|
||||
The tabs for creating virtual worker groups are the same as those for configuring workers:
|
||||
|
||||
* Name
|
||||
* Surname(s)
|
||||
* National ID document (DNI)
|
||||
* Limiting resource (see section)
|
||||
* General Details
|
||||
* Assigned Criteria
|
||||
* Calendars
|
||||
* Associated Hours
|
||||
|
||||
|
||||
.. figure:: images/worker-personal-data.png
|
||||
:scale: 50
|
||||
|
||||
Editing workers' personal details
|
||||
|
||||
2) Criteria tab. This is where the criteria fulfilled by a worker can be configured. Users can assign any worker or generic criteria that they consider suitable to a worker. It is important that the workers fulfil criteria in order for the program to be used to its full extent. Users must do the following to assign criteria:
|
||||
|
||||
i. Click the "Add criteria" button.
|
||||
|
||||
ii. Search for the criterion to be added and select the most appropriate.
|
||||
|
||||
iii. Click the add button.
|
||||
|
||||
iv. Select the start date of the criterion when it becomes applicable.
|
||||
|
||||
v. Select the end date for applying the criterion to the resource. This date is not obligatory if the criterion is shown as being indefinite.
|
||||
|
||||
.. figure:: images/worker-criterions.png
|
||||
:scale: 50
|
||||
|
||||
Associating criteria with workers
|
||||
|
||||
3) Calendar tab. This tab can be used to configure a specific calendar for the worker resource. All workers have an assigned default calendar; however, it is possible to assign a specific calendar for each one based on an existing calendar.
|
||||
|
||||
.. figure:: images/worker-calendar.png
|
||||
:scale: 50
|
||||
|
||||
Calendar tab for a resource
|
||||
|
||||
4) Cost category tab. This tab can be used to configure the cost category that a resource fulfils in a given time. These details are used to subsequently calculate the costs relating to a worker in a project.
|
||||
|
||||
.. figure:: images/worker-costcategory.png
|
||||
:scale: 50
|
||||
|
||||
Cost category tab for a resource
|
||||
|
||||
Resource assignment is explained in the resource assignment section.
|
||||
|
||||
Management of machines
|
||||
=======================
|
||||
|
||||
Machines are resources for all purposes; therefore, similar to workers, machines can be managed and assigned tasks. Resource assignment is dealt with in the assignment section, in which the specific features of machines will be explained.
|
||||
|
||||
Machines are managed from the "Resources" menu entry. This section has an operation called "Machine list", which shows the machines a company has. Users can edit or delete a machine from this list.
|
||||
|
||||
When editing machines, the system shows a series of tabs that can be used to manage different details:
|
||||
|
||||
1) Machine details tab. This tab can be used to edit the ID details of the machines. The details that can be changed on this tab are:
|
||||
|
||||
i Name.
|
||||
|
||||
ii Machine code.
|
||||
|
||||
iii Description of the machine.
|
||||
|
||||
|
||||
.. figure:: images/machine-data.png
|
||||
:scale: 50
|
||||
|
||||
Editing machine details
|
||||
|
||||
2) Criteria tab. As stated in the previous section on worker resources, this tab is used to add criteria that are fulfilled by the different machines on the system. There are two types of criteria that can be assigned to machines: machine or generic. Worker criteria cannot be assigned to machines. Users must do the following to assign criteria:
|
||||
|
||||
i. Click the "Add criteria" button.
|
||||
|
||||
ii. Search for the criterion to be added and select the most appropriate.
|
||||
|
||||
iii. Select the start date for the criterion when it becomes applicable.
|
||||
|
||||
iv. Select the end date for applying the criterion to the resource. This date is not obligatory if the criterion is shown as being indefinite.
|
||||
|
||||
v. Click the "Save and continue" button.
|
||||
|
||||
.. figure:: images/machine-criterions.png
|
||||
:scale: 50
|
||||
|
||||
Assigning criteria to machines
|
||||
|
||||
3) Calendar tab. This tab can be used to configure a specific calendar for the machine resource. All workers have an assigned default calendar; however, it is possible to assign a specific calendar for each one based on an existing calendar.
|
||||
|
||||
.. figure:: images/machine-calendar.png
|
||||
:scale: 50
|
||||
|
||||
Assigning calendars to machines
|
||||
|
||||
4) Machine configuration tab. On this tab, it is possible to configure the ratio of machines to existing worker resources. A machine has an alpha value that indicates the machine/involved resources ratio. As has already been mentioned, an alpha value of 0.5 indicates that 0.5 people are used for each full day's operation of a machine. The system, based on an alpha value, automatically assigns workers who are in some way associated with a machine once the machine is assigned to a task. Associating a worker with a machine can be done in two ways:
|
||||
|
||||
i Specifically assigning a range of dates on which the worker is to be assigned to a machine. This is a specific assignment as the system automatically assigns hours to the worker when the machine is planned.
|
||||
|
||||
ii Specifically assigning criteria to be fulfilled by workers who are assigned to machines. This creates a generic assignment of workers who fulfil the criteria.
|
||||
|
||||
.. figure:: images/machine-configuration.png
|
||||
:scale: 50
|
||||
|
||||
Configuration of machines
|
||||
|
||||
5) Cost category tab. This tab can be used to configure the cost category fulfilled by a machine in a given time. These details are used to subsequently calculate the costs relating to a worker in a project.
|
||||
|
||||
.. figure:: images/machine-costcategory.png
|
||||
:scale: 50
|
||||
|
||||
Assigning cost categories to machines
|
||||
|
||||
Virtual worker groups
|
||||
================================
|
||||
|
||||
The program enables users to create resources in the system, which are not real workers but simulated staff that enable production capacity to be increased at a specific time according to the configured settings in the calendar.
|
||||
|
||||
Through virtual worker groups, it is possible to check how project planning would be affected by contracting and assigning staff who fulfil the defined criteria, thus facilitating the decision-making process.
|
||||
|
||||
The tabs for creating virtual worker groups are the same as the ones to configure workers:
|
||||
|
||||
* General details
|
||||
* Assigned criteria
|
||||
* Calendars
|
||||
* Associated hours
|
||||
|
||||
The difference with respect to workers is that virtual worker groups have a name for the group and a quantity, which refers to the number of real people in the group. There is also a field for comments, in which additional information can be provided, for example, which project would require contracting that is equivalent to the virtual worker group.
|
||||
The difference between virtual worker groups and actual workers is that virtual worker groups have a name for the group and a quantity, which represents the number of real people in the group. There is also a field for comments, where additional information can be provided, such as which project would require hiring equivalent to the virtual worker group.
|
||||
|
||||
.. figure:: images/virtual-resources.png
|
||||
:scale: 50
|
||||
|
||||
Virtual resources
|
||||
Virtual Resources
|
||||
|
||||
Limiting resources
|
||||
================================
|
||||
Queue-based Resources
|
||||
=====================
|
||||
|
||||
Limiting resources are an specific type of productive elements which just can be either not assigned or with a 100% of dedication. What it the same, they are not capable of having more than one task scheduled at the same time nor overassigned.
|
||||
Queue-based resources are a specific type of productive element that can either be unassigned or have 100% dedication. In other words, they cannot have more than one task scheduled at the same time, nor can they be over-allocated.
|
||||
|
||||
For each limiting resource a queue is automatically created so the tasks they have scheduled can be managed in an specific manner using the assignment methods provided, creating automatic assignments between the tasks and the queues matching required criteria or moving tasks between queues.
|
||||
For each queue-based resource, a queue is automatically created. The tasks scheduled for these resources can be managed specifically using the provided assignment methods, creating automatic assignments between tasks and queues that match the required criteria, or by moving tasks between queues.
|
||||
|
|
|
|||
|
|
@ -1,317 +1,299 @@
|
|||
Orders and order elements
|
||||
Orders and Order Elements
|
||||
#########################
|
||||
|
||||
.. contents::
|
||||
|
||||
Orders describe the work to be carried out by the users who use the program.
|
||||
Each order corresponds with the projects that the companies are going to offer their clients.
|
||||
Orders represent the work to be performed by users of the program. Each order corresponds to a project that the company will offer to its clients.
|
||||
|
||||
An order consists of one or several order lines.
|
||||
Each order line corresponds with the planning the works on the order should follow when being implemented.
|
||||
Order lines are organised hierarchically without any limitations on depth.
|
||||
The fact that order lines are organised hierarchically shows how several inheritable features work, such as labels.
|
||||
An order consists of one or more order elements. Each order element represents a specific part of the work to be done and defines how the work on the order should be planned and executed. Order elements are organized hierarchically, with no limitations on the depth of the hierarchy. This hierarchical structure allows for the inheritance of certain features, such as labels.
|
||||
|
||||
The following sections will describe the operations that users can carry out with orders and order lines.
|
||||
The following sections describe the operations that users can perform with orders and order elements.
|
||||
|
||||
Order
|
||||
=====
|
||||
Orders
|
||||
======
|
||||
|
||||
An order is a project or work that a client requests from a company. The order for the planned works identifies the project in the company.
|
||||
The difference with comprehensive management programs such as "LibrePlan" is that they only need to use certain order details. These details are:
|
||||
An order represents a project or work requested by a client from the company. The order identifies the project within the company's planning. Unlike comprehensive management programs, LibrePlan only requires certain key details for an order. These details are:
|
||||
|
||||
* Order name
|
||||
* Order code
|
||||
* Total amount of order
|
||||
* Estimated start date
|
||||
* End date
|
||||
* Person in charge
|
||||
* Description
|
||||
* Assigned calendar
|
||||
* Automatic generation of codes. A field used to instruct the system to automatically generate order element and hour group codes.
|
||||
* Preference between dependencies and restrictions. Users can choose dependencies or restrictions as priorities when applied in the event of conflict.
|
||||
* **Order Name:** The name of the order.
|
||||
* **Order Code:** A unique code for the order.
|
||||
* **Total Order Amount:** The total financial value of the order.
|
||||
* **Estimated Start Date:** The planned start date for the order.
|
||||
* **End Date:** The planned completion date for the order.
|
||||
* **Person in Charge:** The individual responsible for the order.
|
||||
* **Description:** A description of the order.
|
||||
* **Assigned Calendar:** The calendar associated with the order.
|
||||
* **Automatic Generation of Codes:** A setting to instruct the system to automatically generate codes for order elements and hour groups.
|
||||
* **Preference between Dependencies and Restrictions:** Users can choose whether dependencies or restrictions take priority in case of conflicts.
|
||||
|
||||
However, the actual order has other entities that make it more complete:
|
||||
However, a complete order also includes other associated entities:
|
||||
|
||||
* Hours assigned to the order
|
||||
* Progress attributed to the order
|
||||
* Labels
|
||||
* Criteria assigned to the order
|
||||
* Materials
|
||||
* Quality forms
|
||||
* **Hours Assigned to the Order:** The total hours allocated to the order.
|
||||
* **Progress Attributed to the Order:** The progress made on the order.
|
||||
* **Labels:** Labels assigned to the order.
|
||||
* **Criteria Assigned to the Order:** Criteria associated with the order.
|
||||
* **Materials:** Materials required for the order.
|
||||
* **Quality Forms:** Quality forms associated with the order.
|
||||
|
||||
Editing or creating an order can be carried out from various locations in the program:
|
||||
Creating or editing an order can be done from several locations within the program:
|
||||
|
||||
* From the "order list" in the company overview.
|
||||
* **From the "Order List" in the Company Overview:**
|
||||
|
||||
* Editing is carried out by clicking the edit button on the chosen order.
|
||||
* Creating a new order is carried out by clicking "New order".
|
||||
* **Editing:** Click the edit button on the desired order.
|
||||
* **Creating:** Click "New order."
|
||||
|
||||
* From an order in the Gantt chart and changing to the order details view.
|
||||
* **From an Order in the Gantt Chart:** Change to the order details view.
|
||||
|
||||
Users can access the following tabs when editing an order:
|
||||
|
||||
Users can access the following tabs from the editing order option:
|
||||
* **Editing Order Details:** This screen allows users to edit basic order details:
|
||||
|
||||
* Editing order details. Users can edit basic order details on this screen. Currently these are:
|
||||
* Name
|
||||
* Code
|
||||
* Estimated Start Date
|
||||
* End Date
|
||||
* Person in Charge
|
||||
* Client
|
||||
* Description
|
||||
|
||||
* Name
|
||||
* Code
|
||||
* Estimated start date
|
||||
* End date
|
||||
* Person in charge
|
||||
* Client
|
||||
* Description
|
||||
.. figure:: images/order-edition.png
|
||||
:scale: 50
|
||||
|
||||
.. figure:: images/order-edition.png
|
||||
:scale: 50
|
||||
Editing Orders
|
||||
|
||||
Editing orders
|
||||
* **Order Element List:** This screen allows users to perform several operations on order elements:
|
||||
|
||||
* Order element list. Users can carry out several operations from the order element list:
|
||||
* Creating new order elements.
|
||||
* Promoting an order element one level up in the hierarchy.
|
||||
* Demoting an order element one level down in the hierarchy.
|
||||
* Indenting an order element (moving it down the hierarchy).
|
||||
* Unindenting an order element (moving it up the hierarchy).
|
||||
* Filtering order elements.
|
||||
* Deleting order elements.
|
||||
* Moving an element within the hierarchy by dragging and dropping.
|
||||
|
||||
* Creating new order elements.
|
||||
* Raising an order element in the hierarchy by one level.
|
||||
* Lowering an order element in the hierarchy by one level.
|
||||
* Indenting an order element, which is the same as moving it down the hierarchy, by changing the element's level.
|
||||
* Unindenting an order element, which is the same as moving it up the hierarchy, by changing the element's level.
|
||||
* Filtering order elements.
|
||||
* Deleting order elements.
|
||||
* Moving an element in the hierarchy by dragging and dropping.
|
||||
.. figure:: images/order-elements-list.png
|
||||
:scale: 40
|
||||
|
||||
.. figure:: images/order-elements-list.png
|
||||
:scale: 40
|
||||
Order Element List
|
||||
|
||||
Order element list
|
||||
* **Assigned Hours:** This screen displays the total hours attributed to the project, grouping the hours entered in the order elements.
|
||||
|
||||
* Assigned hours. A screen that shows the total hours attributed to a project, consisting of a viewing screen where the hours entered in the order elements are grouped.
|
||||
.. figure:: images/order-assigned-hours.png
|
||||
:scale: 50
|
||||
|
||||
.. figure:: images/order-assigned-hours.png
|
||||
:scale: 50
|
||||
Assigning Hours Attributed to the Order by Workers
|
||||
|
||||
Assigning hours attributed to the order by the workers
|
||||
* **Progress:** This screen allows users to assign progress types and enter progress measurements for the order. See the "Progress" section for more details.
|
||||
|
||||
* Progress. A screen where users can attribute types of progress and progress measurements relating to the order. See the "Progress" section to find out how it works.
|
||||
* **Labels:** This screen allows users to assign labels to an order and view previously assigned direct and indirect labels. See the following section on editing order elements for a detailed description of label management.
|
||||
|
||||
* Labels. A screen where users can assign labels to an order and identify previously assigned direct and indirect labels. See the following order element editing section for an in-depth description of the label management procedure.
|
||||
.. figure:: images/order-labels.png
|
||||
:scale: 35
|
||||
|
||||
.. figure:: images/order-labels.png
|
||||
:scale: 35
|
||||
Order Labels
|
||||
|
||||
Order labels
|
||||
* **Criteria:** This screen allows users to assign criteria that will apply to all tasks within the order. These criteria will be automatically applied to all order elements, except those that have been explicitly invalidated. The hour groups of order elements, which are grouped by criteria, can also be viewed, allowing users to identify the criteria required for an order.
|
||||
|
||||
* Criteria. A screen where users can assign the criteria they want to apply to all the tasks on an order. These criteria will be applied automatically to all order elements, except those that were explicitly invalidated. The hour groups of order elements, which are grouped by criteria, can also be viewed, enabling users to identify the criteria required for an order.
|
||||
.. figure:: images/order-criterions.png
|
||||
:scale: 50
|
||||
|
||||
.. figure:: images/order-criterions.png
|
||||
:scale: 50
|
||||
Order Criteria
|
||||
|
||||
Order criteria
|
||||
* **Materials:** This screen allows users to assign materials to orders. Materials can be selected from the available material categories in the program. Materials are managed as follows:
|
||||
|
||||
* Materials. A screen where users can assign available material to orders. The material can be selected from among the material categories available in the program. Materials are managed in the following way:
|
||||
* Select the "Search materials" tab at the bottom of the screen.
|
||||
* Enter text to search for materials or select the categories for which you want to find materials.
|
||||
* The system filters the results.
|
||||
* Select the desired materials (multiple materials can be selected by pressing the "Ctrl" key).
|
||||
* Click "Assign."
|
||||
* The system displays the list of materials already assigned to the order.
|
||||
* Select the units and the status to assign to the order.
|
||||
* Click "Save" or "Save and continue."
|
||||
* To manage the receipt of materials, click "Divide" to change the status of a partial quantity of material.
|
||||
|
||||
* Users select the tab shown in the lower part of the screen called "Search materials".
|
||||
* Users can enter text to search for materials or select the categories for which they want materials.
|
||||
* The system then filters the results.
|
||||
* Users select the materials they want (users can select more than one material on the list by pressing the "Ctrl" button).
|
||||
* Users then click "Assign".
|
||||
* The system then shows the list of materials that has already been assigned to the order.
|
||||
* Users select the units and the status they want to assign to the order.
|
||||
* Users then click "Save" or "Save and continue".
|
||||
* If users want to manage the receipt of the material, they can click "Divide" to change the status of a partial quantity of material.
|
||||
.. figure:: images/order-material.png
|
||||
:scale: 50
|
||||
|
||||
.. figure:: images/order-material.png
|
||||
:scale: 50
|
||||
Materials Associated with an Order
|
||||
|
||||
Material associated with an order
|
||||
* **Quality:** Users can assign a quality form to the order. This form is then completed to ensure that certain activities associated with the order are carried out. See the following section on editing order elements for details on managing quality forms.
|
||||
|
||||
* Quality. Users can assign a quality form to the order, which would then be completed to ensure that certain activities associated with the order are carried out. See the following section on editing order elements to find out about the management procedure for quality forms.
|
||||
.. figure:: images/order-quality.png
|
||||
:scale: 50
|
||||
|
||||
.. figure:: images/order-quality.png
|
||||
:scale: 50
|
||||
Quality Form Associated with the Order
|
||||
|
||||
Quality form associated with the order
|
||||
Editing Order Elements
|
||||
======================
|
||||
|
||||
Editing order elements
|
||||
==============================
|
||||
Order elements are edited from the "Order element list" tab by clicking the edit icon. This opens a new screen where users can:
|
||||
|
||||
Editing order elements is carried out from the "Order element list" tab by clicking the editing icon, which shows a new screen
|
||||
from which the user can carry out the following:
|
||||
* Edit information about the order element.
|
||||
* View hours attributed to order elements.
|
||||
* Manage progress of order elements.
|
||||
* Manage order labels.
|
||||
* Manage criteria required by the order element.
|
||||
* Manage materials.
|
||||
* Manage quality forms.
|
||||
|
||||
* Edit information about the order element.
|
||||
* View hours attributed to order elements.
|
||||
* Manage progress of order elements.
|
||||
* Manage order labels.
|
||||
* Manage criteria required by the order element.
|
||||
* Manage materials.
|
||||
* Manage quality forms.
|
||||
The following subsections describe each of these operations in detail.
|
||||
|
||||
The following subsections describe each one of the operations in depth.
|
||||
|
||||
Editing information about the order element
|
||||
Editing Information about the Order Element
|
||||
-------------------------------------------
|
||||
|
||||
Editing information about the order element includes the editing of the following details:
|
||||
Editing information about the order element includes modifying the following details:
|
||||
|
||||
* Order element name.
|
||||
* Order element code.
|
||||
* Start date of the order element.
|
||||
* Estimated end date of the order element.
|
||||
* Total hours of the order element. These hours can be calculated from the added hour groups or entered directly into this section, in which the hours have been distributed among the hour groups, and a new one created if the percentages do not coincide with initial percentages.
|
||||
* **Hour groups**: It is possible to add one or several hour groups to the order element. **The purpose of these hour groups** is to establish the requirements of the resources that will be assigned to carry them out.
|
||||
* Criteria: It is possible to add criteria that must be fulfilled to enable generic assignment to carry out the order element.
|
||||
* **Order Element Name:** The name of the order element.
|
||||
* **Order Element Code:** A unique code for the order element.
|
||||
* **Start Date:** The planned start date of the order element.
|
||||
* **Estimated End Date:** The planned completion date of the order element.
|
||||
* **Total Hours:** The total hours allocated to the order element. These hours can be calculated from the added hour groups or entered directly. If entered directly, the hours must be distributed among the hour groups, and a new hour group created if the percentages do not match the initial percentages.
|
||||
* **Hour Groups:** One or more hour groups can be added to the order element. **The purpose of these hour groups** is to define the requirements for the resources that will be assigned to perform the work.
|
||||
* **Criteria:** Criteria can be added that must be met to enable generic assignment for the order element.
|
||||
|
||||
.. figure:: images/order-element-edition.png
|
||||
:scale: 50
|
||||
|
||||
Editing order elements
|
||||
Editing Order Elements
|
||||
|
||||
Viewing hours attributed to order elements
|
||||
------------------------------------------------------
|
||||
Viewing Hours Attributed to Order Elements
|
||||
------------------------------------------
|
||||
|
||||
The "Assigned hours" tab enables users to view the work reports associated with an order element and also how many of the estimated hours have
|
||||
already been carried out.
|
||||
The "Assigned hours" tab allows users to view the work reports associated with an order element and see how many of the estimated hours have already been completed.
|
||||
|
||||
.. figure:: images/order-element-hours.png
|
||||
:scale: 50
|
||||
|
||||
Hours assigned to order elements
|
||||
Hours Assigned to Order Elements
|
||||
|
||||
The screen is divided into two parts:
|
||||
|
||||
* Work report list: Users can view the list of work reports that are associated with an order element in order to check the date and time, resource and number of hours devoted to the task.
|
||||
* Use of estimated hours: The system calculates the total number of hours devoted to a task and compares them with the estimated hours.
|
||||
* **Work Report List:** Users can view the list of work reports associated with the order element, including the date and time, resource, and number of hours devoted to the task.
|
||||
* **Use of Estimated Hours:** The system calculates the total number of hours devoted to the task and compares them with the estimated hours.
|
||||
|
||||
Managing progress of order elements
|
||||
Managing Progress of Order Elements
|
||||
-----------------------------------
|
||||
|
||||
Entering types of progress and the management of order element progress has been described in the "Progress" chapter.
|
||||
Entering progress types and managing order element progress is described in the "Progress" chapter.
|
||||
|
||||
Managing order labels
|
||||
Managing Order Labels
|
||||
---------------------
|
||||
|
||||
Labels, as described in the chapter on labels, enable users to categorise order elements.
|
||||
Consequently, users can group planning or order information based on them.
|
||||
Labels, as described in the chapter on labels, allow users to categorize order elements. This enables users to group planning or order information based on these labels.
|
||||
|
||||
Users can assign labels directly to an order element or even to a previous order element in the hierarchy.
|
||||
From the moment a label from one of the two previous methods is assigned, the order element and the related planning task are associated with the label,
|
||||
and used for subsequent filtering.
|
||||
Users can assign labels directly to an order element or to a higher-level order element in the hierarchy. Once a label is assigned using either method, the order element and the related planning task are associated with the label and can be used for subsequent filtering.
|
||||
|
||||
.. figure:: images/order-element-tags.png
|
||||
:scale: 50
|
||||
|
||||
Assigning labels for order elements
|
||||
Assigning Labels for Order Elements
|
||||
|
||||
As can be seen in the image, users can carry out the following procedures from the **labels** tab:
|
||||
As shown in the image, users can perform the following actions from the **Labels** tab:
|
||||
|
||||
* View the labels associated with an order element that were inherited from an order element that was higher in the hierarchy than the one that was directly assigned. The planning task associated with each order element has the same associated labels.
|
||||
* View labels that are directly associated with an order element by means of the following assignment form for lower-level labels.
|
||||
* Assign existing labels: Users can assign labels by searching for a particular one from among the available labels on the form that is lower than the direct label list. To search for a label, users can click the magnifying glass icon or write the first letters of the label in the text box so that the system can show the available options.
|
||||
* Create and assign new labels: Users can create new labels associated with a type of existing label from this form. In order to carry out the procedure, it is necessary to select a type of label to be associated and then enter the value of the label for the type selected. The system creates the label automatically and assigns the order element when "Create and assign" is clicked.
|
||||
* **View Inherited Labels:** View labels associated with the order element that were inherited from a higher-level order element. The planning task associated with each order element has the same associated labels.
|
||||
* **View Directly Assigned Labels:** View labels directly associated with the order element using the assignment form for lower-level labels.
|
||||
* **Assign Existing Labels:** Assign labels by searching for them among the available labels in the form below the direct label list. To search for a label, click the magnifying glass icon or enter the first letters of the label in the text box to display the available options.
|
||||
* **Create and Assign New Labels:** Create new labels associated with an existing label type from this form. To do this, select a label type and enter the label value for the selected type. The system automatically creates the label and assigns it to the order element when "Create and assign" is clicked.
|
||||
|
||||
|
||||
Managing criteria required by the order element and hour groups
|
||||
Managing Criteria Required by the Order Element and Hour Groups
|
||||
---------------------------------------------------------------
|
||||
|
||||
Both an order and an order element can be assigned criteria that need to be fulfilled for it to be carried out. Criteria can be direct or indirect:
|
||||
Both an order and an order element can have criteria assigned that must be met for the work to be performed. Criteria can be direct or indirect:
|
||||
|
||||
* Direct criteria: These are assigned directly to the order element. They are criteria that are required by the hour groups on the order element.
|
||||
* Indirect criteria: These are assigned on order elements that are higher in the hierarchy and are inherited by the element that is being edited.
|
||||
* **Direct Criteria:** These are assigned directly to the order element. They are criteria required by the hour groups on the order element.
|
||||
* **Indirect Criteria:** These are assigned to higher-level order elements in the hierarchy and are inherited by the element being edited.
|
||||
|
||||
Apart from the required criterion, one or various hour groups that are part of the order element can be defined.
|
||||
It all depends on whether the order element contains other order elements as child nodes or if it is a leaf node.
|
||||
In the first case the information about hours and hour groups can only be viewed, but leaf nodes can be edited. The latter case works as follows:
|
||||
In addition to the required criteria, one or more hour groups that are part of the order element can be defined. This depends on whether the order element contains other order elements as child nodes or if it is a leaf node. In the first case, information about hours and hour groups can only be viewed. However, leaf nodes can be edited. Leaf nodes work as follows:
|
||||
|
||||
* The system creates an hour group by default, which is associated to the order element. The details that can be modified for an hour group are:
|
||||
* The system creates a default hour group associated with the order element. The details that can be modified for an hour group are:
|
||||
|
||||
* Code for the hour group if it is not automatically generated.
|
||||
* Type of criterion. Users can choose to assign a machine or worker criterion.
|
||||
* Number of hours in the hour group.
|
||||
* List of criteria to be applied to the hour group. To add new criteria, users have to click "Add criterion" and select one from the search engine, which appears after clicking the button.
|
||||
* **Code:** The code for the hour group (if not automatically generated).
|
||||
* **Criterion Type:** Users can choose to assign a machine or worker criterion.
|
||||
* **Number of Hours:** The number of hours in the hour group.
|
||||
* **List of Criteria:** The criteria to be applied to the hour group. To add new criteria, click "Add criterion" and select one from the search engine that appears after clicking the button.
|
||||
|
||||
* Users can add new hour groups with features that are different from previous hour groups. An example of this would be when an order element must be carried out by a welder (30h) and a painter (40h).
|
||||
* Users can add new hour groups with different features than previous hour groups. For example, an order element might require a welder (30 hours) and a painter (40 hours).
|
||||
|
||||
.. figure:: images/order-element-criterion.png
|
||||
:scale: 50
|
||||
|
||||
Assigning criteria to order elements
|
||||
Assigning Criteria to Order Elements
|
||||
|
||||
Managing materials
|
||||
------------------------
|
||||
Managing Materials
|
||||
------------------
|
||||
|
||||
Materials are managed in the projects as a list associated with each order line or an order in general.
|
||||
The list of materials is made up of the following fields:
|
||||
Materials are managed in projects as a list associated with each order element or an order in general. The list of materials includes the following fields:
|
||||
|
||||
* Code
|
||||
* Date
|
||||
* Units: Required units.
|
||||
* Type of unit: Type of unit used to measure the material.
|
||||
* Price of the unit: Unit price.
|
||||
* Total price: The price is calculated by multiplying the unit price by the number of units.
|
||||
* Category: Category to which the material belongs.
|
||||
* Status: Received, requested, pending, processing, cancelled.
|
||||
* **Code:** The material code.
|
||||
* **Date:** The date associated with the material.
|
||||
* **Units:** The required number of units.
|
||||
* **Unit Type:** The type of unit used to measure the material.
|
||||
* **Unit Price:** The price per unit.
|
||||
* **Total Price:** The total price (calculated by multiplying the unit price by the number of units).
|
||||
* **Category:** The category to which the material belongs.
|
||||
* **Status:** The status of the material (e.g., Received, Requested, Pending, Processing, Cancelled).
|
||||
|
||||
Working with materials is carried out as follows:
|
||||
Working with materials is done as follows:
|
||||
|
||||
* Users select the "Materials" tab on an order element.
|
||||
* The system then shows two sub-tabs: "Materials" and "Search materials".
|
||||
* If the order element did not have assigned materials, the first tab will be empty.
|
||||
* Users then click on "Search materials" in the lower left-hand part of the window.
|
||||
* The system then shows the list of available categories and associated materials.
|
||||
* Select the "Materials" tab on an order element.
|
||||
* The system displays two sub-tabs: "Materials" and "Search materials."
|
||||
* If the order element has no assigned materials, the first tab will be empty.
|
||||
* Click "Search materials" in the lower-left part of the window.
|
||||
* The system displays the list of available categories and associated materials.
|
||||
|
||||
.. figure:: images/order-element-material-search.png
|
||||
:scale: 50
|
||||
|
||||
Searching material
|
||||
Searching for Materials
|
||||
|
||||
* Users select categories to search to refine searches for materials.
|
||||
* The system shows the materials that belong to the selected categories.
|
||||
* From the materials list, users select the materials to assign to the order element.
|
||||
* Users click "Assign".
|
||||
* The system shows the selected list of materials on the "Materials" tab with new fields to complete.
|
||||
* Select categories to refine the material search.
|
||||
* The system displays the materials that belong to the selected categories.
|
||||
* From the materials list, select the materials to assign to the order element.
|
||||
* Click "Assign."
|
||||
* The system displays the selected list of materials on the "Materials" tab with new fields to complete.
|
||||
|
||||
.. figure:: images/order-element-material-assign.png
|
||||
:scale: 50
|
||||
|
||||
Assigning materials to order elements
|
||||
Assigning Materials to Order Elements
|
||||
|
||||
* Users select the units, status and date of assigned materials.
|
||||
* Select the units, status, and date for the assigned materials.
|
||||
|
||||
For subsequent monitoring of materials, it is possible to change the status of a unit group of the received material.
|
||||
This procedure is carried out as follows:
|
||||
For subsequent monitoring of materials, it's possible to change the status of a group of units of the received material. This is done as follows:
|
||||
|
||||
* Users click the "Divide" button on the list of materials to the right of each row.
|
||||
* Users select the number of units they want the row to be divided into.
|
||||
* The program shows two rows with the material divided.
|
||||
* Users change the status of the row containing the material.
|
||||
* Click the "Divide" button on the list of materials to the right of each row.
|
||||
* Select the number of units to divide the row into.
|
||||
* The program displays two rows with the material divided.
|
||||
* Change the status of the row containing the material.
|
||||
|
||||
The advantage of using this dividing tool is the possibility of receiving partial deliveries of material without having to wait
|
||||
to receive it all in order to mark it as received.
|
||||
The advantage of using this dividing tool is the ability to receive partial deliveries of material without having to wait for the entire delivery to mark it as received.
|
||||
|
||||
Managing quality forms
|
||||
Managing Quality Forms
|
||||
----------------------
|
||||
|
||||
Some order elements must certify that certain tasks have been carried out in order for them to be marked as complete.
|
||||
This is why the program has quality forms, which consist of a list of questions that can be considered important if they are answered positively.
|
||||
Some order elements require certification that certain tasks have been completed before they can be marked as complete. This is why the program has quality forms, which consist of a list of questions that are considered important if answered positively.
|
||||
|
||||
It is important to mention that a quality form has to be created previously so that it can be assigned to an order element.
|
||||
It's important to note that a quality form must be created beforehand to be assigned to an order element.
|
||||
|
||||
To manage quality forms:
|
||||
|
||||
* Go to the "Quality forms" tab.
|
||||
* Go to the "Quality forms" tab.
|
||||
|
||||
.. figure:: images/order-element-quality.png
|
||||
:scale: 50
|
||||
.. figure:: images/order-element-quality.png
|
||||
:scale: 50
|
||||
|
||||
Assigning quality forms to order elements
|
||||
Assigning Quality Forms to Order Elements
|
||||
|
||||
* The program has a search engine for quality forms. There are two types of quality forms: according to element or percentage.
|
||||
* The program has a search engine for quality forms. There are two types of quality forms: by element or by percentage.
|
||||
|
||||
* Element: Every element is independent.
|
||||
* Percentage: Every question increases progress in the order element by a percentage. It must be possible for percentages to be increased to 100%.
|
||||
* **Element:** Each element is independent.
|
||||
* **Percentage:** Each question increases the progress of the order element by a percentage. The percentages must be able to add up to 100%.
|
||||
|
||||
* Users select one of the forms created in the administration interface and click "Assign".
|
||||
* The program assigns the form chosen from the list of forms assigned to the order element.
|
||||
* Users click the "Edit" button on the order element.
|
||||
* The program displays the questions from the quality form in the lower list.
|
||||
* Users mark the questions that have been carried out as achieved.
|
||||
* If the quality form is based on percentages, the questions are answered in order.
|
||||
* If the quality form is based on elements, the questions can be answered in any order.
|
||||
* Select one of the forms created in the administration interface and click "Assign."
|
||||
* The program assigns the chosen form from the list of forms assigned to the order element.
|
||||
* Click the "Edit" button on the order element.
|
||||
* The program displays the questions from the quality form in the lower list.
|
||||
* Mark the questions that have been completed as achieved.
|
||||
|
||||
* If the quality form is based on percentages, the questions are answered in order.
|
||||
* If the quality form is based on elements, the questions can be answered in any order.
|
||||
|
|
|
|||
|
|
@ -1,105 +1,98 @@
|
|||
Task planning
|
||||
Task Planning
|
||||
#############
|
||||
|
||||
.. _planificacion:
|
||||
.. contents::
|
||||
|
||||
|
||||
Task planning
|
||||
Task Planning
|
||||
=============
|
||||
|
||||
Planning in "LibrePlan" is a process that has been described throughout all of the chapters of the user guide,
|
||||
the chapters on orders and the assigning of resources being particularly important in this respect.
|
||||
This chapter describes basic planning procedures after the order and the Gantt charts have been configured properly.
|
||||
Planning in LibrePlan is a process that has been described throughout the user guide, with the chapters on orders and resource assignment being particularly important. This chapter describes the basic planning procedures after the order and Gantt charts have been properly configured.
|
||||
|
||||
.. figure:: images/planning-view.png
|
||||
:scale: 35
|
||||
|
||||
Work planning view
|
||||
Work Planning View
|
||||
|
||||
As with the company overview, the project planning view is divided into several views based on the information it is analysing.
|
||||
The views of a specific project are:
|
||||
As with the company overview, the project planning view is divided into several views based on the information being analyzed. The views available for a specific project are:
|
||||
|
||||
* Planning view
|
||||
* Resource load view
|
||||
* Order list view
|
||||
* Advanced assignment view
|
||||
* Planning View
|
||||
* Resource Load View
|
||||
* Order List View
|
||||
* Advanced Assignment View
|
||||
|
||||
Planning view
|
||||
Planning View
|
||||
-------------
|
||||
The planning view combines three different views:
|
||||
|
||||
* Project planning. Project planning can be viewed in the upper right-hand part of the program. It represents the planning in a Gantt chart. This is the view where users can temporarily move tasks, assign dependencies among them, define milestones and establish restrictions.
|
||||
* Resource load view. The resource load view is the image on the lower right-hand part, which shows the availability of resources according to the assignments that were carried out, as opposed to the assignments made to tasks. The information shown in the image is as follows:
|
||||
The Planning View combines three different perspectives:
|
||||
|
||||
* Purple area: Indicating a resource load under 100% of its capacity.
|
||||
* Green area: Indicating a resource load under 100%, resulting from the resource being planned for another project.
|
||||
* Orange area: Indicating a resource load over 100% as a result of the current project.
|
||||
* Yellow area: Indicating a resource load over 100% as a result of other projects.
|
||||
* **Project Planning:** Project planning is displayed in the upper right-hand part of the program as a Gantt chart. This view allows users to temporarily move tasks, assign dependencies between them, define milestones, and establish restrictions.
|
||||
* **Resource Load:** The Resource Load view, located in the lower right-hand part of the screen, shows resource availability based on assignments, as opposed to the assignments made to tasks. The information displayed in this view is as follows:
|
||||
|
||||
* Graph view and earned value indicators. These can be viewed from the "Earned value" tab. The generated graph is based on the earned value technique and the indicators that are calculated for each of the workdays of the project. The calculated indicators are:
|
||||
* **Purple Area:** Indicates a resource load below 100% of its capacity.
|
||||
* **Green Area:** Indicates a resource load below 100%, resulting from the resource being planned for another project.
|
||||
* **Orange Area:** Indicates a resource load over 100% as a result of the current project.
|
||||
* **Yellow Area:** Indicates a resource load over 100% as a result of other projects.
|
||||
|
||||
* BCWS: accumulative time function for the number of hours planned up to a certain date. It will be 0 at the planned start of the task and the total number of planned hours at the end. As with all accumulative graphs, it will always increase. The function for a task will be the sum of the daily assignments until the calculation day. This function has values for all times, provided that resources have been assigned.
|
||||
* ACWP: accumulative time function for the hours attributed in the work reports up to a certain date. This function will only have a value of 0 before the date of the task's first work report and its value will continue to increase as time passes and work report hours are added. It will have no value after the date of the last work report.
|
||||
* BCWP: accumulative time function that includes the resultant value of multiplying task progress by the amount of work that the task was estimated to require for completion. This function's values increase as time passes. Progress values also increase. Progress is multiplied by the total number of estimated hours for all tasks. The BCWP value is the sum of the values for the tasks that are being calculated. Progress is totalled when it is configured.
|
||||
* CV: Cost variation CV = BCWP - ACWP
|
||||
* SV: Schedule variation SV = BCWP - BCWS
|
||||
* BAC: Budget at completion BAC = max (BCWS)
|
||||
* EAC: Estimate at completion EAC = (ACWP/ BCWP) * BAC
|
||||
* VAC: Variance at completion VAC = BAC - EAC
|
||||
* ETC: Estimate to complete ETC = EAC - ACWP
|
||||
* CPI: Cost performance index CPI = BCWP / ACWP
|
||||
* SPI: Schedule performance index SPI = BCWP / BCWS
|
||||
* **Graph View and Earned Value Indicators:** These can be viewed from the "Earned Value" tab. The generated graph is based on the earned value technique, and the indicators are calculated for each workday of the project. The calculated indicators are:
|
||||
|
||||
In the project planning, users can carry out the following procedures:
|
||||
* **BCWS (Budgeted Cost of Work Scheduled):** The cumulative time function for the number of hours planned up to a certain date. It will be 0 at the planned start of the task and equal to the total number of planned hours at the end. As with all cumulative graphs, it will always increase. The function for a task will be the sum of the daily assignments until the calculation date. This function has values for all times, provided that resources have been assigned.
|
||||
* **ACWP (Actual Cost of Work Performed):** The cumulative time function for the hours reported in work reports up to a certain date. This function will only have a value of 0 before the date of the task's first work report, and its value will continue to increase as time passes and work report hours are added. It will have no value after the date of the last work report.
|
||||
* **BCWP (Budgeted Cost of Work Performed):** The cumulative time function that includes the resultant value of multiplying task progress by the amount of work that the task was estimated to require for completion. This function's values increase as time passes, as do progress values. Progress is multiplied by the total number of estimated hours for all tasks. The BCWP value is the sum of the values for the tasks being calculated. Progress is totaled when it is configured.
|
||||
* **CV (Cost Variance):** CV = BCWP - ACWP
|
||||
* **SV (Schedule Variance):** SV = BCWP - BCWS
|
||||
* **BAC (Budget at Completion):** BAC = max (BCWS)
|
||||
* **EAC (Estimate at Completion):** EAC = (ACWP / BCWP) * BAC
|
||||
* **VAC (Variance at Completion):** VAC = BAC - EAC
|
||||
* **ETC (Estimate to Complete):** ETC = EAC - ACWP
|
||||
* **CPI (Cost Performance Index):** CPI = BCWP / ACWP
|
||||
* **SPI (Schedule Performance Index):** SPI = BCWP / BCWS
|
||||
|
||||
* Assigning dependencies. Right click and choose "Add dependency" and drag the mouse pointer to the tasks that are to be assigned a dependency.
|
||||
In the project planning view, users can perform the following actions:
|
||||
|
||||
* To change the type of dependency, right click on the dependency and choose the type to be assigned.
|
||||
* **Assigning Dependencies:** Right-click a task, choose "Add dependency," and drag the mouse pointer to the task to which the dependency should be assigned.
|
||||
|
||||
* Creating a new milestone. Click the task before the milestone that is to be added and select the "Add milestone" option. Milestones can be moved by selecting the task with the mouse pointer and dragging it to the desired position.
|
||||
* Moving tasks without disturbing dependencies. Right click the body of the task, and drag it to the desired position. If no restrictions or dependencies are disturbed, the system will update the daily assignment of resources to the task and place the task in the selected date.
|
||||
* Assign restrictions. Click the task in question and select the "Task properties" option. A *pop-up* will appear with a "Restrictions" field that can be changed. Restrictions can conflict with dependencies, which is why each order states whether dependencies take priority or not over restrictions. The restrictions that can be established are:
|
||||
* To change the type of dependency, right-click the dependency and choose the desired type.
|
||||
|
||||
* *As soon as possible*: Indicating that the task must start as soon as possible.
|
||||
* *Not before*. Indicating that the task must not start before a certain date.
|
||||
* *Start on a specific date*. Indicating that the task must start on a specific date.
|
||||
* **Creating a New Milestone:** Click the task before which the milestone is to be added and select the "Add milestone" option. Milestones can be moved by selecting the milestone with the mouse pointer and dragging it to the desired position.
|
||||
* **Moving Tasks without Disturbing Dependencies:** Right-click the body of the task and drag it to the desired position. If no restrictions or dependencies are violated, the system will update the daily assignment of resources to the task and place the task on the selected date.
|
||||
* **Assigning Restrictions:** Click the task in question and select the "Task properties" option. A pop-up window will appear with a "Restrictions" field that can be modified. Restrictions can conflict with dependencies, which is why each order specifies whether dependencies take priority over restrictions. The restrictions that can be established are:
|
||||
|
||||
* **As Soon as Possible:** Indicates that the task must start as soon as possible.
|
||||
* **Not Before:** Indicates that the task must not start before a certain date.
|
||||
* **Start on a Specific Date:** Indicates that the task must start on a specific date.
|
||||
|
||||
The planning view also offers several procedures that ultimately function as viewing options:
|
||||
The planning view also offers several procedures that function as viewing options:
|
||||
|
||||
* Zoom level: Users can choose the zoom level they require. There are several zoom levels: annual, four-monthly, monthly, weekly and daily.
|
||||
* Search filters: Users can filter tasks based on labels or criteria.
|
||||
* Critical path. As a result of using the *Dijkstra* algorithm to calculate paths on graphs, the critical path was implemented which can be viewed by clicking on the "Critical path" button from the viewing options.
|
||||
* Show labels: Enabling users to view the labels assigned to tasks in a project, which can be viewed on screen or printed.
|
||||
* Show resources: Enabling users to view the resources assigned to tasks in a project, which can be viewed on screen or printed.
|
||||
* Print: Enabling users to print the Gantt chart being viewed at that moment.
|
||||
* **Zoom Level:** Users can choose the desired zoom level. There are several zoom levels: annual, four-monthly, monthly, weekly, and daily.
|
||||
* **Search Filters:** Users can filter tasks based on labels or criteria.
|
||||
* **Critical Path:** As a result of using the *Dijkstra* algorithm to calculate paths on graphs, the critical path was implemented. It can be viewed by clicking the "Critical path" button in the viewing options.
|
||||
* **Show Labels:** Enables users to view the labels assigned to tasks in a project, which can be viewed on screen or printed.
|
||||
* **Show Resources:** Enables users to view the resources assigned to tasks in a project, which can be viewed on screen or printed.
|
||||
* **Print:** Enables users to print the Gantt chart being viewed.
|
||||
|
||||
Resource load view
|
||||
Resource Load View
|
||||
------------------
|
||||
The resource load view provides a list of resources that contains a list of tasks or criteria that generate workloads.
|
||||
Each task or criterion is shown as a Gantt chart so that the start and end date of the load can be seen.
|
||||
A different colour is shown depending on whether the resource has a load that is higher or lower than 100%:
|
||||
|
||||
* Green: load lower than 100%
|
||||
* Orange: 100% load
|
||||
* Red: load over 100%
|
||||
The Resource Load View provides a list of resources that contains a list of tasks or criteria that generate workloads. Each task or criterion is shown as a Gantt chart so that the start and end dates of the load can be seen. A different color is shown depending on whether the resource has a load that is higher or lower than 100%:
|
||||
|
||||
* **Green:** Load lower than 100%
|
||||
* **Orange:** 100% load
|
||||
* **Red:** Load over 100%
|
||||
|
||||
.. figure:: images/resource-load.png
|
||||
:scale: 35
|
||||
|
||||
Resource load view for a specific order
|
||||
Resource Load View for a Specific Order
|
||||
|
||||
If the mouse pointer is placed on the resource's Gantt chart, the load percentage for the worker will be shown.
|
||||
|
||||
Order list view
|
||||
---------------------------
|
||||
The order list view allows users to go to the order editing and deleting options. See the "Orders" chapter for more information.
|
||||
Order List View
|
||||
---------------
|
||||
|
||||
The Order List View allows users to access the order editing and deleting options. See the "Orders" chapter for more information.
|
||||
|
||||
Advanced assignment view
|
||||
Advanced Assignment View
|
||||
------------------------
|
||||
The advanced assignment view is explained in depth in the "Resource assignment" chapter.
|
||||
|
||||
|
||||
|
||||
The Advanced Assignment View is explained in depth in the "Resource Assignment" chapter.
|
||||
|
|
|
|||
|
|
@ -1,281 +1,158 @@
|
|||
Assignment of resources
|
||||
########################
|
||||
Resource Assignment
|
||||
###################
|
||||
|
||||
.. asigacion_
|
||||
.. _asigacion_:
|
||||
.. contents::
|
||||
|
||||
The assignment of resources is one of the program's most important features,
|
||||
and can be carried out in two different ways:
|
||||
Resource assignment is one of the program's most important features and can be carried out in two different ways:
|
||||
|
||||
* Specific assignment.
|
||||
|
||||
* Generic assignment.
|
||||
* Specific assignment
|
||||
* Generic assignment
|
||||
|
||||
Both types of assignment are explained in the following sections.
|
||||
|
||||
To carry out either of the two types of resource assignment, the following
|
||||
steps are necessary:
|
||||
To perform either type of resource assignment, the following steps are necessary:
|
||||
|
||||
* Go to the planning of an order.
|
||||
|
||||
* Right click on the task to be planned.
|
||||
* Go to the planning view of an order.
|
||||
* Right-click on the task to be planned.
|
||||
|
||||
.. figure:: images/resource-assignment-planning.png
|
||||
:scale: 50
|
||||
|
||||
Resource assignment menu
|
||||
Resource Assignment Menu
|
||||
|
||||
* The program shows a screen in which the following information can be viewed:
|
||||
* The program displays a screen with the following information:
|
||||
|
||||
* List of criteria that must be fulfilled. For each hour group, a list of
|
||||
hour groups is shown, each of which requires a list of criteria.
|
||||
* **List of Criteria to be Fulfilled:** For each hour group, a list of required criteria is shown.
|
||||
* **Task Information:** The start and end dates of the task.
|
||||
* **Type of Calculation:** The system allows users to choose the strategy for calculating assignments:
|
||||
|
||||
* Task information: start and end date of the task.
|
||||
|
||||
* Type of calculation: The system allows users to choose the strategy to
|
||||
be used to calculate assignments:
|
||||
|
||||
* Calculate number of hours: This calculates the number of hours
|
||||
required to be devoted to the assigned resources, which are given an
|
||||
end date and a resource number per day.
|
||||
|
||||
* Calculate end date: This calculates the end date of the task based on
|
||||
the number of task resources and the total number of hours to finish
|
||||
the task.
|
||||
|
||||
* Calculate number of resources: This calculates the number of resources
|
||||
required to finish the task on a specific date and devotes a known
|
||||
number of hours to them.
|
||||
|
||||
* Recommended assignment: This option allows the program to gather
|
||||
criteria that must be fulfilled and the total number of hours from all
|
||||
hour groups, and then recommends a generic assignment. If there was
|
||||
a prior assignment, the system deletes it and replaces it with the new
|
||||
one.
|
||||
|
||||
* Assignments: A list of assignments that have been carried out. This list
|
||||
shows the generic assignments (the number will be the list of fulfilled
|
||||
criteria, and the number of hours and resources per day). Every
|
||||
assignment carried out can be explicitly removed by clicking the delete
|
||||
button.
|
||||
* **Calculate Number of Hours:** This calculates the number of hours required from the assigned resources, given an end date and a number of resources per day.
|
||||
* **Calculate End Date:** This calculates the end date of the task based on the number of resources assigned to the task and the total number of hours required to complete the task.
|
||||
* **Calculate Number of Resources:** This calculates the number of resources required to finish the task by a specific date, given a known number of hours per resource.
|
||||
* **Recommended Assignment:** This option allows the program to gather the criteria to be fulfilled and the total number of hours from all hour groups, and then recommend a generic assignment. If a prior assignment exists, the system deletes it and replaces it with the new one.
|
||||
* **Assignments:** A list of assignments that have been made. This list shows the generic assignments (the number will be the list of fulfilled criteria, and the number of hours and resources per day). Each assignment can be explicitly removed by clicking the delete button.
|
||||
|
||||
.. figure:: images/resource-assignment.png
|
||||
:scale: 50
|
||||
|
||||
Resource assignment
|
||||
Resource Assignment
|
||||
|
||||
* Users select "Search resources".
|
||||
|
||||
* The program shows a new screen consisting of a criteria tree and a list to
|
||||
the right of workers that fulfil the selected criteria:
|
||||
* Users select "Search resources."
|
||||
* The program displays a new screen consisting of a criteria tree and a list of workers who fulfill the selected criteria on the right:
|
||||
|
||||
.. figure:: images/resource-assignment-search.png
|
||||
:scale: 50
|
||||
|
||||
Resource assignment search
|
||||
Resource Assignment Search
|
||||
|
||||
* Users can select:
|
||||
* Users can select:
|
||||
|
||||
* Specific assignment. See the "Specific assignment" section to find out
|
||||
what is involved when choosing this option.
|
||||
* **Specific Assignment:** See the "Specific Assignment" section for details on this option.
|
||||
* **Generic Assignment:** See the "Generic Assignment" section for details on this option.
|
||||
|
||||
* Generic assignment. See the "Generic assignment" section to find out
|
||||
what is involved when choosing this option.
|
||||
* Users select a list of criteria (generic) or a list of workers (specific). Multiple selections can be made by pressing the "Ctrl" key while clicking each worker/criterion.
|
||||
* Users then click the "Select" button. It's important to remember that if a generic assignment is not selected, users must choose a worker or machine to perform the assignment. If a generic assignment is selected, it is sufficient for users to choose one or more criteria.
|
||||
* The program then displays the selected criteria or resource list in the list of assignments on the original resource assignment screen.
|
||||
* Users must choose the hours or resources per day, depending on the assignment method used in the program.
|
||||
|
||||
* Users select a list of criteria (generic) or a list of workers (specific).
|
||||
A multiple-choice selection is performed by pressing the "Ctrl" button
|
||||
when clicking each worker/criterion.
|
||||
|
||||
* Users then click the "Select" button. It is important to remember that if
|
||||
a generic assignment is not marked, users need to choose a worker or
|
||||
machine to perform an assignment. If this is not done, it is sufficient
|
||||
for users to choose one or several criteria.
|
||||
|
||||
* The program then shows the selected criteria or resource list on the list
|
||||
of assignments from the original resource assignment screen.
|
||||
|
||||
* Users must choose the hours or resources per day depending on the
|
||||
assignment method used on the program.
|
||||
|
||||
|
||||
Specific assignment
|
||||
Specific Assignment
|
||||
===================
|
||||
|
||||
This is the specific assignment of a resource to a project task, i.e. the
|
||||
user decides which specific "name and surname(s)" or "machine" must be
|
||||
assigned to a task.
|
||||
This is the specific assignment of a resource to a project task. In other words, the user decides which specific worker (by name and surname) or machine must be assigned to a task.
|
||||
|
||||
Specific assignment can be carried out on the screen shown in this image:
|
||||
|
||||
|
||||
.. figure:: images/asignacion-especifica.png
|
||||
:scale: 50
|
||||
|
||||
Specific resource assignment
|
||||
Specific Resource Assignment
|
||||
|
||||
When a resource is specifically assigned, the program creates daily
|
||||
assignments in relation to the percentage of daily assigned resources
|
||||
selected, by previously comparing it with the available resource calendar.
|
||||
For example, an assignment of 0.5 resources for a 32-hour task means that
|
||||
4 hours per day are assigned to the specific resource to fulfil the
|
||||
task (supposing a working calendar of 8 hours per day).
|
||||
When a resource is specifically assigned, the program creates daily assignments based on the percentage of daily assigned resources selected, after comparing it with the available resource calendar. For example, an assignment of 0.5 resources for a 32-hour task means that 4 hours per day are assigned to the specific resource to complete the task (assuming a working calendar of 8 hours per day).
|
||||
|
||||
Specific machine assignment
|
||||
Specific Machine Assignment
|
||||
---------------------------
|
||||
|
||||
Specific machine assignment functions in the same way as that for workers.
|
||||
When a machine is assigned a task, the system stores a specific assignment
|
||||
of hours for the chosen machine. The main difference is that the system
|
||||
searches the list of assigned workers or criteria at the moment the machine
|
||||
is assigned:
|
||||
Specific machine assignment functions in the same way as worker assignment. When a machine is assigned to a task, the system stores a specific assignment of hours for the chosen machine. The main difference is that the system searches the list of assigned workers or criteria at the moment the machine is assigned:
|
||||
|
||||
* If the machine has a list of assigned workers, the program chooses from
|
||||
those that are required by the machine for the assigned calendar. For
|
||||
example, if the machine calendar is 16 hours per day and the resource
|
||||
calendar is 8 hours, two resources are assigned from the list of available
|
||||
resources.
|
||||
* If the machine has a list of assigned workers, the program chooses from those that are required by the machine, based on the assigned calendar. For example, if the machine calendar is 16 hours per day and the resource calendar is 8 hours, two resources are assigned from the list of available resources.
|
||||
* If the machine has one or more assigned criteria, generic assignments are made from among the resources that fulfill the criteria assigned to the machine.
|
||||
|
||||
* If the machine has one or several assigned criteria, generic assignments
|
||||
are carried out from among the resources that fulfil the criteria assigned
|
||||
to the machine.
|
||||
|
||||
Generic assignment
|
||||
Generic Assignment
|
||||
==================
|
||||
|
||||
Generic assignment occurs when users do not choose resources specifically,
|
||||
but leave the decision to the program, which distributes the loads among the
|
||||
company's available resources.
|
||||
Generic assignment occurs when users do not choose resources specifically but leave the decision to the program, which distributes the loads among the company's available resources.
|
||||
|
||||
.. figure:: images/asignacion-xenerica.png
|
||||
:scale: 50
|
||||
|
||||
Generic resource assignment
|
||||
Generic Resource Assignment
|
||||
|
||||
The assignment system uses the following assumptions as a basis:
|
||||
|
||||
* Tasks have criteria that are required from resources.
|
||||
* Tasks have criteria that are required from resources.
|
||||
* Resources are configured to fulfill criteria.
|
||||
|
||||
* Resources are configured to fulfil criteria.
|
||||
However, the system does not fail when criteria have not been assigned, but when all resources fulfill the non-requirement of criteria.
|
||||
|
||||
However, the system does not fail when criteria have not been assigned, but
|
||||
when all resources fulfil the non-requirement of criteria.
|
||||
The generic assignment algorithm functions as follows:
|
||||
|
||||
The generic assignment algorithm functions in the following way:
|
||||
* All resources and days are treated as containers where daily assignments of hours fit, based on the maximum assignment capacity in the task calendar.
|
||||
* The system searches for the resources that fulfill the criterion.
|
||||
* The system analyzes which assignments currently have different resources that fulfill criteria.
|
||||
* The resources that fulfill the criteria are chosen from those that have sufficient availability.
|
||||
* If freer resources are not available, assignments are made to the resources that have less availability.
|
||||
* Over-assignment of resources only begins when all the resources that fulfill the respective criteria are 100% assigned, until the total amount required to carry out the task is attained.
|
||||
|
||||
* All resources and days are treated as containers where daily assignment of
|
||||
hours fit, based on the maximum assignment capacity in the task calendar.
|
||||
|
||||
* The system searches for the resources that fulfil the criterion.
|
||||
|
||||
* The system analyses which assignments currently have different resources
|
||||
that fulfil criteria.
|
||||
|
||||
* The resources that fulfil the criteria are chosen from those that have
|
||||
sufficient availability.
|
||||
|
||||
* If freer resources are not available, assignments are made to the
|
||||
resources that have less availability.
|
||||
|
||||
* Over-assignment of resources only starts when all the resources that
|
||||
fulfil the respective criteria are 100% assigned until the total amount
|
||||
required to carry out the task is attained.
|
||||
|
||||
Generic machine assignment
|
||||
Generic Machine Assignment
|
||||
--------------------------
|
||||
|
||||
Generic machine assignment functions in the same way as worker assignment.
|
||||
For example, when a machine is assigned to a task, the system stores
|
||||
a generic assignment of hours for all machines that fulfil the criteria as
|
||||
described for the resources in general. However, in addition, the system
|
||||
performs the following procedure for machines:
|
||||
Generic machine assignment functions in the same way as worker assignment. For example, when a machine is assigned to a task, the system stores a generic assignment of hours for all machines that fulfill the criteria, as described for resources in general. However, in addition, the system performs the following procedure for machines:
|
||||
|
||||
* For all machines chosen for generic assignment:
|
||||
* For all machines chosen for generic assignment:
|
||||
|
||||
* It collects the machine's configuration information: alpha value,
|
||||
assigned workers and criteria.
|
||||
* It collects the machine's configuration information: alpha value, assigned workers, and criteria.
|
||||
* If the machine has an assigned list of workers, the program chooses the number required by the machine, depending on the assigned calendar. For example, if the machine calendar is 16 hours per day and the resource calendar is 8 hours, the program assigns two resources from the list of available resources.
|
||||
* If the machine has one or more assigned criteria, the program makes generic assignments from among the resources that fulfill the criteria assigned to the machine.
|
||||
|
||||
* If the machine has an assigned list of workers, the program chooses the
|
||||
number required by the machine depending on the assigned calendar. For
|
||||
example, if the machine calendar is 16 hours per day and the resource
|
||||
calendar is 8 hours, the program assigns two resources from the list of
|
||||
available resources.
|
||||
|
||||
* If the machine has one or several assigned criteria, the program makes
|
||||
generic assignments from among the resources that fulfil the criteria
|
||||
assigned to the machine.
|
||||
|
||||
|
||||
Advanced assignment
|
||||
Advanced Assignment
|
||||
===================
|
||||
|
||||
Advanced assignments allow users to design assignments that are
|
||||
automatically carried out by the application in order to personalise them.
|
||||
This procedure allows users to manually choose the daily hours that are
|
||||
dedicated by resources to tasks that are assigned or define a function that
|
||||
is applied to the assignment.
|
||||
Advanced assignments allow users to design assignments that are automatically carried out by the application to personalize them. This procedure allows users to manually choose the daily hours that are dedicated by resources to assigned tasks or define a function that is applied to the assignment.
|
||||
|
||||
The steps to follow in order to manage advanced assignments are:
|
||||
The steps to follow to manage advanced assignments are:
|
||||
|
||||
* Go to the advanced assignment window. There are two ways to access advanced assignments:
|
||||
* Go to the advanced assignment window. There are two ways to access advanced assignments:
|
||||
|
||||
* Go to a specific order and change the view to advanced assignment. In
|
||||
this case, all the tasks on the order and assigned resources (specific
|
||||
and generic) will be shown.
|
||||
|
||||
* Go to the resource assignment window by clicking the "Advanced
|
||||
assignment" button. In this case, the assignments that show the
|
||||
resources (generic and specific) assigned for a task will be shown.
|
||||
* Go to a specific order and change the view to advanced assignment. In this case, all the tasks on the order and assigned resources (specific and generic) will be shown.
|
||||
* Go to the resource assignment window by clicking the "Advanced assignment" button. In this case, the assignments that show the resources (generic and specific) assigned to a task will be shown.
|
||||
|
||||
.. figure:: images/advance-assignment.png
|
||||
:scale: 45
|
||||
|
||||
Advanced resource assignment
|
||||
Advanced Resource Assignment
|
||||
|
||||
* Users can choose the required zoom level they want:
|
||||
* Users can choose the desired zoom level:
|
||||
|
||||
* If the chosen zoom is more than one day. If users change the assigned
|
||||
hour value to a week, month, four-month or six-month period, the system
|
||||
distributes the hours lineally for all days throughout the chosen
|
||||
period.
|
||||
* **Zoom Levels Greater Than One Day:** If users change the assigned hour value to a week, month, four-month, or six-month period, the system distributes the hours linearly across all days throughout the chosen period.
|
||||
* **Daily Zoom:** If users change the assigned hour value to a day, these hours only apply to that day. Consequently, users can decide how many hours they want to assign per day to task resources.
|
||||
|
||||
* If the chosen zoom is one day. If users change the assigned hour value
|
||||
to a day, these hours only apply to a day. Consequently, users can
|
||||
decide how many hours they want to assign per day to task resources.
|
||||
* Users can choose to design an advanced assignment function. To do so, users must:
|
||||
|
||||
* Users can choose to design an advanced assignment function. In order to do so, users have to:
|
||||
* Choose the function from the selection list that appears next to each resource and click "Configure."
|
||||
* The system displays a new window if the chosen function needs to be specifically configured. Supported functions:
|
||||
|
||||
* Choose the function on the selection list that appears at the side of
|
||||
each resource and click "Configure".
|
||||
* **Segments:** A function that allows users to define segments to which a polynomial function is applied. The function per segment is configured as follows:
|
||||
|
||||
* The system shows a new window if the chosen function needs to be
|
||||
specifically configured. Supported functions:
|
||||
* **Date:** The date on which the segment ends. If the following value (length) is established, the date is calculated; alternatively, length is calculated.
|
||||
* **Defining the Length of Each Segment:** This indicates what percentage of the task's duration is required for the segment.
|
||||
* **Defining the Amount of Work:** This indicates what workload percentage is expected to be completed in this segment. The quantity of work must be incremental. For example, if there is a 10% segment, the next one must be larger (for example, 20%).
|
||||
* **Segment Graphs and Accumulated Loads.**
|
||||
|
||||
* Segments: A function that allows users to define segments to which
|
||||
a polynomial function is applied. The function per segment is
|
||||
configured as follows:
|
||||
|
||||
* Date. Date on which the segment ends. If the following value is
|
||||
established (length), the date is calculated, alternatively, length is
|
||||
calculated.
|
||||
|
||||
* Defining the length of each segment. This indicates what percentage of
|
||||
the task's duration is required for the segment.
|
||||
|
||||
* Defining the amount of work. This indicates what workload percentage
|
||||
is expected to be completed in this segment. The quantity of work must
|
||||
be incremental. For example, if there is a 10% segment, the next one
|
||||
must be larger (for example, 20%).
|
||||
|
||||
* Segment graphs and accumulated loads.
|
||||
|
||||
* Users then click "Accept".
|
||||
|
||||
* The program stores the function and applies it to the daily resource
|
||||
assignments.
|
||||
* Users then click "Accept."
|
||||
* The program stores the function and applies it to the daily resource assignments.
|
||||
|
||||
.. figure:: images/stretches.png
|
||||
:scale: 40
|
||||
|
||||
Configuration of the segment function
|
||||
|
||||
|
||||
Configuration of the Segment Function
|
||||
|
|
|
|||
|
|
@ -1,75 +1,74 @@
|
|||
Work reports
|
||||
#################
|
||||
Work Reports
|
||||
############
|
||||
|
||||
.. contents::
|
||||
|
||||
Work reports enable the monitoring of the hours that existing resources dedicate to the tasks in which they are scheduled.
|
||||
Work reports enable the monitoring of the hours that resources dedicate to the tasks to which they are assigned.
|
||||
|
||||
The program allows users to configure new forms to enter dedicated hours, specifying the fields that they want to appear in these models, to incorporate reports from tasks that are carried out by workers and to monitor workers.
|
||||
The program allows users to configure new forms for entering dedicated hours, specifying the fields that they want to appear in these forms. This allows for the incorporation of reports from tasks carried out by workers and the monitoring of worker activity.
|
||||
|
||||
Before being able to add entries for resources, users must at least specify a work report type that defines the structure, including all the rows that are added to it. Users can create as many work reports on the system as necessary.
|
||||
Before users can add entries for resources, they must define at least one work report type. This type defines the structure of the report, including all the rows that are added to it. Users can create as many work report types as necessary within the system.
|
||||
|
||||
Work report type
|
||||
================
|
||||
Work Report Types
|
||||
=================
|
||||
|
||||
A work report has a series of fields that are common to the whole report, and a set of work report lines with specific values for the fields defined in each row. For example, resources and tasks are common to all reports, however, there can be other new fields such as "incidents", which are not required in all types.
|
||||
A work report consists of a series of fields that are common to the entire report and a set of work report lines with specific values for the fields defined in each row. For example, resources and tasks are common to all reports. However, there can be other new fields, such as "incidents," which are not required in all report types.
|
||||
|
||||
Users can configure different work report types so that a company can design its reports to meet its own needs:
|
||||
Users can configure different work report types so that a company can design its reports to meet its specific needs:
|
||||
|
||||
.. figure:: images/work-report-types.png
|
||||
:scale: 40
|
||||
|
||||
Work report types
|
||||
Work Report Types
|
||||
|
||||
The administration of the work report types allows users to configure this type of feature and add new text fields or optional tags. In the first tab for editing work report types, it is possible to configure the type for the obligatory attributes (if they are applicable to the whole report or if they are specified at line level), and add new optional fields.
|
||||
The administration of work report types allows users to configure these types and add new text fields or optional tags. In the first tab for editing work report types, it is possible to configure the type for the mandatory attributes (whether they apply to the whole report or are specified at the line level) and add new optional fields.
|
||||
|
||||
The obligatory fields that must appear in all work reports are as follows:
|
||||
The mandatory fields that must appear in all work reports are as follows:
|
||||
|
||||
* Name and code: ID fields for the name of the work report type and its code.
|
||||
* Date: Field for the date of the report.
|
||||
* Resource: Worker or machine appearing on the report or work report line.
|
||||
* Order element: Code for the order element to which the performed work is attributed.
|
||||
* Hour management: Determining the hour attribution policy to be carried out, which can be:
|
||||
* According to assigned hours.
|
||||
* According to start and finish times.
|
||||
* According to the number of hours and start and finish range (discrepancies are allowed and the number of hours takes priority).
|
||||
* **Name and Code:** Identification fields for the name of the work report type and its code.
|
||||
* **Date:** Field for the date of the report.
|
||||
* **Resource:** Worker or machine appearing on the report or work report line.
|
||||
* **Order Element:** Code for the order element to which the performed work is attributed.
|
||||
* **Hour Management:** Determines the hour attribution policy to be used, which can be:
|
||||
|
||||
* **According to Assigned Hours:** Hours are attributed based on the assigned hours.
|
||||
* **According to Start and Finish Times:** Hours are calculated based on the start and finish times.
|
||||
* **According to the Number of Hours and Start and Finish Range:** Discrepancies are allowed, and the number of hours takes priority.
|
||||
|
||||
Users can add new fields to the reports:
|
||||
|
||||
* Tag type: Users can request the system to show a tag when completing the work report. For example, the client tag type, if the user wishes to enter the client, for which the work was carried out, in each report.
|
||||
* Free fields: Fields where text can be entered freely in the work report.
|
||||
* **Tag Type:** Users can request the system to display a tag when completing the work report. For example, the client tag type, if the user wishes to enter the client for whom the work was carried out in each report.
|
||||
* **Free Fields:** Fields where text can be entered freely in the work report.
|
||||
|
||||
.. figure:: images/work-report-type.png
|
||||
:scale: 50
|
||||
|
||||
Creating a work report type with personalised fields
|
||||
Creating a Work Report Type with Personalized Fields
|
||||
|
||||
Users can configure date, resource, and order element fields to appear in the header of the report, which means they apply to the entire report, or they can be added to each of the rows.
|
||||
|
||||
Users can configure date, resource and order element fields if they appear in the header of the report, which means they apply to the whole report, or if they are added to each of the rows.
|
||||
Finally, new additional text fields or tags can be added to the existing ones, in the work report header or in each line, by using the "Additional text" and "Tag type" fields, respectively. Users can configure the order in which these elements are to be entered in the "Management of additional fields and tags" tab.
|
||||
|
||||
Finally, new additional text fields or tags can be added to the existing ones, in the work report header or in each line, by using the "Additional text" and "Tag type" fields respectively. Users can configure the order in which these elements are to be entered in the "Management of additional fields and tags" tab.
|
||||
|
||||
Work report list
|
||||
Work Report List
|
||||
================
|
||||
|
||||
As soon as the format of the reports to be incorporated into the system have been configured, users can enter the details in the created form according to the structure defined in the corresponding work report type. In order to do this, users need to follow these steps:
|
||||
Once the format of the reports to be incorporated into the system has been configured, users can enter the details in the created form according to the structure defined in the corresponding work report type. To do this, users need to follow these steps:
|
||||
|
||||
* Click the "New work report" button associated with the desired report from the list of work report types.
|
||||
* The program then shows the report based on the configurations given for the type. See the following image.
|
||||
* Click the "New work report" button associated with the desired report from the list of work report types.
|
||||
* The program then displays the report based on the configurations given for the type. See the following image.
|
||||
|
||||
.. figure:: images/work-report-type.png
|
||||
:scale: 50
|
||||
|
||||
Structure of the work report based on type
|
||||
Structure of the Work Report Based on Type
|
||||
|
||||
* Select all the fields shown for the report:
|
||||
* Select all the fields shown for the report:
|
||||
|
||||
* Resource: If the header has been chosen, the resource is only shown once, alternatively, for each line of the report, it is necessary to choose a resource.
|
||||
* Task code: Code of the task to which the work report is being assigned. Similar to the rest of the fields, if the field is the header, the value is entered once or as many times as necessary on the lines of the report.
|
||||
* Date: Date of the report or each line, depending on whether the heading or line is configured.
|
||||
* Number of hours. The number of work hours in the project.
|
||||
* Start and finish times. Start and finish times for the work in order to calculate definitive work hours. This field only appears in the case of the hour assignment policies, "According to start and finish times" and "According to the number of hours and start and finish range".
|
||||
* Type of hours: Enabling users to choose the type of hour, e.g. "Normal", "Extraordinary", etc.
|
||||
|
||||
* Click "Save" or "Save and continue".
|
||||
* **Resource:** If the header has been chosen, the resource is only shown once. Alternatively, for each line of the report, it is necessary to choose a resource.
|
||||
* **Task Code:** Code of the task to which the work report is being assigned. Similar to the rest of the fields, if the field is in the header, the value is entered once or as many times as necessary on the lines of the report.
|
||||
* **Date:** Date of the report or each line, depending on whether the header or line is configured.
|
||||
* **Number of Hours:** The number of work hours in the project.
|
||||
* **Start and Finish Times:** Start and finish times for the work in order to calculate definitive work hours. This field only appears in the case of the hour assignment policies, "According to Start and Finish Times" and "According to the Number of Hours and Start and Finish Range."
|
||||
* **Type of Hours:** Enables users to choose the type of hour, e.g., "Normal," "Extraordinary," etc.
|
||||
|
||||
* Click "Save" or "Save and continue."
|
||||
|
|
|
|||
|
|
@ -1,63 +1,55 @@
|
|||
Tags
|
||||
####
|
||||
Labels
|
||||
######
|
||||
|
||||
.. contents::
|
||||
|
||||
Tags are entities used in the program to conceptually organise tasks or order elements.
|
||||
Labels are entities used in the program to conceptually organize tasks or order elements.
|
||||
|
||||
Tags are categorised according to tag type. A tag can only belong to one tag type, however,
|
||||
users can create many similar tags belonging to different tag types.
|
||||
Labels are categorized according to label type. A label can only belong to one label type; however, users can create many similar labels belonging to different label types.
|
||||
|
||||
Tag types
|
||||
=========
|
||||
Label Types
|
||||
===========
|
||||
|
||||
Tag types are used to group the types of tag that users want to manage in the program. Here are some examples of possible tag types:
|
||||
Label types are used to group the types of labels that users want to manage in the program. Here are some examples of possible label types:
|
||||
|
||||
i. Client: Users may be interested in tagging tasks, orders or order elements in relation to the client who requests them.
|
||||
ii. Area: Users may be interested in tagging tasks, orders or order elements in relation to the areas in which they are carried out.
|
||||
* **Client:** Users may be interested in labeling tasks, orders, or order elements in relation to the client who requests them.
|
||||
* **Area:** Users may be interested in labeling tasks, orders, or order elements in relation to the areas in which they are carried out.
|
||||
|
||||
The administration of tag types is managed from the "Administration" menu option.
|
||||
This is where users can edit tag types, create new tag types and add tags to tag types. Users can access the list of tags from this option.
|
||||
The administration of label types is managed from the "Administration" menu option. This is where users can edit label types, create new label types, and add labels to label types. Users can access the list of labels from this option.
|
||||
|
||||
.. figure:: images/tag-types-list.png
|
||||
:scale: 50
|
||||
|
||||
List of tag types
|
||||
List of Label Types
|
||||
|
||||
From the list of tag types, users can:
|
||||
From the list of label types, users can:
|
||||
|
||||
i. Create a new tag type.
|
||||
ii. Edit an existing tag type.
|
||||
iii. Delete a tag type with all of its tags.
|
||||
* Create a new label type.
|
||||
* Edit an existing label type.
|
||||
* Delete a label type with all of its labels.
|
||||
|
||||
Editing and creating tags share the same form.
|
||||
From this form, the user can assign a name to the tag type, create or delete tags and store the changes.
|
||||
The procedure is as follows:
|
||||
Editing and creating labels share the same form. From this form, the user can assign a name to the label type, create or delete labels, and store the changes. The procedure is as follows:
|
||||
|
||||
i. Select a tag to edit or click the create button for a new one.
|
||||
ii. The system shows a form with a text entry for the name and a list of text entries with existing and assigned tags.
|
||||
iii. If users wish to add a new tag, they must click on the "New tag" button.
|
||||
iv. The system shows a new row on the list with an empty text box that users must edit.
|
||||
v. Users enter a name for the tag.
|
||||
vi. The system adds the name to the list.
|
||||
vii. Users click "Save" or "Save and continue" to continue editing the form.
|
||||
* Select a label to edit or click the create button for a new one.
|
||||
* The system displays a form with a text entry for the name and a list of text entries with existing and assigned labels.
|
||||
* If users wish to add a new label, they must click the "New label" button.
|
||||
* The system displays a new row on the list with an empty text box that users must edit.
|
||||
* Users enter a name for the label.
|
||||
* The system adds the name to the list.
|
||||
* Users click "Save" or "Save and continue" to continue editing the form.
|
||||
|
||||
.. figure:: images/tag-types-edition.png
|
||||
:scale: 50
|
||||
|
||||
Editing tag types
|
||||
Editing Label Types
|
||||
|
||||
Tags
|
||||
====
|
||||
Labels
|
||||
======
|
||||
|
||||
Tags are entities that belong to a tag type. These entities can be assigned to order elements.
|
||||
Assigning a tag to an order element means that all the elements descending from this element will inherit the tag to which they belong.
|
||||
Having an assigned tag means that these entities are filtered where searches can be carried out:
|
||||
|
||||
i. Search for tasks in the Gantt chart.
|
||||
ii. Search for order elements in the list of order elements.
|
||||
iii. Filters for reports.
|
||||
|
||||
The assignment of tags to order elements is covered in the chapter on orders.
|
||||
Labels are entities that belong to a label type. These entities can be assigned to order elements. Assigning a label to an order element means that all the elements descending from this element will inherit the label to which they belong. Having an assigned label means that these entities can be filtered where searches can be carried out:
|
||||
|
||||
* Search for tasks in the Gantt chart.
|
||||
* Search for order elements in the list of order elements.
|
||||
* Filters for reports.
|
||||
|
||||
The assignment of labels to order elements is covered in the chapter on orders.
|
||||
|
|
|
|||
|
|
@ -1,45 +1,42 @@
|
|||
Materials
|
||||
#########
|
||||
Materials Management
|
||||
####################
|
||||
|
||||
.. _materiales:
|
||||
.. contents::
|
||||
|
||||
|
||||
Administration of materials
|
||||
Administration of Materials
|
||||
===========================
|
||||
|
||||
Users can manage a basic database of materials, organised by categories.
|
||||
Users can manage a basic database of materials, organized by categories.
|
||||
|
||||
The categories are containers that can be assigned specific materials and also more categories.
|
||||
They are stored in a tree structure as the materials can belong to leaf or intermediary categories.
|
||||
Categories are containers to which specific materials and other categories can be assigned. They are stored in a hierarchical tree structure, as materials can belong to leaf categories or intermediary categories.
|
||||
|
||||
Users have to do the following to manage categories:
|
||||
To manage categories, users must follow these steps:
|
||||
|
||||
* Go to the "Administration->Materials" option.
|
||||
* The program shows a tree of categories.
|
||||
* The user enters a category name in the text box and then clicks "Add".
|
||||
* The program adds the category to the tree.
|
||||
* Go to the "Administration -> Materials" option.
|
||||
* The program displays a tree of categories.
|
||||
* Enter a category name in the text box and then click "Add."
|
||||
* The program adds the category to the tree.
|
||||
|
||||
If users want to insert a category into the category tree, they have to first select the parent category in the tree and then click "Add".
|
||||
To insert a category into the category tree, users must first select the parent category in the tree and then click "Add."
|
||||
|
||||
.. figure:: images/material.png
|
||||
:scale: 50
|
||||
|
||||
Material administration screen
|
||||
Material Administration Screen
|
||||
|
||||
Users have to do the following to manage materials:
|
||||
To manage materials, users must follow these steps:
|
||||
|
||||
* Select the category to which materials are to be included and click "Add" to the right of "Materials".
|
||||
* The program adds a new empty row with fields to enter details about the material:
|
||||
* Select the category to which materials are to be added and click "Add" to the right of "Materials."
|
||||
* The program adds a new empty row with fields to enter details about the material:
|
||||
|
||||
* Code: Material type code (this can be the external code from an ERP).
|
||||
* Description: Description of the material.
|
||||
* Price of the unit: Unit price of each piece of material.
|
||||
* Unit: Unit that is used to measure each unit of material.
|
||||
* Category: Category to which it belongs.
|
||||
* Availability: Whether or not the material has been removed.
|
||||
|
||||
* Users complete the fields and click "Save".
|
||||
|
||||
The assignment of materials to order elements is explained in the chapter on "Orders".
|
||||
* **Code:** Material type code (this can be the external code from an ERP).
|
||||
* **Description:** Description of the material.
|
||||
* **Unit Price:** Unit price of each piece of material.
|
||||
* **Unit:** Unit used to measure each unit of material.
|
||||
* **Category:** Category to which the material belongs.
|
||||
* **Availability:** Indicates whether or not the material is active.
|
||||
|
||||
* Users complete the fields and click "Save."
|
||||
|
||||
The assignment of materials to order elements is explained in the chapter on "Orders."
|
||||
|
|
|
|||
|
|
@ -1,39 +1,35 @@
|
|||
Quality forms
|
||||
Quality Forms
|
||||
#############
|
||||
|
||||
.. _calidad:
|
||||
.. contents::
|
||||
|
||||
|
||||
Administration of quality forms
|
||||
Administration of Quality Forms
|
||||
===============================
|
||||
|
||||
Quality forms consist of a list of questions or sentences that indicate the tasks or processes that should have been
|
||||
completed so that a task can be marked as complete by the company. These forms consist of the following fields:
|
||||
Quality forms consist of a list of questions or statements that indicate the tasks or processes that should have been completed before a task can be marked as complete by the company. These forms include the following fields:
|
||||
|
||||
* Name
|
||||
* Description
|
||||
* Type of quality form. The type can have two values:
|
||||
* **Name:** The name of the quality form.
|
||||
* **Description:** A description of the quality form.
|
||||
* **Type of Quality Form:** The type can have two values:
|
||||
|
||||
* Percentage: Indicating that the questions must have a logical order and affirmative answers to the questions indicate that the task is progressing. For example, a basic process for a task suggests that the task is 15% complete. Users need to answer a question beforehand to be able to go on to the next one.
|
||||
* Item: Indicating that the questions are not required to have a logical order and therefore can be answered as desired.
|
||||
* **Percentage:** Indicates that the questions must be answered in a logical order, and affirmative answers indicate that the task is progressing. For example, a basic process for a task might suggest that the task is 15% complete. Users must answer a question before proceeding to the next one.
|
||||
* **Item:** Indicates that the questions do not need to be answered in a logical order and can be answered in any sequence.
|
||||
|
||||
Users must carry out the following steps to manage the quality forms:
|
||||
Users must follow these steps to manage quality forms:
|
||||
|
||||
* From the "Administration" menu, access the "Quality forms" option.
|
||||
* Click edit an existing form or "Create".
|
||||
* The program shows a form with a name, description and type.
|
||||
* Select the type.
|
||||
* The program shows the fields that are allowed for each type:
|
||||
* From the "Administration" menu, access the "Quality forms" option.
|
||||
* Click "Edit" on an existing form or click "Create" to create a new one.
|
||||
* The program displays a form with fields for the name, description, and type.
|
||||
* Select the type.
|
||||
* The program displays the fields that are allowed for each type:
|
||||
|
||||
* Percentage: question and percentage.
|
||||
* Item: question.
|
||||
* **Percentage:** Question and percentage.
|
||||
* **Item:** Question.
|
||||
|
||||
* Click "Save" or "Save and continue".
|
||||
* Click "Save" or "Save and continue."
|
||||
|
||||
.. figure:: images/quality.png
|
||||
:scale: 50
|
||||
|
||||
Material administration screen
|
||||
|
||||
|
||||
Quality Form Administration Screen
|
||||
|
|
|
|||
|
|
@ -1,63 +1,59 @@
|
|||
Users
|
||||
########
|
||||
User Management
|
||||
###############
|
||||
|
||||
.. _tareas:
|
||||
.. contents::
|
||||
|
||||
|
||||
Managing users
|
||||
Managing Users
|
||||
==============
|
||||
|
||||
"LibrePlan"'s system enables users to manage profiles, authorisations and users. Users belong to user profiles, which may have a series of predefined roles to access the program. Roles are defined authorisations in "LibrePlan". Examples of roles:
|
||||
LibrePlan's system allows administrators to manage user profiles, authorizations, and users. Users are assigned to user profiles, which can have a series of predefined roles that grant access to the program's features. Roles are defined authorizations within LibrePlan. Examples of roles include:
|
||||
|
||||
* Administration: A role to which administrators must be assigned in order to be able to carry out administration operations.
|
||||
* Web service reader: A role that users need to be able to consult the program's web services.
|
||||
* Web service writer: A role that users need to be able to write via the program's web services.
|
||||
* **Administration:** A role that must be assigned to administrators to enable them to perform administrative operations.
|
||||
* **Web Service Reader:** A role required for users to consult the program's web services.
|
||||
* **Web Service Writer:** A role required for users to write data via the program's web services.
|
||||
|
||||
Roles are predefined in the system. A user profile consists of one or several roles. Users must have certain roles to carry out certain operations.
|
||||
Roles are predefined within the system. A user profile consists of one or more roles. Users must have specific roles to perform certain operations.
|
||||
|
||||
Users have one or several profiles or one or several roles directly so that specific or generic authorisation can be assigned.
|
||||
Users can be assigned one or more profiles, or one or more roles directly, allowing for specific or generic authorization to be granted.
|
||||
|
||||
It is necessary to carry out the following steps to manage users:
|
||||
To manage users, follow these steps:
|
||||
|
||||
* Go to "Manage users" on the "Administration" menu.
|
||||
* The program shows a form with a list of users.
|
||||
* Click the editing button for the chosen user or click the "Create" button.
|
||||
* A form will appear with the following fields:
|
||||
* Go to "Manage users" in the "Administration" menu.
|
||||
* The program displays a form with a list of users.
|
||||
* Click the edit button for the desired user or click the "Create" button.
|
||||
* A form will appear with the following fields:
|
||||
|
||||
* User name.
|
||||
* Password
|
||||
* Authorised/unauthorised.
|
||||
* Email
|
||||
* List of associated roles. Users need to search for one of the roles shown on the selection list and click "Assign" to add a new role.
|
||||
* List of associated profiles. Users need to search for one of the profiles shown on the selection list and click "Assign" to add a new profile.
|
||||
* **User Name:** The user's login name.
|
||||
* **Password:** The user's password.
|
||||
* **Authorized/Unauthorized:** A setting to enable or disable the user's account.
|
||||
* **Email:** The user's email address.
|
||||
* **List of Associated Roles:** To add a new role, users must search for a role in the selection list and click "Assign."
|
||||
* **List of Associated Profiles:** To add a new profile, users must search for a profile in the selection list and click "Assign."
|
||||
|
||||
.. figure:: images/manage-user.png
|
||||
:scale: 50
|
||||
|
||||
Managing users
|
||||
Managing Users
|
||||
|
||||
* Click "Save" or "Save and continue".
|
||||
* Click "Save" or "Save and continue."
|
||||
|
||||
|
||||
Managing profiles
|
||||
Managing Profiles
|
||||
-----------------
|
||||
|
||||
Users need to carry out the following steps to manage the program's profiles.
|
||||
To manage the program's profiles, users must follow these steps:
|
||||
|
||||
* Go to "Manage user profiles" on the "Administration" menu.
|
||||
* The program shows a list of profiles.
|
||||
* Click the editing button for the chosen profile or click "Create".
|
||||
* A form appears in the program with the following fields:
|
||||
* Go to "Manage user profiles" in the "Administration" menu.
|
||||
* The program displays a list of profiles.
|
||||
* Click the edit button for the desired profile or click "Create."
|
||||
* A form appears in the program with the following fields:
|
||||
|
||||
* Name
|
||||
* List of roles (authorisations) associated with the profile. Users must select a role from the role list and click "Add" to add one that is associated with the profile.
|
||||
* **Name:** The name of the user profile.
|
||||
* **List of Roles (Authorizations):** To add a role to the profile, users must select a role from the role list and click "Add."
|
||||
|
||||
.. figure:: images/manage-user-profile.png
|
||||
:scale: 50
|
||||
|
||||
Managing user profiles
|
||||
|
||||
* Click "Save" or "Save and continue" and the system will store the created or modified profile.
|
||||
|
||||
Managing User Profiles
|
||||
|
||||
* Click "Save" or "Save and continue," and the system will store the created or modified profile.
|
||||
|
|
|
|||
|
|
@ -1,92 +1,88 @@
|
|||
Cost management
|
||||
Cost management
|
||||
################
|
||||
|
||||
.. _costes:
|
||||
.. contents::
|
||||
|
||||
|
||||
Costs
|
||||
=====
|
||||
|
||||
Cost management allows users to estimate the costs of resources used in a project. In order to manage costs, the following entities have to be determined:
|
||||
Cost management allows users to estimate the costs of resources used in a project. To manage costs, the following entities must be defined:
|
||||
|
||||
* Hour type worked: These indicate the hour types worked for the resource. Users can include hour types for machines and for workers. Examples of hour types include: Additional hours paid at €20 per hour generically. The following fields can be included in the hour types worked:
|
||||
* **Hour Types:** These indicate the types of hours worked by a resource. Users can define hour types for both machines and workers. Examples of hour types include: "Additional hours paid at €20 per hour." The following fields can be defined for hour types:
|
||||
|
||||
* Code: External code for the hour type.
|
||||
* Name: Name of the hour type. For example, additional.
|
||||
* Default rate: Basic default rate for the hour type.
|
||||
* Activation: Indicating whether the hour type is activated or not.
|
||||
* **Code:** External code for the hour type.
|
||||
* **Name:** Name of the hour type. For example, "Additional."
|
||||
* **Default Rate:** Basic default rate for the hour type.
|
||||
* **Activation:** Indicates whether the hour type is active or not.
|
||||
|
||||
* Cost categories. Cost categories show categories that are used to define costs according to hour type during certain periods (these periods may be indefinite). For example, the cost of additional hours for first grade skilled workers in the following year is €24 per hour. Cost categories contain:
|
||||
* **Cost Categories:** Cost categories define the costs associated with different hour types during specific periods (which may be indefinite). For example, the cost of additional hours for first-grade skilled workers in the following year is €24 per hour. Cost categories include:
|
||||
|
||||
* Name: Cost category name.
|
||||
* Activation: Indicating whether the category is activated or not.
|
||||
* List of hour types assigned to the cost category. They indicate several periods and rates for hour types. For example, as rates change, each year is included on this list as an hour type period, but an hourly rate is maintained for each hour type (which may be different from the default hourly rate included for the hour type).
|
||||
* **Name:** Cost category name.
|
||||
* **Activation:** Indicates whether the category is active or not.
|
||||
* **List of Hour Types:** This list defines the hour types included in the cost category. It specifies the periods and rates for each hour type. For example, as rates change, each year can be included on this list as an hour type period, with a specific hourly rate for each hour type (which may differ from the default hourly rate for that hour type).
|
||||
|
||||
Managing Hour Types
|
||||
-------------------
|
||||
|
||||
Managing hour types worked
|
||||
--------------------------
|
||||
Users must follow these steps to register hour types:
|
||||
|
||||
Users need to carry out the following steps to register hour types worked:
|
||||
|
||||
* Select "Manage hour types worked" on the "Administration" menu.
|
||||
* The program shows a list of existing hour types.
|
||||
* Select "Manage hour types worked" on the "Administration" menu.
|
||||
* The program displays a list of existing hour types.
|
||||
|
||||
.. figure:: images/hour-type-list.png
|
||||
:scale: 35
|
||||
|
||||
Hour type list
|
||||
Hour Type List
|
||||
|
||||
* Click "Edit" or "Create".
|
||||
* The program shows an hour type editing form.
|
||||
* Click "Edit" or "Create."
|
||||
* The program displays an hour type editing form.
|
||||
|
||||
.. figure:: images/hour-type-edit.png
|
||||
:scale: 50
|
||||
|
||||
Editing hour types
|
||||
Editing Hour Types
|
||||
|
||||
* Users can enter or change:
|
||||
* Users can enter or change:
|
||||
|
||||
* The hour type name.
|
||||
* The hour type code.
|
||||
* The default rate.
|
||||
* Hour type activation/de-activation.
|
||||
* The hour type name.
|
||||
* The hour type code.
|
||||
* The default rate.
|
||||
* Hour type activation/deactivation.
|
||||
|
||||
* Click "Save" or "Save and continue".
|
||||
* Click "Save" or "Save and continue."
|
||||
|
||||
Cost categories
|
||||
Cost Categories
|
||||
---------------
|
||||
|
||||
Users need to carry out the following steps to register cost categories:
|
||||
Users must follow these steps to register cost categories:
|
||||
|
||||
* Select "Manage cost categories" on the "Administration" menu.
|
||||
* The program shows a list of existing categories.
|
||||
* Select "Manage cost categories" on the "Administration" menu.
|
||||
* The program displays a list of existing categories.
|
||||
|
||||
.. figure:: images/category-cost-list.png
|
||||
:scale: 50
|
||||
|
||||
Cost category list
|
||||
Cost Category List
|
||||
|
||||
* Click "Edit" or "Create" button.
|
||||
* The program shows a cost category editing form.
|
||||
* Click the "Edit" or "Create" button.
|
||||
* The program displays a cost category editing form.
|
||||
|
||||
.. figure:: images/category-cost-edit.png
|
||||
:scale: 50
|
||||
|
||||
Editing cost categories
|
||||
Editing Cost Categories
|
||||
|
||||
* Users enter or change:
|
||||
* Users enter or change:
|
||||
|
||||
* The name of the cost category.
|
||||
* The activation/de-activation of the hour type.
|
||||
* The list of hour types included in the category. All hour types have the following fields:
|
||||
* The name of the cost category.
|
||||
* The activation/deactivation of the cost category.
|
||||
* The list of hour types included in the category. All hour types have the following fields:
|
||||
|
||||
* Hour type: Choose one of the existing hour types on the system. If none exist, an hour type has to be created (this process is explained in the previous subsection).
|
||||
* Start and finish date (the latter is optional) for the period that applies to the cost category.
|
||||
* Hourly rate for this specific category
|
||||
|
||||
* Click "Save" or "Save and continue".
|
||||
* **Hour Type:** Choose one of the existing hour types in the system. If none exist, an hour type must be created (this process is explained in the previous subsection).
|
||||
* **Start and Finish Date:** The start and finish dates (the latter is optional) for the period that applies to the cost category.
|
||||
* **Hourly Rate:** The hourly rate for this specific category.
|
||||
|
||||
* Click "Save" or "Save and continue."
|
||||
|
||||
The assignment of cost categories to resources is described in the chapter on resources. Go to the "Resources" section.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
Hours Worked By Resource Report
|
||||
Hours Worked by Resource Report
|
||||
###############################
|
||||
|
||||
.. contents::
|
||||
|
|
@ -6,28 +6,28 @@ Hours Worked By Resource Report
|
|||
Purpose
|
||||
=======
|
||||
|
||||
This report allows to extract a list of the tasks and time devoted to them by workers in a period of time. There are several filters which allow users to adjust the query to get just the wanted information and avoiding extra data.
|
||||
This report extracts a list of tasks and the time resources have dedicated to them within a specified period. Several filters allow users to refine the query to obtain only the desired information and exclude extraneous data.
|
||||
|
||||
Input parameters and filters
|
||||
Input Parameters and Filters
|
||||
============================
|
||||
|
||||
* **Dates**.
|
||||
* *Type*: Optional.
|
||||
* *Two date fields*:
|
||||
* *Start Date.* This is the minimum date of the work reports which are wanted. Work reports with an earlier date than the *start date* are ignored. If this parameter is not filled, there is no filtering of work reports by *start date*.
|
||||
* *End Date.* This is the maximum date of the work reports which will be included in the results. Work reports with a later date than the *end date* will be ignored. If this parameter is not filled, there is no filtering of work reports by *end date*.
|
||||
* **Dates**.
|
||||
* *Type*: Optional.
|
||||
* *Two date fields*:
|
||||
* *Start Date:* This is the earliest date for work reports to be included. Work reports with dates earlier than the *Start Date* are excluded. If this parameter is left blank, work reports are not filtered by *Start Date*.
|
||||
* *End Date:* This is the latest date for work reports to be included. Work reports with dates later than the *End Date* are excluded. If this parameter is left blank, work reports are not filtered by *End Date*.
|
||||
|
||||
* **Filter by workers**
|
||||
* *Type*: Optional.
|
||||
* *How it works*: You can select one or several workers to restrict the work reports to the time tracking of that particular worker. You can add a worker to be used as a filter by searching them in the selector and by pressing the *Add* button. If you leave it empty, the work reports are retrieved independently of the worker.
|
||||
* **Filter by Workers:**
|
||||
* *Type:* Optional.
|
||||
* *How it works:* You can select one or more workers to restrict the work reports to the time tracked by those specific workers. To add a worker as a filter, search for them in the selector and click the *Add* button. If this filter is left empty, work reports are retrieved regardless of the worker.
|
||||
|
||||
* **Filter by labels**
|
||||
* *Type:* Optional.
|
||||
* *How it works*: You can add one or several labels to be used as filter by searching them in the selector and by pressing the *Add* button. They are used to select the tasks that will be included in the results to compute the hours devoted in them. This filter can be applied to timesheets, tasks, both, or any.
|
||||
* **Filter by Labels:**
|
||||
* *Type:* Optional.
|
||||
* *How it works:* You can add one or more labels to use as filters by searching for them in the selector and clicking the *Add* button. These labels are used to select the tasks to be included in the results when calculating the hours dedicated to them. This filter can be applied to timesheets, tasks, both, or neither.
|
||||
|
||||
* **Filter by criteria**
|
||||
* *Type:* Optional.
|
||||
* *How it works:* You can select one or several criteria by searching them in the selector and, then, by clicking on the *Add* button. These criteria are used to select the resources that satisfy at least one of them. The report will show all the time devoted by the resources satisfying one of the criteria of the filtering.
|
||||
* **Filter by Criteria:**
|
||||
* *Type:* Optional.
|
||||
* *How it works:* You can select one or more criteria by searching for them in the selector and then clicking the *Add* button. These criteria are used to select the resources that satisfy at least one of them. The report will show all the time dedicated by the resources that meet one of the selected criteria.
|
||||
|
||||
Output
|
||||
======
|
||||
|
|
@ -35,33 +35,34 @@ Output
|
|||
Heading
|
||||
-------
|
||||
|
||||
In the heading of the report is informed about the filters that were configured and that were applied in the current report extract.
|
||||
The report heading displays the filters that were configured and applied to the current report.
|
||||
|
||||
Foot page
|
||||
---------
|
||||
The date on which the report was run is listed.
|
||||
Footer
|
||||
------
|
||||
|
||||
The date on which the report was generated is listed in the footer.
|
||||
|
||||
Body
|
||||
----
|
||||
|
||||
The body of the report consists of several groups of information.
|
||||
The report body consists of several groups of information.
|
||||
|
||||
* There is a first aggretation of information per resource. All the time devoted by a resource is showed together below the header. Each resource it is identified by:
|
||||
* The first level of aggregation is by resource. All the time dedicated by a resource is shown together below the header. Each resource is identified by:
|
||||
|
||||
* *Worker*: Surname, Firstname
|
||||
* *Machine*: Name.
|
||||
* *Worker:* Surname, First Name.
|
||||
* *Machine:* Name.
|
||||
|
||||
It is showed a summing-up line with the total number of hours worked by the resource.
|
||||
A summary line shows the total number of hours worked by the resource.
|
||||
|
||||
* There is a second grouping level consisting of the *date*. All the reports coming from a concrete resource at the same date are showed together.
|
||||
* The second level of grouping is by *date*. All the reports from a specific resource on the same date are shown together.
|
||||
|
||||
There is a summing-up line with the total number of hours worked by the resource.
|
||||
A summary line shows the total number of hours worked by the resource on that date.
|
||||
|
||||
* There is a last level at which there are listed the work reports belonging to the same day for the worker. The information which is displayed for each work report line is:
|
||||
* The final level lists the work reports for the worker on that day. The information displayed for each work report line is:
|
||||
|
||||
* *Task code* the tracked hours impute.
|
||||
* *Task name* the tracked hours impute.
|
||||
* *Starting time*. It is not mandatory. It is the starting time at which the resource began doing the work tracked in the task.
|
||||
* *Ending time*. It is not mandatory. It is the ending time until which the resource works in the task at the date specified.
|
||||
* *Textfields*. It is optional. If the work report line has text fields the filled values, they are showed here. The format is: <Name of the text field>:<Value>
|
||||
* *Labels*. It depends on if the work report model has a label field in its definition. If there are several labels they are showed in the same column. The format is: <Name of the label type>:<Value of the label>
|
||||
* *Task Code:* The code of the task to which the tracked hours are attributed.
|
||||
* *Task Name:* The name of the task to which the tracked hours are attributed.
|
||||
* *Starting Time:* This is optional. It is the time at which the resource began working on the task.
|
||||
* *Ending Time:* This is optional. It is the time at which the resource finished working on the task on the specified date.
|
||||
* *Text Fields:* This is optional. If the work report line has text fields, the filled values are shown here. The format is: <Name of the text field>:<Value>
|
||||
* *Labels:* This depends on whether the work report model has a label field in its definition. If there are multiple labels, they are shown in the same column. The format is: <Name of the label type>:<Value of the label>
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
Total hours worked by resource in a month report
|
||||
Total Hours Worked by Resource in a Month Report
|
||||
################################################
|
||||
|
||||
.. contents::
|
||||
|
|
@ -6,39 +6,39 @@ Total hours worked by resource in a month report
|
|||
Purpose
|
||||
=======
|
||||
|
||||
This reports allows to get the total number of worked hours by the resources in a month. This can be useful to know the overtime a worker did or, depending of the organization, the quantity of hours that have to be paid to each resource.
|
||||
This report provides the total number of hours worked by each resource in a given month. This information can be useful for determining worker overtime or, depending on the organization, the number of hours for which each resource should be compensated.
|
||||
|
||||
The application allows to track work reports for the workers and for the machines. According to this, the report in the case of machines sums up the number of hours they were functioning in a month.
|
||||
The application tracks work reports for both workers and machines. For machines, the report sums up the number of hours they were in operation during the month.
|
||||
|
||||
Input parameters and filters
|
||||
Input Parameters and Filters
|
||||
============================
|
||||
|
||||
The report needs the user specify the year and month to get the total number of hours that the resources worked.
|
||||
To generate this report, users must specify the year and month for which they want to retrieve the total number of hours worked by each resource.
|
||||
|
||||
Output
|
||||
======
|
||||
|
||||
The format of the output is the following:
|
||||
The output format is as follows:
|
||||
|
||||
Header
|
||||
------
|
||||
|
||||
In the header of the report it is showed:
|
||||
The report header displays:
|
||||
|
||||
* The *year* to which the data in the report belong.
|
||||
* The *month* to which the data in the report belong.
|
||||
* The *year* to which the data in the report pertains.
|
||||
* The *month* to which the data in the report pertains.
|
||||
|
||||
Foot page
|
||||
---------
|
||||
Footer
|
||||
------
|
||||
|
||||
The date in which the report was asked to be obtained.
|
||||
The footer displays the date on which the report was generated.
|
||||
|
||||
Body
|
||||
----
|
||||
|
||||
The data area of the report consists of just one section at which a table with two columns is shown:
|
||||
The data section of the report consists of a single table with two columns:
|
||||
|
||||
* One column called **Name** for the name of the resource.
|
||||
* One column called **Hours** with the addition of all the hours devoted by the resource the row is of.
|
||||
* One column labeled **Name** for the name of the resource.
|
||||
* One column labeled **Hours** with the total number of hours worked by the resource in that row.
|
||||
|
||||
There is a final line aggregating the total of the hours devoted by any resource in the *month*, *year* the report is about.
|
||||
There is a final row that aggregates the total number of hours worked by all resources during the specified *month* and *year*.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
Work and progress per project report
|
||||
Work and Progress per Project Report
|
||||
####################################
|
||||
|
||||
.. contents::
|
||||
|
|
@ -6,74 +6,74 @@ Work and progress per project report
|
|||
Purpose
|
||||
=======
|
||||
|
||||
This report lets you know find out which is the overall status of the projects taking into account two variables: the progress and the cost.
|
||||
This report provides an overview of the status of projects, considering both progress and cost.
|
||||
|
||||
It is analyzed the current status of project progress comparing it with the forseen one according to planning and according to the work devoted.
|
||||
It analyzes the current progress of each project, comparing it with the planned progress and the work completed.
|
||||
|
||||
It is also showed several ratios related to the project cost comparing current performance with the theorical one.
|
||||
The report also displays several ratios related to project cost, comparing current performance with the planned performance.
|
||||
|
||||
Input parameters and filters
|
||||
Input Parameters and Filters
|
||||
============================
|
||||
|
||||
There are several mandatory parameters. They are:
|
||||
There are several mandatory parameters:
|
||||
|
||||
* **Reference date**. It is the date which is wanted to have as reference to make the comparison with the planned foreseen status of the project at that date with the real performance of the project at that date according. *The default value for this field is the current date*.
|
||||
* **Reference Date:** This is the date used as a reference point for comparing the planned status of the project with its actual performance. *The default value for this field is the current date*.
|
||||
|
||||
* **Progress type**. It is the progress type it is wanted to be used to measure the projects progress. In the application a project can be measured simultaneously with different progress types, and the one selected with the pulldown component by the user is the one used for calculating the report data. The default value for the *progress type* is *spread*, which is a special progress type consisting of using the preferred way of measuring the progress configured in each WBS element.
|
||||
* **Progress Type:** This is the progress type used to measure project progress. The application allows a project to be measured simultaneously with different progress types. The type selected by the user in the dropdown menu is used for calculating the report data. The default value for the *progress type* is *spread*, which is a special progress type that uses the preferred method of measuring progress configured for each WBS element.
|
||||
|
||||
With regard to the optional fields, they are the following:
|
||||
The optional parameters are:
|
||||
|
||||
* **Starting date**. It is the minimum starting date of the projects to be included in the report. It is optional. If no starting time is filled, there is not minimum date for the projects.
|
||||
* **Starting Date:** This is the earliest start date for projects to be included in the report. If this field is left blank, there is no minimum start date for the projects.
|
||||
|
||||
* **Ending date**. It is the maximum ending date of the projects to be included in the report. All the projects which finish after the *Ending date* will be excluded.
|
||||
* **Ending Date:** This is the latest end date for projects to be included in the report. All projects that finish after the *Ending Date* will be excluded.
|
||||
|
||||
* **Filter by projects**. This filter allows to select the set of projects to which the user wants to limit the report data to be extracted. If no projects are added to the filter, the report is shown for all the projects in the database. There is a searchable pulldown to find out the wanted project. They are added to the filter by pushing the *Add* button.
|
||||
* **Filter by Projects:** This filter allows users to select the specific projects to be included in the report. If no projects are added to the filter, the report will include all projects in the database. A searchable dropdown menu is provided to find the desired project. Projects are added to the filter by clicking the *Add* button.
|
||||
|
||||
Output
|
||||
======
|
||||
|
||||
The format of the output is the following:
|
||||
The output format is as follows:
|
||||
|
||||
Heading
|
||||
-------
|
||||
|
||||
In the report header the following fields are showed:
|
||||
The report header displays the following fields:
|
||||
|
||||
* **Starting date**. The filtering starting date field. It is not showed if the report is not filtered by this field.
|
||||
* **Ending date**. The filtering ending date field. It is not showed if the report is not filtered by this field.
|
||||
* **Progress type**. The progress type used for the report.
|
||||
* **Projects**. It informs about the filtered projects for which the report is being got. It will show the string *All* when the report is got for all the projects satisfying the rest of filters.
|
||||
* **Reference date**. The mandatory input reference date selected to extract the report.
|
||||
* **Starting Date:** The filtering start date. This is not displayed if the report is not filtered by this field.
|
||||
* **Ending Date:** The filtering end date. This is not displayed if the report is not filtered by this field.
|
||||
* **Progress Type:** The progress type used for the report.
|
||||
* **Projects:** This indicates the filtered projects for which the report is generated. It will show the string *All* when the report includes all projects that satisfy the other filters.
|
||||
* **Reference Date:** The mandatory input reference date selected for the report.
|
||||
|
||||
Foot page
|
||||
---------
|
||||
Footer
|
||||
------
|
||||
|
||||
It is showed the date in which the report has been got.
|
||||
The footer displays the date on which the report was generated.
|
||||
|
||||
Body
|
||||
----
|
||||
|
||||
The body are consists of a list of projects which has been selected as result of the input filters.
|
||||
The body of the report consists of a list of projects selected based on the input filters.
|
||||
|
||||
Filters work adding conditions except the set formed by the date filters (*Starting date*, *Ending date*) and the *filter by projects*. In this case, if one or the two date filters are filled and the *filter by projects* has a list of selected projects at the same this, this last filter is the one that commands the filter. This means that the projects that are included in the report are the provided by the *filter by projects* independently of the date filters.
|
||||
Filters work by adding conditions, except for the set formed by the date filters (*Starting Date*, *Ending Date*) and the *Filter by Projects*. In this case, if one or both date filters are filled and the *Filter by Projects* has a list of selected projects, the latter filter takes precedence. This means that the projects included in the report are those provided by the *Filter by Projects*, regardless of the date filters.
|
||||
|
||||
Another important thing are that the progress in the report are calculated giving as a fraction of unity. They are between 0 and 1.
|
||||
It's important to note that progress in the report is calculated as a fraction of unity, ranging between 0 and 1.
|
||||
|
||||
For each project selected to be included in the report output, the following information is showed:
|
||||
For each project selected for inclusion in the report output, the following information is displayed:
|
||||
|
||||
* *The project name*.
|
||||
* *Total hours*. The total hours of the project are showing by adding the hours of each of task. Two total hours types are showed:
|
||||
* *Estimated (TE)*. This quantity is the addition of all the hours in the WBS of the project. They are the total number of hours in which a project is estimated to be completed.
|
||||
* *Planned (TP)*. In *LibrePlan* it is possible to have two different quantities. The estimated number of hours of a task, which is the number of hours that in advance are needed to do the task, and the planned hours, which are the hours allocated in the plan to do the task. The planned hours can be equal, less or more than the estimated hours and are decided in a later phase, the assignment operation. So, the total planned hours of a project is the addition of all the allocated hours of its tasks
|
||||
* *Progress*. Three measurements related to the global progress of the type specified in the progress input filter for each project at the reference date are showed:
|
||||
* *Measured (PM)*. It is the the global progress considering the progress measurements with a date less than the *reference date* in the input parameters of the report. Besides, all the task are taken into account and the addition is weighted but the number of hours of each task.
|
||||
* *Imputed (PI)*. This is the progress considering that the work goes on at the same pace as the hours devoted in a task. If X hours out of Y hours of a task are done, it is considered that the global imputed progress is X/Y.
|
||||
* *Planned (PP)*.This is the global progress of the project according to the theorical planning at the reference date. If things hapened exactly as planned the measured progress should be the same as the planned progress.
|
||||
* *Hours up to date*.There are two field that show the number of hours until the reference date from two points of view:
|
||||
* *Planned (HP)*. This number is the addition of the hours allocated in any task of the project with a date less or equal to the *reference date*.
|
||||
* *Real (HR)*. This number is the addition of the hours reported in the work reports to any of the tasks of the project with a date less or equal to the *reference date*.
|
||||
* *Difference*. Under this title there are several meters related to the cost:
|
||||
* *Cost*. It is the difference in hours between the number of hours spent taking into account the progress measured and the hours devoted until the the reference date. Formula is: *PM*TP - HR*.
|
||||
* *Planned*. It is the difference between the hours spent according the global project measured and the number planned till the *reference date*. It measures the advantage or delay in time. Formula es: *PM*TP - HR*.
|
||||
* *Cost ratio*. It is calculated dividing the *PM* / *PI*. If it is greater than 1, it means that the project is with benefits at this point and if it es less than 1, it means that the project is losing money.
|
||||
* *Planned ratio*. It is calculated dividing the *PM* / *PP*. If it is greater than 1, it means that the project is ahead of time and it is less than 1 that the project is with delay.Work and progress per project report
|
||||
* *Project Name*.
|
||||
* *Total Hours*. The total hours for the project are shown by adding the hours for each task. Two types of total hours are shown:
|
||||
* *Estimated (TE)*. This is the sum of all the estimated hours in the project's WBS. It represents the total number of hours estimated to complete the project.
|
||||
* *Planned (TP)*. In *LibrePlan*, it's possible to have two different quantities: the estimated number of hours for a task (the number of hours initially estimated to complete the task) and the planned hours (the hours allocated in the plan to complete the task). The planned hours can be equal to, less than, or greater than the estimated hours and are determined in a later phase, the assignment operation. Therefore, the total planned hours for a project are the sum of all the allocated hours for its tasks.
|
||||
* *Progress*. Three measurements related to the overall progress of the type specified in the progress input filter for each project at the reference date are shown:
|
||||
* *Measured (PM)*. This is the overall progress considering the progress measurements with a date earlier than the *Reference Date* in the input parameters of the report. All tasks are taken into account, and the sum is weighted by the number of hours for each task.
|
||||
* *Imputed (PI)*. This is the progress assuming that work continues at the same pace as the hours completed for a task. If X hours out of Y hours for a task are completed, the overall imputed progress is considered to be X/Y.
|
||||
* *Planned (PP)*. This is the overall progress of the project according to the planned schedule at the reference date. If everything happened exactly as planned, the measured progress should be the same as the planned progress.
|
||||
* *Hours up to Date*. There are two fields that show the number of hours up to the reference date from two perspectives:
|
||||
* *Planned (HP)*. This number is the sum of the hours allocated to any task in the project with a date less than or equal to the *Reference Date*.
|
||||
* *Actual (HR)*. This number is the sum of the hours reported in the work reports for any of the tasks in the project with a date less than or equal to the *Reference Date*.
|
||||
* *Difference*. Under this heading, there are several metrics related to cost:
|
||||
* *Cost*. This is the difference in hours between the number of hours spent, considering the measured progress, and the hours completed up to the reference date. The formula is: *PM*TP - HR*.
|
||||
* *Planned*. This is the difference between the hours spent according to the overall measured project progress and the number planned up to the *Reference Date*. It measures the advantage or delay in time. The formula is: *PM*TP - HP*.
|
||||
* *Cost Ratio*. This is calculated by dividing *PM* / *PI*. If it is greater than 1, it means that the project is profitable at this point. If it is less than 1, it means that the project is losing money.
|
||||
* *Planned Ratio*. This is calculated by dividing *PM* / *PP*. If it is greater than 1, it means that the project is ahead of schedule. If it is less than 1, it means that the project is behind schedule.
|
||||
|
|
|
|||
|
|
@ -4,18 +4,17 @@ Reports
|
|||
.. _informes:
|
||||
.. contents::
|
||||
|
||||
LibrePlan integrates with *JasperReports* to provide report management, enabling users to generate various reports for analyzing the data available in the program.
|
||||
|
||||
"LibrePlan" is integrated with *JasperReports* to manage reports, which allows users to enter various reports to analyse available data in the program.
|
||||
|
||||
The defined reports are:
|
||||
The available reports are:
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="15-1-report-hours-worked-by-resource.html">Report on worked hours by resource</a>
|
||||
<a href="15-1-report-hours-worked-by-resource.html">Hours Worked by Resource Report</a>
|
||||
</li><li>
|
||||
<a href="15-2-total-hours-by-resource-month.html">Report on the total hours worked by resource in a month</a>
|
||||
<a href="15-2-total-hours-by-resource-month.html">Total Hours Worked by Resource in a Month Report</a>
|
||||
</li><li>
|
||||
<a href="15-3-work-progress-per-project.html">Report on the work and progress per report</a>
|
||||
<a href="15-3-work-progress-per-project.html">Work and Progress per Project Report</a>
|
||||
</ul>
|
||||
|
|
|
|||
|
|
@ -3,73 +3,74 @@ LDAP Configuration
|
|||
|
||||
.. contents::
|
||||
|
||||
This screen allows to establish a connection with LDAP to delegate
|
||||
This screen allows you to establish a connection with LDAP to delegate
|
||||
authentication and/or authorization.
|
||||
|
||||
It is divided in four different areas related which are explained below:
|
||||
It is divided into four different areas, which are explained below:
|
||||
|
||||
Activation
|
||||
==========
|
||||
|
||||
This area is used to set the properties about the way in which *LibrePlan* uses
|
||||
This area is used to set the properties that determine how *LibrePlan* uses
|
||||
LDAP.
|
||||
|
||||
If the field *Enable LDAP authentication* is checked, *LibrePlan* will look in
|
||||
LDAP each time an user tries to login in the application.
|
||||
If the field *Enable LDAP authentication* is checked, *LibrePlan* will query
|
||||
LDAP each time a user attempts to log in to the application.
|
||||
|
||||
The field *Use LDAP roles* checked means that a mapping between LDAP roles and
|
||||
LibrePlan roles is established, so the permissions for an user in LibrePlan
|
||||
will depend on the roles in LDAP that the user has.
|
||||
LibrePlan roles is established. Consequently, the permissions for a user in
|
||||
LibrePlan will depend on the roles the user has in LDAP.
|
||||
|
||||
Configuration
|
||||
=============
|
||||
|
||||
This section has the parameter values for accessing LDAP. *Base*, *UserDN* and
|
||||
*Password* are parameters used to connect to LDAP and search for the users, so
|
||||
given user must have permission to do that operation in LDAP. At bottom part of
|
||||
this section there is a button to check if LDAP connection is possible with the
|
||||
given parameters. It is a good idea to try it before continuing the
|
||||
configuration.
|
||||
This section contains the parameter values for accessing LDAP. *Base*, *UserDN*, and
|
||||
*Password* are parameters used to connect to LDAP and search for users. Therefore,
|
||||
the specified user must have permission to perform this operation in LDAP. At the
|
||||
bottom of this section, there is a button to check if an LDAP connection is
|
||||
possible with the given parameters. It is advisable to test the connection before
|
||||
continuing the configuration.
|
||||
|
||||
.. NOTE::
|
||||
|
||||
If your LDAP is configured to work with anonymous authentication you can
|
||||
leave empty *UserDN* and *Password* attributes.
|
||||
If your LDAP is configured to work with anonymous authentication, you can
|
||||
leave the *UserDN* and *Password* attributes empty.
|
||||
|
||||
.. TIP::
|
||||
|
||||
About *Active Directory (AD)* configuration, the *Base* field must be the
|
||||
exact location where the bound user lives in the AD.
|
||||
Regarding *Active Directory (AD)* configuration, the *Base* field must be the
|
||||
exact location where the bound user resides in AD.
|
||||
|
||||
Example: ``ou=organizational_unit,dc=example,dc=org``
|
||||
|
||||
Authentication
|
||||
==============
|
||||
|
||||
Here can be configured the property in LDAP nodes where should be found the
|
||||
given username. The property *UserId* must be filled with the name of the
|
||||
Here, you can configure the property in LDAP nodes where the given username
|
||||
should be found. The property *UserId* must be filled with the name of the
|
||||
property where the username is stored in LDAP.
|
||||
|
||||
The checkbox *Save passwords in database* when it is checked, means that the
|
||||
password is stored also in LibrePlan database. In this way, if LDAP is offline
|
||||
or unreachable, LDAP users could authenticate against LibrePlan database. If it
|
||||
is not checked, LDAP users can only be authenticated against LDAP.
|
||||
The checkbox *Save passwords in database*, when checked, means that the
|
||||
password is also stored in the LibrePlan database. In this way, if LDAP is
|
||||
offline or unreachable, LDAP users can authenticate against the LibrePlan
|
||||
database. If it is not checked, LDAP users can only be authenticated against
|
||||
LDAP.
|
||||
|
||||
Authorization
|
||||
=============
|
||||
|
||||
This section allows to define an strategy for matching LDAP roles with
|
||||
LibrePlan roles. In fact, the first choice is the strategy to use, depending on
|
||||
This section allows you to define a strategy for matching LDAP roles with
|
||||
LibrePlan roles. The first choice is the strategy to use, depending on the
|
||||
LDAP implementation.
|
||||
|
||||
Group strategy
|
||||
Group Strategy
|
||||
--------------
|
||||
|
||||
When this strategy is used, it means that LDAP has a role-group strategy. It
|
||||
means that users in LDAP are nodes that hang directly from a branch which
|
||||
When this strategy is used, it indicates that LDAP has a role-group strategy.
|
||||
This means that users in LDAP are nodes that are directly under a branch that
|
||||
represents the group.
|
||||
|
||||
The next example represents a valid LDAP structure to use group strategy.
|
||||
The next example represents a valid LDAP structure for using the group strategy.
|
||||
|
||||
* LDAP structure::
|
||||
|
||||
|
|
@ -86,7 +87,7 @@ The next example represents a valid LDAP structure to use group strategy.
|
|||
|- uid=worker2
|
||||
|- uid=worker3
|
||||
|
||||
In this case, each group will have an attribute, for example called ``member``,
|
||||
In this case, each group will have an attribute, for example, called ``member``,
|
||||
with the list of users belonging to the group:
|
||||
|
||||
* ``cn=admins``:
|
||||
|
|
@ -105,14 +106,14 @@ with the list of users belonging to the group:
|
|||
* ``member: uid=worker2,ou=people,dc=example,dc=org``
|
||||
* ``member: uid=worker3,ou=people,dc=example,dc=org``
|
||||
|
||||
The configuration for this case is the following:
|
||||
The configuration for this case is as follows:
|
||||
|
||||
* Role search strategy: ``Group strategy``
|
||||
* Group path: ``ou=groups``
|
||||
* Role property: ``member``
|
||||
* Role search query: ``uid=[USER_ID],ou=people,dc=example,dc=org``
|
||||
|
||||
And for example if you want to match some roles:
|
||||
And, for example, if you want to match some roles:
|
||||
|
||||
* Administration: ``cn=admins;cn=itpeople``
|
||||
* Web service reader: ``cn=itpeople``
|
||||
|
|
@ -121,15 +122,15 @@ And for example if you want to match some roles:
|
|||
* All projects edition allowed: ``cn=admins``
|
||||
* Project creation allowed: ``cn=workers``
|
||||
|
||||
Property strategy
|
||||
Property Strategy
|
||||
-----------------
|
||||
|
||||
When administrator decides to use this strategy, it means that each user is a
|
||||
LDAP node and in the node exists a property that represents the group(s) for
|
||||
the user. In this case, the configuration does not need the parameter *Group
|
||||
path*:
|
||||
When an administrator decides to use this strategy, it indicates that each user
|
||||
is an LDAP node, and within the node, there exists a property that represents
|
||||
the group(s) for the user. In this case, the configuration does not require the
|
||||
*Group path* parameter.
|
||||
|
||||
The next example represents a valid LDAP structure to use property strategy.
|
||||
The next example represents a valid LDAP structure for using the property strategy.
|
||||
|
||||
* LDAP structure::
|
||||
|
||||
|
|
@ -142,10 +143,10 @@ The next example represents a valid LDAP structure to use property strategy.
|
|||
|- uid=worker2
|
||||
|- uid=worker3
|
||||
|
||||
**With attribute**
|
||||
**With Attribute**
|
||||
|
||||
In this case, each user will have attribute, for example called ``group`` with
|
||||
the name of the group to which it belongs:
|
||||
In this case, each user will have an attribute, for example, called ``group``,
|
||||
with the name of the group to which they belong:
|
||||
|
||||
* ``uid=admin1``:
|
||||
|
||||
|
|
@ -174,16 +175,16 @@ the name of the group to which it belongs:
|
|||
|
||||
.. WARNING::
|
||||
|
||||
This strategy has a restriction, each user can belong only to one group.
|
||||
This strategy has a restriction: each user can belong to only one group.
|
||||
|
||||
The configuration for this case is the following:
|
||||
The configuration for this case is as follows:
|
||||
|
||||
* Role search strategy: ``Property strategy``
|
||||
* Group path:
|
||||
* Role property: ``group``
|
||||
* Role search query: ``[USER_ID]``
|
||||
|
||||
And for example if you want to match some roles:
|
||||
And, for example, if you want to match some roles:
|
||||
|
||||
* Administration: ``admins;itpeople``
|
||||
* Web service reader: ``itpeople``
|
||||
|
|
@ -192,22 +193,22 @@ And for example if you want to match some roles:
|
|||
* All projects edition allowed: ``admins``
|
||||
* Project creation allowed: ``workers``
|
||||
|
||||
**By user identifier**
|
||||
**By User Identifier**
|
||||
|
||||
You can even have a workaround to specify LibrePlan roles directly to users,
|
||||
You can even use a workaround to specify LibrePlan roles directly to users
|
||||
without having an attribute in each LDAP user.
|
||||
|
||||
In this case, you will specify which users have the different LibrePlan roles
|
||||
by ``uid``.
|
||||
|
||||
The configuration for this case is the following:
|
||||
The configuration for this case is as follows:
|
||||
|
||||
* Role search strategy: ``Property strategy``
|
||||
* Group path:
|
||||
* Role property: ``uid``
|
||||
* Role search query: ``[USER_ID]``
|
||||
|
||||
And for example if you want to match some roles:
|
||||
And, for example, if you want to match some roles:
|
||||
|
||||
* Administration: ``admin1;it1``
|
||||
* Web service reader: ``it1;it2``
|
||||
|
|
@ -216,20 +217,20 @@ And for example if you want to match some roles:
|
|||
* All projects edition allowed: ``admin1``
|
||||
* Project creation allowed: ``worker1;worker2;worker3``
|
||||
|
||||
Role matching
|
||||
Role Matching
|
||||
-------------
|
||||
|
||||
At the bottom of this section there is a table with all the LibrePlan roles and
|
||||
a text field next to each one. This is for matching roles. For instance, if
|
||||
administrator decides that *Administration* LibrePlan role matches with *admin*
|
||||
and *administrators* roles of LDAP, in the text field should appear:
|
||||
At the bottom of this section, there is a table with all the LibrePlan roles
|
||||
and a text field next to each one. This is for matching roles. For instance,
|
||||
if an administrator decides that the *Administration* LibrePlan role matches
|
||||
the *admin* and *administrators* roles of LDAP, the text field should contain:
|
||||
"``admin;administrators``". The character for splitting roles is "``;``".
|
||||
|
||||
.. NOTE::
|
||||
|
||||
If you want to specify that all users or all groups have one permission you
|
||||
can use an asterisk (``*``) as wildcard to refer to them. For example, if you
|
||||
want that everybody has the role *Project creation allowed* you will
|
||||
If you want to specify that all users or all groups have one permission, you
|
||||
can use an asterisk (``*``) as a wildcard to refer to them. For example, if
|
||||
you want everyone to have the *Project creation allowed* role, you will
|
||||
configure the role matching as follows:
|
||||
|
||||
* Project creation allowed: ``*``
|
||||
|
|
|
|||
|
|
@ -1,164 +1,116 @@
|
|||
Project dashboard
|
||||
Project Dashboard
|
||||
#################
|
||||
|
||||
.. contents::
|
||||
|
||||
The project dashboard is a *LibrePlan* perspective which contains a set of **KPI (Key Performance Indicators)**
|
||||
which help to know how is performing a project according to:
|
||||
The project dashboard is a *LibrePlan* perspective that contains a set of **KPIs (Key Performance Indicators)** to help assess a project's performance in terms of:
|
||||
|
||||
* how the work is progressing
|
||||
* how much is costing
|
||||
* the status of the resources allocated
|
||||
* the time constraints
|
||||
* Work progress
|
||||
* Cost
|
||||
* Status of allocated resources
|
||||
* Time constraints
|
||||
|
||||
Progress performance indicators
|
||||
Progress Performance Indicators
|
||||
===============================
|
||||
|
||||
There are two indicators calculated: project progress percentage and task
|
||||
status.
|
||||
Two indicators are calculated: project progress percentage and task status.
|
||||
|
||||
Project progress percentage
|
||||
Project Progress Percentage
|
||||
---------------------------
|
||||
|
||||
It is a chart where the global progress of a project is calculated and compared to
|
||||
the expected value of progress the project should have according to the *Gantt*.
|
||||
This chart displays the overall progress of a project, comparing it to the expected progress based on the *Gantt* chart.
|
||||
|
||||
The progress is represented with two bars:
|
||||
Progress is represented by two bars:
|
||||
|
||||
* *Current progress*. It is the progress existing at the moment according to
|
||||
the measurements done.
|
||||
* *Expected progress*. It is the progress the project should have at the
|
||||
moment according to the planning created.
|
||||
* *Current Progress:* The current progress based on the measurements taken.
|
||||
* *Expected Progress:* The progress the project should have achieved at this point, according to the project plan.
|
||||
|
||||
To view each bar's actual measured valued hover the mouse cursor over the bar.
|
||||
To view the actual measured value for each bar, hover the mouse cursor over the bar.
|
||||
|
||||
The project global progress is estimated in several different ways as there
|
||||
is not a unique right method to do it:
|
||||
The overall project progress is estimated using several different methods, as there is no single, universally correct approach:
|
||||
|
||||
* **Spreading progress**. It is the progress type set as spreading progress
|
||||
at project level. In this case, there is not way to calculate an expected
|
||||
value and only the current bar is displayed.
|
||||
* **By all tasks hours**. The progress of all project tasks is averaged to
|
||||
calculate the global value. It is a weighted average taking into account
|
||||
the number of hours allocated at each task.
|
||||
* **By critical path hours**. The progress of the tasks belonging to any of
|
||||
the critical paths of the project is averaged to obtain the global value.
|
||||
It is done a weighted average taking into account the total allocated hours
|
||||
of each of the involved tasks.
|
||||
* **By critical path duration**. The progress of the tasks belonging to any of
|
||||
the critical paths is averaged by doing a weighted average but this time taking
|
||||
into account the duration of each involved task instead of the assigned
|
||||
hours.
|
||||
* **Spreading Progress:** This is the progress type set as the spreading progress at the project level. In this case, there is no way to calculate an expected value, and only the current bar is displayed.
|
||||
* **By All Task Hours:** The progress of all project tasks is averaged to calculate the overall value. This is a weighted average that considers the number of hours allocated to each task.
|
||||
* **By Critical Path Hours:** The progress of tasks belonging to any of the project's critical paths is averaged to obtain the overall value. This is a weighted average that considers the total allocated hours for each involved task.
|
||||
* **By Critical Path Duration:** The progress of tasks belonging to any of the critical paths is averaged using a weighted average, but this time considering the duration of each involved task instead of the assigned hours.
|
||||
|
||||
Task status
|
||||
Task Status
|
||||
-----------
|
||||
|
||||
A pie chart showing the percentage of the project tasks being at different
|
||||
states. The defined states are the next ones:
|
||||
A pie chart shows the percentage of project tasks in different states. The defined states are:
|
||||
|
||||
* **Finished**. They are the completed tasks, detected by a 100% progress value measured.
|
||||
* **In progress**. They are the tasks which are underway. They have a
|
||||
progress value distinct from 0% and 100% or some worked time tracked.
|
||||
* **Ready to start**. They have a progress of 0%, do not have time tracked, all their *FINISH_TO_START* dependent tasks are *finished*
|
||||
and all their *START_TO_START* dependent tasks are *finished* or *in progress*.
|
||||
* **Blocked**. These are the tasks with a 0% of progress, without time
|
||||
tracked and with previous dependent tasks neither *in progress* not in *ready to start* state.
|
||||
* **Finished:** Completed tasks, identified by a 100% progress value.
|
||||
* **In Progress:** Tasks that are currently underway. These tasks have a progress value other than 0% or 100%, or some work time has been tracked.
|
||||
* **Ready to Start:** Tasks with 0% progress, no tracked time, all their *FINISH_TO_START* dependent tasks are *finished*, and all their *START_TO_START* dependent tasks are *finished* or *in progress*.
|
||||
* **Blocked:** Tasks with 0% progress, no tracked time, and with previous dependent tasks that are neither *in progress* nor in the *ready to start* state.
|
||||
|
||||
Cost indicators
|
||||
Cost Indicators
|
||||
===============
|
||||
|
||||
There are several *Earned Value Management* cost indicators calculated:
|
||||
Several *Earned Value Management* cost indicators are calculated:
|
||||
|
||||
* **CV (Cost Variance)**. Difference between the *Earned Value curve* and the
|
||||
*Actual Cost curve* at the moment. Positive values indicate benefit and
|
||||
negative ones loss.
|
||||
* **ACWP (Actual Cost Work Performed)**. It is the total number of hours tracked in the project at the
|
||||
moment.
|
||||
* **CPI (Cost Performance Index)**. It is the *Earned Value / Actual
|
||||
Cost* ratio.
|
||||
* **CV (Cost Variance):** The difference between the *Earned Value curve* and the *Actual Cost curve* at the current moment. Positive values indicate a benefit, and negative values indicate a loss.
|
||||
* **ACWP (Actual Cost of Work Performed):** The total number of hours tracked in the project at the current moment.
|
||||
* **CPI (Cost Performance Index):** The *Earned Value / Actual Cost* ratio.
|
||||
|
||||
* > 100 is good, means to be under budget.
|
||||
* = 100 is also good, means the cost is right on plan.
|
||||
* < 100 is bad, means that the cost of completing the work is higher than
|
||||
planned.
|
||||
* **ETC (Estimate To Complete)**. It is the time that is pending to devote
|
||||
to the project to finish it.
|
||||
* **BAC (Budget At Completion)**. It is the total amount of work allocated
|
||||
in the project plan.
|
||||
* **EAC (Estimate At Completion)**. It is the manager projection of the total
|
||||
cost at project completion time according to the *CPI*.
|
||||
* **VAC (Variance At Completion)**. It is the difference between the *BAC*
|
||||
and the *ETC*.
|
||||
* > 100 is favorable, indicating that the project is under budget.
|
||||
* = 100 is also favorable, indicating that the cost is right on plan.
|
||||
* < 100 is unfavorable, indicating that the cost of completing the work is higher than planned.
|
||||
* **ETC (Estimate To Complete):** The time remaining to complete the project.
|
||||
* **BAC (Budget At Completion):** The total amount of work allocated in the project plan.
|
||||
* **EAC (Estimate At Completion):** The manager's projection of the total cost at project completion, based on the *CPI*.
|
||||
* **VAC (Variance At Completion):** The difference between the *BAC* and the *EAC*.
|
||||
|
||||
* < 0 is over budget.
|
||||
* > 0 is under budget.
|
||||
* < 0 indicates that the project is over budget.
|
||||
* > 0 indicates that the project is under budget.
|
||||
|
||||
Resources
|
||||
=========
|
||||
|
||||
To analyze the project from resources' point of view two ratios and a histogram
|
||||
are provided.
|
||||
To analyze the project from the resources' point of view, two ratios and a histogram are provided.
|
||||
|
||||
Estimation deviation on completed task histogram
|
||||
Estimation Deviation on Completed Task Histogram
|
||||
------------------------------------------------
|
||||
|
||||
It is calculated the deviation between the number of hours allocated to the
|
||||
project tasks and the eventual number of hours dedicated to them.
|
||||
This histogram calculates the deviation between the number of hours allocated to the project tasks and the actual number of hours dedicated to them.
|
||||
|
||||
The deviation is calculated in percentage for all the finished tasks and the
|
||||
calculated deviations are represented in a histogram. In the vertical axis the number of tasks which are in an
|
||||
interval of deviation is shown. Six deviation intervals are dynamically calculated.
|
||||
The deviation is calculated as a percentage for all finished tasks, and the calculated deviations are represented in a histogram. The vertical axis shows the number of tasks within each deviation interval. Six deviation intervals are dynamically calculated.
|
||||
|
||||
Overtime ratio
|
||||
Overtime Ratio
|
||||
--------------
|
||||
|
||||
It sums up the overload of the resources that are allocated in the project tasks.
|
||||
It is calculated according to the formula: **overtime ratio = overload / (load +
|
||||
overload)**.
|
||||
This ratio summarizes the overload of resources allocated to the project tasks. It is calculated using the formula: **overtime ratio = overload / (load + overload)**.
|
||||
|
||||
* = 0 is good, meaning that the resources are not overloaded.
|
||||
* > 0 is bad, meaning that the resources are overloaded.
|
||||
* = 0 is favorable, indicating that the resources are not overloaded.
|
||||
* > 0 is unfavorable, indicating that the resources are overloaded.
|
||||
|
||||
Availability ratio
|
||||
Availability Ratio
|
||||
------------------
|
||||
|
||||
It sums up the capacity that is free in the resources currently allocated to the
|
||||
project. Therefore it is a measurement of the resource availability to receive more allocations without
|
||||
being overloaded. It is calculated as: **availability ratio = (1 - load/capacity)*100**
|
||||
This ratio summarizes the free capacity of the resources currently allocated to the project. Therefore, it measures the resources' availability to receive more allocations without being overloaded. It is calculated as: **availability ratio = (1 - load/capacity) * 100**
|
||||
|
||||
* Possible values are between 0% (fully assigned) and 100 (not assigned).
|
||||
* Possible values are between 0% (fully assigned) and 100% (not assigned).
|
||||
|
||||
Time
|
||||
====
|
||||
|
||||
They are included two charts: a histogram for the time deviation in the finish
|
||||
time of project tasks and a pie chart for the deadline violations.
|
||||
Two charts are included: a histogram for the time deviation in the finish time of project tasks and a pie chart for deadline violations.
|
||||
|
||||
Task completion lead or lag
|
||||
Task Completion Lead or Lag
|
||||
---------------------------
|
||||
|
||||
It is calculated the difference in days between the planned end time for the project
|
||||
tasks and their actual end time. The planned completion date is got from the
|
||||
*Gantt* and the actual finish date is got from the last time tracked at the task.
|
||||
This calculation determines the difference in days between the planned end time for project tasks and their actual end time. The planned completion date is taken from the *Gantt* chart, and the actual finish date is taken from the last time tracked for the task.
|
||||
|
||||
The lag or lead in task completion is represented in a histogram. In the
|
||||
vertical axis the number of tasks with a lead/lag day difference value
|
||||
corresponding to the abscissa days interval is represented. Six
|
||||
dynamic task completion deviation intervals are calculated.
|
||||
The lag or lead in task completion is represented in a histogram. The vertical axis shows the number of tasks with a lead/lag day difference value corresponding to the abscissa days interval. Six dynamic task completion deviation intervals are calculated.
|
||||
|
||||
* Negative values mean finishing ahead of time.
|
||||
* Positive values mean finishing with a delay.
|
||||
* Negative values mean finishing ahead of schedule.
|
||||
* Positive values mean finishing behind schedule.
|
||||
|
||||
Deadline violations
|
||||
Deadline Violations
|
||||
-------------------
|
||||
|
||||
On one hand it is calculated the margin with the project deadline, if set. On the other hand a pie chart with
|
||||
the percentage of tasks hitting their deadline is painted. Three types of values
|
||||
are included in the chart:
|
||||
|
||||
* Percentage of task without deadline configured.
|
||||
* Percentage of ended tasks with an actual end date later than their
|
||||
deadline. The actual end date is got from the last time tracked in the
|
||||
task.
|
||||
* Percentage of ended tasks with an actual end date sooner than their
|
||||
This section calculates the margin with the project deadline, if set. Additionally, a pie chart shows the percentage of tasks meeting their deadline. Three types of values are included in the chart:
|
||||
|
||||
* Percentage of tasks without a deadline configured.
|
||||
* Percentage of ended tasks with an actual end date later than their deadline. The actual end date is taken from the last time tracked for the task.
|
||||
* Percentage of ended tasks with an actual end date earlier than their deadline.
|
||||
|
|
|
|||
|
|
@ -1,24 +1,22 @@
|
|||
Pipeline planning dashboard
|
||||
###############################
|
||||
Pipeline Dashboard
|
||||
##################
|
||||
|
||||
.. contents::
|
||||
|
||||
The pipeline planning dashboard is a *LibrePlan* perspective which lists the names of all company projects in a table.
|
||||
This 'pipeline' table has nine columns each corresponding to a project status:
|
||||
The pipeline dashboard is a *LibrePlan* perspective that lists all company projects in a table. This "pipeline" table has nine columns, each corresponding to a project status:
|
||||
|
||||
* PRE-SALES
|
||||
* OFFERED
|
||||
* OUTSOURCED
|
||||
* ACCEPTED
|
||||
* STARTED
|
||||
* ON HOLD
|
||||
* FINISHED
|
||||
* CANCELLED
|
||||
* ARCHIVED
|
||||
* PRE-SALES
|
||||
* OFFERED
|
||||
* OUTSOURCED
|
||||
* ACCEPTED
|
||||
* STARTED
|
||||
* ON HOLD
|
||||
* FINISHED
|
||||
* CANCELLED
|
||||
* ARCHIVED
|
||||
|
||||
Projects are listed by name in each column based on their current status.
|
||||
|
||||
A project's start date, end date, and current progress can be viewed in a 'tool tip' popup by hovering the mouse pointer
|
||||
over a project's name.
|
||||
A project's start date, end date, and current progress can be viewed in a tooltip popup by hovering the mouse cursor over a project's name.
|
||||
|
||||
Projects with an *ARCHIVED* status can be hidden by unchecking the 'Show archived column data' checkbox.
|
||||
Projects with an *ARCHIVED* status can be hidden by unchecking the "Show archived column data" checkbox.
|
||||
|
|
|
|||
|
|
@ -4,16 +4,15 @@ Dashboards
|
|||
.. _informes:
|
||||
.. contents::
|
||||
|
||||
*LibrePlan* offers dashboard views for projects, providing an overview of their current status.
|
||||
|
||||
"LibrePlan" has dashboard views for projects that provide an overview of the current state of projects.
|
||||
|
||||
The two dashboard views are:
|
||||
The two available dashboard views are:
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="17-1-project-dashboard.html">Individual project dashboard</a>
|
||||
<a href="17-1-project-dashboard.html">Individual Project Dashboard</a>
|
||||
</li><li>
|
||||
<a href="17-2-pipeline-dashboard.html">All projects pipeline dashboard</a>
|
||||
<a href="17-2-pipeline-dashboard.html">All Projects Pipeline Dashboard</a>
|
||||
</ul>
|
||||
|
|
|
|||
|
|
@ -3,274 +3,230 @@ Connectors
|
|||
|
||||
.. contents::
|
||||
|
||||
Connectors are Libreplan client applications that could be used to communicate with (web) servers to get
|
||||
data, process and store them. At this moment there are three connectors, JIRA connector, Tim Enterprise Connector and E-mail Connector.
|
||||
Connectors are *LibrePlan* client applications that can be used to communicate with (web) servers to retrieve data, process it, and store it. Currently, there are three connectors: the JIRA connector, the Tim Enterprise connector, and the E-mail connector.
|
||||
|
||||
Configuration
|
||||
=============
|
||||
Connectors should be configured properly before being used. They can be configured from configuration's ``Main Setting``
|
||||
screen, the tab ``Connectors``.
|
||||
|
||||
The connector screen comprises:
|
||||
Connectors must be configured properly before they can be used. They can be configured from the "Main Settings" screen under the "Connectors" tab.
|
||||
|
||||
* ``Pull-down list``: a list of available connectors
|
||||
* ``Properties edit screen``: a property ``edit form`` for the selected connector
|
||||
* ``Test connection button``: to test the connection with the connectors
|
||||
|
||||
Select the connector you would like to configure from the ``pull-down`` list of connectors. A ``property editor form``
|
||||
for the selected connector will be shown. In the ``property editor form`` you can change the values of the properties
|
||||
to your likes and test your configurations using the ``Test connection`` button.
|
||||
The connector screen includes:
|
||||
|
||||
* **Pull-down list:** A list of available connectors.
|
||||
* **Properties edit screen:** A property edit form for the selected connector.
|
||||
* **Test connection button:** A button to test the connection with the connector.
|
||||
|
||||
Select the connector you want to configure from the pull-down list of connectors. A property editor form for the selected connector will be displayed. In the property editor form, you can change the property values as needed and test your configurations using the "Test connection" button.
|
||||
|
||||
.. NOTE::
|
||||
The properties are configured with default values. The most important one is the property ``Activated``. By
|
||||
default it is set to ``N``. This indicates that the connector would not be used unless you change the value to ``Y``
|
||||
and save the changes.
|
||||
|
||||
JIRA connector
|
||||
The properties are configured with default values. The most important property is "Activated." By default, it is set to "N." This indicates that the connector will not be used unless you change the value to "Y" and save the changes.
|
||||
|
||||
JIRA Connector
|
||||
==============
|
||||
|
||||
|
||||
JIRA is an issue and project tracking system.
|
||||
|
||||
JIRA connector is an application that can be used to request JIRA web server for JIRA issues and process the response.
|
||||
The request is based on ``JIRA labels``. In JIRA, labels can be used to categorize issues.
|
||||
So the request is simple like this: get all issues that are categorized by this ``label-name``.
|
||||
The JIRA connector is an application that can be used to request JIRA web server data for JIRA issues and process the response. The request is based on JIRA labels. In JIRA, labels can be used to categorize issues. The request is structured as follows: retrieve all issues that are categorized by this label name.
|
||||
|
||||
The connector gets the response, in this case the issues and convert them to Libreplan's ``Order elements`` and ``Time sheets``.
|
||||
The connector receives the response, which in this case is the issues, and converts them to *LibrePlan* "Order elements" and "Time sheets."
|
||||
|
||||
The *JIRA connector* should be configured properly before being used.
|
||||
The *JIRA connector* must be configured properly before it can be used.
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
|
||||
From the configuration's ``Main Setting screen`` choose the tab ``Connectors``.
|
||||
In the connectors screen select the JIRA connector from the ``pull-down`` list. A ``property editor screen``
|
||||
is displayed now.
|
||||
From the "Main Settings" screen, choose the "Connectors" tab. In the connectors screen, select the JIRA connector from the pull-down list. A property editor screen will then be displayed.
|
||||
|
||||
In this screen you can configure the following property values:
|
||||
In this screen, you can configure the following property values:
|
||||
|
||||
* ``Activated``: Y/N, whether you want to use the JIRA connector or not. Default is ``N``.
|
||||
* ``Server URL``: the absolute path to the JIRA web server.
|
||||
* ``user name and password``: the user credentials for authorization
|
||||
* ``JIRA labels: comma-separated list of labels or URL``: Either you enter the label URL or a comma separated labels.
|
||||
* ``Hours type``: type of work hours. Default is ``Default``
|
||||
* **Activated:** Y/N, indicating whether you want to use the JIRA connector. The default is "N."
|
||||
* **Server URL:** The absolute path to the JIRA web server.
|
||||
* **User name and password:** The user credentials for authorization.
|
||||
* **JIRA labels: comma-separated list of labels or URL:** You can either enter the label URL or a comma-separated list of labels.
|
||||
* **Hours type:** The type of work hours. The default is "Default."
|
||||
|
||||
.. NOTE::
|
||||
JIRA labels: At this moment JIRA web server doesn't support to provide a list of all available labels. As work around
|
||||
we have being developed a simple PHP script that does a simple SQL query in JIRA database to fetch all distinct labels.
|
||||
You can either use this PHP script as ``JIRA labels url`` or enter the labels you want as comma separated texts
|
||||
in the field of JIRA labels.
|
||||
|
||||
Finally click the ``Test connection`` button to test if you are able to connect to JIRA web server and that
|
||||
your configurations are right.
|
||||
**JIRA labels:** Currently, the JIRA web server does not support providing a list of all available labels. As a workaround, we have developed a simple PHP script that performs a simple SQL query in the JIRA database to fetch all distinct labels. You can either use this PHP script as the "JIRA labels URL" or enter the labels you want as comma-separated text in the "JIRA labels" field.
|
||||
|
||||
Finally, click the "Test connection" button to test if you can connect to the JIRA web server and that your configurations are correct.
|
||||
|
||||
Synchronization
|
||||
---------------
|
||||
From the project window ``General data`` you are able to start synchronizing order elements with JIRA issues.
|
||||
|
||||
Click the button ``Sync with JIRA`` to start the synchronization.
|
||||
From the project window, under "General data," you can start synchronizing order elements with JIRA issues.
|
||||
|
||||
* If it is for the first time a ``pop-up`` window(with auto completed list of labels) will be shown.
|
||||
In this window you can select a ``label`` to sync with and click the button ``Start sync`` to start the
|
||||
synchronization process, or click the ``Cancel`` button to cancel it.
|
||||
Click the "Sync with JIRA" button to start the synchronization.
|
||||
|
||||
* If label is already synchronized, the ``last synchronized date`` and the ``label`` are displayed in the JIRA screen.
|
||||
In this case no ``pop-up`` window to select label will be shown. Instead synchronization process will be started directly
|
||||
for that displayed(already synchronized) label.
|
||||
* If this is the first time, a pop-up window (with an auto-completed list of labels) will be displayed. In this window, you can select a label to synchronize with and click the "Start sync" button to begin the synchronization process, or click the "Cancel" button to cancel it.
|
||||
|
||||
* If a label is already synchronized, the last synchronized date and the label will be displayed in the JIRA screen. In this case, no pop-up window to select a label will be displayed. Instead, the synchronization process will start directly for that displayed (already synchronized) label.
|
||||
|
||||
.. NOTE::
|
||||
The relation between ``Order`` and ``label`` is one-to-one. Only one ``label`` is allowed to sync with one ``Order``
|
||||
|
||||
The relationship between "Order" and "label" is one-to-one. Only one label can be synchronized with one "Order."
|
||||
|
||||
.. NOTE::
|
||||
On the successful (re)synchronization, the information would be written to the database and the JIRA screen would
|
||||
be updated with the last synchronized -``date`` and -``label``.
|
||||
|
||||
Upon successful (re)synchronization, the information will be written to the database, and the JIRA screen will be updated with the last synchronized date and label.
|
||||
|
||||
(Re)synchronization process is performed in two phases:
|
||||
(Re)synchronization is performed in two phases:
|
||||
|
||||
* phase-1: Synchronizing order elements including progress assignment and measurements.
|
||||
* phase-2: Synchronizing time sheets.
|
||||
* **Phase 1:** Synchronizing order elements, including progress assignment and measurements.
|
||||
* **Phase 2:** Synchronizing time sheets.
|
||||
|
||||
.. NOTE::
|
||||
if phase-1 fails, phase-2 will not be performed and no information will be written to the database.
|
||||
|
||||
If Phase 1 fails, Phase 2 will not be performed, and no information will be written to the database.
|
||||
|
||||
.. NOTE::
|
||||
The success or failure information would be displayed in pop-up window.
|
||||
|
||||
On successful completing of synchronization, the result would be displayed in ``Work Breakdown Structure(WBS tasks)`` tab of the
|
||||
``Project details`` screen. In this UI there are two changes from the standard ``WBS``:
|
||||
|
||||
* The ``Total task hours`` column is unmodifiable (read-only) as the synchronization is one way. Task hours can be only updated in
|
||||
in JIRA web server
|
||||
* The ``Code`` column shows the ``JIRA issue keys`` and as the same time they are ``Hyperlinks`` to the JIRA issues. Click the
|
||||
desired key if you want to go to the document of that key(JIRA issue)
|
||||
The success or failure information will be displayed in a pop-up window.
|
||||
|
||||
Upon successful completion of synchronization, the result will be displayed in the "Work Breakdown Structure (WBS tasks)" tab of the "Project details" screen. In this UI, there are two changes from the standard WBS:
|
||||
|
||||
* The "Total task hours" column is unmodifiable (read-only) because the synchronization is one-way. Task hours can only be updated in the JIRA web server.
|
||||
* The "Code" column displays the JIRA issue keys, and they are also hyperlinks to the JIRA issues. Click the desired key if you want to go to the document for that key (JIRA issue).
|
||||
|
||||
Scheduling
|
||||
----------
|
||||
Re-synchronization of JIRA issues can also take place through the scheduler. Go to ``Job scheduling`` screen.
|
||||
In that screen you can configure a JIRA ``job`` to do synchronization. The ``job`` searches for last synchronized
|
||||
``labels`` in the database and re-synchronize them accordingly. see also the scheduler Manual.
|
||||
|
||||
Tim Enterprise connector
|
||||
Re-synchronization of JIRA issues can also be performed through the scheduler. Go to the "Job scheduling" screen. In that screen, you can configure a JIRA job to perform synchronization. The job searches for the last synchronized labels in the database and re-synchronizes them accordingly. See also the Scheduler Manual.
|
||||
|
||||
Tim Enterprise Connector
|
||||
========================
|
||||
Tim Enterprise is a Dutch product from Aenova. It is a web based application for the administration
|
||||
of time spent on projects and tasks.
|
||||
|
||||
Tim connector is an application that can be used to communicate with Tim Enterprise server to:
|
||||
Tim Enterprise is a Dutch product from Aenova. It is a web-based application for the administration of time spent on projects and tasks.
|
||||
|
||||
* export all hours spent by worker(user) on a project that could be registered in Tim Enterprise.
|
||||
* import all rosters of the worker(user) in order to plan the resource effectively.
|
||||
|
||||
The *Tim connector* should be configured properly before being used.
|
||||
The Tim connector is an application that can be used to communicate with the Tim Enterprise server to:
|
||||
|
||||
* Export all hours spent by a worker (user) on a project that could be registered in Tim Enterprise.
|
||||
* Import all rosters of the worker (user) to plan the resource effectively.
|
||||
|
||||
The *Tim connector* must be configured properly before it can be used.
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
|
||||
From the configuration's ``Main Setting`` screen choose the tab ``Connectors``.
|
||||
In the connectors screen select the Tim connector from the ``pull-down`` list. A ``property editor screen``
|
||||
is displayed now.
|
||||
From the "Main Settings" screen, choose the "Connectors" tab. In the connectors screen, select the Tim connector from the pull-down list. A property editor screen will then be displayed.
|
||||
|
||||
In this screen you can configure the following property values:
|
||||
In this screen, you can configure the following property values:
|
||||
|
||||
* ``Activated``: Y/N, whether you want to use the Tim connector or not. Default is ``N``.
|
||||
* ``Server URL``: the absolute path to the Tim Enterprise server.
|
||||
* ``user name and password``: the user credentials for authorization
|
||||
* ``Number of days timesheet to Tim``: how many days back you want to export the times heets
|
||||
* ``Number of days roster from Tim``: how many days forward you want to import the rosters
|
||||
* ``Productivity factor``: Effective working hours in percentage. Default is ``100%``
|
||||
* ``Department IDs to import roster``: comma separated department IDs.
|
||||
* **Activated:** Y/N, indicating whether you want to use the Tim connector. The default is "N."
|
||||
* **Server URL:** The absolute path to the Tim Enterprise server.
|
||||
* **User name and password:** The user credentials for authorization.
|
||||
* **Number of days timesheet to Tim:** The number of days back you want to export the time sheets.
|
||||
* **Number of days roster from Tim:** The number of days forward you want to import the rosters.
|
||||
* **Productivity factor:** Effective working hours in percentage. The default is "100%."
|
||||
* **Department IDs to import roster:** Comma-separated department IDs.
|
||||
|
||||
Finally, click the "Test connection" button to test if you can connect to the Tim Enterprise server and that your configurations are correct.
|
||||
|
||||
Finally click the ``Test connection`` button to test if you are able to connect to
|
||||
Tim Enterprise server and that your configurations are right.
|
||||
|
||||
Export
|
||||
------
|
||||
From the project window ``General data`` you are able to start exporting time sheets to Tim Enterprise server.
|
||||
|
||||
Enter the ``Tim product code`` and click the button ``Exprot to Tim`` to start the Export.
|
||||
From the project window, under "General data," you can start exporting time sheets to the Tim Enterprise server.
|
||||
|
||||
Enter the "Tim product code" and click the "Export to Tim" button to start the export.
|
||||
|
||||
The Tim connector adds the following fields along with the product code:
|
||||
|
||||
* The Worker/user full name
|
||||
* The Date worked on a task by worker
|
||||
* The Effort, hours worked on task
|
||||
* and an option whether Tim Enterprise should update the registration or inserts a new one
|
||||
* The worker/user's full name.
|
||||
* The date the worker worked on a task.
|
||||
* The effort, or hours worked on the task.
|
||||
* An option indicating whether Tim Enterprise should update the registration or insert a new one.
|
||||
|
||||
The Tim Enterprise *response* contains only a list of ``record-IDs(integers)``. This is the difficult part to see what is
|
||||
go wrong as the response list contains only numbers not related to the request fields.
|
||||
The *Export* request(registration in Tim) assumed to be succeeded if all the list entries doesn't contain ``0`` values. Otherwise
|
||||
the *Export* request is failed for those entries which contains ``0`` values. So, you can't see here which
|
||||
request is failed as the list entries contains only the value ``0``. The only way to figure out this is to look at the log file
|
||||
in Tim Enterprise server.
|
||||
The Tim Enterprise response contains only a list of record IDs (integers). This makes it difficult to determine what went wrong, as the response list contains only numbers not related to the request fields. The export request (registration in Tim) is assumed to have succeeded if all the list entries do not contain "0" values. Otherwise, the export request has failed for those entries that contain "0" values. Therefore, you cannot see which request failed, as the list entries only contain the value "0." The only way to determine this is to examine the log file on the Tim Enterprise server.
|
||||
|
||||
.. NOTE::
|
||||
On the successful exporting, the information would be written to the database and the Tim screen would be updated
|
||||
with last exported -``date`` -``product code``.
|
||||
|
||||
Upon successful exporting, the information will be written to the database, and the Tim screen will be updated with the last exported date and product code.
|
||||
|
||||
.. NOTE::
|
||||
The success or failure information would be displayed in pop-up window.
|
||||
|
||||
Scheduling export
|
||||
------------------
|
||||
Export process can also take place through the scheduler. Go to ``Job Scheduling`` screen.
|
||||
In that screen you can configure a Tim Export ``job``. The ``job`` searches for last exported
|
||||
time sheets in the database and re-export them accordingly. See also the Scheduler manual.
|
||||
The success or failure information will be displayed in a pop-up window.
|
||||
|
||||
Scheduling Export
|
||||
-----------------
|
||||
|
||||
The export process can also be performed through the scheduler. Go to the "Job Scheduling" screen. In that screen, you can configure a Tim Export job. The job searches for the last exported time sheets in the database and re-exports them accordingly. See also the Scheduler manual.
|
||||
|
||||
Import
|
||||
------
|
||||
Importing of rosters works only with the help of the *Scheduler*. There is no user-interface designed for as
|
||||
no input is needed from the user.
|
||||
Go to ``Job scheduling`` screen and configure Tim Import ``job``. The ``job`` loops through all departments
|
||||
configured in *connectors property* and import all rosters for each department. See also the scheduler Manual.
|
||||
|
||||
For import, the Tim connector adds the following fields in the *request*:
|
||||
Importing rosters only works with the help of the scheduler. There is no user interface designed for this, as no input is needed from the user. Go to the "Job scheduling" screen and configure a Tim Import job. The job loops through all departments configured in the connector properties and imports all rosters for each department. See also the Scheduler Manual.
|
||||
|
||||
* Period: The period(date from - date to) you want import the roster. This can be provided as a filter criteria
|
||||
* Department: For which department you want to import the roster. Departments are configurable.
|
||||
* The fields you are interested in(like Person info, RosterCategory etc) that the Tim server should include in its response.
|
||||
For import, the Tim connector adds the following fields in the request:
|
||||
|
||||
The import *response* contains the following fields, which is enough to manage the ``exception days`` in Libreplan:
|
||||
* **Period:** The period (date from - date to) for which you want to import the roster. This can be provided as a filter criterion.
|
||||
* **Department:** The department for which you want to import the roster. Departments are configurable.
|
||||
* The fields you are interested in (like Person info, RosterCategory, etc.) that the Tim server should include in its response.
|
||||
|
||||
* Person info: name and network name
|
||||
* Department: The department the worker working in
|
||||
* Roster category: Information on the presence/absence(Aanwzig/afwezig) of the worker and the reason(Libreplan exception type)
|
||||
in case that the worker is absent
|
||||
* Date: The Date worker is present/absent
|
||||
* Time: The Start time of present/absent, for example 08:00
|
||||
* duration: Number of hours that the worker is present/absent
|
||||
|
||||
By converting the import *response* to Libreplan's ``Exception day`` the following translations takes into account:
|
||||
The import response contains the following fields, which are sufficient to manage the exception days in *LibrePlan*:
|
||||
|
||||
* If the roster category contains the name ``Vakantie`` it would be translated to ``RESOURCE HOLIDAY``
|
||||
* The Roster category, ``Feestdag`` would be translated to ``BANK HOLIDAY``
|
||||
* All the rest like ``Jus uren``, ``PLB uren`` etc should be added to the ``Calendar Exception Days`` manually
|
||||
|
||||
Moreover the import *response*, the roster is divided into two or three parts per day: For example roster-morning,
|
||||
roster-afternoon and roster-evening. But Libreplan allows only one ``Exception type`` per day. The Tim connector is then
|
||||
responsible for merging these parts as one ``exception type``. That is, the roster category with the highest ``duration`` is
|
||||
assumed to be a valid ``Exception type`` but the total duration is the sum of all durations of these category parts.
|
||||
* **Person info:** Name and network name.
|
||||
* **Department:** The department the worker is working in.
|
||||
* **Roster category:** Information on the presence/absence (Aanwzig/afwezig) of the worker and the reason (*LibrePlan* exception type) in case the worker is absent.
|
||||
* **Date:** The date the worker is present/absent.
|
||||
* **Time:** The start time of presence/absence, for example, 08:00.
|
||||
* **Duration:** The number of hours that the worker is present/absent.
|
||||
|
||||
Contrary to the Libreplan, in Tim Enterprise, the ``total duration`` in case that the worker is on holiday means the worker is
|
||||
not available for that ``total duration``. But in Libreplan if the worker is on holiday the total duration should be ``Zero``.
|
||||
The Tim connector also takes care of this translation.
|
||||
By converting the import response to *LibrePlan*'s "Exception day," the following translations are taken into account:
|
||||
|
||||
E-mail connector
|
||||
* If the roster category contains the name "Vakantie," it will be translated to "RESOURCE HOLIDAY."
|
||||
* The roster category "Feestdag" will be translated to "BANK HOLIDAY."
|
||||
* All the rest, like "Jus uren," "PLB uren," etc., should be added to the "Calendar Exception Days" manually.
|
||||
|
||||
Moreover, in the import response, the roster is divided into two or three parts per day: for example, roster-morning, roster-afternoon, and roster-evening. However, *LibrePlan* allows only one "Exception type" per day. The Tim connector is then responsible for merging these parts as one exception type. That is, the roster category with the highest duration is assumed to be a valid exception type, but the total duration is the sum of all durations of these category parts.
|
||||
|
||||
Contrary to *LibrePlan*, in Tim Enterprise, the total duration in case the worker is on holiday means the worker is not available for that total duration. However, in *LibrePlan*, if the worker is on holiday, the total duration should be zero. The Tim connector also handles this translation.
|
||||
|
||||
E-mail Connector
|
||||
================
|
||||
|
||||
|
||||
E-mail is a method of exchanging digital messages from an author to one or more recipients.
|
||||
|
||||
E-mail connector can be used to set Simple Main Transfer Protocol (SMTP) server connection properties.
|
||||
The E-mail connector can be used to set Simple Mail Transfer Protocol (SMTP) server connection properties.
|
||||
|
||||
The *E-mail connector* should be configured properly before being used.
|
||||
The *E-mail connector* must be configured properly before it can be used.
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
|
||||
From the configuration's ``Main Settings`` screen choose the tab ``Connectors``.
|
||||
In the connectors screen select the E-mail connector from the ``pull-down`` list. A ``property editor screen``
|
||||
is displayed now.
|
||||
From the "Main Settings" screen, choose the "Connectors" tab. In the connectors screen, select the E-mail connector from the pull-down list. A property editor screen will then be displayed.
|
||||
|
||||
In this screen you can configure the following property values:
|
||||
In this screen, you can configure the following property values:
|
||||
|
||||
* ``Activated``: Y/N, whether you want to use the E-mail connector or not. Default is ``N``.
|
||||
* ``Protocol``: type of SMTP protocol.
|
||||
* ``Host``: the absolute path to SMTP server.
|
||||
* ``Port``: port of SMTP server.
|
||||
* ``From address``: e-mail address of messages sender.
|
||||
* ``Username``: username for SMTP server.
|
||||
* ``Password``: password for SMTP server.
|
||||
* **Activated:** Y/N, indicating whether you want to use the E-mail connector. The default is "N."
|
||||
* **Protocol:** The type of SMTP protocol.
|
||||
* **Host:** The absolute path to the SMTP server.
|
||||
* **Port:** The port of the SMTP server.
|
||||
* **From address:** The e-mail address of the message sender.
|
||||
* **Username:** The username for the SMTP server.
|
||||
* **Password:** The password for the SMTP server.
|
||||
|
||||
Finally click the ``Test connection`` button to test if you are able to connect to
|
||||
SMTP server and that your configurations are right.
|
||||
Finally, click the "Test connection" button to test if you can connect to the SMTP server and that your configurations are correct.
|
||||
|
||||
Edit E-mail template
|
||||
Edit E-mail Template
|
||||
--------------------
|
||||
|
||||
From the project window ``Configuration`` and then ``Edit E-mail Templates`` you are able to modify E-mail templates of
|
||||
messages.
|
||||
From the project window, under "Configuration" and then "Edit E-mail Templates," you can modify the e-mail templates for messages.
|
||||
|
||||
You are able to choose:
|
||||
You can choose:
|
||||
|
||||
* Template language
|
||||
* Template type
|
||||
* E-mail subject
|
||||
* Template contents
|
||||
* **Template language:**
|
||||
* **Template type:**
|
||||
* **E-mail subject:**
|
||||
* **Template contents:**
|
||||
|
||||
You need to specify language because web application will send e-mail to user in language that user have chosen in
|
||||
preferences.
|
||||
You need to choose template type, type is user role, it means that this e-mail will be send only to users who are in\
|
||||
selected role (type).
|
||||
You need to set e-mail subject. Subject - a brief summary of the topic of the message.
|
||||
You need to set e-mail contents. Any information that you want to send to user. Also there are some keywords that you
|
||||
may use in message; web application will parse it and set a new value instead of keyword.
|
||||
You need to specify the language because the web application will send e-mails to users in the language they have chosen in their preferences. You need to choose the template type. The type is the user role, meaning that this e-mail will be sent only to users who are in the selected role (type). You need to set the e-mail subject. The subject is a brief summary of the topic of the message. You need to set the e-mail contents. This is any information that you want to send to the user. There are also some keywords that you may use in the message; the web application will parse them and set a new value instead of the keyword.
|
||||
|
||||
Scheduling e-mails
|
||||
Scheduling E-mails
|
||||
------------------
|
||||
|
||||
Sending e-mails process can take place only through the scheduler. Go to ``Configuration`` then ``Job Scheduling``
|
||||
screen.
|
||||
In that screen you can configure a e-mail sending ``job``. The ``job`` is taking a list of e-mail notifications,
|
||||
gathering data and sending it to user`s e-mail. See also the Scheduler manual.
|
||||
|
||||
Sending e-mails can only be performed through the scheduler. Go to "Configuration," then the "Job Scheduling" screen. In that screen, you can configure an e-mail sending job. The job takes a list of e-mail notifications, gathers data, and sends it to the user's e-mail. See also the Scheduler manual.
|
||||
|
||||
.. NOTE::
|
||||
The success or failure information would be displayed in pop-up window.
|
||||
|
||||
The success or failure information will be displayed in a pop-up window.
|
||||
|
|
|
|||
|
|
@ -3,84 +3,84 @@ Scheduler
|
|||
|
||||
.. contents::
|
||||
|
||||
The scheduler is designed to schedule Jobs dynamically. It is developed with the help of *Spring framework Quartz scheduler*.
|
||||
The scheduler is designed to schedule jobs dynamically. It is developed using the *Spring Framework Quartz scheduler*.
|
||||
|
||||
In order to use this scheduler effectively the Jobs(Quartz jobs) that should be scheduled must be created first. Then these
|
||||
jobs could be added to the database as all jobs to be scheduled is stored in the database.
|
||||
To use this scheduler effectively, the jobs (Quartz jobs) that should be scheduled must be created first. Then, these jobs can be added to the database, as all jobs to be scheduled are stored in the database.
|
||||
|
||||
When the scheduler first starts, it reads the jobs to be scheduled/unscheduled from the database and schedule/remove
|
||||
them accordingly. Afterwards jobs can be added/updated or removed dynamically using ``Job scheduling`` user interface.
|
||||
When the scheduler starts, it reads the jobs to be scheduled or unscheduled from the database and schedules or removes them accordingly. Afterward, jobs can be added, updated, or removed dynamically using the ``Job scheduling`` user interface.
|
||||
|
||||
.. NOTE::
|
||||
The scheduler starts when the Libreplan web application starts and stops when the application stops.
|
||||
The scheduler starts when the LibrePlan web application starts and stops when the application stops.
|
||||
|
||||
.. NOTE::
|
||||
this scheduler supports only ``cron expressions`` to schedule the jobs.
|
||||
This scheduler supports only ``cron expressions`` to schedule jobs.
|
||||
|
||||
The criteria that the scheduler uses to schedule or remove jobs when it starts are as follows:
|
||||
|
||||
The criteria that the scheduler uses to schedule/remove the jobs when it first starts:
|
||||
For all jobs:
|
||||
|
||||
* Schedule
|
||||
|
||||
* Job has a *Connector* and the *Connector* is activated and a Job is allowed to be scheduled
|
||||
* Job has no *Connector* and is allowed to be scheduled
|
||||
* Job has a *Connector*, and the *Connector* is activated, and the job is allowed to be scheduled.
|
||||
* Job has no *Connector* and is allowed to be scheduled.
|
||||
|
||||
* Remove
|
||||
|
||||
* Job has a *Connector* and the *Connector* is not activated
|
||||
* Job has a *Connector* and the *Connector* is activated but Job is not allowed to be scheduled
|
||||
* Job has no *Connector* and is not allowed to be scheduled
|
||||
* Job has a *Connector*, and the *Connector* is not activated.
|
||||
* Job has a *Connector*, and the *Connector* is activated, but the job is not allowed to be scheduled.
|
||||
* Job has no *Connector* and is not allowed to be scheduled.
|
||||
|
||||
.. NOTE::
|
||||
Jobs can not be re-scheduled/unscheduled if they are currently running
|
||||
|
||||
Job scheduling list view
|
||||
========================
|
||||
The ``job scheduling list`` view allows users to
|
||||
Jobs cannot be rescheduled or unscheduled if they are currently running.
|
||||
|
||||
* add a new Job
|
||||
* edit an existing Job
|
||||
* remove a Job
|
||||
* start a process manually
|
||||
Job Scheduling List View
|
||||
========================
|
||||
|
||||
The ``Job scheduling list`` view allows users to:
|
||||
|
||||
* Add a new job.
|
||||
* Edit an existing job.
|
||||
* Remove a job.
|
||||
* Start a process manually.
|
||||
|
||||
Add or Edit Job
|
||||
===============
|
||||
From the ``job scheduling list`` view, click
|
||||
|
||||
* ``Create`` button to add a new Job or
|
||||
* ``Edit`` button to modify the chosen Job.
|
||||
From the ``Job scheduling list`` view, click:
|
||||
|
||||
Both actions will lead you to a create/edit ``job form``. The ``form`` displayed the following properties:
|
||||
* ``Create`` to add a new job, or
|
||||
* ``Edit`` to modify the selected job.
|
||||
|
||||
* Fields:
|
||||
Both actions will open a create/edit ``job form``. The ``form`` displays the following properties:
|
||||
|
||||
* Job group: name of the job group
|
||||
* Job name: name of the job
|
||||
* Cron expression: read only field and an ``Edit`` button to open ``cron expression`` input window
|
||||
* Job class name: ``pull-down list`` to select your Job(an existing job)
|
||||
* Connector: ``pull-down list`` to select a connector. This is not mandatory
|
||||
* Schedule: check box whether you want to schedule this job or not
|
||||
* Fields:
|
||||
|
||||
* Buttons:
|
||||
* **Job group:** The name of the job group.
|
||||
* **Job name:** The name of the job.
|
||||
* **Cron expression:** A read-only field with an ``Edit`` button to open the ``cron expression`` input window.
|
||||
* **Job class name:** A ``pull-down list`` to select the job (an existing job).
|
||||
* **Connector:** A ``pull-down list`` to select a connector. This is not mandatory.
|
||||
* **Schedule:** A checkbox to indicate whether to schedule this job.
|
||||
|
||||
* Save: to save/update a Job both in database and in the scheduler. The user is then back to the ``Job scheduling list view``
|
||||
* Save and continue: the same as save above, only user is not back to the ``Job scheduling list view``
|
||||
* Cancel: nothing saved and user is back to ``Job scheduling list view``
|
||||
* Buttons:
|
||||
|
||||
* And a hint about cron expression syntax
|
||||
* **Save:** To save or update a job in both the database and the scheduler. The user is then returned to the ``Job scheduling list view``.
|
||||
* **Save and continue:** The same as "Save," but the user is not returned to the ``Job scheduling list view``.
|
||||
* **Cancel:** Nothing is saved, and the user is returned to the ``Job scheduling list view``.
|
||||
|
||||
Cron expression pop-up
|
||||
----------------------
|
||||
In order to enter the ``cron expression`` correctly a ``cron expression`` pop-up form is used. In this form you can enter
|
||||
the desired ``cron expression``. See also the hint about the ``cron expression``. In case you enter a wrong ``cron expression``,
|
||||
you will be directly notified that the ``cron expression`` you entered is illegal.
|
||||
* And a hint section about cron expression syntax.
|
||||
|
||||
Cron Expression Pop-up
|
||||
----------------------
|
||||
|
||||
To enter the ``cron expression`` correctly, a ``cron expression`` pop-up form is used. In this form, you can enter the desired ``cron expression``. See also the hint about the ``cron expression``. If you enter an invalid ``cron expression``, you will be notified immediately.
|
||||
|
||||
Remove Job
|
||||
==========
|
||||
Click the button ``Remove`` to delete the job both from the database and the scheduler. The success/failure info of this action
|
||||
will be shown.
|
||||
|
||||
Click the ``Remove`` button to delete the job from both the database and the scheduler. The success or failure of this action will be displayed.
|
||||
|
||||
Start Job Manually
|
||||
==================
|
||||
As an alternative to wait until the Job is run as scheduled by the scheduler, you can click this button to start the
|
||||
process directly. Afterwards the success/failure info will be shown in ``pop-up window``.
|
||||
|
||||
As an alternative to waiting for the job to run as scheduled, you can click this button to start the process directly. Afterward, the success or failure information will be displayed in a ``pop-up window``.
|
||||
|
|
|
|||
|
|
@ -8,25 +8,24 @@ About
|
|||
Copyright
|
||||
=========
|
||||
|
||||
Copyright (C) 2009-2010 Fundación para o Fomento da Calidade Industrial e
|
||||
Desenvolvemento Tecnolóxico de Galicia
|
||||
Copyright (C) 2014-2025 i2rs ; Coderial; Igalia, S.L.; Wireless Galicia, S.L.; CafédeRed Solutions, S.L.
|
||||
|
||||
Copyright (C) 2012 Igalia, S.L.; Wireless Galicia, S.L.; CafédeRed Solutions, S.L.
|
||||
|
||||
Copyright (C) 2011 Igalia, S.L.; Wireless Galicia, S.L.; ComtecSF, S.L.; CafédeRed Solutions, S.L.
|
||||
|
||||
Copyright (C) 2010 Igalia, S.L.; Wireless Galicia, S.L.
|
||||
|
||||
Copyright (C) 2011 Igalia, S.L.; Wireless Galicia, S.L.; ComtecSF, S.L.;
|
||||
CafédeRed Solutions, S.L.
|
||||
|
||||
Copyright (C) 2012 Igalia, S.L.; Wireless Galicia, S.L.; CafédeRed Solutions,
|
||||
S.L.
|
||||
Copyright (C) 2009-2010 Fundación para o Fomento da Calidade Industrial e Desenvolvemento Tecnolóxico de Galicia
|
||||
|
||||
|
||||
Licence
|
||||
License
|
||||
=======
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU Affero General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
at your option) any later version.
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
|
|
@ -43,16 +42,16 @@ Written by
|
|||
LibrePlan Team
|
||||
--------------
|
||||
|
||||
* Jeroen Baten <jeroen@libreplan-enterprise.com>
|
||||
* Jeroen Baten <jeroen@libreplan.dev>
|
||||
* Edwin Zuijdendorp <edwin@zuydendorp.nl>
|
||||
* Bjørn Vos <bjorn@libreplan-enterprise.com>
|
||||
* Philippe Poumaroux <philippe.poumaroux@free.fr>
|
||||
* Vova Perebykivskyi <vova@libreplan-enterprise.com>
|
||||
* Paul Luchyn <ddiamondbbackk@gmail.com>
|
||||
|
||||
Previous Team Members
|
||||
---------------------
|
||||
|
||||
* Vova Perebykivskyi <vova@libreplan-enterprise.com>
|
||||
* Bjørn Vos <bjorn@libreplan-enterprise.com>
|
||||
* Fernando Bellas Permuy <fbellas@udc.es>
|
||||
* José María Casanova Crespo <jmcasanova@igalia.com>
|
||||
* Óscar González Fernández <ogonzalez@igalia.com>
|
||||
|
|
@ -108,13 +107,14 @@ Contributors
|
|||
* Adrián Pérez <aperez@igalia.com>
|
||||
|
||||
|
||||
Public funding
|
||||
Public Funding
|
||||
==============
|
||||
|
||||
Inside the global scope that LibrePlan is designed for regarding planning management,
|
||||
a project was developed to solve some common planning problems.
|
||||
This project is partially financed by Xunta de Galicia, Ministerio de Industria, Turismo e Comercio, and by the European Union,
|
||||
Fondo Europeo de Desenvolvemento Rexional.
|
||||
This project currently accepts donations through the Open Collective organization <https://opencollective.com/LibrePlan>.
|
||||
|
||||
Within the global scope that LibrePlan is designed for regarding planning management, a project was developed to solve some common planning problems.
|
||||
|
||||
This project was partially financed by Xunta de Galicia, Ministerio de Industria, Turismo e Comercio, and by the European Union, Fondo Europeo de Desenvolvemento Rexional.
|
||||
|
||||
.. figure:: images/logos.png
|
||||
|
||||
|
|
|
|||
|
|
@ -1,9 +1,6 @@
|
|||
Subcontractor work description
|
||||
Subcontractor Work Description
|
||||
###############################
|
||||
|
||||
It is possible to keep this field empty.
|
||||
|
||||
But if you do, you could get errors in communication functionality when multiple empty fields exist.
|
||||
|
||||
We recommend to always use a unique work description.
|
||||
While it is possible to leave this field empty, doing so can lead to errors in communication functionality when multiple empty fields exist.
|
||||
|
||||
Therefore, we strongly recommend always using a unique work description.
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue