.. include:: ImageReplacement.txt

.. raw:: latex

    \newpage

.. title:: Real work allocation

.. index:: Real work allocation 

.. _RWA:

Real work allocation
********************

This screen is devoted to input of real work.

The resource informs his work day by day, for each assigned task.

Data entry for one resource, on a weekly base.

.. note::

   The corresponding cost to the real work is automatically updated to the assignment, activity and project.

.. warning:: 

   **Global parameter - Number of hours per day**

   * In global parameters screen, you can define wether work will be entered in hours or in days.
   * If you enter work in hours, you must define  the parameter **number of hours per day** before some real work has been entered.
   * After first work is entered, this parameter will be locked.
      
   **see:** :ref:`Global Parameters<work-time>`

.. figure:: /images/GUI/REALWORK_SCR_TimeSheetZone2.png
   :alt: Timesheet zone screen
   :align: center

   Timesheet zone screen

.. rubric:: |one| Selection timesheet

* Allows to select a timesheet for a resource and for a period.
* More detail about selection timesheet, see : :ref:`selectionTimesheet-section`.

.. rubric:: |two| Show planned work

* Check this box to display the planned work.
* Planned work is indicated over each input cell, on top left corner, in light blue color.
* Allows to display the planned working time by day, for the resource assigned to the task.

.. figure:: /images/GUI/REALWORK_ZONE_WithPlannedWork2.png
   :alt: Planned work displayed zone
   :align: center

   Planned work displayed zone

.. note::

   The planned work will be deleted if the real work is entered instead of planned work (to avoid duplication of work in reports) to see it you have to refresh the screen.

.. rubric:: |three| Filters

Filters allow to define the list of assigned tasks displayed.

 .. compound:: **Show only current week meeting**

    * Check this box  to show only the tasks on meetings of the week.

 .. compound:: **Hide not handled items**

    * Check this box to hide tasks not taken over.

 .. compound:: **Hide done items**

    * Check this box to hide completed tasks.

 .. compound:: **Show closed items**

    * Check this box to show closed tasks.

   .. compound:: **Show ID**

* Show ID to identify all single task.

.. note:: 

   **Global parameter - "Display only handled tasks"**

   If the value of the parameter is set to "Yes", only tasks taken over (status "handled") will be displayed.
   
   The checkbox "Hide not handled items" will be hidden.

.. rubric:: |four| Buttons

Buttons of the timesheet:

* Click on |buttonIconSave| to save timesheet data.
* Click on |buttonIconPrint| to print timesheet.
* Click on |buttonIconPdf| to export timesheet in PDF format.
* Click on |buttonIconCsv| to export timesheet in CSV format.
* Click on |buttonIconUndo| to undo modification on the timesheet.

.. rubric:: |five| Data entry validation

.. image:: /images/GUI/Button_Timesheet_EnterRealWork.png 

* To enter automatically  the work as it is planned

.. image:: /images/GUI/Button_Timesheet_SubmitWork.png 

* Buttons allow to send and validate real work.
* Displayed if mandatory
* Users can send works to project leader.

.. image:: /images/GUI/Button_Timesheet_ValidateWork.png 

* Project leaders can validate works.



.. rubric:: |six| Scroll bar

* Scroll bar allows the scrolling on imputation lines.
* The header of table stays visible.
* The footer of the table (with the sum of inputs) remains visible, fixed, as soon as the number of lines is greater than 20.

.. rubric:: |seven| Input fields

* Input fields in timesheet.
* More detail about, see : :ref:`inputFields-section`

.. rubric:: |eight| Tasks list

.. figure:: /images/GUI/REALWORK_ZONE_IMPUTATION2.png
   :alt: Task list zone
   :align: center

   Task list zone


.. rubric:: |A| **Tasks**
 
.. compound:: **The list displays the assigned tasks for the resource.**

* Only assigned tasks that meet the next criteria will be displayed.
   
  * Assigned tasks planned during this period.
  * Assigned tasks that meet the criteria of selected filters.

.. note::

     * Assigned tasks with real work are always displayed, even if closed.
     * The goal is to show all lines of the sum for each column, to be able to check that the week is completely entered.



* Assigned tasks are grouped by project and displayed according the project structure.  
* Click on the name of the activity to access it.  
* Click on |minusButton| or |plusButton| on the line will expand-shrink the group.
* Click on the icon of the activity to display it detail without leaving the current screen.  
 

.. rubric:: |B| **Assigned task function**

    * The assigned task function is displayed in blue after the name of the activity.  

.. _assignedtask-comment:

.. rubric:: |C| **Assigned task comments**
    
    * The icon |iconNoteAdd| allows to add a comment.
    * The icon |Note| indicates there is a comment on assigned task. 
    * Just move the mouse over the icon to see the last comment.

.. note:: The comments |Note|

   fly over the icon with the mouse to see the comment
   
   .. figure:: /images/GUI/REALWORK_BOX_Timesheet_ViewComment.PNG
   
   * Click on the icon to open windows view comments
      
   .. figure:: /images/GUI/REALWORK_BOX_leftclickNote.png
      :alt: 
      :align: center
             
        
.. compound:: |D| **Imput fields**

Each day, for each task, an input field allows you to enter your actual work.

The column of the day is highlighted with a yellow background

see: :ref:`inputFields-section`

In order to see and know the assignment times on a task, several columns indicate the periods that are assigned to a resource

      * **Planned dates**: Planned start and end dates.
      * **Assigned**: Planned work assigned to the resource.
      * **Real**: Sum of work done by the resource.
      * **Left**: The remaining planned work. 
      * **Reassessed**: The work needed to complete the task. 
      
.. figure:: /images/GUI/REALWORK_ZONE_RowsTime.png
   :scale: 60%
              
          
**Total of days**

On the last column is the sum for all days of the week. 

It is a synthesis displayed for each project and globally for the whole week.
    
.. figure:: /images/GUI/REALWORK_ZONE_TimesheetTotalDay.PNG
   :alt: Total of the day
   
   Total of the day Zone  
   
 
.. raw:: latex

    \newpage

.. _selectionTimesheet-section:

Selection timesheet
-------------------

.. figure:: /images/GUI/REALWORK_ZONE_TimeSheetSelector.png
   :alt: Timesheet selector zone
   :align: center

   Timesheet selector zone

.. rubric:: |one| Selection of the resource 

* By default, users can only select themselves as a resource.

* Access to other resources timesheet depending on :ref:`specific_access`, then user can select other resources timesheets. 

* Clicking on the checkbox below allows to select only resources allocated to the selected project on the list roll displayed. 

.. figure:: /images/GUI/REALWORK_ZONE_Timesheet_LimitList.PNG
   :alt: Limit list of resources
   :align: center
   
   
.. rubric:: |two| |three| Selection period

* By default, the period is determined depending on the current day.

* It is possible to change the period of two ways:

  * Select year and week |two| 
  
  * Or select the first day of the week |three| 
  
  * Or click on the **Today** button to return to the current week

.. rubric:: |four| |five| |six| Displayed timesheet

* A timesheet is displayed depends on the resource and period selection.
* The name of the resource and the week are displayed. |four|
* The days of the week are displayed. |five|
* The current day is displayed. |six|



.. raw:: latex

    \newpage

.. _inputFields-section:

Input fields
------------

.. figure:: /images/GUI/REALWORK_ZONE_InputTimesheet.png
   :alt: Input timesheet zone
   :align: center

   Input timesheet zone

.. rubric:: |one| Comments

* A global comment can be added on the weekly follow-up.
* Possibility to extend the main comment area.
* Can enter a comment on each line of real work allocation screen.

.. rubric:: |two| Real work entry

* Area to enter real work.
* Week is displayed from monday to sunday.
* It possible put real work in off days.

.. topic:: **Unit time of real work data entry**

    * The global parameter **Unit for real work allocation** into Work Time tab allows to set the unit time.
    
    .. figure:: /images/GUI/GLOBALPARAM_WorkTime_UnitsWorks.png
    
    * unit for Timesheet (real work) : available are in "Days" or "Hours".
    * Selected unit time is displayed on left at bottom window. |four|      


.. compound:: **Current day**

    * Columns of current day is displayed in yellow.

.. compound:: **Days off**

    * Columns of days off is displayed in grey.
    * Days off is determine in resource calendar definition, see: :ref:`calendars`.

.. rubric:: |three| Left work

* Left work is automatically decreased on input of real work.
* Resources can adjust this value to estimate the work needed to complete the task.



.. raw:: latex

    \newpage


Input entry validation
----------------------

This section explains controls done on data entries.

* These controls are not blocking.

* yellow background : Enhancement of data entered


.. rubric:: Resource capacity validation

* The total of the day is green whether entries respects the resource capacity of days.
* The total of the day is red whether entries is more than the resource capacity of days.

.. topic:: Resource capacity of days

   * The resource capacity is defined by the number of hours per day and the resource capacity.
   
   * The number of hours per day is defined on :ref:`Global parameters<unitForWork-section>` screen.
   
   * The capacity of the resource is defined on :ref:`resource` screen.

.. figure:: /images/GUI/REALWORK_ZONE_WithColumnsValidation.png
   :alt: Columns validation zone
   :align: center

   Columns validation zone


.. rubric:: Entering real work is in excess of the number of days specified 

* This alert box appears when the real work to a resource is entering ahead of time.

.. figure:: /images/GUI/REALWORK_ALERT_RealWorkBlocked.png

* Resource can enter his real work is defined in "max days to book work" parameter in :ref:`Global parameters<unitForWork-section>` screen.
    
.. figure:: /images/GUI/GLOBALPARAM_WorkTime_Timesheet.png
   :alt: Real work over expected days alert
   :align: center

   
.. raw:: latex

    \newpage

The status of tasks
-------------------

The task status can be changed automatically according to data entries on real work and left work.

.. rubric:: Global parameter "Set to first 'handled' status"

* If the parameter value is set to "Yes", when real work is entered on a task, its status will be changed automatically to the first status "handled".

.. rubric:: Global parameter "Set to first 'done' status"

* If the parameter value is set to "Yes", when left work is set to zero on a task, its status will be changed automatically to the first status "done".

.. rubric:: Change status validation

* An icon will be displayed on the task if a status change is applicable.

 .. compound:: **Icons**

    * |statusStart| Due to real work is entered, the task status will be changed to the first 'handled' status.
    * |statusStartKO| The real work is entered, but the task status will not change because at issue is occurring. 
    * |statusFinish| Due to no more left work, the task status will be changed to the first ‘done’ status.
    * |statusFinishKO| No more left work, but the task status will not change because at issue is occurring. 

    .. note::

       Move the cursor over the icon to see the message.

 .. compound:: **Common issue**

    * If a :term:`responsible` or a :term:`result` are set as mandatory in element type definition for the task. It's impossible to set those values by real work allocation screen.
    * The change status must be done in treatment section on the task definition screen.

    
Timesheet Validation
--------------------

The timesheet validation screen allows the project leader to receive, 

check and validate the time charged by the resources on an activity.

.. figure:: /images/GUI/REALWORK_ZONE_TimesheetValidation.png


.. list-table:: Fields - Timesheet validation
   :widths: 30, 80
   :header-rows: 1

   * - Field
     - Description
   * - Resource
     - resource name, owner of the posting sheet
   * - Week
     - dates of the imputed period - One shipment per week
   * - Expected
     - Expected work for the resource
   * - Operational work
     - work actually done for the resource
   * - Administrative work
     - period of leave/sickness/absence
   * - Sum
     - total days of resources over the period indicated
   * - Timesheet submitted
     - Date the timesheet was sent by the resource 
   * - Timesheet validation
     - project learder placeholder to validate or invalidate timesheet

.. note:: **Color code**

   According to the work completed by the resource, and according to the expected workload for this resource, 
   
   the PL receives the timesheet with a precise color code

      * **Green:** The completed job is the same as the expected one

      * **Red:** The filled workload is shorter. It does not match the expected work

      * **Orange:** the job is not the same as the expected job but the load is the same

