External Agent COM API Reference Guide › About the External Agent COM API

About the External Agent COM API

Note: The interface defined in this specification uses Microsoft COM so is only suitable for use on Windows platforms. A socket-based API is also available for CA DataMinder; this is described in the CA DataMinder External Agent Socket API, available from CA Technical Support: http//ca.com/support

The External Agent API facilitates third party integration with CA DataMinder and smart tag metadata. Specifically, it enables third party applications to pass messages to CA for policy processing and, if required, to store the resulting smart tag metadata with the archived message. Events corresponding to these policy-processed messages can also be stored on a CMS, from where they can be retrieved, reviewed and audited using the iConsole or Data Management console.

Note use of the following terms:

• Caller is a third party application passing e-mails to the External Agent. The caller is sometimes also referred to as the 'calling application' or 'client'.
• Savable e-mail is an e-mail that would normally be saved in the CMS database. Specifically, while being processed by a policy engine the e-mail activated a policy trigger that was configured to save e-mail events in the CMS database.
• Smart tags are used by CA DataMinder to categorize captured events.

This section contains the following topics:

Which Interfaces Do I Use?

WgnActiveImportConnector Object

WgnImportConnector Object

Interface Versions

WgnImportObject Object

Smart Tags