Smile CDR v2023.11.PRE
On this page:
   43.21    Kafka
  • Configuration Categories
  • 43.0 Web Admin Console Settings
  • 43.1 appSphere
  • 43.2 Payer Config
  • 43.3 Initial appSphere Seeding
  • 43.4 Authentication Callback Scripts
  • 43.5 Auth: General for APIs
  • 43.6 User Authentication
  • 43.7 Auth: HTTP Basic
  • 43.8 Auth: OpenID Connect
  • 43.9 Browser Syntax Highlighting
  • 43.10 Camel
  • 43.11 Capability Statement (metadata)
  • 43.12 Care Gaps
  • 43.13 CDA Generation
  • 43.14 CDA Import
  • 43.15 CDA Interceptors
  • 43.16 CDA JavaScript Execution Scripts
  • 43.17 CDA Terminology
  • 43.18 CDS Hooks Definitions
  • 43.19 Channel Import
  • 43.20 Channel Retry
  • 43.21 Kafka
  • 43.22 Cluster Manager Maintenance
  • 43.23 Message Broker
  • 43.24 Cluster Level Security
  • 43.25 CQL
  • 43.26 Credentials
  • 43.27 Cross-Origin Resource Sharing (CORS)
  • 43.28 Database
  • 43.29 Da Vinci Health Record Exchange
  • 43.30 DQM
  • 43.31 DTR
  • 43.32 Email Configuration
  • 43.33 Encounter Start CDS hook configuration
  • 43.34 MDM UI
  • 43.35 ETL Import: CSV Properties
  • 43.36 ETL Import: Source
  • 43.37 FHIR Binary Storage
  • 43.38 FHIR Bulk Operations
  • 43.39 Capability Statement
  • 43.40 FHIR Configuration
  • 43.41 Consent Service
  • 43.42 FHIR Endpoint Conversion
  • 43.43 FHIR Endpoint HFQL Support
  • 43.44 Interceptors
  • 43.45 FHIR Endpoint Partitioning
  • 43.46 Resource Providers
  • 43.47 FHIR Endpoint Security
  • 43.48 Endpoint Terminology
  • 43.49 FHIR Gateway Configuration
  • 43.50 FHIR Interceptors
  • 43.51 LiveBundle Service
  • 43.52 FHIR MDM Server
  • 43.53 FHIR Performance
  • 43.54 FHIR Performance Tracing
  • 43.55 FHIR Realtime Export
  • 43.56 Repository Validation
  • 43.57 FHIR Resource Types
  • 43.58 FHIR REST Endpoint
  • 43.59 FHIR Search
  • 43.60 Custom Resource Types
  • 43.61 IG Support
  • 43.62 MegaScale
  • 43.63 FHIR Storage Module Conditional Updates
  • 43.64 FHIR Storage Module Scheduled Tasks
  • 43.65 FHIR Validation Services
  • 43.66 FHIR Storage Package Registry
  • 43.67 FHIR Storage Partitioning
  • 43.68 Versioned References
  • 43.69 FHIR Subscription Delivery
  • 43.70 FHIR Subscription Persistence
  • 43.71 Amazon HealthLake REST Endpoint
  • 43.72 HL7 v2.x Mapper - Contained Resource
  • 43.73 HL7 v2.x Mapper - DG1
  • 43.74 HL7 v2.x Mapper - Forced Namespace Mode
  • 43.75 HL7 v2.x Mapper - General
  • 43.76 HL7 v2.x Mapper - Medications
  • 43.77 HL7 v2.x Mapper - OBR
  • 43.78 HL7 v2.x to FHIR Mapper - OBSERVATION Group
  • 43.79 HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group
  • 43.80 HL7 v2.x Mapper - PID
  • 43.81 HL7 v2.x Mapper - PV1
  • 43.82 Listener Interceptors
  • 43.83 HL7 v2.x Listener Script
  • 43.84 HL7 v2.x MLLP Listener
  • 43.85 HL7 v2.x MLLP Sender
  • 43.86 FHIR to HL7 v2.x Mapper Script
  • 43.87 HL7 v2.x Outbound Mapping
  • 43.88 Da Vinci Health Record Exchange (HRex)
  • 43.89 HTTP Access Log
  • 43.90 HTTP Listener
  • 43.91 HTTP Request Pool
  • 43.92 HTTP Security
  • 43.93 Hybrid Providers Definitions
  • 43.94 Initial User Seeding
  • 43.95 JavaScript Execution Environment
  • 43.96 JSON Web KeySet (JWKS)
  • 43.97 LDAP Authentication
  • 43.98 Smile CDR License
  • 43.99 Lucene FullText Indexing
  • 43.100 MDM
  • 43.101 Narrative Generator
  • 43.102 OpenID Connect Token Validation
  • 43.103 OpenID Connect (OIDC)
  • 43.104 Payer to Payer
  • 43.105 Prior Authorization Coverage Requirement Discovery
  • 43.106 Privacy Security Notice
  • 43.107 Provenance Injection
  • 43.108 Realtime Export
  • 43.109 Endpoint Validation: Request Validating
  • 43.110 Scheduler Configuration
  • 43.111 Search Parameter Seeding
  • 43.112 SAML Provider
  • 43.113 Security Inbound Script
  • 43.114 Inbound SMART on FHIR Authentication
  • 43.115 Inbound SMART on FHIR Endpoints
  • 43.116 OAuth2/OIDC Federation
  • 43.117 SMART Callback Script
  • 43.118 Cross-Organizational Data Access Profile
  • 43.119 SMART Login Skin
  • 43.120 SMART Login Terms of Service
  • 43.121 SMART Authorization
  • 43.122 SMART Definitions Seeding
  • 43.123 Sessions
  • 43.124 Two Factor Authentication
  • 43.125 TLS / SSL (Encryption)
  • 43.126 Transaction Log
  • 43.127 Trusted Client
  • 43.128 User Self Registration
    • 43.23    Message Broker   
       Table of Contents

    Cluster Manager Maintenance

    43.22.1Cluster Manager Maintenance

     

    The Cluster Manager Maintenance configuration category includes the following configurable options:

    • Audit Log Broker Channel Name

    • Audit Log Broker Enabled

    • Always Write to Cluster Manager Log

    • Audit Log Database Async Writes

    • Audit Log Database Enabled

    • Request headers to store

    • Stats Retention (Days) - Day Level

    • Stats Retention (Days) - Hour Level

    • Stats Retention (Days) - Minute Level

    • Transaction Log Retention (Days)

    • Scheduler Thread Count

    • Persist Runtime Monitoring Statistics Enabled

    • Heartbeat Persist Frequency MS

    • Stats Cleanup Frequency MS

    • Stats Persist Frequency MS

    43.22.2Property: Audit Log Broker Channel Name

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

    43.22.3Property: Audit Log Broker Enabled

     
    Property Name Audit Log Broker Enabled
    Property Key
    Property Type BOOLEAN
    Description This setting may be used to submit all audit log events to a message queue.
    Applies to Modules
    • Cluster Manager
    Default Value false
    Example Property 
    module.[MODULE_ID].config.audit_log.broker.enabled = false

    43.22.4Property: Always Write to Cluster Manager Log

     
    Property Name Always Write to Cluster Manager Log
    Property Key
    Property Type BOOLEAN
    Description Forces Smile CDR to always send audit logs to the cluster manager audit database, even if another module of type audit is defined. Normally, creating such a module would disable the builtin audit log in the cluster manager. Setting this setting to true will cause all audit log events to be written to both databases.
    Applies to Modules
    • Cluster Manager
    Default Value true
    Example Property 
    module.[MODULE_ID].config.audit_log.db.always_write_to_clustermgr = true

    43.22.5Property: Audit Log Database Async Writes

     
    Property Name Audit Log Database Async Writes
    Property Key
    Property Type BOOLEAN
    Description If enabled, writing to the audit log will be performed asynchronously, resulting in potentially shorter transaction times and a more efficient use of the database. An in-memory asynchronous queue is used, meaning that there can be a small delay between an auditable action occurring and the audit log being written.
    Applies to Modules
    • Cluster Manager
    Default Value false
    Example Property 
    module.[MODULE_ID].config.audit_log.db.async_writes.enabled = false

    43.22.6Property: Audit Log Database Enabled

     
    Property Name Audit Log Database Enabled
    Property Key
    Property Type BOOLEAN
    Description This setting may be used to disable saving audit logs to all event writers if it is not needed in a given solution design.
    Applies to Modules
    • Cluster Manager
    Default Value true
    Example Property 
    module.[MODULE_ID].config.audit_log.db.enabled = true

    43.22.7Property: Request headers to store

     
    Property Name Request headers to store
    Property Key
    Property Type STRING
    Description This setting can be set to a comma-delimited list of header names that the audit service will extract from the request and store with any Audit Log.
    Applies to Modules
    • Cluster Manager
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.audit_log.request_headers_to_store =

    43.22.8Property: Stats Retention (Days) - Day Level

     
    Property Name Stats Retention (Days) - Day Level
    Property Key
    Property Type NON_NEGATIVE_INTEGER
    Description The number of days that statistics at the day precision will be retained.
    Applies to Modules
    • Cluster Manager
    Default Value 365
    Example Property 
    module.[MODULE_ID].config.retain_day_stats_days = 365

    43.22.9Property: Stats Retention (Days) - Hour Level

     
    Property Name Stats Retention (Days) - Hour Level
    Property Key
    Property Type NON_NEGATIVE_INTEGER
    Description The number of days that statistics at the hour precision will be retained.
    Applies to Modules
    • Cluster Manager
    Default Value 31
    Example Property 
    module.[MODULE_ID].config.retain_hour_stats_days = 31

    43.22.10Property: Stats Retention (Days) - Minute Level

     
    Property Name Stats Retention (Days) - Minute Level
    Property Key
    Property Type NON_NEGATIVE_INTEGER
    Description The number of days that statistics at the minute precision will be retained.
    Applies to Modules
    • Cluster Manager
    Default Value 7
    Example Property 
    module.[MODULE_ID].config.retain_minute_stats_days = 7

    43.22.11Property: Transaction Log Retention (Days)

     
    Property Name Transaction Log Retention (Days)
    Property Key
    Property Type NON_NEGATIVE_INTEGER
    Description The number of days that entries in the transaction log should be retained before being deleted from the database. If blank, the transaction log will be retained indefinitely.
    Applies to Modules
    • Cluster Manager
    • Transaction Log Persistence
    Default Value 7
    Example Property 
    module.[MODULE_ID].config.retain_transaction_log_days = 7

    43.22.12Property: Scheduler Thread Count

     
    Property Name Scheduler Thread Count
    Property Key
    Property Type POSITIVE_INTEGER
    Description The number of threads allocated to processing Scheduled Jobs (both local and clustered). See Scheduler Performance for more information.
    Applies to Modules
    • Cluster Manager
    • FHIR Storage (DSTU2 RDBMS)
    • FHIR Storage (R3 RDBMS)
    • FHIR Storage (R4 RDBMS)
    • FHIR Storage (R5 RDBMS)
    • Subscription Matcher (All FHIR Versions)
    Default Value 4
    Example Property 
    module.[MODULE_ID].config.schedule.thread_count = 4

    43.22.13Property: Persist Runtime Monitoring Statistics Enabled

     
    Property Name Persist Runtime Monitoring Statistics Enabled
    Property Key
    Property Type BOOLEAN
    Description If this is enabled, runtime monitoring statistics will be periodically stored in the database.
    Applies to Modules
    • Cluster Manager
    Default Value true
    Example Property 
    module.[MODULE_ID].config.scheduled_jobs.persist_runtime_monitoring_statistics.enabled = true

    43.22.14Property: Heartbeat Persist Frequency MS

     
    Property Name Heartbeat Persist Frequency MS
    Property Key
    Property Type POSITIVE_INTEGER
    Description How often module health status is persisted to the database
    Applies to Modules
    • Cluster Manager
    Default Value 15000
    Example Property 
    module.[MODULE_ID].config.stats.heartbeat_persist_frequency_ms = 15000

    43.22.15Property: Stats Cleanup Frequency MS

     
    Property Name Stats Cleanup Frequency MS
    Property Key
    Property Type POSITIVE_INTEGER
    Description How often module performance statistics are deleted from the database and collapsed into time interval statistics. Should be greater than stats.stats_persist_frequency_ms
    Applies to Modules
    • Cluster Manager
    Default Value 300000
    Example Property 
    module.[MODULE_ID].config.stats.stats_cleanup_frequency_ms = 300000

    43.22.16Property: Stats Persist Frequency MS

     
    Property Name Stats Persist Frequency MS
    Property Key
    Property Type POSITIVE_INTEGER
    Description How often module performance statistics are persisted to the database. Should be greater than or equal to stats.heartbeat_persist_frequency_ms
    Applies to Modules
    • Cluster Manager
    Default Value 60000
    Example Property 
    module.[MODULE_ID].config.stats.stats_persist_frequency_ms = 60000
       43.21    Kafka
  • Configuration Categories
  • 43.0 Web Admin Console Settings
  • 43.1 appSphere
  • 43.2 Payer Config
  • 43.3 Initial appSphere Seeding
  • 43.4 Authentication Callback Scripts
  • 43.5 Auth: General for APIs
  • 43.6 User Authentication
  • 43.7 Auth: HTTP Basic
  • 43.8 Auth: OpenID Connect
  • 43.9 Browser Syntax Highlighting
  • 43.10 Camel
  • 43.11 Capability Statement (metadata)
  • 43.12 Care Gaps
  • 43.13 CDA Generation
  • 43.14 CDA Import
  • 43.15 CDA Interceptors
  • 43.16 CDA JavaScript Execution Scripts
  • 43.17 CDA Terminology
  • 43.18 CDS Hooks Definitions
  • 43.19 Channel Import
  • 43.20 Channel Retry
  • 43.21 Kafka
  • 43.22 Cluster Manager Maintenance
  • 43.23 Message Broker
  • 43.24 Cluster Level Security
  • 43.25 CQL
  • 43.26 Credentials
  • 43.27 Cross-Origin Resource Sharing (CORS)
  • 43.28 Database
  • 43.29 Da Vinci Health Record Exchange
  • 43.30 DQM
  • 43.31 DTR
  • 43.32 Email Configuration
  • 43.33 Encounter Start CDS hook configuration
  • 43.34 MDM UI
  • 43.35 ETL Import: CSV Properties
  • 43.36 ETL Import: Source
  • 43.37 FHIR Binary Storage
  • 43.38 FHIR Bulk Operations
  • 43.39 Capability Statement
  • 43.40 FHIR Configuration
  • 43.41 Consent Service
  • 43.42 FHIR Endpoint Conversion
  • 43.43 FHIR Endpoint HFQL Support
  • 43.44 Interceptors
  • 43.45 FHIR Endpoint Partitioning
  • 43.46 Resource Providers
  • 43.47 FHIR Endpoint Security
  • 43.48 Endpoint Terminology
  • 43.49 FHIR Gateway Configuration
  • 43.50 FHIR Interceptors
  • 43.51 LiveBundle Service
  • 43.52 FHIR MDM Server
  • 43.53 FHIR Performance
  • 43.54 FHIR Performance Tracing
  • 43.55 FHIR Realtime Export
  • 43.56 Repository Validation
  • 43.57 FHIR Resource Types
  • 43.58 FHIR REST Endpoint
  • 43.59 FHIR Search
  • 43.60 Custom Resource Types
  • 43.61 IG Support
  • 43.62 MegaScale
  • 43.63 FHIR Storage Module Conditional Updates
  • 43.64 FHIR Storage Module Scheduled Tasks
  • 43.65 FHIR Validation Services
  • 43.66 FHIR Storage Package Registry
  • 43.67 FHIR Storage Partitioning
  • 43.68 Versioned References
  • 43.69 FHIR Subscription Delivery
  • 43.70 FHIR Subscription Persistence
  • 43.71 Amazon HealthLake REST Endpoint
  • 43.72 HL7 v2.x Mapper - Contained Resource
  • 43.73 HL7 v2.x Mapper - DG1
  • 43.74 HL7 v2.x Mapper - Forced Namespace Mode
  • 43.75 HL7 v2.x Mapper - General
  • 43.76 HL7 v2.x Mapper - Medications
  • 43.77 HL7 v2.x Mapper - OBR
  • 43.78 HL7 v2.x to FHIR Mapper - OBSERVATION Group
  • 43.79 HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group
  • 43.80 HL7 v2.x Mapper - PID
  • 43.81 HL7 v2.x Mapper - PV1
  • 43.82 Listener Interceptors
  • 43.83 HL7 v2.x Listener Script
  • 43.84 HL7 v2.x MLLP Listener
  • 43.85 HL7 v2.x MLLP Sender
  • 43.86 FHIR to HL7 v2.x Mapper Script
  • 43.87 HL7 v2.x Outbound Mapping
  • 43.88 Da Vinci Health Record Exchange (HRex)
  • 43.89 HTTP Access Log
  • 43.90 HTTP Listener
  • 43.91 HTTP Request Pool
  • 43.92 HTTP Security
  • 43.93 Hybrid Providers Definitions
  • 43.94 Initial User Seeding
  • 43.95 JavaScript Execution Environment
  • 43.96 JSON Web KeySet (JWKS)
  • 43.97 LDAP Authentication
  • 43.98 Smile CDR License
  • 43.99 Lucene FullText Indexing
  • 43.100 MDM
  • 43.101 Narrative Generator
  • 43.102 OpenID Connect Token Validation
  • 43.103 OpenID Connect (OIDC)
  • 43.104 Payer to Payer
  • 43.105 Prior Authorization Coverage Requirement Discovery
  • 43.106 Privacy Security Notice
  • 43.107 Provenance Injection
  • 43.108 Realtime Export
  • 43.109 Endpoint Validation: Request Validating
  • 43.110 Scheduler Configuration
  • 43.111 Search Parameter Seeding
  • 43.112 SAML Provider
  • 43.113 Security Inbound Script
  • 43.114 Inbound SMART on FHIR Authentication
  • 43.115 Inbound SMART on FHIR Endpoints
  • 43.116 OAuth2/OIDC Federation
  • 43.117 SMART Callback Script
  • 43.118 Cross-Organizational Data Access Profile
  • 43.119 SMART Login Skin
  • 43.120 SMART Login Terms of Service
  • 43.121 SMART Authorization
  • 43.122 SMART Definitions Seeding
  • 43.123 Sessions
  • 43.124 Two Factor Authentication
  • 43.125 TLS / SSL (Encryption)
  • 43.126 Transaction Log
  • 43.127 Trusted Client
  • 43.128 User Self Registration
    • 43.23    Message Broker