EmailRelay <CQDatabase> XML block
The EmailRelay <CQDatbase> XML block contains attributes that the EmailRelay
PostOffice mode uses to establish communication with the Rational®
ClearQuest® Web server. This communication is required
to in order poll the Rational
ClearQuest database for
new EmailPlus email records.
If you configure the EmailRelay application for more than one Rational
ClearQuest user database, there will be a separate
<repository> section for each user database.
Note: When you configure the
EmailRelay application in PostOffice Relay mode, the <repository> section is
ignored.
This example shows how to use the Rational
ClearQuest Web server
parameters:
<CQDatabase>
<repository connection_timeout="30000" dbname="SAMPL" dbset="EmailPlus" is_enabled="yes" keyfile="" password="" payloaddumpdir="C:\EmailRelay" retries="3" socket_timeout="30000" url="http://your.cqweb.com/cqweb/oslc/" username="admin"/>
</CQDatabase>| Attribute name | Description |
|---|---|
| connection_timeout | Contains an integer that specifies in milliseconds how long EmailRelay will
wait before it gives up on a connection request with Rational
ClearQuest Web server. The default value is 30000,
which is 30 seconds. If your Rational
ClearQuest Web
server is heavily utilized, and EmailRelay reports connection timeouts, increase this value. Keep in
mind that it will take longer for email to be sent. Note: For best results,
connection_timeout and socket_timeout should be set to the
same value.
|
| dbname | Contains the Rational ClearQuest User database name. You cannot change the value of this attribute. It is automatically generated based on the parameter that you pass to the -userdb parameter. |
| dbset | Contains the Rational ClearQuest Master database name. You cannot change the value of this attribute. It is automatically generated based on the parameter that you pass to the -dbset parameter. |
| is_enabled | Contains the value yes or no. The default value is yes. You can temporarily change the value of this attribute to disable sending emails for this Rational ClearQuest repository. For example, you can disable sending email notifications when you are doing batch updates. |
| keyfile | Contains the key-file name that has the key
to decrypt the user password that is stored in the password attribute.
You should not need to change the value of this attribute. It is automatically
generated for you based on the value of the -relaycfgdir parameter. Important: If you change the value of this attribute, such as
the file name or directory path, you must also make the same change
to the physical key file.
|
| password | Contains the Rational
ClearQuest user’s encrypted password. Note: You cannot change the value of this attribute. It is
automatically generated based on the parameter that you pass to the -password
parameter.
|
| payloadddumpdir | Contains the directory into which the payload
is dumped. The payload is the email data that is being received from
the EmailPlus package. The value of this attribute is based on the
value of the -dumppayload attribute. You can change
the value of this attribute to specify a different location. Note: This
attribute is optional. The attribute is generated only when the -dumppayload attribute
is used. Use the attribute only to debug EmailRelay application issues.
|
| retries | Contains an integer larger than -1. This value represents the number of attempts to retry communicating to the Rational ClearQuest Web server when a connection attempt fails. The default value is 3. You can change the value of this attribute. If there are communication problems between the EmailRelay application and your Rational ClearQuest Web server, increase the value of this attribute. |
| socket_timeout | Contains an integer that specifies in milliseconds how long EmailRelay will
wait before it gives up on a socket connection request with Rational
ClearQuest Web server. The default value is 30000,
which is 30 seconds. If your network environment and Rational
ClearQuest Web server are heavily utilized, and
EmailRelay reports connection timeouts, increase this value. Keep in mind that it will take longer
for email to be sent. Note: For best results, connection_timeout and
socket_timeout should be set to the same value.
|
| url | Contains the URL that the EmailRelay server uses to poll the Rational ClearQuest database for new EmailPlus email records. This attribute value is generated automatically based on the value of the -servername attribute. You can change the value of this attribute. You might change the value, for example, when your Rational ClearQuest Web server location has changed and you want the change reflected in this XML block without running the cqemailrelay.pl script. |
| username | Contains the name that Rational ClearQuest uses when the EmailRelay application connects to the Rational ClearQuest Web server. The value of this attribute is automatically generated based on the parameter that is passed to the -password attribute. |