Source processor that exposes a REST endpoint specifically for retrieving archived payloads.


Name Summary


Optional, descriptive name for the processor.


Required identifier of the processor, unique across all processors within the flow. Must be between 3 and 30 characters long; contain only lower and uppercase alphabetical characters (a-z and A-Z), numbers, dashes ("-"), and underscores ("_"); and start with an alphabetical character. In other words, it adheres to the regex pattern [a-zA-Z][a-zA-Z0-9_-]{2,29}.


Optional set of custom properties in a simple jdk-format, that are added to the message exchange properties before processing the incoming payload. Any existing properties with the same name will be replaced by properties defined here.


Whether the incoming payload is available for error processing on failure. Defaults to false.


Name Summary


Strategy for describing how a processor’s message is logged on the server.


Strategy for archiving payloads.


Strategy that customizes the conversion of an incoming payload by a processor (e.g., string to object). Should be used when the processor’s default conversion logic cannot be used.



The archiveLookup processor creates a GET endpoint on the path /payloads/{payloadArchivePath}. The payloadArchivePath parameter becomes a payload property that can be used in the flow to look up archived payloads from a given storage solution.

This standardized REST endpoint helps automate the retrieval of archived payloads in Utilihive Heartbeat. However, a proper "archive" flow requires certain configurations to be in place. See the Archiving and Resubmission documentation for more details.