This section describes how to monitor the progress of a task.
NOTE: Progress reporting is not available for every action.
To monitor the progress of a task
Send the following action to the connector:
action=QueueInfo&QueueName=fetch&QueueAction=progress&Token=...
where,
Token
|
The token of the task that you want to monitor. If you started the task by sending an action to the connector, the token was returned in the response. If the connector started the task according to the schedule in its configuration file, you can use the QueueInfo action to find the token (use /action=QueueInfo&QueueName=fetch&QueueAction=getstatus ). |
The connector returns the progress report, inside the <progress>
element of the response. The following example is for a File System Connector synchronize task.
<autnresponse> <action>QUEUEINFO</action> <response>SUCCESS</response> <responsedata> <action> <token>MTAuMi4xMDUuMTAzOjEyMzQ6RkVUQ0g6MTAxNzM0MzgzOQ==</token> <status>Processing</status> <progress> <building_mode>false</building_mode> <percent>7.5595</percent> <time_processing>18</time_processing> <estimated_time_remaining>194</estimated_time_remaining> <stage title="MYTASK" status="Processing" weight="1" percent="7.5595"> <stage title="Ingestion" status="Processing" weight="999" percent="7.567"> <stage title="C:\Test Files\" status="Processing" weight="6601" percent="7.567" progress="0" maximum="6601"> <stage title="Folder01" status="Processing" weight="2317" percent="43.116" progress="999" maximum="2317"/> <stage title="Folder02" status="Pending" weight="2567"/> <stage title="Folder03" status="Pending" weight="1715"/> <stage title="." status="Pending" weight="2"/> </stage> </stage> <stage title="Deletion" status="Pending" weight="1"/> </stage> </progress> </action> </responsedata> </autnresponse>
To read the progress report
The information provided in the progress report is unique to each connector and each action. For example, the File System Connector reports the progress of a synchronize task by listing the folders that require processing.
A progress report can include several stages:
MaxDepth
parameter in the QueueInfo
action.weight
attribute indicates the amount of work included in a stage, relative to other stages at the same level.status
attribute shows the status of a stage. The status can be "Pending", "Processing", or "Finished".progress
attribute shows the number of items that have been processed for the stage.maximum
attribute shows the total number of items that must be processed to complete the stage.percent
attribute shows the progress of a stage (percentage complete). In the previous example, the progress report shows that MYTASK is 7.5595% complete.AllStages=true
in the QueueInfo
action.
|