Presented by: SIF 3.0 Environments, Zones & Contexts Environments, Zones, Contexts and their Relationship Joerg Huber

© Systemic Pty Ltd September 2014 Training Course - Sydney: SIF Env., Zone & Context 2 Overview  What is an Environment?  What is a Zone? Compare it to SIF 2.x Zone Default Zone  What is a Context? Default Context  How do these concepts/Terms relate to each other? Do I need all of these?  Components of an Environment Metadata, Infrastructure URIs & ACLs

© Systemic Pty Ltd September 2014 Training Course - Sydney: SIF Env., Zone & Context 3 What is an Environment? The “SIF 3.0 Environment” the totality of every service the Consumer might possibly provision itself to access. Based upon authentication constraints however, the Consumer’s access to some services it can see might be restricted. It is provided by:  Provider in a direct Environment  Environment Provider in a brokered Environment Holds mainly  Service URLs scoped for each zone  Access Rights for each Service scoped for each zone

© Systemic Pty Ltd September 2014 Training Course - Sydney: SIF Env., Zone & Context 4 What is a Zone? – Consumer’s Point of view An Environment has 1 or Many zones!  There is always a DEFAULT Zone. If no zoneId is provided in the REST URL then the default Zone is assumed.  A Zone is a collection of Services a consumer has some sort of access to In SIF 2.x they were a collection of SIF Objects an agents had access to. Access rights are allocated in each zone for each service Context may be assigned to each service.  Various types of Services Object Services (StudentPersonal, SchoolInfo etc.) Utility Services (Alerts, Zone Registry etc.) Functional Services (i.e. Endo-Of-Year rollover).

© Systemic Pty Ltd September 2014 Training Course - Sydney: SIF Env., Zone & Context 5 What is a Context? – Consumer’s Point of view A Context is optional Data Model-specific metadata that may accompany a Consumer Request as a way of further scoping and restricting the possible Provider.  There is always a DEFAULT Context for each Service. If no contextId is provided in the REST URL then the default Context is assumed.  In a zone there can be more than one Object Provider for the same “SIF Object” as long as they operate in a different context! Current Students Special Ed Students  Contexts are NOT global. They apply to a specific Service Provider in a zone

© Systemic Pty Ltd September 2014 Training Course - Sydney: SIF Env., Zone & Context 6 Relationships… A consumer “connects” to one Environment. That environment may:  Have many Zones.  Each Zone may have many services. Service Name = SIF Object Name +’s’ (plural form)  A zone may have more than one provider for the same SIF Object (i.e. StudentPersonal) as long as they use a different context.  A consumer who creates a SIF Object in more than one Zone or Context may be given more than one RefId for the same Object! One RefId per service it calls for the same object. A service is scoped per environment, zone and context. May sound complicated but most of the time you will operate in the DEFAULT Zone and Context.

© Systemic Pty Ltd September 2014 Training Course - Sydney: SIF Env., Zone & Context 7 Environment XML –Example (snippet)

© Systemic Pty Ltd September 2014 Training Course - Sydney: SIF Env., Zone & Context 8 Create an Environment Before a Consumer can do anything in SIF 3.x it must Create an environment!  Call POST on environment connector  Provide some basic info about the environment to be created in the XML Payload of the request Exercise in next session will showcase this  The Environment Provider (DIRECT or BROKERED) will respond with a full environment XML Exercise in next session will showcase this Note: The SIF3 Frameworks make all the interactions listed above completely transparent to the consumer

© Systemic Pty Ltd September 2014 Training Course - Sydney: SIF Env., Zone & Context 9 Components of an Environment A Response XML to an environment Create Request contains a number of sections:  Some metadata about of the environment (name, data model version, vendor, transport protocol, authentication method etc.)  Default Zone  A set of infrastructure service URIs (request, event, queue etc.)  List of zones & services in each zone Service type Context ACLs for each service

© Systemic Pty Ltd September 2014 Training Course - Sydney: SIF Env., Zone & Context 10 Environment: Metadata & Default Zone 919f2b2a-e57f-41a e9c173acf test AU Demo Zone: Default Zone Basic Student Consumer TestSIS REST Systemic Pty Ltd Demo Consumer Default Zone Info Metadata

© Systemic Pty Ltd September 2014 Training Course - Sydney: SIF Env., Zone & Context 11 Environment: Infrastructure URIs Main Interest for this training course Events and Delayed Responses use these

© Systemic Pty Ltd September 2014 Training Course - Sydney: SIF Env., Zone & Context 12 Environment: Service ACLs  There are 7 permissions each service can set: QUERY CREATE UPDATE DELETE SUBSCRIBE PROVIDE ADMIN (not used, yet)  Each permission can have 3 values: APPROVED (you are allowed to do this) REJECTED (you aren’t allowed to do this) SUPPORTED (this operation is supported but you don’t have access) => Requires a provision request first Permissions for Consumer only Only permission for Provider (brokered)!

© Systemic Pty Ltd September 2014 Training Course - Sydney: SIF Env., Zone & Context 13 Environment: Service ACLs (cont.) APPROVED REJECTED APPROVED REJECTED

© Systemic Pty Ltd September 2014 Training Course - Sydney: SIF Env., Zone & Context 14 Question Time… Questions? Note: Next Session is about SIF Environment Management.