Vantara Connector 25.1
Vantara Connector Help

# Monitor the Progress of a Task

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:

- A stage represents part of a task.
- A stage can have sub-stages. In the previous example, the stage "C:\Test Files\" has three stages that represent sub-folders ("Folder01", "Folder02", and "Folder03") and one stage that represents the contents of the folder itself ("."). You can limit the depth of the sub-stages in the progress report by setting the `MaxDepth` parameter in the `QueueInfo` action.
- The `weight` attribute indicates the amount of work included in a stage, relative to other stages at the same level.
- The `status` attribute shows the status of a stage. The status can be "Pending", "Processing", or "Finished".
- The `progress` attribute shows the number of items that have been processed for the stage.
- The `maximum` attribute shows the total number of items that must be processed to complete the stage.
- The `percent` attribute shows the progress of a stage (percentage complete). In the previous example, the progress report shows that MYTASK is 7.5595% complete.
- Finished stages are grouped, and pending stages are not expanded into sub-stages, unless you set the action parameter `AllStages=true` in the `QueueInfo` action.

Copyright 2024 Open Text
Version 25.1 | Last updated January 2025

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery Vantara Connector 25.1

Topic Title: Monitor the Progress of a Task