Create the TypeDoc

A TypeDoc is an XML file that contains entity type definitions. Entity type definitions describe the format of data associated with a configurable item. For more details on entity types, see Entity types.

All TypeDocs for custom filters must:

  • Extend the Filter type
  • Define a constant filter class (for example, JabberFilter)
  • List the configuration fields for the entity

The following example shows how the TypeDoc lists the various fields that form the configuration data for the JabberFilter.

  <entityType name="JabberFilter" extends="Filter">
      <constant name="class" type="string" 
      <field name="fromEmailAddress" type="string" cardinality="1"/>
      <field name="password" type="string" cardinality="1"/>
      <field name="resourceName" type="string" cardinality="1"/>
      <field name="toEmailAddress" type="string" cardinality="1"/>
      <field name="messageStr" type="string" cardinality="1"/>

You can also provide internationalized log messages by specifying an <entity> block of type InternationationalizationFilter in the <entityStoreData> elements. For example:

 <!-- Internationalization for logging / audit trail -->
 <entity xmlns="" 
    <key type="Internationalization">
        <id field="name" value="Internationalization Default"/>
    <fval name="type">
    <fval name="logFatal">
        <value>Error in the Jabber Filter sending instant message. 
          Error: ${circuit.exception}</value>
    <fval name="logFailure">
        <value>Failed in the Jabber Filter sending instant message</value>
    <fval name="logSuccess">
        <value>Success in the Jabber Filter sending instant message</value>

Related Links