Overview - Common API - Client API - Admin API - Runtime API
Historian
The Historian records the history of actions taken using Composer. It is a registry that stores HistorianRecords; each record is created in response to a transaction being executred.
As well as the transactions that are defined in the Network model other actions such as adding assets are treated as transactions so are therefore recorded.
Details of these are in the system model.
Applications should retrieve instances from BusinessNetworkConnection
Details
Extends Registry
Module client
See also
- See Registry
Method Summary
| Name | Returns | Description |
|---|---|---|
| add | void |
Unsupported operation; you cannot add a historian record to the historian |
| addAll | void |
Unsupported operation; you cannot add a historian record to the historian |
| getHistorian | Promise |
Get an existing historian |
| remove | void |
Unsupported operation; you cannot remove a historian record from the historian |
| removeAll | void |
Unsupported operation; you cannot remove a historian record from the historian |
| update | void |
Unsupported operation; you cannot update a historian record in the historian |
| updateAll | void |
Unsupported operation; you cannot update a historian record in the historian |
Inherited Method Summary
| Supertype | Name | Returns | Description |
|---|---|---|---|
| Registry | getAll | Promise |
Get all of the resources in the registry |
| Registry | get | Promise |
Get a specific resource in the registry |
| Registry | exists | Promise |
Determines whether a specific resource exists in the registry |
| Registry | resolveAll | Promise |
Get all of the resources in the registry, and resolve all of their relationships to other assets, participants, and transactions |
| Registry | resolve | Promise |
Get a specific resource in the registry, and resolve all of its relationships to other assets, participants, and transactions |
Method Details
getHistorian
Promise getHistorian( SecurityContext securitycontext, ModelManager modelmanager, Factory factory, Serializer serializer )
Get an existing historian.
Returns
Promise - A promise that will be resolved with a Historian instance representing the historian.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| securityContext | SecurityContext | Yes | The user's security context. |
| modelManager | ModelManager | Yes | The ModelManager to use for this historian. |
| factory | Factory | Yes | The factory to use for this historian. |
| serializer | Serializer | Yes | The Serializer to use for this historian. |
add
add( Resource resource )
Unsupported operation; you cannot add a historian record to the historian. This method will always throw an exception when called.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| resource | Resource | Yes | The resource to be added to the registry. |
addAll
addAll( resources )
Unsupported operation; you cannot add a historian record to the historian. This method will always throw an exception when called.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| resources | Yes | The resources to be added to the registry. |
update
update( Resource resource )
Unsupported operation; you cannot update a historian record in the historian. This method will always throw an exception when called.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| resource | Resource | Yes | The resource to be updated in the registry. |
updateAll
updateAll( resources )
Unsupported operation; you cannot update a historian record in the historian. This method will always throw an exception when called.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| resources | Yes | The resources to be updated in the asset registry. |
remove
remove( Resource; string resource )
Unsupported operation; you cannot remove a historian record from the historian. This method will always throw an exception when called.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| resource | Resource; string | Yes | The resource, or the unique identifier of the resource. |
removeAll
removeAll( Resource[]; string[] resources )
Unsupported operation; you cannot remove a historian record from the historian. This method will always throw an exception when called.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| resources | Resource[]; string[] | Yes | The resources, or the unique identifiers of the resources. |
Inherited methods
getAll
Promise getAll( )
Inherited from: Registry
Get all of the resources in the registry.
Returns
Promise - A promise that will be resolved with an array of JSON objects representing the resources.
Parameters
No parameters
get
Promise get( string id )
Inherited from: Registry
Get a specific resource in the registry.
Returns
Promise - A promise that will be resolved with a JSON object representing the resource.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| id | string | Yes | The unique identifier of the resource. |
exists
Promise exists( string id )
Inherited from: Registry
Determines whether a specific resource exists in the registry.
Returns
Promise - A promise that will be resolved with true/false depending on whether the resource exists.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| id | string | Yes | The unique identifier of the resource. |
resolveAll
Promise resolveAll( )
Inherited from: Registry
Get all of the resources in the registry, and resolve all of their relationships to other assets, participants, and transactions. The result is a JavaScript object, and should only be used for visualization purposes. You cannot use the add or update functions with a resolved resource.
Returns
Promise - A promise that will be resolved with an array of JavaScript objects representing the resources and all of their resolved relationships.
Parameters
No parameters
resolve
Promise resolve( string id )
Inherited from: Registry
Get a specific resource in the registry, and resolve all of its relationships to other assets, participants, and transactions. The result is a JavaScript object, and should only be used for visualization purposes. You cannot use the add or update functions with a resolved resource.
Returns
Promise - A promise that will be resolved with a JavaScript object representing the resource and all of its resolved relationships.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| id | string | Yes | The unique identifier of the asset. |