Skip to main content

Feeding Configuration

Queue

The Feeding Queue shows all events that are waiting to be processed. These are incoming feed events that have not yet been indexed into the system.

Available actions:

  • Details – Shows the full payload of the event
  • Ignore – Ignores the event in the next fullfeed job
  • Delete – Deletes the event from the queue
  • Purge queue – Deletes all documents from the queue

You can use the same search patterns as in the History section to filter and retrieve queue entries.

Event Statuses

StatusDescription
CREATEDThe event was sent to the API
PREPAREDThe event is selected to be processed and has a batch ID assigned
STARTEDThe batch processing has started
FINISHEDThe batch was finished successfully, and the event is removed from the queue
ERRORThe batch encountered an error, and the document stays in the queue
IGNOREThe event is ignored and will not be processed

Processing Workflow

A polling process continuously checks for new events to process:

  1. If there is a running batch, no new batch is created to maintain processing order
  2. Documents with status IGNORE or ERROR are skipped – error documents do not block the queue
  3. The process selects up to 100 documents, changes their status to PREPARED, and assigns a batch ID
  4. A worker picks up all documents with the batch ID and changes their status to STARTED
  5. On success: Status changes to FINISHED and documents are removed from the queue
  6. On failure: Status changes to ERROR for the entire batch, even if only one document failed

Note: You will never see documents with status FINISHED in the queue, as they are removed immediately after successful processing.

If the queue is blocked (e.g., due to many error documents), you can use Purge queue to clear it.

History

The Feeding History provides a complete, chronological view of all feed events that were processed by the system. It shows all fed events, ordered with the newest entries first, allowing you to quickly inspect the most recent changes. For each document, only the latest event for the same document ID is considered indexed and effective. To keep the history compact and efficient, a nightly compaction process removes redundant events and retains only the last event per document. If this last event is a delete, the document and its related history entry are removed completely from the system.

Available actions:

  • Details – Shows the full payload of the event
  • Ignore – Ignores the event in the next fullfeed job
  • Refeed – Copies the event back into the queue and reprocesses it
  • Delete – Deletes the event from the queue
  • Start fullfeed – Creates a fullfeed start event
  • End fullfeed – Deletes all events before the last fullfeed start event and triggers a new fullfeed job
  • Purge history – Deletes all documents from the history

You can use various search patterns to precisely filter and retrieve the feeding history entries that are relevant to you. The available query patterns are listed in the following table.

Query PatternExampleDescription
toptopReturns the latest 100 feeding history entries for the job (ID desc)
id:id:3452Returns the feeding history entry with the exact given ID
id>:id>:3452Returns all entries with ID greater than the given value
id<:id<:3452Returns all entries with ID less than the given value
id>=:id>=:3452Returns all entries with ID greater than or equal to the given value
id<=:id<=:3452Returns all entries with ID less than or equal to the given value
id><:id><:3452 3462Returns all entries with ID between the two given values (inclusive)
documentId:documentId:doc-123Returns entries matching the given document ID
batchId:batchId:batch-42Returns all entries for the given batch ID (ID asc)
operation:operation:fullfeedStartReturns the latest 1,000 entries where a full feed starts
operation:operation:fullfeedEndReturns the latest 1,000 entries where a full feed ends
operation:operation:createReturns the latest 1,000 entries for document creation
operation:operation:updateReturns the latest 1,000 entries for document updates
operation:operation:deleteReturns the latest 1,000 entries for document deletion
status:status:CREATEDReturns the latest 1,000 entries with status CREATED
status:status:PREPAREDReturns the latest 1,000 entries with status PREPARED
status:status:STARTEDReturns the latest 1,000 entries with status STARTED
status:status:FINISHEDReturns the latest 1,000 entries with status FINISHED
status:status:ERRORReturns the latest 1,000 entries with status ERROR

Variables

KeydataTypeexampledescription
trackingPaylodbooleantrue (default: true)flag to disable tracking of the payload
urlslist.stringTODO
regexstring".*"TODO
fullFeedPageSizestring"500"The page size for the fullfeed. Value must be a string
mapAttributeFieldsbooleantrueFlag to enable the mapping of all attributes
expectedDocumentCountlong491371The expected document count. To show a progress bar in the ui

Security Ids

To secure feeding configurations we have securityIds field. You can use security configuration for feeding-api-integration For the information how to create and use security configuration see security

Example

{
"securityIds": [
"security-api-key",
"security-public",
"security-basic-auth"
]
}