Understanding the installation result
- Timo Fuchs
Files and directories
Important directories
The installation will create a directory “UM” in the given installation path. All files needed by the Universal Messenger will be located within this directory. The following paths will be given relative to that directory.
Path | Description |
|---|---|
cmsbs-conf/ | Base path for all configuration files |
cmsbs-conf/cse/ | Core Scripting Engine (basic API + individual project extensions) |
cmsbs-work/ | Working directory and log files |
scripts/ | Helper scripts |
Important files
Path | Description |
|---|---|
cmsbs-conf/cmsbs.properties | Main application configuration file |
cmsbs-conf/cmsbs.sender.csv , cmsbs.replyto.csv | CSV files with all licensed sender e-mail addresses |
cmsbs-conf/cmsbs.license | Your license file |
cmsbs.pid | If the Universal Messenger is running, it’s PID will be stored in that file. As long as this file exists you cannot start (another) Universal Messenger. |
Log files
Path | Description |
|---|---|
cmsbs-work/sys.log | General system log file |
cmsbs-work/cse.log | Log file for all CSE functions |
cmsbs-conf/bounce.log | Log file for bounce information |
Hint: All relevant log files can be viewed in the GUI as well.
Optional log files
The contents of all outgoing e-mails can be logged into local log files. Note that this will have an effect on e-mail sending speed and can quickly fill your file system. You can turn the logging on and off by creating an empty file with that name or remove the file.
Path | Description |
|---|---|
cmsbs-work/mail-out.log | Logging all regular outgoing e-mails (transaction mails, double opt-in mails etc.) |
cmsbs-work/mail-news-out.log | Logging all outgoing newsletter e-mails |
Tomcat integration
If you are using the embedded Tomcat all files will be “hidden” within the UM base directory. The Universal Messenger will act as a self-contained application.
If you are using an external Tomcat, the Universal Messenger installation will have registered a context file $TOMCAT_HOME/conf/Catalina/localhost/cmsbs.xml which defines the base directory “UM” as the application root.
Start and stop
Embedded Tomcat
Start: UM/scripts/startup.sh
Stop: UM/scripts/shutdown.sh
External Tomcat
Starting and stopping the external Tomcat will also start or stop the UM application.