IMS Global Learning Consortium

SIG Use Case Tool

This spreadsheet captures information regarding use cases that may drive the scope of Charters develo
Overview by IMS SIGs.
Version 1
Date 5-Mar-03

This is the first version of the spreadsheet and is being used by the ESWS SIG as a trial. Feedback on
Notes needed changes to this template are encouraged. Send them to Lisa Mattson at lmattson@imsglobal.or

1. Make copies of the 2nd worksheet and rename with your organizational abbreviation and the next iter
Instructions number.
2. Fill out the forms. Evaluate your use case against the three types. Fill out only one column. See the
Infrastructure Questions worksheet for details and guidance in filling out the form.
3. Post to the SIG Forum using a subject of "Use Cases - ESWS - organizational name"
he scope of Charters developed

SIG as a trial. Feedback on

on at lmattson@imsglobal.org

bbreviation and the next iterative

ut only one column. See the

form.
ional name"
S Global Learning Consortium
ging Questionnaire (DRAFT V2)

Organization ABC Organization

Submitted by Joe Smith
Use Case Number ABC-01

Infrastructure Questions - App

Type of Transaction Set (fill out only one column; select only
No. Request Data Update / ACK (or NAK)
1 Event receivers pre-subscribed to N/A
If Topics/Objects, then must Source pre-
2
register events on the Topics? N/A
3 Can the target system reject a request? Y|N
4 Sync or Asynch Sync | Async

5 QOS - Duplicates Target detects |

Infrastructure. Prevents

6 QOS - Connection Target must be running |

Infrastructure Gaurantee
QOS - Must message delivery order be
7
the same as posting order N/A
QOS - Notify Recipients when all
8
messages are delivered? N/A
9 Target Identification "Pre-wired" | Discovered
10 If multiple targets, how selected? ?

11 Scope of Record ID Target & Partners |

Internet
Source need to synchronize with
12
Target? Y|N
13 3rd party event logger Y|N
Y | N,
14 Encrytion required direction X>Y | X<Y | X<>Y,
type
15 Source authenticated to Y Y|N
16 Source authorized to Y Y|N

17 Security provided by infrastructure None | Encryption, Authentication,

Authorization
18 Stateful sessions Y|N
19 If stateful, then based on what? Cookie | other??
If stateful, then how is basis of state
20
id'd? Dynamically Discovered | Configured
21 Optional elements in schema Y|N
22 Optional element resolution strategy ?

23 Transport Requirements HTTP, HTTPS, IIOP (Corba), IIOP

DCOM, MOM - MQ/Series, MOM-
MSMQ, MOM-JMQ, SMTP, Other?
24 Multiple object retrieval possible N/A
25 How flexible is query? N/A
26 Can source report on multiple objects N/A
If yes, does message schema support
27
aggregates N/A
28 Can Source send batch to Target Y|N
If batch is yes, then does schema
29
support aggregates Enterprise Spec does
Can transaction/event be part of larger
30
transaction? Y|N
If so, how are transaction boundaries
31
identified ?
If part of larger transaction, then is a 3rd
32
system or more involved? Y|N
33 Version Number Context Application | Object | Schema
34 Multiple Payloads Y|N
35 Payload format always XML Y|N
36 Non-refutablity requirements? Y|N
37 Non-alterability requirements Y|N
38 Are partial mods allowed Y|N
39 If so, must originals be included Y|N
If not originals, then how are fields to be
40
changed indicated? ?

41 Who generates GUID on create requests

Source | Target
Is GUID passed to/from GUID
42
generator Y|N
Security requirements between Mssg
43
Broker and applications N/A
44 Event Propogation security set by N/A
Does Mssg broker enforce N/A
45 Encryption of Data N/A
Authorization of event generators and
46
receivers N/A
47 Authentication of generators of events N/A
 Infrastructure Questions - Applies to all transactions
(fill out only one column; select only one of items A | B; select one each of A | B, C | D.)

Read Request / Response Data Monitoring

N/A Source's Events | Source's Topic/Objects

N/A Y|N
N/A N/A
Sync | Async N/A
Target detects |
Infrastructure. Prevents N/A
Target must be running | Recipients must be running |
Infrastructure Gaurantee Infrastructure Gaurantee

N/A Y|N

N/A Y|N
"Pre-wired" | Discovered N/A
? N/A
Target & Partners |
Internet N/A

Y|N N/A
Y|N N/A
Y | N,
direction X>Y | X<Y | X<>Y,
type N/A
Y|N N/A
Y|N N/A
None | Encryption, Authentication,
Authorization N/A
Y|N N/A
 Cookie | other?? N/A

Dynamically Discovered | Configured N/A

Y|N Y|N
? ?

HTTP, HTTPS, IIOP (Corba), IIOP

DCOM, MOM - MQ/Series, MOM-
MSMQ, MOM-JMQ, SMTP, Other? N/A
Y|N N/A
List | Full SQL N/A
N/A Y|N

N/A Enterprise Schema Does

N/A N/A

N/A N/A

Y|N Y|N

? ?

Y|N N/A
Application | Object | Schema Application | Object | Schema
Y|N Y|N
Y|N Y|N
Y|N Y|N
Y|N Y|N
N/A Y|N
N/A Y|N

N/A ?

N/A N/A

N/A N/A

N/A Y|N
N/A Application | Admin of Mssg Broker
N/A Y|N
N/A Y|N

N/A Y|N
N/A Y|N
Document Author: Ron Kleinman, Sun.

See [#s] for mapping to Use Case Questions

Use Case FAQ to generate IxRetail

Infrastructure Requirements

Use Case #1: Request Data Update / ACK

(or NAK)

1. X sends Create / Update / Delete to Y

2. Y sends back Response to X

Infrastructure Questions: Top 15

1. [3] Accept only or Reject possible?

Can the Y system reject the X change? What if the version # is wrong or (worse)
if the Request message doesn’t pass the “well formed” or “valid” checks? What if
the change is illegal (ex: no such object)?

Should all errors (system level, XML level, business level) be reported in the same
way?

2. [4] Synchronous or Asynchronous Response?

Is the Y response expected immediately? If not, how is the response correlated to

the request?

Does the Response imply that the Y database update has actually been made? If
so, can X always leave its Request pending until this occurs (even if Y is in
another organization)?

Alternatively, can the Change Request be acknowledged immediately, and the

actual Response be returned later (asynchronously), after the Y database update is
Is the Y response expected immediately? If not, how is the response correlated to
the request?

Does the Response imply that the Y database update has actually been made? If
so, can X always leave its Request pending until this occurs (even if Y is in
another organization)?

Alternatively, can the Change Request be acknowledged immediately, and the

actual Response be returned later (asynchronously), after the Y database update is