SanteSuite Help Portal
Search…
SanteSuite Help Portal
SanteSuite Help Portal
Product Overview
SanteSuite Products
Architecture
SanteDB Architecture
Solution Architecture
Software Architecture
Data & Information Architecture
Security Architecture
Privacy Architecture
Matching Engine
HIE & Interoperability
Installation
Installation
Releases
Quick Start Guide
Operationalizing SanteDB
Demonstration Environment
Operations
SanteDB Operations
Server Administration
Configuration Tool
Server Configuration File
SanteDB iCDR Host Command
Backup Procedures
Log File Management
CDR Administration
Standard Operating Procedures
User Guides & Training
SanteDB User Guides
Common User Interface Elements
SanteMPI
SanteGuard
Developers
Extending SanteSuite
Getting Started
Applets
.NET Plugins
Service APIs
SanteDB Software Publishers
Knowledgebase
Knowledgebase
Fixes & Patches
OpenIZ
About OpenIZ
FAQ
OpenIZ Demonstration Servers
Powered By GitBook
SanteDB iCDR Host Command
The SanteDB iCDR server runs via the SanteDB.exe file located in the following default installation directories:
  • Microsoft Windows Operating Systems: C:\Program Files\SanteSuite\SanteDB\Server\SanteDB.exe
  • Linux Operating Systems: /opt/santesuite/santedb/server/SanteDB.exe
This process can be used to operate one or more IMS services.

Getting Started

Configuration of Host

When you install the SanteDB iCDR server, the application (by default) has no configuration file. The default configuration file is santedb.config.xml , this file can be created by running ConfigTool.exe (as illustrated here) .
For more information, see the SanteDB Configuration documentation.

Command Options

The following options can be used on the SanteDB.exe command
Option
Use
Example
--console
Run as an application rather than a service.
--console
--test-startup
Tests the configuration file (for startup) then stops .
--test-startup
--name=INSTANCE
Named instance to configure as a windows service
--name=IMS1
--config=file
Load an alternate configuration file
--config=myconf.xml
--genconfig
Generate an empty configuration file.
​
--install-certs
Install the SanteSuite community certificates into the local trust store for the server
​

Running in Linux / MacOS

To run the SanteDB.exe process in a terminal you can the following command:
mono /opt/sante-suite/santedb/server/SanteDB.exe --console
Additionally the service can be installed into your operating system by copying the service definition from /opt/santesuite/santedb/server/santedb.service to your distribution's appropriate directory.
Then you can control the service by running:
systemctl start santedb

Folder Structure

The SanteDB iCDR server uses a folder structure as illustrated below.
The folders are:
  • applets - Applet PAK files which control the behavior, business rules, BI definitions, and common user interface elements. These files are documented more in the Applets wiki page.
  • data - Dataset files which are installed by the SanteDB host service on start. These files contain common terminology, identity domains, places, etc. See the Dataset Files wiki page.
  • plugins - This folder is used by FirebirdSQL to load custom SQL plugins.
  • queue - This folder is the default location of the file-system based persistent queue service. This directory stores outbound messages and has a dead-letter queue for retry.
    • Note: Future persistent queue plugins may use databases or queue technologies in lieu of this directory.
  • match - This folder contains one or more match definition files and is the default directory for the file system match configuration provider.
    • Note: Future match configuration providers will use databases or other technologies for storing/reading match configurations.
  • sql - This folder contains SQL files that you will need to deploy the SanteDB databases including:
    • fbsql/ - Core SQL in Firebird SQL syntax to create a new database
    • psql/ - Core SQL in PL/PGSQL syntax to create a new database
    • updates/ - Patches to the database which should be applied in-order
​
​
Previous
Data Quality Services
Next
Backup Procedures
Last modified 2mo ago
Copy link
Contents
Getting Started
Configuration of Host
Command Options
Running in Linux / MacOS
Folder Structure