Introduction to the SIF 3.0 Infrastructure: An Environment for Educational Data Exchange

Transcription

1 Introduction to the SIF 3.0 Infrastructure: An Environment for Educational Data Exchange

2 SIF 3.0 Infrastructure Goals of the Release Environment types & types Registration & Security Basic Architectural Framework Scoping REST and REST extensions Query options Queues & Events Getting Started REST Developer Sandbox (SIF-RS) Documentation

3 A high level overview of the SIF 3.0 Infrastructure

4 Goals of the Infrastructure release Independence from Payload Contents Secure, scalable transport Single infrastructure for all locale DMs, special Profiles REST Transport / Design Paradigm No SIF-unique technology where industry standards exist Basic+ URL access to REST Resources XQuery script support Direct Consumer Connection Option Middleware optional in SIF v3.0 solutions! Vertical Organization Scalability Extensions Multiple v2.x Zones in single v3.0 Consumer Environment Multiple Contexts for same Object Type in given Zone

5 A Comparison of Environment Types Client Consumer API Direct Direct Environment Provider API Provider Logic Client Consumer API ESB Middleware Provider API Client Consumer API Brokered Environment Provider API Provider API Brokered

6 Direct Environments Providers Central Data Connects Consumers to its s (no middleware) SIS, LMS, Data Store No externally implemented Object s are available Supports multiple Consumers Each Consumer is the only one in its Environment Consumers can see Events generated by others Supports mobile Consumers Tablet Dashboards, Smart Phone Queries Provides Clean API Subset of Brokered Environment All Direct Consumers run in Brokered Environments

7 SIS providing a Direct Environment to multiple Consumers Browser JavaScript Student Contact System Browser JavaScript RESTful Mobile Client SIF v3.0 SIF v3.0 V3.0 Dir. Environ Provider Adapter V3.0 Provider Adapter SIS

8 Brokered Environments Providers Central Message Broker Connects multiple Consumers and Providers Enterprise Bus + other middleware components Modular (Queues, Connectors, Registries) vs. SIF v2 ZIS Provide Clean API Superset of Direct Environment All Direct Consumers run in Brokered Environments Brokered Consumers can become Providers Support for Administrative Interfaces Centralized Enforcement of Site Security Policy Registries & Governance Preventative Maintenance & Diagnostics ( quiet apps ) Highly scalable

9 SIS as a Provider in a Brokered Environment Browser JavaScript Student Contact System RESTful Mobile Client Browser SIF v3.0 SIF v3.0 SIF v3.0 Broker SIF v3.0 V3.0 Provider Adapter SIS

10 Types Standard REST Request Framework+ All or subset of Query, Create, Update, Delete Publish Events Data Object (ex: SIS) Data Model (ex: SIF US 3.2) defines message payloads Functional (ex: SRE) Encapsulate behavior as well as data Awaiting DM POC Infrastructure (Connectors, Queues, Self- Provision) Core component of Infrastructure, URL Addressible Utility (Alert, Registries) Normal service concerned with infrastructure

11 SIF 3.0 Scoping SIF v2.x Zone One Object Provider (SIS) per Object Type in Zone SIF v3.0 Environment spans all known s Available s divided into Zones Single Zone typical of Direct Environment Provider Contexts One or more Contexts specific to Type Ex: Current or Archived Students One Provider / Context / Type / Zone A Consumer Registers & Provisions once

12 Student s in an Environment Environment Student (Context: Current) Client Consumer Adapter High School A Zone Student (Context: Archived) Student (Context Special Ed) High School B Zone Student (Context: Current)

13 Security: Baked in Encryption X.509 Certificates via Transport Level Security (SSL) Authentication Shared Secrets, supported by HMAC SHA256 Session Tokens Client Certificate Management reuse where present Authorization Consumer Registration maps to Consumer Provisioning Key, Instance and / or User Key (ID, Passwd) XML Filters applied via XQuery Reports

14 Infrastructure: REST operations: Get/Post/Put/Delete Every Provider is a REST Resource Class is URL, Object is URL/RefId (students/1234) Responses are immediate HTTP Message payload is pure data HTTP Error Codes Infrastructure values in: HTTP Header fields URL Segments URL Matrix and / or Query Parameters as appropriate But there s more...

15 Basic Consumer / Provider Interface (all operations single or multi-object) CRUD Request Consumer CRUD Response API Environment Provider CUD Event

16 Immediate and Delayed Responses CRUD HTTP Request Accept HTTP Response Consumer CUD Event API Environment Provider Get HTTP Request CRUD Response Q

17 Data Query Packaging Options Query Retrieval Option Unqualified Query Provider Response if successful Returns all data for all objects held by the Provider. Ex: students Query by RefId Returns all data for the object corresponding to the specified RefId Ex: students/1234 Paged Query The XQuery response is limited to a selected Page of object results. Each page of results is individually requested by Page # and limited to Size of Page in Objects, May be issued interactively (individually) or delayed (once to get all pages sent to Queue) etags A common REST way to detect whether any objects have changed since the last Consumer Query, implying the Consumer can avoid re-querying all objects to synch up with the data held by the. An inferior but well supported alternative to subscribing to Events.

18 Data Query Selection Options Query Retrieval Option XQuery Template Provider Response if successful Uses an XQuery Token Name to indicate a registered XQuery Template which will be executed by the named Provider to return the predefined set of elements (including possible calculated aggregates) in the qualified set of objects satisfying the query. Parameters to the Template are supplied as URL Query Parameters Ex: StudentSnapshot/?id=1234 Path Used to bridge Associative objects in a single Query, by specifying a Path rather than a Name: Assuming an Ex: schools/4567/students returns all Students in School 4567 Dynamic Query A where clause specified as a URL Query parameter can constrain the set of objects returned by the Query Ex: students?where=[familyname=smith]

19 Consumer: Low end Typical Environment Provider Direct Single (ex: SIS with Student Data) Could be other s available which are not used Consumer Functionality Consumer is pre-provisioned. Register - then issue CRUD requests to preset s All Responses immediate and single object Default Zone & Context use only Full object Query only (Paged or not) No XQuery, no Dynamic Query Issue create to Alert Utility in case of errors Standard RESTful Client

20 Consumer: High end Typical Environment Provider State Level Brokered (SLDS with full CEDS Data Model) Consumer Functionality Register, examine Registry, dynamically provision Gather, update, monitor data from multiple Zones Acquire multiple Queues, subscribe to & process Events Utilize single & multiple object Requests Utilize XQuery scripts to support Composite and Report Object types Utilize Paths and Dynamic Query Provision as a Provider (Brokered Environs only)

21 Environment Providers (concentric levels of increased functionality) Consumer Environ SIS

22 A Simple Consumer Session Initialization Immediate Object Retrieval Object Creation & Event Reception

23 1a. Consumer Registration Request Client Consumer Adapter Create Environment Authentication Key Info Environments URL

24 Client 1b. Environments Response Consumer Adapter Session Token Environment Consumer Provisioning URL Queue Instance Returned URLs may correspond to a testing, staging or production environment REQ Connector URL Queue Manager URL Event Connector URL Provisioned Access Rights

25 A Simple Consumer Session Initialization Immediate Object Retrieval Object Creation & Event Reception

26 2. Immediate Query Request / Response Client Consumer Adapter Environment Connector Consumer Provisioning Component URL Queue REQ Connector Management URL Component Provider Adapter Queue Manager URL Registry Component Event Connector Queue Instance Zone Provider Interface Provisioned Access Rights Authorization Token

27 Requests to Connector URL determines destination Object Type or Path or XQuery Template is in URL segments Zone & Context are URL Matrix Parameters Request routed (Brokered Environment) directly to Provider Multiple Object Requests Create, Query, Update, Delete students Single Object Requests Create students/student Query, Update, Delete students/12345

28 Responses from Connector Immediate: HTTPS Response from Delayed: HTTPS Response is Accepted Actual Response asynchronously delivered to Queue Multi-object Request has Multi-object Response Total Operation Status: Success, Per object substatus: Ordered, Success or Failure All successful changes are reflected in issued Event

29 A Simple Consumer Session Initialization Immediate Object Retrieval Object Creation & Event Reception

30 3.a Change Object Request Client Consumer Adapter Environment Consumer Provisioning URL REQ Connector URL Provider Adapter Queue Manager URL Event Connector Queue Instance Provisioned Access Rights Authorization Token

31 3.b Provider Response & Change Event Environment Client Consumer Adapter Consumer Provisioning URL REQ Connector URL Provider Adapter Queue Manager URL Queue Instance Event Connector Zone Provider Interface Provisioned Access Rights Authorization Token

32 SIF 3.0 Infra Artifacts Read This First (RTF) Explains and highlights the standard documentation Base Architecture Framework for Infrastructure All Request Types and Options explored Infrastructure s Core Components comprising the Infrastructure Environment Security, Connectors, Queues Utility s Zone & Provider Registry & Alert Associated XML Schema

33 SIF-RS (Sandbox) A self-explanatory hands on learning tool for SIF v3.0. Maps the SIF v3.0 specification to the REST platform. Serves as a detailed reference implementation / test harness with an associated human interface to help REST programmers understand and use the SIF v3.0 infrastructure. Provides quick Consumer access to a defined set of SIF v3.0 RESTful services (Environ, Connector, Provision, Student) Is a maturing developer tool and now features the ability to subscribe to Events and access them through a Queue. Available at:

34 SIF 3.0 Infrastructure Summary Converts Logical Data Model to multi-app Solution Independent of Payload REST Technology (plus extensions) Middleware leveraged but optional Low Entry Point for Consumers (Register and Go) Massively scalable at high end Environment spans multiple Zones and Contexts Pub / Sub Events and Asynch Message Queues Multi-object Responses and Events Enforcement of Site Data Security Policies Documents & Sandbox in place:

35 7/2012 Goals and 8/2013 Release 1. Independence from the SIF Data Model Check 2. Increased Scalability (Multiple Objects/ Message) Check 3. A more flexible SIF Zone (Environment). Check 4. Support for Lightweight Client / Server connection type. (Direct Environment) Check and double check 5. Alignment of Infrastructure interfaces with existing middleware products Check 6. Define educational process behavior as well as data - Functional s, (SRE is the POC) 1/2 7. Provide a REST Transport Story Check and double check 8. Support XQuery functionality Check 9. Extend Security Functionality Check 10. Standardize Zone Diagnostic and Preventative Maintenance hooks (Alerts & Queue statistics are a part of this). 1/2

36 SIF 3.0: Where do you want it to take you?

37 Questions? Ron Kleinman, CTO SIF 3.0 Infrastructure: per-resources/sif-3-0/pages/sif-3.0- Infrastructure.aspx EduGuy SIF REST Developer Sandbox