ulexsn:MatchSubscription

A subscription to new or modified Data Items that match a search query.  The end user specifies search terms, and the notification producer delivers a notification every time one or more Data Items are created or modified that match those search terms. This can include any kind of search supported by the publisher, including a structured query, a text query, or a metadata search.  For example, if the end user specifies "first name is John and last name is Doe", a notification will be produced whenever a new or modified Data Item appears that includes the first name John and the last name Doe.

Element information

Namespace: http://ulex.gov/subscribenotify/2.0

Schema document: ulex.gov/ulex-subscribe-notify/2.0/ulex-subscribe-notify.xsd

Type: ulexsn:SubscriptionType

Properties: Global, Qualified

Content

Sequence [1..1]
1. ulex:SNMessageMetadata [1..1]Metadata about a ULEX subscription/notification message.
2. ulex:SearchRequestMetadata [0..1]Metadata about a search request. This metadata is used in StructuredSearchRequestMessage in a doStructuredSearch request and in TextSearchRequestMessage in a doTextSearch request.
3. Choice [0..1]
4. Choice [1..1]

Attributes

None

Used in

Type wsnt:FilterType (Element wsnt:Filter)

Substitution hierarchy

ulexsn:SubscriptionAbstract
- ulexsn:DataItemRetrievalSubscription
- ulexsn:DataItemSearchSubscription
- ulexsn:IdenticalSearchSubscription
- ulexsn:MatchSubscription
- ulexsn:SimilarSearchSubscription
- ulexsn:TopicSubscription

Sample instance

<ulexsn:MatchSubscription>
   <ulex:SNMessageMetadata>
      <ulex:ULEXFrameworkVersionText>2.0</ulex:ULEXFrameworkVersionText>
      <ulex:ULEXImplementation>
         <ulex:ULEXImplementationVersionText>4.0</ulex:ULEXImplementationVersionText>
         <ulex:ULEXImplementationName>LEXS</ulex:ULEXImplementationName>
      </ulex:ULEXImplementation>
      <ulex:MessageDateTime>2006-12-17T09:30:47.0Z</ulex:MessageDateTime>
      <wsa:MessageID>http://www.cjis.fbi.gov/OneDOJ/413</wsa:MessageID>
      <wsa:To>http://www.cjis.fbi.gov/N-DEx/NotificationService</wsa:To>
      <wsa:ReplyTo>
         <wsa:Address>http://www.cjis.fbi.gov/OneDOJ/017</wsa:Address>
      </wsa:ReplyTo>
      <wsa:Action>http://docs.oasis-open.org/wsn/bw-2/NotificationProducer/SubscribeRequest</wsa:Action>
      <ulex:MessageOriginMetadata>
         <lexs:SystemIdentifier>
            <nc:OrganizationName>Hypothetical Organization F</nc:OrganizationName>
            <lexs:SystemID>SysF</lexs:SystemID>
         </lexs:SystemIdentifier>
         <lexs:SystemContact>
            <nc:PersonGivenName>Bob</nc:PersonGivenName>
            <nc:PersonSurName>Jones</nc:PersonSurName>
            <nc:ContactTelephoneNumber>
               <nc:FullTelephoneNumber>
                  <nc:TelephoneNumberFullID>404-555-1212</nc:TelephoneNumberFullID>
               </nc:FullTelephoneNumber>
            </nc:ContactTelephoneNumber>
         </lexs:SystemContact>
      </ulex:MessageOriginMetadata>
      <lexs:MessageDestinationIdentifier>
         <nc:OrganizationName>Hypothetical Organization E</nc:OrganizationName>
         <lexs:SystemID>SysE</lexs:SystemID>
      </lexs:MessageDestinationIdentifier>
   </ulex:SNMessageMetadata>
   <ulex:SearchRequestMetadata>
      <lexs:RequestedDataCategoryCode>Person</lexs:RequestedDataCategoryCode>
      <ulex:MaxItemMatchesNumeric>10</ulex:MaxItemMatchesNumeric>
      <lexs:SortOrderCode>Date</lexs:SortOrderCode>
      <ulex:StructuredPayloadsRequestedCode>none</ulex:StructuredPayloadsRequestedCode>
   </ulex:SearchRequestMetadata>
   <lexs:UserAssertion>
      <lexs:UserID>ABC123</lexs:UserID>
      <nc:PersonGivenName>Bill</nc:PersonGivenName>
      <nc:PersonSurName>Jones</nc:PersonSurName>
      <nc:ContactTelephoneNumber>
         <nc:NANPTelephoneNumber>
            <nc:TelephoneAreaCodeID>111</nc:TelephoneAreaCodeID>
            <nc:TelephoneExchangeID>222</nc:TelephoneExchangeID>
            <nc:TelephoneLineID>3333</nc:TelephoneLineID>
         </nc:NANPTelephoneNumber>
      </nc:ContactTelephoneNumber>
      <nc:OrganizationName>ATF</nc:OrganizationName>
   </lexs:UserAssertion>
   <ulex:SubscriptionStructuredQuery>
      <ulex:StructuredQuery>
         <ulex:DigestQueryStatement>
            <lexs:DigestQueryField>
               <lexsdigest:EntityPerson>
                  <lexsdigest:Person>
                     <nc:PersonName>
                        <nc:PersonSurName>Jones</nc:PersonSurName>
                     </nc:PersonName>
                  </lexsdigest:Person>
               </lexsdigest:EntityPerson>
            </lexs:DigestQueryField>
            <ulex:QueryMatchCode>exact</ulex:QueryMatchCode>
         </ulex:DigestQueryStatement>
         <ulex:DigestQueryStatement>
            <lexs:DigestQueryField>
               <lexsdigest:EntityPerson>
                  <lexsdigest:Person>
                     <nc:PersonName>
                        <nc:PersonGivenName>Tommy</nc:PersonGivenName>
                     </nc:PersonName>
                  </lexsdigest:Person>
               </lexsdigest:EntityPerson>
            </lexs:DigestQueryField>
            <ulex:QueryMatchCode>exact</ulex:QueryMatchCode>
         </ulex:DigestQueryStatement>
      </ulex:StructuredQuery>
   </ulex:SubscriptionStructuredQuery>
</ulexsn:MatchSubscription>