***********************
Report Progress Of Task
***********************

Problem
=======

You want to report progress from the task to the client for monitoring purposes.



Solution
========

First, to receive the progress messages sent from the task to the client, subscribe to the job's 
:py:obj:`task_progress_updated <agiparallel.client.Job.task_progress_updated>` event or
the task's :py:obj:`progress_updated` event.


.. literalinclude:: ..\..\..\code\HowTos\ReportProgressOfTask.py
	:language: python
	:linenos:
	:dedent: 8
	:lines: 33
	
Then, on the task, call :py:meth:`set_progress() <agiparallel.infrastructure.Task.set_progress>`.
The values passed to :py:meth:`set_progress() <agiparallel.infrastructure.Task.set_progress>`
will be received on the client's progress event handling method.


.. literalinclude:: ..\..\..\code\HowTos\ReportProgressOfTask.py
	:language: python
	:linenos:
	:dedent: 8
	:lines: 15


.. literalinclude:: ..\..\..\code\HowTos\ReportProgressOfTask.py
	:language: python
	:linenos:



Discussion
==========

If a job could potentially take a long time to finish, reporting the progress of tasks while the task is 
running helps to notify the user how long the task could take. You can read more about working with 
task progress :ref:`here <Reporting the Progress of Tasks>`.

To view the progress through the monitoring applications, open the task monitor (through the coordinator 
or agent tray application).
Right click on the column headings and then click on "Status Description" on the drop down menu.

.. image:: ..\\..\\..\\..\\..\\..\\Documentation\\Media\\ShowStatusDescription.png
	:align: center
	:alt: ShowStatusDescription.png
	
Once the Status Description column is visible, the value of the task progress description can be seen. This is shown in the example above.

.. image:: ..\\..\\..\\..\\..\\..\\Documentation\\Media\\MonitorTaskProgressUsingUI.png
	:align: center
	:alt: MonitorTaskProgressUsingUI.png


See Also
========

Other Resources
"""""""""""""""
* :ref:`Reporting the Progress of Tasks`