Apply application rules

The application rules are applied by the CCM_Registration standard process as the first step of the application request processing. For correspondence and import requests, the application rules are not put into use.

The application rules are used one by one on the application events for the request. If a rule matches, it can either create a correspondence or explicitly ignore the event, preventing further rules from being applied. Multiple rules can match on a single event, so you can create multiple correspondences for the same event.

The application rules are applied to an XML serialization of the application events that are being processed by the CCM_Registration standard process. This XML serialization is defined by the ApplicationEvent complex type in the CcmBomRequest XSD. You can find the B&OM XSD files in: <deploy root>\KCM\Documentation\<KCM version>\Resources\Schemas\Output Management.

Example

<ccm:ApplicationEvent Reference="AEV_4894" Brand="BR22"
                                          Application="MyApp1" Process="P1" Event="EV_4894_19"
                                          xmlns:ccm="http://www.kofax.com/ccm"
                                          xmlns:dbb="http://www.kofax.com/ccm/dbb" 
                                          xmlns:ct="http://www.kofax.com/ccm/ct"
                                          xmlns:data="http://www.kofax.com/ccm/data">
    <ccm:Recipients>
      <ccm:Recipient Type="Customer">
        <ct:Name>M.L. Surname</ct:Name>
        <ct:Street>Sunny Avenue 12</ct:Street>
        <ct:Zipcode/>
        <ct:Country>HolidayResolt</ct:Country>
      </ccm:Recipient>
      <ccm:Recipient Type="Intermediary">
        <ct:Name>H.T. Work</ct:Name>
        <ct:Street>Busy Lane 52</ct:Street>
        <ct:Zipcode>ABCD 78</ct:Zipcode>
        <ct:Country>OfficeLand</ct:Country>
      </ccm:Recipient>
    </ccm:Recipients>
    <ccm:OrganisationalMetadata>
        <data:Key1>value</data:Key1>
    </ccm:OrganisationalMetadata>
    <ccm:DataBackbone>
      <dbb:Data_Backbone>
         <dbb:Part>17</dbb:Part>
         <dbb:System>S45</dbb:System>
      </dbb:Data_Backbone>
    </ccm:DataBackbone>
    <ccm:OptionalDocuments>
        <ccm:OptionalDocument>Terms&amp;Conditions</ccm:OptionalDocument>
    </ccm:OptionalDocuments>
  </ccm:ApplicationEvent>

The following information of the application event is available to the application rules:

  • Properties of the application event: reference, application, process, event, and brand, if any
  • Contact data of the sender, if any
  • Type and contact data of the allowed recipients
  • Organisational metadata
  • Data Backbone
  • Optional documents
  • Import documents, if any (not shown in the preceding example)