56.137    TLS / SSL (Encryption) 56.139    Trusted Client   

56.141.1Transaction Log

 

The Transaction Log configuration category includes the following configurable options:

  • Transaction Log Broker Channel Name

  • Event Blacklist

  • Event Whitelist

  • Persist Transaction Bodies (All)

  • Persist Transaction Bodies: Incoming Request

  • Persist Transaction Bodies: Incoming Response

  • Persist Storage Outcome Details

  • Transaction Log Step Body Serialization Mode

  • Transaction Log Broker Enabled (DEPRECATED)

  • Cluster Manager Transaction Log Storage

  • Transaction Log Show Request Body Enabled

  • Truncate Transaction Bodies (bytes)

56.141.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
  • Transaction Log Broker
Default Value smilecdr-transaction
Example Property
module.[MODULE_ID].config.broker.channel_name = smilecdr-transaction

56.141.3Property: 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
  • Transaction Log Broker
  • Transaction Log Persistence
Default Value (no default)
Example Property
module.[MODULE_ID].config.event_blacklist = 

56.141.4Property: 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
  • Transaction Log Broker
  • Transaction Log Persistence
Default Value (no default)
Example Property
module.[MODULE_ID].config.event_whitelist = 

56.141.5Property: Persist Transaction Bodies (All)

 
Property Name Persist Transaction Bodies (All)
Property Key
Property Type BOOLEAN
Description If enabled, the payload bodies of transactions will be persisted in the transaction log. 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 primary switch, and disabling it takes precedence over any more specific persistence switches. Also note that for historical reasons, this setting includes the word "clustermgr" in its name, but it does not only apply to the Cluster Manager. If this setting is applied to the Cluster Manager module, it controls whether payload bodies are stored in transaction log entries in the cluster manager database. If it is applied to a Transaction Log Persistence module, it controls whether payload bodies are stored in that module's database, etc.
Applies to Modules
  • Cluster Manager
  • Transaction Log Broker
  • Transaction Log Persistence
Default Value true
Example Property
module.[MODULE_ID].config.persist_bodies_in_clustermgr_db = true

56.141.6Property: 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
  • Transaction Log Broker
  • Transaction Log Persistence
Default Value true
Example Property
module.[MODULE_ID].config.persist_endpoint_receive_bodies = true

56.141.7Property: 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
  • Transaction Log Broker
  • Transaction Log Persistence
Default Value true
Example Property
module.[MODULE_ID].config.persist_endpoint_reply_bodies = true

56.141.8Property: Persist Storage Outcome Details

 
Property Name Persist Storage Outcome Details
Property Key
Property Type BOOLEAN
Description Enabled storage of individual Storage Outcome Details within the generated Transaction Log entries when processing FHIR Transaction or Batch operations.
Applies to Modules
  • Cluster Manager
  • Transaction Log Broker
  • Transaction Log Persistence
Default Value false
Example Property
module.[MODULE_ID].config.persist_storage_outcome_details = false

56.141.9Property: 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

56.141.10Property: Transaction Log Broker Enabled (DEPRECATED)

 
Property Name Transaction Log Broker Enabled (DEPRECATED)
Property Key
Property Type BOOLEAN
Description If enabled, the transaction log will submit events to the configured broker for use in realtime reporting. This setting is deprecated; this functionality is available using the Transaction Log Broker Module.
Applies to Modules
  • Cluster Manager
Default Value false
Example Property
module.[MODULE_ID].config.transactionlog.broker.enabled = false

56.141.11Property: Cluster Manager Transaction Log Storage

 
Property Name Cluster Manager Transaction Log Storage
Property Key
Property Type BOOLEAN
Description This setting enables storage of Transaction Log events directly in the Cluster Manager database. This should be disabled unless you specifically want to store your transaction log events directly in the Cluster Manager database.
Applies to Modules
  • Cluster Manager
Default Value true
Example Property
module.[MODULE_ID].config.transactionlog.enabled = true

56.141.12Property: Transaction Log Show Request Body Enabled

 
Property Name Transaction Log Show Request Body Enabled
Property Key
Property Type BOOLEAN
Description If enabled, the transaction log will show the body of the FHIR request events.
Applies to Modules
  • Cluster Manager
  • Transaction Log Persistence
Default Value false
Example Property
module.[MODULE_ID].config.transactionlog.show_request_body.enabled = false

56.141.13Property: 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
  • Transaction Log Broker
  • Transaction Log Persistence
Default Value 10000
Example Property
module.[MODULE_ID].config.truncate_body.bytes = 10000
   56.137    TLS / SSL (Encryption) 56.139    Trusted Client