
	Version 9.6	SEARCH CONTENTS \| PDF BOOKS \| HOME UP PREV NEXT

— Basic Operations —

Configuring the Email Server

Certain facilities within CentraSite communicate information to users using email (the Send Email Notification policy action, for example). These facilities will not function properly until you configure CentraSite's email settings. These settings specify the Simple Mail Transport Protocol (SMTP) server that CentraSite is to use for sending outgoing email messages.

Configuring the Email Server Settings

Use the following procedure to specify the email server settings for CentraSite. To perform this procedure, you must know the name (or IP address) of the email server that CentraSite is to use and the port number on which that server listens for SMTP requests. If the email server is configured to authenticate users, you must additionally provide the user ID and password that CentraSite is to use to log on to the server.

You can configure the email server settings by executing the following commands in the command line interface CentraSiteCommand.cmd (Windows) or CentraSiteCommand.sh (UNIX) of Command Central. The tool is located in <CentraSiteInstallDir>/utilities.

If you start this command line tool with no parameters, you receive a help text summarizing the required input parameters.

The parameters of the command are case-sensitive, so for example the parameter "-url" must be specified as shown and not as "-URL".

To configure the email server settings

Create an XML configuration file that contains the following predefined properties. This file should be in Java XML properties format. For example:

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties version="1.0">
  <entry key="com.centrasite.config.email.SMTPHost">localhost</entry>
  <entry key="com.centrasite.config.email.SMTPPort">25</entry>
  <entry key="com.centrasite.config.email.ReplyTo">noreply@editthisdomain.com</entry>
  <entry key="com.centrasite.config.email.ConnectionTimeout">20</entry>
  <entry key="com.centrasite.config.email.Authentication">false</entry>
  <entry key="com.centrasite.config.email.User">xyz</entry>
  <entry key="com.centrasite.config.email.Password">xyz</entry>
  <entry key="com.centrasite.config.email.TransportLayerSecurity">false</entry>
  </properties>

Descriptions of these properties are as follows:

In this field...	Specify...
SMTPHost	The name or IP address of the machine on which the SMTP server is running.
SMTPPort	The port on which the machine specified in SMTP Host listens for SMTP requests.
ReplyTo	The email address to which responses to the emails sent by CentraSite are to be directed. CentraSite uses this address to populate the "From" email header in the emails that it sends.
ConnectionTimeout	The number of seconds that CentraSite will wait for the email server to accept a connection request. If the email server does not respond within the specified time period, CentraSite writes an error message to the console and discards the email.
Authentication	Whether the SMTP server authenticates users. Set Authentication to "yes" if authentication is enabled on the SMTP server. If you set this field to "yes", you must specify the appropriate log-on credentials in the User and Password fields below.
User	The user ID that CentraSite is to use to log on to the SMTP server. This value is required only when Authentication is set to "yes".
Password	The password that CentraSite is to use when it logs on to the SMTP server. This value is required only when Authentication is set to "yes".
TransportLayerSecurity	If true, enables the use of the `STARTTLS` command (if supported by the server) to switch the connection to a TLS-protected connection before issuing any login commands. Note that an appropriate trust store must configured so that the client will trust the server's certificate. Defaults to false.

Execute the following command in this format:

CentraSiteCommand set Email [-url <CENTRASITE-URL>] -user <USER-ID> -password
<PASSWORD> -file <CONFIG-FILE>

The following table describes the complete set of input parameters that you can use with the set Email utility:

Parameter	Description
-url	The fully qualified URL (http://localhost:53307/CentraSite/CentraSite) for the CentraSite registry/repository.
-user	The user ID of a user who has the "CentraSite Administrator" role.
-password	The password of the user identified by the parameter "-user".
-file	The URI (file: or http:) of the configuration file.

For example:

CentraSiteCommand set Email [-url "http://localhost:53307/CentraSite/CentraSite"] -user "Administrator" -password
"manage" -file "config.xml"

Getting the Email Server Settings

You can get (retrieve) the email server settings by executing a command in the command line interface of Command Central.

To get the settings, execute the following command, which will print the configuration:

CentraSiteCommand.sh get Email [-url <CENTRASITE-URL>] -user <USER-ID> -password
<PASSWORD> -file <CONFIG-FILE>

The following table describes the complete set of input parameters that you can use with the get Email utility:

Parameter	Description
-url	The fully qualified URL (http://localhost:53307/CentraSite/CentraSite) for the CentraSite registry/repository.
-user	The user ID of a user who has the "CentraSite Administrator" role.
-password	The password of the user identified by the parameter "-user".
-file	The URI (file: or http:) of the configuration file.

For example:

CentraSiteCommand.sh get Email [-url "http://localhost:53307/CentraSite/CentraSite"] -user "Administrator" -password
"manage" -file "config.xml"

SEARCH CONTENTS | PDF BOOKS | HOME UP PREV NEXT