Connector Framework Server 23.2

# Asynchronous Actions

When you send an asynchronous action to Connector Framework Server, the CFS adds the task to a queue and returns a token. Connector Framework Server performs the task when a thread becomes available. You can use the token with the `QueueInfo` action to check the status of the action and retrieve the results of the action.

Most of the actions sent to CFS are `ingest` actions, so when you use the `QueueInfo` action, query the `ingest` action queue, for example:

         /action=QueueInfo&QueueName=ingest&QueueAction=GetStatus

## Check the Status of an Asynchronous Action

To check the status of an asynchronous action, use the token that was returned by Connector Framework Server with the `QueueInfo` action. For more information about the `QueueInfo` action, refer to the Connector Framework Server Reference.

To check the status of an asynchronous action

- Send the `QueueInfo` action to Connector Framework Server with the following parameters.

  `QueueName` | The name of the action queue that you want to check.
  `QueueAction` | The action to perform. Set this parameter to `GetStatus`.
  `Token` | (Optional) The token that the asynchronous action returned. If you do not specify a token, Connector Framework Server returns the status of every action in the queue.

For example:

    /action=QueueInfo&QueueName=ingest&QueueAction=getstatus&Token=...

## Cancel an Asynchronous Action that is Queued

To cancel an asynchronous action that is waiting in a queue, use the following procedure.

To cancel an asynchronous action that is queued

- Send the `QueueInfo` action to Connector Framework Server with the following parameters.

  `QueueName` | The name of the action queue that contains the action to cancel.
  `QueueAction` | The action to perform . Set this parameter to `Cancel`.
  `Token` | The token that the asynchronous action returned.

For example:

    /action=QueueInfo&QueueName=ingest&QueueAction=Cancel&Token=...

## Stop an Asynchronous Action that is Running

You can stop an asynchronous action at any point.

To stop an asynchronous action that is running

- Send the `QueueInfo` action to Connector Framework Server with the following parameters.

  `QueueName` | The name of the action queue that contains the action to stop.
  `QueueAction` | The action to perform. Set this parameter to `Stop`.
  `Token` | The token that the asynchronous action returned.

For example:

    /action=QueueInfo&QueueName=ingest&QueueAction=Stop&Token=...

Copyright 2023 Open Text
Version 23.2 | Last updated March 2023

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 swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL Connector Framework Server 23.2

Topic Title: Asynchronous Actions