Table of Contents

Search

  1. Preface
  2. Introduction
  3. Servers
  4. Console Client
  5. Search Clients
  6. Table Loader
  7. Update Synchronizer
  8. Globalization
  9. Siebel Connector
  10. Web Services
  11. ASM Workbench
  12. Cluster Merge Rules
  13. Forced Link and Unlink
  14. System Backup and Restore
  15. Batch Utilities

Notification Service

Notification Service

The Notification Service is provided by the Synchronization Server. Therefore, The Synchronization Server must be running. This is achieved by allocating the server’s host name (
SSA_XSHOST
) and port number (
SSA_XSPORT
) in
env\mdmres.bat
(Windows) or
env/mdmres
(UNIX). The default port number of the Synchronization Server is 1671.

Conformance

The Notification Service implements the Oasis Web Services Base Notification 1.3 (WSBaseNotification) specification.

Enabling the Notification Service

The Notification Service will not start unless the Real Time Web Service has been enabled and configured.
The service is enabled on a per-rule basis in the Real Time Web Service configuration file using a
<notification>
card:
<server xmlns="http://www.identitysystems.com/xmlschema/iss-version-8/xrserv"> <mode>custom</mode> <pid_thread_num>8</pid_thread_num> <txn_thread_num>8</txn_thread_num> <work_queue_size>4000<work_queue_size> <profile name="profile"> <rule name="rule"> <system>sysname</system> <idt>IDTFP</idt> <rulebase>ids:rb</rulebase> <extra_audit_info>false</extra_audit_info> <notification>true</notification> <!-- turn notification ON --> </rule> </profile> </server>

Notification Service Functions

Notify
Notification messages are sent out to all subscribers in response to a clustering action. A notification message looks like this:
<?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsa="http://www.w3.org/2005/08/addressing" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"> <soap:Header> <wsa:MessageID>urn:uuid:e2af275e-6656-438f-ae2f-93a8479aa1ff</wsa:MessageID> <wsa:Action>http://docs.oasis-open.org/wsn/bw-2/NotificationConsumer/Notify</wsa:Action> <wsa:To>http://www.w3.org/2005/08/addressing/role/anonymous</wsa:To> <wsa:From> <wsa:Address>http://localhost:1671</wsa:Address> </wsa:From> <wsse:Security> <wsu:Timestamp wsu:Id="Timestamp-194320fa-cc2e-46a7-94e8-00d3388e179f"> <wsu:Created>2011-06-16T05:23:44Z</wsu:Created> <wsu:Expires>2011-06-16T05:28:44Z</wsu:Expires> </wsu:Timestamp> </wsse:Security> </soap:Header> <soap:Body> <wsnt:Notify xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2"> <NotificationMessage> <SubscriptionReference> <wsa:Address>http://localhost:1671</wsa:Address> </SubscriptionReference> <Topic Dialect="http://docs.oasis-open.org/wsn/t-1/TopicExpression/Simple">rule</Topic> <AuditMessage> <System>sysname</System> <IDT>IDTFP</IDT> <Rulebase>ids:rb</Rulebase> <ClusterAction> <Type>Delete from Cluster</Type> <To> <ID>AA</ID> <No>653</No> </To> <New>false</New> <Automatic>true</Automatic> <RecordActions/> <RecordActions/> <Modifier/> <Comment/> </ClusterAction> </AuditMessage> </NotificationMessage> </wsnt:Notify> </soap:Body> </soap:Envelope>
  1. The header contains WS-Addressing information.
  2. The Topic is the rule from the configuration.
  3. The NotificationMessage contains an AuditMessage
The Notification Service requires WS-Addressing.

Subscribe

In order to receive notification messages, a client must first subscribe to the messages that it wishes to receive. A subscription message looks like this:
<?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"> <env:Header xmlns:env="http://www.w3.org/2003/05/soap-envelope"> <wsa:Action>http://docs.oasis-open.org/wsn/bw-2/NotificationProducer/SubscribeRequest</wsa:Action> <wsa:MessageID>urn:uuid:a127a7e6-444e-43f2-85c7-79bfd0820098</wsa:MessageID> <wsa:ReplyTo> <wsa:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:Address> </wsa:ReplyTo> <wsa:To>http://localhost:1671/</wsa:To> <wsse:Security> <wsu:Timestamp wsu:Id="Timestamp-9159d636-343a-4951-9bd2-802f7b079a52"> <wsu:Created>2011-06-16T05:23:45Z</wsu:Created> <wsu:Expires>2011-06-16T05:28:45Z</wsu:Expires> </wsu:Timestamp> </wsse:Security> </env:Header> <soap:Body> <Subscribe xmlns="http://docs.oasis-open.org/wsn/b-2"> <ConsumerReference> <Address xmlns="http://www.w3.org/2005/08/addressing"> http://localhost:1671/PullPoint/dff98400-1c24-48d9-aab4-a43c84225b1e</Address> </ConsumerReference> <Filter> <TopicExpression xmlns="" Dialect="http://docs.oasis-open.org/wsn/t-1/ TopicExpression/Simple">rule</TopicExpression> </Filter> <InitialTerminationTime xsi:nil="true"/> </Subscribe> </soap:Body> </soap:Envelope>
  1. The header contains WS-Addressing information.
  2. The ConsumerReference contains the address
  3. The TopicExpression limits the subscriber to retrieving messages from a single rule. Only simple topics
    (http://docs.oasis-open.org/wsn/t-1/TopicExpression/Simple)
    are supported. If no TopicExpression is supplied, then the subscriber will be subscribed to all rules.
  4. The InitialTerminationTime here is set to
    xsi:nil="true"
    , which means that the subscription does not expire until the server is shut down or restarted. Alternatively, a date or duration could be supplied. A date must be in the
    xsd:date
    Time format ([-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]) while a duration needs to be in the
    xsd:duration
    form.
The service will send a response like this:
<?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:wsa="http://www.w3.org/2005/08/addressing" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2"> <soap:Header> <wsa:MessageID>urn:uuid:f58820eb-c25b-4e39-a042-92cbf095fd54</wsa:MessageID> <wsa:Action>http://docs.oasis-open.org/wsn/bw-2/NotificationProducer/SubscribeResponse</wsa:Action> <wsa:RelatesTo wsa:RelationshipType="http://www.w3.org/2005/08/addressing/reply"> urn:uuid:a127a7e6-444e-43f2-85c7-79bfd0820098</wsa:RelatesTo> <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To> <wsa:From> <wsa:Address>http://www.identitysystems.com/xmlschema/2011/notify/ PausableSubscriptionManager</wsa:Address> </wsa:From> <wsse:Security> <wsu:Timestamp wsu:Id="Timestamp-8d5be574-3122-4f26-8755-bf6de0142737"> <wsu:Created>2011-06-16T05:23:45Z</wsu:Created> <wsu:Expires>2011-06-16T05:28:45Z</wsu:Expires> </wsu:Timestamp> </wsse:Security> </soap:Header> <soap:Body> <wsnt:SubscribeResponse> <wsnt:SubscriptionReference> <wsa:Address>http://localhost:1670/PullPoint/dff98400-1c24-48d9-aab4-a43c84225b1e</wsa:Address> <wsa:ReferenceParameters> <ssa:SubscriptionID xmlns:ssa="http://www.identitysystems.com/xmlschema/2011/notify"> 7863511b-5b67-4f33-8316-e0b81a19395b</ssa:SubscriptionID> </wsa:ReferenceParameters> </wsnt:SubscriptionReference> <wsnt:CurrentTime>2011-06-16T05:23:45Z</wsnt:CurrentTime> <wsnt:TerminationTime xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/> </wsnt:SubscribeResponse> </soap:Body> </soap:Envelope>
  1. The header contains WS-Addressing information.
  2. The ReferenceParameters contains a subscription ID. This is used by the Unsubscribe request.
  3. The InitialTerminationTime here is set to
    xsi:nil="true"
    , which means that the subscription does not expire until the server is shut down or restarted. Alternatively, a date or duration could be supplied.

GetCurrentMessage

The latest message for a given topic can be returned with a GetCurrentMessage request:
<?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"> <env:Header xmlns:env="http://www.w3.org/2003/05/soap-envelope"> <wsa:Action>http://docs.oasis-open.org/wsn/bw-2/NotificationProducer/GetCurrentMessageRequest</wsa:Action> <wsa:MessageID>urn:uuid:88afbfb3-0d0f-4038-9702-ddbf5663afb1</wsa:MessageID> <wsa:ReplyTo> <wsa:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:Address> </wsa:ReplyTo> <wsa:To>http://localhost:1671/</wsa:To> <wsse:Security> <wsu:Timestamp wsu:Id="Timestamp-e35188af-0877-4cf4-b977-d0439d6bee32"> <wsu:Created>2011-06-17T03:24:07Z</wsu:Created> <wsu:Expires>2011-06-17T03:29:07Z</wsu:Expires> </wsu:Timestamp> </wsse:Security> </env:Header> <soap:Body> <GetCurrentMessage xmlns="http://docs.oasis-open.org/wsn/b-2"> <Topic Dialect="http://docs.oasis-open.org/wsn/t-1/TopicExpression/Simple">rule</Topic> </GetCurrentMessage> </soap:Body> </soap:Envelope>
  • A TopicExpression must be suppled with this request Only simple topics
    (http://docs.oasisopen.org/wsn/t-1/TopicExpression/Simple)
    are supported.
The response will include the last message that was sent:
<?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:wsa="http://www.w3.org/2005/08/addressing" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2"> <soap:Header> <wsa:MessageID>urn:uuid:b9770978-4a3d-4f1e-9bd2-f1851df83a9a</wsa:MessageID> <wsa:Action>http://docs.oasis-open.org/wsn/bw-2/NotificationProducer/ GetCurrentMessageResponse</wsa:Action> <wsa:RelatesTo wsa:RelationshipType="http://www.w3.org/2005/08/addressing/reply"> urn:uuid:88afbfb3-0d0f-4038-9702-ddbf5663afb1</wsa:RelatesTo> <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To> <wsa:From> <wsa:Address>http://www.identitysystems.com/xmlschema/2011/ notify/PausableSubscriptionManager</wsa:Address> </wsa:From> <wsse:Security> <wsu:Timestamp wsu:Id="Timestamp-d79f3cf7-ffb7-4529-911c-4c93157adc5d"> <wsu:Created>2011-06-17T03:24:07Z</wsu:Created> <wsu:Expires>2011-06-17T03:29:07Z</wsu:Expires> </wsu:Timestamp> </wsse:Security> </soap:Header> <soap:Body> <wsnt:GetCurrentMessageResponse> <NotificationMessage> <Topic Dialect="http://docs.oasis-open.org/wsn/t-1/TopicExpression/Simple">rule</Topic> <AuditMessage> <System>sysname</System> <IDT>IDTFP</IDT> <Rulebase>ids:rb</Rulebase> <ClusterAction> <Type>Delete from Cluster</Type> <To> <ID>AA</ID> <No>653</No> </To> <New>false</New> <Automatic>true</Automatic> <RecordActions/> <RecordActions/> <Modifier/> <Comment/> </ClusterAction> </AuditMessage> </NotificationMessage> </wsnt:GetCurrentMessageResponse> </soap:Body> </soap:Envelope>

Renew

The subscription’s termination time can be changed with a Renew request:
<?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"> <env:Header xmlns:env="http://www.w3.org/2003/05/soap-envelope"> <wsa:Action>http://docs.oasis-open.org/wsn/bw-2/SubscriptionManager/RenewRequest</wsa:Action> <wsa:MessageID>urn:uuid:e9d04d81-de0b-4a79-9173-4dfaefa50cf4</wsa:MessageID> <wsa:ReplyTo> <wsa:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:Address> </wsa:ReplyTo> <wsa:To>http://localhost:1671/</wsa:To> <wsse:Security> <wsu:Timestamp wsu:Id="Timestamp-14399d03-58d1-4769-8f63-1f04d8f78431"> <wsu:Created>2011-06-17T05:33:54Z</wsu:Created> <wsu:Expires>2011-06-17T05:38:54Z</wsu:Expires> </wsu:Timestamp> </wsse:Security> </env:Header> <soap:Body> <Renew xmlns="http://docs.oasis-open.org/wsn/b-2"> <TerminationTime xsi:nil="true"/> <ssa:SubscriptionID xmlns:ssa="http://www.identitysystems.com/xmlschema/2011/notify"> 30e1752c-7bf5-4441-b8e9-67ba5f59c1b3</ssa:SubscriptionID> </Renew> </soap:Body> </soap:Envelope>
  1. This requires the subscription ID from the subscription response
  2. It this case, the subscription is being extended indefinitely

Unsubscribe

A subscription can be terminated at any time with an Unsubscribe request:
<?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"> <env:Header xmlns:env="http://www.w3.org/2003/05/soap-envelope"> <wsa:Action>http://docs.oasis-open.org/wsn/bw-2/SubscriptionManager/UnsubscribeRequest</wsa:Action> <wsa:MessageID>urn:uuid:2bb7d56d-85cd-410d-9ba2-2f9d604294fd</wsa:MessageID> <wsa:ReplyTo> <wsa:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:Address> </wsa:ReplyTo> <wsa:To>http://localhost:1671/</wsa:To> <wsse:Security> <wsu:Timestamp wsu:Id="Timestamp-5030ba37-e056-464d-bad4-56f25b83da6c"> <wsu:Created>2011-06-17T03:24:07Z</wsu:Created> <wsu:Expires>2011-06-17T03:29:07Z</wsu:Expires> </wsu:Timestamp> </wsse:Security> </env:Header> <soap:Body> <Unsubscribe xmlns="http://docs.oasis-open.org/wsn/b-2"> <ssa:SubscriptionID xmlns:ssa="http://www.identitysystems.com/xmlschema/2011/notify"> e3ccfab3-47f7-42cc-b595-e247df33f7d9</ssa:SubscriptionID> </Unsubscribe> </soap:Body> </soap:Envelope>
This requires the subscription ID from the subscription response.

PauseSubscription

A subscription can be paused at any time with an
pauseSubscription
request. No notification messages will be sent until a
ResumeSubscription
request is received.
<?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"> <env:Header xmlns:env="http://www.w3.org/2003/05/soap-envelope"> <wsa:Action>http://docs.oasis-open.org/wsn/bw-2/SubscriptionManager/PauseSubscriptionRequest</wsa:Action> <wsa:MessageID>urn:uuid:3ea43a8a-a505-4c1d-8c7f-a307117f0539</wsa:MessageID> <wsa:ReplyTo> <wsa:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:Address> </wsa:ReplyTo> <wsa:To>http://localhost:1671/</wsa:To> <wsse:Security> <wsu:Timestamp wsu:Id="Timestamp-77b937e0-6699-498f-9665-adad34fb1214"> <wsu:Created>2011-06-17T03:24:06Z</wsu:Created> <wsu:Expires>2011-06-17T03:29:06Z</wsu:Expires> </wsu:Timestamp> </wsse:Security> </env:Header> <soap:Body> <PauseSubscription xmlns="http://docs.oasis-open.org/wsn/b-2"> <ssa:SubscriptionID xmlns:ssa="http://www.identitysystems.com/xmlschema/2011/notify"> e3ccfab3-47f7-42cc-b595-e247df33f7d9</ssa:SubscriptionID> </PauseSubscription> </soap:Body> </soap:Envelope>
This requires the subscription ID from the subscription response.

ResumeSubscription

The ResumeSubscription request tells the Notification service to resume sending notify messages to a paused subscription.
<?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"> <env:Header xmlns:env="http://www.w3.org/2003/05/soap-envelope"> <wsa:Action>http://docs.oasis-open.org/wsn/bw-2/SubscriptionManager/ResumeSubscriptionRequest</wsa:Action> <wsa:MessageID>urn:uuid:73b2727c-ce1b-4704-a62e-cf9e0a69b10c</wsa:MessageID> <wsa:ReplyTo> <wsa:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:Address> </wsa:ReplyTo> <wsa:To>http://localhost:1671/</wsa:To> <wsse:Security> <wsu:Timestamp wsu:Id="Timestamp-7eb82fd9-e5a4-43a3-83a5-5ed9a3284e3d"> <wsu:Created>2011-06-17T03:24:06Z</wsu:Created> <wsu:Expires>2011-06-17T03:29:06Z</wsu:Expires> </wsu:Timestamp> </wsse:Security> </env:Header> <soap:Body> <ResumeSubscription xmlns="http://docs.oasis-open.org/wsn/b-2"> <ssa:SubscriptionID xmlns:ssa="http://www.identitysystems.com/xmlschema/2011/notify"> e3ccfab3-47f7-42cc-b595-e247df33f7d9</ssa:SubscriptionID> </ResumeSubscription> </soap:Body> </soap:Envelope>
This requires the subscription ID from the subscription response.

0 COMMENTS

We’d like to hear from you!