.. include:: ImageReplacement.txt

.. title:: Gantt charts

.. raw:: latex

    \newpage

.. _Gantt_chart:

Gantt charts
************

The Gantt chart is a tool used in scheduling and project management and allowing to visualize in time the various tasks composing a project.

It is a representation of a connected graph, evaluated and oriented, which makes it possible to graphically represent the progress of the project

This chapter offers many features that will be described in the next sections

.. index:: Gantt chart (Planning)

Planning
========

This screen allows to define projects planning and follow progress.

.. figure:: /images/GUI/GANTT_ZONE_Planning.png 
   :alt: Gantt (Planning)
   :align: center

   Gantt (Planning)

the Gantt Chart is composed of two main areas:

* :ref:`task-list-area` |one| 
* :ref:`gantt-chart-view` |two|

---------------------------------------------------

.. rubric:: |threeBLC| Activity planning calculation

Click on |calculatePlanning| to start the activity planning calculation.

See: :ref:`project-planning`

.. raw:: latex

    \newpage

.. note::

   * Any changes to an assignment (rate, resource name, number, dates, etc.) made from an activity are not displayed on the planning screen with the new recalculated mode. 
   * Click |calculatePlanning| to start the new planning calculation
   * The automatic schedule calculation only works when you are in the Gantt schedule view and you are editing an item from this screen.


.. rubric:: |fourBLC| Buttons

* Click on |iconEnableCalendar| to validate planning. See: :ref:`Planning validation<planning-validation>`
* Click on |storePlannedDates| to save baseline of planning. See: :ref:`Save Baseline<save-baseline>`
* Click on |buttonIconPrint| to get a printable version of the Gantt chart.
* Click on |buttonIconPdf| to export Gantt chart in PDF format. See: :ref:`export-Gantt-PDF`
* Click on |msProject| to export planning to MS-Project xml format.
* Click on |createNewItem| to create a new item. See: :ref:`Add a new planning element<add-new-planningelement>`
* Click on |buttonIconFilter| to filter the list. see the picture below. 
* Click on |buttonIconColumn| to define the columns that will be displayed. See: :ref:`progress-data-view`


.. figure:: /images/GUI/GANTT_BOX_AdvancedFilter.png
   :alt: Advanced filters
   :align: center

   Advanced filters of the Gantt chart

.. note:: 

   Filter the schedule: possibility to filter the activities to display on the Gantt Planning view
   
   The "parents" of the selected activities are also displayed to maintain the :term:`WBS` structure
    

.. warning:: 

   Check the box **save date** to keep registered displayed date of the overview planning, otherwise dates removing to general mode, after navigating away from this page.  

.. _display-baseline:

.. rubric:: |fiveBLC| Display Baseline

The baseline is a record of the planning state at a time T.

This option displays this line at the top and / or bottom of your current Gantt chart for comparison. 

Baseline can be saved with |storePlannedDates|.
  
  
.. note::

   * Ability to display two baselines on the Gantt chart.
   * You can recording only one baseline every day

.. rubric:: |sixBLC| Show Critical path

The critical path is used to determine the total duration of your project. 
The critical path of your project is the longest sequence of tasks that must be completed for the project to be completed by the due date.

* click on the **critical path** check box to calculate and display the red path in the Gantt schedule.

.. warning:: Project tasks that are not traversed by the critical path are elements that will not affect the duration of the project and, 
   even if modified, will not result in a modification of this duration on the entire project

.. figure:: /images/GUI/GANTT_ZONE_CriticalPath.png
   :alt: Critical Path
   :align: center
   
   The red net represents the critical path of the project. 

.. raw:: latex

    \newpage

.. _task-list-area:

Task list area
--------------

The task list area is composed with:

* :ref:`task-list` |one| 
* :ref:`progress-data-view` |two|

.. figure:: /images/GUI/GANTT_ZONE_PlanningDATAs.png
   :alt: Task list & progress data view
   :align: center

   Task list & progress data view

.. rubric:: |threeBLC| Area splitter

The splitter is used to show or hide the progress data view.

.. note:: 

   The progress data view is hidden by default.
   
   Move the splitter on your right to display them.



.. _task-list:

Task List
_________

The task list displays the planning elements in hierarchical form by dividing the :term:`WBS`.

Tasks are regrouped by projects and activities.

.. rubric:: Projects displayed

The projects displayed depend on the selection made with **the project selector** See: :ref:`top-bar`


.. figure:: /images/GUI/GANTT_ZONE_TaskList.png
   :alt: Task list & progress data view
   :align: center

   Task list & progress data view

.. rubric:: |oneBLC| and |twoBLC| Hide activities

Show or hide project activities

Click on |minusButton| or |plusButton|  

      * Click on the icons at the top of the list |one| to enlarge or reduce all groups of projects at the same time
      
      * Click on the group line |two| to enlarge or reduce the group only 
            
.. rubric:: |threeBLC| Icon of element

A specific icon appears to the left of each item type for faster identification.

* |iconProject16| Project
* |iconReplan16| project to recalculate (the Gant diagramm to display with the latest settings) 
* |iconActivity16| Activity
* |iconMilestone16| Milestone
* |iconMeeting16| Meeting
* |iconTestSession16| Test session

Other items can be displayed in the :ref:`gantt-planning` (action, decision, delivery...)

.. rubric:: |fourBLC| Show WBS

Click on "Show WBS" to display the :term:`WBS` number before the names.

.. figure:: /images/GUI/GANTT_ZONE_TaskWBS.PNG
   :alt: Task list with WBS display
   :align: center
      
   Task list without and with WBS Display

.. rubric:: |fiveBLC| Item name 

Click on a line to display the detail of the item in the detail area.

.. rubric:: |sixBLC| Checkbox "Show closed items"

Flag on "Show closed items" allows to list closed items.


.. raw:: latex

    \newpage


.. _progress-data-view:

Progress data view
__________________

The progress data view allows to show progress on project elements.
to display the progress columns, pull the splitter to the right.

For each planning element, the progress data are displayed at them right.


.. figure:: /images/GUI/GANTT_ZONE_ProjectDATAView.png
   :alt: Progress data view
   :align: center

   Progress data view

.. rubric:: |oneBLC| Group row

* The group row has a gray background.
* Used to display consolidated progress data by tasks.

.. rubric:: |twoBLC| Task row

* The task row has a white background.
* Used to display task progress data.

.. note:: **Create a new item**

   * Each new element |createNewItem| will be placed below the selected line in the "task" column after it is created.
   
   * If this item is "new project" and you have selected a line activity. The new element will automatically be a project subproject of the activity in question
   
   * If no line is selected, the new item will move to the end of the task list

.. rubric:: |threeBLC| Define the columns of progress data that will be displayed

* Click on |buttonIconColumn| to define the columns displayed.

* Use checkboxes to select or unselect columns to display.

* Use the |IconDragBLC| to reorder columns with drag & drop feature.
   
* Click on **OK** button to apply changes.
   

.. figure:: /images/GUI/GANTT_ZONE_SelectColumns.png
   :alt: Popup list - Select columns
   :align: center

   Popup list - Select columns

.. _gantt-chart-view:

Gantt chart view
----------------

The Gantt chart view is a graphical representation of the progress data of a project. 
For each planning element, a bar is associated with it

.. figure:: /images/GUI/GANTT_ZONE_ChartView1.png 
   :alt: Gantt chart view
   :align: center

   Gantt chart view

.. rubric:: |oneBLC| Scale

Scale available: daily, weekly, monthly and quarter

The Gantt chart view will be adjusted according to scale selected.

.. rubric:: |twoBLC| Display from... to... 

Change the start and / or end date to limit or extend the display of a Gantt Chart.

.. rubric:: |threeBLC| Saving dates and All the projet

Save your dates to retrieve them on every connection.

Check **"All the project"** for the gantt chart to show all project tasks when possible.

If the display is truncated because the project is too long, think to change the display scale.

.. _gantt-bars:

.. rubric:: |fourBLC| Gantt bars

The bars displayed in the gantt chart can appear with different colors. Each color has a meaning.

.. compound:: **LIGHTER BAR: no charge**

.. image:: /images/GUI/GANTT_BAR_PaleGreen.png 
   :alt: Without assigned work
   :align: left
   :height: 20px
   :width: 80 px


.. describe:: Condition
   Activities without assigned work
   pale red or pale green as appropriate

.. compound:: **GREEN BAR : all is well**

.. image:: /images/GUI/GANTT_BAR_Green.png 
   :alt: all is well
   :align: left
   :height: 20px
   :width: 80 px

.. describe:: **Condition**
   Assigned resources are available and meet workload, validated or scheduled dates do not conflict with other items.

.. compound:: **RED BAR : Overdue tasks**

.. image:: /images/GUI/GANTT_BAR_Red.png 
   :alt: Overdue tasks
   :align: left
   :height: 20px
   :width: 80 px

.. describe:: **Condition**
   Planned end date > Validated end date
   Real end date if completed task > Valited end date

.. compound:: **PURPLE BAR : impossible to calculate the remaining work** 

.. image:: /images/GUI/GANTT_BAR_Purple.png 
   :alt: Impossible to calculate
   :align: left
   :height: 20px
   :width: 80 px

.. describe:: **Condition**
   the remaining work on the task can't be planned.
   
.. note:: **example**

   When a resource is assigned to a task over a defined period of time, and the task requests a higher workload than the resource can provide,
   or if the resource is unavailable for the assigned task then the bar becomes purple.

.. compound:: **REAL WORK IN PROGRESS**

.. image:: /images/GUI/GANTT_BAR_GreenWork.png 
   :alt: Work in progress
   :align: left
   :height: 20px
   :width: 80 px

.. describe:: Condition
   The line appears in the bar when real work is filled   
   it shows the percentage of actual progress
   
.. note:: its length represents the percentage of completion based on the actual progress versus the length of the Gantt bar.

.. compound:: **CONSOLIDATION BAR**

    .. image:: /images/GUI/GANTT_BAR_Consolidation.png
       :alt: consolidation bar
       :align: left
       :height: 20 px
       :width: 160 px
 
.. describe:: Condition
   Graphic display of consolidated dates for planning elements group
     
.. note:: 

   **Displayed at group row level**
   
   Start with the smallest start date and end with the biggest end date, either with planned or real dates.


.. note:: 
   .. figure:: /images/GUI/GANTT_ZONE_DisplayDates.png 
      :alt: View the item name and scheduled dates on the selected bar
      :align: center
      
      item name and scheduled dates on the selected bar
      
   Move the cursor over the bar to display item name and planned dates.   

.. index: Dependency Links

.. _Gantt_DependencyLink_Milestone:

.. rubric:: |fiveBLC| Dependency links

* Dependencies between planning elements are displayed with an arrow.

* To modify dependency link, click on dependency to displays a pop-up

.. figure:: /images/GUI/GANTT_BOX_dependencies.png
   :alt: update dependency pop-up
   
   Dependencies dialog box

**3 dependency types are managed:**

|iconES| **End-Start:** The second activity can not start before the end of the first activity.

|iconSS| **Start-Start:** the successor can not begin before the beginning of the predecessor. Anyway, the successor can begin after the beginning of the predecessor.

|iconEE| **End-End:** The successor should not end after the end of the predecessor, which leads to planning "as late as possible". Anyway, the successor can end before the predecessor. Note that the successor "should" not end after the end of predecessor, but in some cases this will not be respected:

  * if the resource is already 100% used until the end of the successor
  * if the successor has another predecessor of type "End-Start" or "Start-Start" and the remaining time is not enough to complete the task
  * if the delay from the planning start date does not allow to complete the task
 
.. note:: **Update Pop-up**

     Right click on a dependency link (when its color is orange) will show update pop-up
     
     You can modify the delay, add a comment or remove the dependency.

.. note:: **Graphical add dependency**

     You can easily add a dependency with drag and drop from predecessor bar to successor bar
     
     These dependencies are always End-Start, but you can change their type afterwards


.. raw:: latex

    \newpage

.. rubric:: |sixBLC| Milestone

Milestones appear as small diamonds. Filled if completed, empty otherwise.

Color of  diamond depends on milestone progress.

.. compound:: **Ongoing milestone and in times**

   .. image:: /images/GUI/GANTT_ZONE_GreenMilestone.png
      :alt: ongoing milestone and in times

.. compound:: **Completed milestone and in times**

   .. image:: /images/GUI/GANTT_ZONE_FilledGreenMilestone.png
      :alt: completed milestone and in times

.. compound:: **Ongoing milestone and delayed**

Planned end date > Validate end date

.. image:: /images/GUI/GANTT_ZONE_RedMilestone.png
      :alt: ongoing milestone and delayed

.. compound:: **Completed milestone and delayed**

Real end date > Validated end date

.. image:: /images/GUI/GANTT_ZONE_FilledRedMilestone.png
      :alt: completed milestone and delayed


.. rubric:: |sevenBLC| Show resources 

Click on “Show resources” to display resources assigned to tasks.

.. figure:: /images/GUI/GANTT_ZONE_DisplayResource.png
   :alt: Show the ressources with initials or name
   :align: center
   
   Display with initials or with the complete name
   

.. topic:: 
   
   **Name or Initials**
   
   See :ref:`Global Parameters<gp_activity_planning>` 
   
   This parameter defines the option availability and whether the resource name or initial is displayed.
    
   
.. rubric:: |eightBLC| Current date

.. figure:: /images/GUI/GANTT_BAR_YellowBar.png
   :align: left
   :height: 40px
   
   Current date bar
   
Yellow column indicates the current day, week, month or quarter, according to scale selected.

The red line in yellow collumn display the current day and time.

.. rubric:: |nineBLC| Detail of the work

Right click on a bar to displays the detail of the work for this bar.

.. figure:: /images/GUI/GANTT_ZONE_Resources.png 
   :alt: Display details of the work
   :align: center
   
   Display details of the work

.. Warning:: 

   You have to selected week or day scale to display detail or a message will ask you to switch to smaller scale.

.. rubric:: |tenBLC| Miscellaneous

On "floating" elements (floating milestone, fixed duration activity) without predecessor, set the planned start date to the validated start date

.. raw:: latex

    \newpage

.. index:: Project planning

.. _project-planning:

Project planning
================

Project planning and activity planning calculation can be done in the Gantt.

.. figure:: /images/GUI/GANTT_ZONE_ProjectPlanning.png 
   :alt: Project planning
   :align: center

   Project planning 

.. _add-new-planningelement:
.. rubric:: |oneBLC| Add a new planning element

* Allows to create a new planning element.
* The created element is added under the previously selected element with the same level of incrementation
* The created element is added in the Gantt and detail window is opened.
* The detail window allows to complete entry.

.. figure:: /images/GUI/GANTT_TIP_CreateNewItem.png
   :alt: Popup menu - Create a new item
   :align: center

   Popup menu - Create a new item

.. note:: **Planning elements management**
  
   * Click on an element, the detail window will be displayed.
   * Planning elements can be managed with their own dedicated screen.
   * Test session and Meeting elements can be added to the planning with their own dedicated screen.  

.. rubric:: |twoBLC| Reorder planning elements

The selector |buttonIconDrag| allows to reorder the planning elements.

.. note:: Important ! 

   Ability to move multiple tasks at one time from one location to another using the key control to select the lines and then dragging and dropping them.


.. rubric:: |threeBLC| Hierarchical level

show or hide project activities

Click on |minusButton| or |plusButton| to enlarge or reduce all groups of projects at the same time.


.. rubric:: |fourBLC| Dependency links

* To create a dependency, click on a graphic element and keep it clicked, the mouse cursor changes to |dndLink|.
* Move the mouse cursor over the graphic element that will be linked and release the button.


.. note:: **Dependency links management**
  
    * In addition to being directly clickable in the Gantt schedule, you can manage dependencies in the detail screen of each element in the predecessor and successor section.
    * See: :ref:`predSuces-element-section`.
    
    .. image:: /images/GUI/GANTT_ZONE_PredecessorDependencies.png
      :alt: predecessor and successor section.
      :align: center
      
    .. image:: /images/GUI/GANTT_ZONE_SuccessorDependencies.png
      :alt: successor dependencies
      :align: center
            
    click on the Add button |ButtonADD| to add or remove a dependency on the selected item
    
    .. image:: /images/GUI/GANTT_ZONE_SectionDependencies_ADD.png
      :alt: Pop up dependency management  
      :align: center 

.. rubric:: |fiveBLC| Activity planning calculation

Click on |calculatePlanning| to start the activity planning calculation.

 .. compound:: **Automatic run plan**

    Check the box to activate automatic calculation on each change.
    
    .. Warning:: Only works on the Gantt Planning view. If the modification of an element is carried out on the dedicated screen of the element, then it is necessary to click again on BUTTON to restart the computation

    .. note:: All modifications about assignement (rate, name or numbers of resources, dates...) done are not displayed on the new planning screen until having, for this purpose, activited the planning calculation, either in an automatic run plan or not.
      On the contrary, the screen planning will not change even if modifications have been loaded yet.


 .. compound:: **Automatic calculation**

  Differential calculation = calculation of projects that require a recalculation.
  
  Complete calculation = calculation of all projects

  The calculations are programmed according to a frequency of CRON type (every minute, every hour, at a given hour every day, at a given time on a given week day, ...)

.. _planning-validation:

.. rubric:: |sixBLC| Planning validation

Allows to modify the dates validated by the planned dates.

This feature allows you to set all reference dates from the calculated schedule.

.. compound:: **Action available**

    **Always:** will overwrite existing values.
    
    **If empty:** will not overwrite existing values.  

.. figure:: /images/GUI/GANTT_BOX_StorePlannedDates.png
   :alt: Dialog box - Store planned dates
   :align: center

   Store planned dates

.. _save-baseline:

.. rubric:: |sevenBLC| Save baseline

The baseline is a record of the planning state at a time T.

See: :ref:`display-baseline`

.. warning:: Your can recording only one baseline every day

.. figure:: /images/GUI/GANTT_BOX_Baseline.png
   :alt: Record baseline
   :align: center
   
   Record baseline

.. rubric:: |eightBLC| Increase and decrease indent

.. figure:: /images/GUI/GANTT_Button_Indent.png
   :alt: Indentation
   :align: center
   
   Indentation buttons


.. compound:: **Increase indent**
   
   The element will become the child of the previous element.
   
.. compound:: **Decrease indent**
   
   The element will be moved at the same level than the previous element.

.. raw:: latex

    \newpage


.. _gantt-planning:

Planning global
===============

.. figure:: /images/GUI/GANTT_ZONE_PlanningGlobal.png
   :alt: Global planning
   
   Global planning

The global planning allows to create and visualize any type of element (project, activity, milestones, risk, meeting, action ...)

* Add and Show any new planning element on Gantt chart
* The created item is added in the Gantt and detail window is opened.
* The detail window allows to complete entry
* Project planning and activity planning calculation can be done in the Gantt.

.. figure:: /images/GUI/GANTT_TIP_PlanningElement.png
   :alt: Create a new item
   :align: center

   Create a new item

.. index:: Gantt chart (Projects portfolio)

Projects portfolio
==================

This screen displays only the projects on the diagram. The activities and other elements that make up the schedule are hidden.

It displays summary and project dependencies only.

.. note::

   This section describes specific behavior for this screen.
   All others behaviors are similar to :ref:`gantt-planning` screen.


.. figure:: /images/GUI/GANTT_ZONE_PortfolioPlanning.png 
   :alt: Gantt (Projects portfolio)
   :align: center

   Gantt (Projects portfolio) 

.. rubric:: Show milestones

Ability to display milestones or not. 

If they are displayed, it is possible to define the type of milestone to display or to display them all. 

All milestones are available: deliverable, incoming, key date...



.. raw:: latex

    \newpage

.. index:: Gantt chart (Resource planning)

Resource Planning
=================

.. figure:: /images/GUI/GANTT_ZONE_ResourcesPlanning.png 
   :alt: Gantt (Resource planning) 
   :align: center

   Gantt (Resource planning)  
    
This screen displays Gantt chart from the resources point of view.

Assigned tasks are grouped under resource level.

On resource planning, group periodic meetings is under its parent

Ability to display assigned activities with zero load

.. rubric:: Gantt bars

For activities, the Gantt bar is split in two: 

.. figure:: /images/GUI/GANTT_ZONE_ResourcePlanning_WorkBar.png
   :alt: Work Bar
   :align: center
   
   Work bars

Real work in grey.

Left work in green or in red. 

See: :ref:`Gantt Bars<gantt-bars>`

The gray bar in the middle graphically represents the actual percentage progress relative to the total duration of the activity 

.. note:: 

   This makes appear some planning gap between started work and reassessed work.

.. rubric:: Dependencies behavior

Links between activities are displayed only in the resource group. 

Links existing between tasks on different resources are not displayed.

.. note::

   This section describes specific behavior for this screen.
   
   All others behaviors are similar to :ref:`gantt-planning` screen.

.. rubric:: |oneBLC| Show project level  

Tasks are grouped by project.

Click "View Project Level" to view the projects on which resource activities depend.

Below the two views with and without "View Project Level" 

.. figure:: /images/GUI/GANTT_ZONE_ResourcesPlanning_with&without_PjtLVL.png 
   :alt: view with project levels (Resource planning) 

   view with project levels and without project levels

.. rubric:: |twoBLC| Show left work 

The remaining work can be displayed to the right of the Gantt bar..

Click "Show left work" to display or not the duration of the rest to be done. .

.. rubric:: |threeBLC| Limit display to selected ressource or team 

Click and select one ressource to display only his data.

Click and select one team to display only data of resources of this team.

.. rubric:: |fourBLC| show activities without work

Ability to display assigned activities with zero work 

The names of the activities appear in the task area but no gantt bar will be displayed




.. raw:: latex

    \newpage

.. _export-Gantt-PDF:

Export planning to PDF
======================

Allows to export planning to PDF format.
Export can be done horizontally (landscape) or vertically (portrait) in A4 and / or A3 format
with great detail even with a zoom

Export contains all details and links between tasks and also include a pagination.

.. figure:: /images/GUI/GANTT_BOX_ExportPlanningPDF.png
   :alt: Dialog box - Export planning to PDF
   :align: center

   Export planning to PDF

.. tabularcolumns:: |l|l|

.. list-table:: Fields - Export planning to PDF dialog box
   :widths: 20, 80
   :header-rows: 1

   * - Field
     - Description
   * - Orientation
     - Page orientation.
   * - Format
     - Page format.  
   * - Zoom
     - Allows to fit planning on page.
   * - Repeat headers
     - Planning can be  span multiple pages.

.. note:: 

   **Technical points**

   This feature will execute export on client side, in your browser. Thus the server will not be *heavy loaded* like *standard* PDF export does.
   
   It is highly faster than *standard* PDF export.

.. warning:: This feature is hightly dependant to browser compatibility
   
.. note:: 

   **Browser compatibility**

   This new feature is technically complex and it is not compatible with all browsers.
   
   Compatible with the latest versions of IE (v11), Firefox, Edge and Chrome.
   
   Else, the old export feature will be used.

.. seealso:: 

   **Forced feature activation/deactivation**

   To enable this feature for all browsers, add the parameter **$pdfPlanningBeta='true';** in parameters.php file.
   
   To disable if for all browsers (including Chrome), add the parameter **$pdfPlanningBeta='false';**
   
   Default (when **$pdfPlanningBeta** parameter is not set) is *enabled with Chrome, disabled with other browsers* 

