3.2Global parameters of cmsWorks
The global parameters for cmsWorks can be found in the properties-file <cmsWorks-installdir>/run/topas.properties. The exception to this rule are the RemoteHosts and CMSIdentification in the file <cmsWorks-installdir>/run/properties/cms.properties and the email properties which can be found at <cmsWorks-installdir>/run/properties/email.properties.
The telnet server port
To start up, cmsWorks needs at least one port on the host machine, otherwise starting will fail with an error. The port's standard value is 8050, if this port is taken on the server, it's value can be altered in property-file <cmsWorks-installdir>/run/topas.properties, the parameter name is /com/itechworks/topas/server/telnet/Port. The parameter /com/itechworks/topas/server/telnet/Password that contains the telnet-server password (default: "topas") should definitely be altered at the beginning, too.
cmsWorks server instance, customer folder, remote preview port and root folder name
You should change the name of the cmsWorks server-instance in the topas.properties - file by altering the line /com/itechworks/topas/server/name=<cmsWorks-instance-name>, thereby allocating a unique <cmsWorks-instance-name>.
Additionally, you should change the parameter "Customer" in the file <cmsWorks-installdir>/run/properties/cms.properties (cms.properties) at /app/cmsworks/service/cms/CMSCore/Customer=<myCustomerName> to a valid yet short customer name without special chars (i.E. whitespace or "/"). This is necessary for the UI customization, so please create the folder <cmsWorks-installdir>/htdocs/webui/cmsdesk.custom.<myCustomerName> too.
The CMSIdentification parameter (/app/cmsworks/service/webui/CMSWebUI/CMSIdentification) in the file cms.properties let you change the name of the absolute root folder in the cmsWorks explorer.
It is not necessary to restart the whole server after the parameters "CMSIdentification" and/or "RemoteHosts" were changed, a simple restart of the CMSWebUI service from the telnet server via "service restart CMSWebUI" will do the job. But remember to logout and re-login to the cmsWorks editors desktop so that the changes can apply.
In case the preview and the cmsWorks editors desktop are running on different (sub)domains, the parameter /app/cmsworks/service/webui/CMSWebUI/ForcedHost=<domain-of-the-cmsWorks-desktop> can be used, so that the preview knows the correct location of the cmsWorks editors desktop and the UI-link functions work properly.
Email parameters
The cmsWorks-server, especially the services of cmsWorks are capable to send emails in case a not solvable problem may occur (i.e. the database is not reachable, memory ran out etc.). To be able to send such mails, a reachable, external SMTP mail server is needed and the email configuration has to be done correctly for an existing email-address.
The parameters are:
Entry | Description |
/com/topasworks/server/email/Sender | The name of the sending mail account |
/com/topasworks/server/email/Recipients | Recipients of mails, separated by a semicolon |
/com/topasworks/server/email/SMTPServerConfigurationProperties | Path to a properties file containing all parameters SMTP needs for sending emails |
/com/topasworks/server/email/MaxRetries | Retry count if initial mail sending fails |
/com/topasworks/server/email/SendWaitTime | Retry waiting time if sending failed |
/com/topasworks/server/email/EmailShutdownTimeout | Timeout to wait before shutdown to send mails |
If the parameters are set correctly and the cmsWorks-server is restarted, you may test email sending via the telnet command 'email send "Test subject" "Test text"'.
The "SMTPServerConfigurationProperties" points to a file having the credentials for SMTP mailing. For a host like, for example, "smtp.myserver.com" the parameters would look like:
Entry | Description |
mail.smtp.host | The smtp host domain, like "smtp.myserver.com" |
| mail.smtp.port | The smtp port of the SMTP server, i.e. 465 |
| mail.smtp.ssl.trust | In case you need to "trust", the domain of the trusted server, like "smtp.myserver.com" |
| mail.smtp.starttls.enable | If starttls shall be enabled |
| mail.smtp.ssl.enable | If SSL is enabled on your SMTP server |
| mail.smtp.auth | In case the server demands transport of SMTP over SSL/TLS (true or false) |
| account.user | Normally analogous to "/com/topasworks/server/email/Sender", see above |
| account.password | The password the user account needs to send mails. |
So in this case the smtp property file assembled would look like this (replace the values in the angle brackets through your own configuration values and drop the brackets):
mail.smtp.host=<smtp.myserver.com>
mail.smtp.port=465
mail.smtp.ssl.trust=<smtp.myserver.com>
mail.smtp.starttls.enable=true
mail.smtp.ssl.enable=true
mail.smtp.auth=true
account.user=<sendingusermailaddress>@<cmsworksserver>.com
account.password=<password>
It is not necessary to restart the server, if not desired. Instead login to the telnet server of cmsWorks and use the email command to set the correct parameters. The command "help email" shows the necessary commandline options for the email-command.
You may alter the parameters on the fly, but do not forget to edit the "emails.properties" file accordingly to persist the changes for the next server restart.