External Agent COM API Reference Guide › Common Parameter Details › Specification for XmlMessageAttribute Data

Specification for XmlMessageAttribute Data

XmlMessageAttributes is an XML string that specifies additional data to be stored on the CMS as attributes of the imported event. For the current release, two attributes are supported—see below.

The XML string specified by XmlMessageAttributes must conform to the following structure. For the current version of this interface, only two message attributes are supported, ProcessAs and IMNetworkName (highlighted below). Note also that the schema definition is installed automatically when you install the External Agent.

The message attrirubte XML schema differs for the IWgnImportConnector3 and IWgnActiveImportConnector interfaces.

The following is an example of additional information XML for the IWgnImportConnector3 interface:

<?xml version="1.0" encoding="utf-16" ?>
<ImportConnector>
  <AdditionalInputData>
    <ProcessAs>IM</ProcessAs>
    <IMNetworkName>MSN IM</IMNetworkName>
  </AdditionalInputData>
</ImportConnector>

The following is an example of additional information XML for the IwgnActiveImportConnector interface:

<?xml version="1.0" encoding="utf-16" ?>
<apm>
  <event>
    <email>
      <embedding>
        <process_as>IM</process_as>
        <network_name>MSN IM</network_name>
      </embedding>
    </email>
  </event>
</apm>

Where:

ProcessAs / process_as

This attribute defines the event type for item being imported. It can take three possible values:

IM

Flags the imported event as an IM conversation. If ProcessAs is set to IM, the RDI also saves the IM network name, as specified by IMNetworkName.

eFax

Flags the imported event as an electronic fax.

Set ProcessAs is set to eFax when importing fax messages saved as MAPI messages.

Bloomberg

Flags the imported event as a Bloomberg e-mail.

Set ProcessAs is set to Bloomberg when importing Bloomberg e-mails saved as MAPI messages. These are e‑mails that were originally sent using Bloomberg terminals but which have been subsequently saved as MAPI messages.

IMNetworkName / network_name

Note:  This attribute is only supported if ProcessAs is set to IM.

This identifies the name of the IM network associated with the IM conversation being imported. The example above (MSN IM) indicates an import operation for MSN instant messaging data.

Specifically, it defines the string values that get saved in the CMS database. To allow iConsole users to search for IM conversations by IM network, the same string values must be specified in an iConsole search definition file. It is essential that you consistently use the same string for a specific IM network.

For this reason, we strongly recommend that you adhere to strings defined in the XML schema for IMNetworkName. The same strings are used in the iConsole Standard Search to allow users to search by IM network. The strings in the schema are:

"AOL IM"

"Bloomberg"

"GoogleTalk"

"HubConnex"

"ICQ IM"

"IMTrader"

"Indii"

"Jabber"

"Microsoft Exchange IM"

"Mindalign"

"MS LCS IM"

"MSN IM"

"Reuters IM"

"SameTime"

"WebEx"

"Yahoo! IM"

"YahooEE IM"

Note:  If you want to validate attributes for XmlMessageAttributes against the XML schema definition, note that the schema, ImportConnector.XSD, is installed automatically when you install the RDI. You can find this schema in the \Client subfolder of the CA DataMinder installation folder.