Smile CDR v2022.11.PRE
On this page:
   37.105    TLS / SSL (Encryption) 37.107    Trusted Client   

37.106Transaction Log

 

The Transaction Log configuration category includes the following configurable options:

  • Transaction Log Step Body Serialization Mode

  • Transaction Log Broker Channel Name

  • Transaction Log Broker Enabled

  • Transaction Log Database Storage Enabled

  • Event Blacklist

  • Event Whitelist

  • Persist Transaction Bodies (Global)

  • Persist Transaction Bodies: Incoming Request

  • Persist Transaction Bodies: Incoming Response

  • Truncate Transaction Bodies (bytes)

37.106.1Property: Transaction Log Step Body Serialization Mode

 
Property Name Transaction Log Step Body Serialization Mode
Property Key
Property Type ENUM
Values
  • FHIR_JSON
  • INLINE_JSON
Description Controls whether the transaction log step body is serialized as formatted JSON or flattened(inline)
Applies to Modules
  • Cluster Manager
Default Value FHIR_JSON
Example Property
module.[MODULE_ID].config.transaction_log_step.serialization.bodytype.mode = FHIR_JSON

37.106.2Property: Transaction Log Broker Channel Name

 
Property Name Transaction Log Broker Channel Name
Property Key
Property Type STRING
Description The transaction logs will be sent to the specified topic/queue name. Must be non-empty.
Applies to Modules
  • Cluster Manager
Default Value smilecdr-transaction
Example Property
module.[MODULE_ID].config.transactionlog.broker.channel_name = smilecdr-transaction

37.106.3Property: Transaction Log Broker Enabled

 
Property Name Transaction Log Broker Enabled
Property Key
Property Type BOOLEAN
Description If enabled, the transaction log will submit events to the configured broker for use in realtime reporting.
Applies to Modules
  • Cluster Manager
Default Value false
Example Property
module.[MODULE_ID].config.transactionlog.broker.enabled = false

37.106.4Property: Transaction Log Database Storage Enabled

 
Property Name Transaction Log Database Storage Enabled
Property Key
Property Type BOOLEAN
Description If disabled, no new entries will be written to the transaction log table in the database. Existing entries will remain available until the configured retention period has elapsed.
Applies to Modules
  • Cluster Manager
Default Value true
Example Property
module.[MODULE_ID].config.transactionlog.enabled = true

37.106.5Property: Event Blacklist

 
Property Name Event Blacklist
Property Key
Property Type STRING
Description This setting provides a blacklist of event Type/SubType codes that should not be stored in the Transaction Log. See Controlling Transaction Log Events for more information.
Applies to Modules
  • Cluster Manager
Default Value (no default)
Example Property
module.[MODULE_ID].config.transactionlog.event_blacklist = 

37.106.6Property: Event Whitelist

 
Property Name Event Whitelist
Property Key
Property Type STRING
Description This setting provides a whitelist of event Type/SubType codes to be stored in the Transaction Log. See Controlling Transaction Log Events for more information.
Applies to Modules
  • Cluster Manager
Default Value (no default)
Example Property
module.[MODULE_ID].config.transactionlog.event_whitelist = 

37.106.7Property: Persist Transaction Bodies (Global)

 
Property Name Persist Transaction Bodies (Global)
Property Key
Property Type BOOLEAN
Description If enabled, the bodies of transactions will be stored in the cluster manager database. This can be useful for troubleshooting; however, it has database capacity and performance implications under heavy load. This configuration is enabled by default. Note that this is a master switch, and disabling it takes precedence over any more specific persistence switches.
Applies to Modules
  • Cluster Manager
Default Value true
Example Property
module.[MODULE_ID].config.transactionlog.persist_bodies_in_clustermgr_db = true

37.106.8Property: Persist Transaction Bodies: Incoming Request

 
Property Name Persist Transaction Bodies: Incoming Request
Property Key
Property Type BOOLEAN
Description If enabled, incoming request transaction bodies (e.g. the request body for a FHIR create request received by a FHIR Endpoint module) will be persisted in the transaction log.
Applies to Modules
  • Cluster Manager
Default Value true
Example Property
module.[MODULE_ID].config.transactionlog.persist_endpoint_receive_bodies = true

37.106.9Property: Persist Transaction Bodies: Incoming Response

 
Property Name Persist Transaction Bodies: Incoming Response
Property Key
Property Type BOOLEAN
Description If enabled, incoming response transaction bodies (e.g. the response body for a FHIR search request received by a FHIR Endpoint module) will be persisted in the transaction log.
Applies to Modules
  • Cluster Manager
Default Value true
Example Property
module.[MODULE_ID].config.transactionlog.persist_endpoint_reply_bodies = true

37.106.10Property: Truncate Transaction Bodies (bytes)

 
Property Name Truncate Transaction Bodies (bytes)
Property Key
Property Type NON_NEGATIVE_INTEGER
Description If set to a positive integer, transaction log payload bodies will be truncated before being stored in the transaction log.
Applies to Modules
  • Cluster Manager
Default Value 10000
Example Property
module.[MODULE_ID].config.transactionlog.truncate_body.bytes = 10000
   37.105    TLS / SSL (Encryption) 37.107    Trusted Client