Configuring the CA Service Desk monitor adapter
You configure an adapter in BMC Atrium Orchestrator Grid Manager. The configuration provides information about how the adapter interacts with CA Service Desk. Although each adapter must have a unique name, you can create multiple adapters with the same adapter type to allow for different configuration properties.
The form view provides an easy-to-use interface for configuring adapters. The form view prevents errors that might occur when you copy the configuration XML from the adapter documentation to the UI during configuration. You can switch to the XML view to configure those elements and attributes that are not available as fields or to configure all the elements and attributes using XML only. However, after you switch to the XML view and save the configuration in XML from that view, you cannot thereafter use the form view to modify that configuration.
To configure the monitor adapter
- Log on to BMC Atrium Orchestrator Grid Manager.
- To access the adapters page, click the Manage tab, and then click the Adapters tab.
- In the Adapters in Repository list, select the bmc-adapter-ca-servicedesk-monitor check box.
- To include the adapter in the Adapters on Grid list, click Add to Grid.
- Click Configure corresponding to the newly added adapter.
- On the Add an Adapter Configuration page, perform the following steps to configure the adapter by using the form view, or skip to step 7 to configure the adapter by using the XML view:
- Enter a name for the adapter.;
- Enter a description for the adapter.
- Under Properties, enter or select values for the configuration elements.
Include all required elements, which are indicated with an asterisk (*). - Click OK.
The newly configured adapter is now listed in the Adapters on Grid list.
(Optional) Configure the adapter in the XML view by performing the following steps:
Note
If you switch to the XML view, you cannot thereafter use the form view to modify the configuration.
- Enter a name and a description for the adapter.
- Click Switch to XML View.
- On the warning message that appears, click Switch View.
In the Properties text box, use XML format to enter the configuration elements and attributes, and then click OK.
Note
If the default value for an optional element is acceptable, omit the element. Do not include empty elements.
- On the warning message that appears, click Save.
The adapter configuration with settings is saved in the XML view permanently. The newly configured adapter is now listed in the Adapters on Grid list.
The following table describes the configuration elements for the monitor adapter. You cannot use the form view to configure elements and attributes that do not have an entry in the UI label column.
Node elements required for configuring the monitor adapter
UI label | Element | Description | Required |
|---|---|---|---|
Target |
| Specifies the host name or the IP address of the IMAP server | Yes |
Port |
| Specifies the port on which the IMAP server listens | No |
User Name |
| Specifies the user name for the account to be monitored | Conditional; required when the email application requires authentication |
Password |
| Specifies the password that corresponds to the | Conditional; required when the email application requires authentication |
Encryption Type |
| Indicates whether the password specified is encrypted; is an attribute of the | No |
Character Set |
| Specifies the supporting character set (CharSet), which includes identifiers that describe a series of universal characters | No |
Javamail Debug |
| Indicates that debug message logging for JavaMail must be turned on | No |
Email Address |
| Specifies the email address of the account to be monitored | Yes |
Protocol |
| Specifies the email protocol to be used | Yes |
Refresh |
| Specifies the interval, in seconds, for checking for new messages | No |
Mail Timeout |
| Specifies the time, in seconds, to maintain an established connection | No |
Connection Timeout |
| Specifies the time, in seconds, to wait when establishing a connection | No |
Process All Unread Emails |
| Specifies whether to read the unread messages that are received when the adapter is inactive | No |
Disable Auth Login |
| Prevents the use of a nonstandard | No |
Disable Auth Plain |
| Prevents the use of the | No |
Ignore Attachments |
| Indicates whether attachments must be ignored and excluded from the adapter event | No |
Expand Htmltext Attachment |
| Specifies whether the HTML data content of a message that is sent as an attachment appears in the | No |
Expand Plaintext Attachment |
| Specifies whether the plain text content of a message that is sent as an attachment appears in the | No |
Create Subdirectory |
| Indicates whether each attachment must be downloaded into a separate directory
| No |
Attachment Download Directory |
| Specifies the path and the directory into which attachments on the monitored email messages are downloaded | No |
Attachment Overwrite Existing |
| Indicates whether an attachment with the same file name has already been downloaded and overwrites that file with the current attachment | No |
Attachment Ttl |
| Specifies the time an attachment is permitted to reside in the download directory before being deleted | No |
Max Attachment Size |
| Specifies the maximum file size, in MB, that can be attached to a mail message | No |
Max Pool Threads |
| Specifies the maximum number of threads that can be used to download attachments in parallel | No |
Delete Attachments On Exit |
| Deletes all downloaded attachments when the adapter is stopped or disabled | No |
Disk Cleanup Interval |
| Specifies the interval at which the deletion of attachments that have exceeded the | No |
File Name Filter |
| Contains the elements that specify the file name criteria for downloading an attachment | Conditional; required if the |
File Name |
| Specifies the criteria for an attached file to be downloaded, based on the file name
| No |
File Type Filter |
| Contains the elements that specify the file type criteria for downloading a file attachment | Conditional; required if the |
File Type |
| Specifies the criteria for file download, based on the file type
| No |
Use Ssl Certificate |
| Specifies whether SSL certificates are used for authentication Note To establish a secure connection with the specified target, set this element to true. | No |
Allow Unsigned Certificates |
| Specifies whether unsigned certificates are permitted for SSL authentication Note If If you are using self-signed SSL certificates (a common practice), set the value of this element to true. | No |
Install Certificate |
| Updates the default keystore file, java.Home\jre\lib\security\cacerts, with the certificates sent by the target URL during the SSLHandshake Note If <use-ssl-certificate> is false or blank, you do not need this element. If you prefer to have security certificates installed automatically (a common practice), set the value of this element to true. If you prefer to manually export the security certificate from the specified target server and manually import it into the BMC Atrium Orchestrator's local peer's cacerts file (a rare practice), set the value of this element to false. | No |
Passphrase |
| Specifies the password to the keystore file (cacerts) local to the BMC Atrium Orchestrator peer. Note If <use-ssl-certificate> is false or blank, you do not need this element. This value must match the passphrase in the keystore. You can change the passphrase using keytool. If you make a change, you must update this value to reflect the new passphrase. | No |
Ignore Peer Name In Attachment |
| Specifies whether to add or remove the peer name from an email event XML Notes
| No |
Note
The IMAP mail adapter supports the following message formats for the content of an email:
- Plain text
- HTML
XML sample for configuring the monitor adapter
<config name="config1">
<target>machine.domain.com</target>
<port>993</port>
<user-name>casd12345</user-name>
<password>service</password>
<javamail-debug>true</javamail-debug>
<email-address>casd12345@domain.com</email-address>
<protocol>imap</protocol>
<refresh>20</refresh>
<mail-timeout>10</mail-timeout>
<connection-timeout>3</connection-timeout>
<disable-auth-login>true</disable-auth-login>
<disable-auth-plain>true</disable-auth-plain>
<ignore-attachments>false</ignore-attachments>
<create-subdirectory>true</create-subdirectory>
<attachment-overwrite-existing>false</attachment-overwrite-existing>
<attachment-ttl>1d</attachment-ttl>
<max-attachment-size>5</max-attachment-size>
<max-pool-threads>2</max-pool-threads>
<delete-attachments-on-exit>true</delete-attachments-on-exit>
<disk-cleanup-interval>5m</disk-cleanup-interval>
<use-ssl-certificate>true</use-ssl-certificate>
<allow-unsigned-certificate>true</allow-unsigned-certificate>
<install-certificate>true</install-certificate>
<passphrase>changeit</passphrase>
<ignore-peer-name-in-attachment>true</ignore-peer-name-in-attachment>
</config>
Comments
Log in or register to comment.