Hyperledger Fabric Query Block Agent Service (com.ibi.agents.XDFabricQueryBlockAgent)

Syntax:

com.ibi.agents.XDFabricQueryBlockAgent

iIT Service Object:

format: Hyperledger Fabric Query Block Agent

Description: Queries a Hyperledger Fabric Channel for block information.

Parameters:

Parameter

Description

Fabric Channel Provider *

The name of the Fabric Channel Provider.

Query Type

Determines the search criteria for the block query.

Query Argument *

When querying by block number, this is a non-negative integer block number, or a negative integer block number relative to the current block height (-1 is the latest block). When querying by block hash, this is a hex-encoded string with two hex characters per byte. When querying by transaction ID, this is the transaction ID.

Output Format

The format of the result.

Batch Mode

Early Limit

The format is yyyy-MM-dd'T'HH:mm:ss.SSSXXX where XXX is an ISO 8601 time zone. Specifying an Early Limit turns on batch mode which will always return the queried block, and also includes the previous blocks up to but not including the first encountered block with all transactions timestamped earlier than the early limit. Timestamps are created by clients without a central clock. It is therefore recommended to specify a date earlier than necessary by some margin. The batch is also limited by the Batch Size when defined.

Batch Size

Specifying a batch size turns on batch mode which will return up to that many blocks, starting from the queried block and its previous blocks, within the limits of the Early Limit if defined or the origin of the chain.

Edges:

The following table lists the available Line Edges for the Hyperledger Fabric Query Block Agent Service (com.ibi.agents.XDFabricQueryBlockAgent).

Line Edge

Description

OnError

An exception occurred during execution.

OnSuccess

The operation was successful.

OnFailure

A fail condition occurred during execution.

OnFailedOperation

Could not perform the operation requested.

OnFailParse

Could not parse a document.