Connector Framework Server 24.4
IDOL Connector Framework Server Help

# GetStatus

The `GetStatus` action returns information about the current state of CFS.

Type: Synchronous

## Example

    http://12.3.4.56:7000/action=GetStatus

This action uses port `7000` to request details about Connector Framework Server, which is located on a machine with the IP address `12.3.4.56`.

## Response

The following XML is a sample response from the `GetStatus` action:

    <autnresponse>
       <action>GETSTATUS</action>
       <response>SUCCESS</response>
       <responsedata>
          <product>Connector Framework</product>
          <version>7.6.0.0</version>
          <build>1</build>
          <aciport>7000</aciport>
          <serviceport>7532</serviceport>
          <directory>C:\ConnectorFramework</directory>
          <acithreads>4</acithreads>
          <ingest calls="1" adds="1"/>
          <nodes>2</nodes>
          <importactive>0</importactive>
          <importpending>0</importpending>
          <keyviewmemory>0</keyviewmemory>
          <import queued="2" started="2" finished="2"/>
       </responsedata>
    </autnresponse>

Value | Description
--- | ---
product | The name of the product.
version | The product version.
build | The product build.
aciport | The ACI port used by CFS.
serviceport | The service port used by CFS.
directory | The running directory.
acithreads | The number of threads configured for ACI commands.
ingest | The attributes in the ingest tag count the number of requests made to CFS. `Calls` is the total number of requests. `Adds` is the total number of add requests. `Updates` is the total number of update requests. `Removes` is the total number of remove requests.
nodes | The number of documents waiting to be collected into an index batch (the number of documents that CFS has finished importing).
importactive | The number of documents currently being imported.
importpending | The number of documents waiting to be imported.
keyviewmemory | The amount of memory allocated to the KeyView process.
import | Details about the number of documents imported. The `import` tag contains the following attributes: `Queued` is the number of documents that were added to the import queue. `Started` is the number of documents that started the import process. `Finished` is the number of documents that were imported successfully. `Cancelled` is the total number of documents that were canceled during the import process. Documents are canceled if you use a Pre or Post import task to run a Lua script, and the script returns `false`.

Copyright 2024 Open Text
Version 24.4 | Last updated September 2024

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: IDOL Connector Framework Server 24.4

Topic Title: GetStatus