SIF 3 0 Environments Zones Contexts Environments Zones

SIF 3. 0 Environments, Zones & Contexts Environments, Zones, Contexts and their Relationship Presented by: Joerg Huber

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

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 Training Course SIF 3: Env. , Zone & Context November 20 © Systemic Pty Ltd

4 What is a Zone? – Consumer’s Point of view An Environment has 1 or Many zones! ¡ There is always a DEFAULT Zone. l ¡ A Zone is a collection of Services a consumer has some sort of access to l l l ¡ If no zone. Id is provided in the REST URL then the default Zone is assumed. 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 l l l Object Services (Student. Personal, School. Info etc. ) Utility Services (Alerts, Zone Registry etc. ) Functional Services (i. e. Endo-Of-Year rollover). Training Course SIF 3: Env. , Zone & Context November 20 © Systemic Pty Ltd

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. l ¡ 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! l l ¡ If no context. Id is provided in the REST URL then the default Context is assumed. Current Students Special Ed Students Contexts are NOT global. They apply to a specific Service Provider in a zone Training Course SIF 3: Env. , Zone & Context November 20 © Systemic Pty Ltd

6 Relationships… A consumer “connects” to one Environment. That environment may: ¡ ¡ Have many Zones. Each Zone may have many services. l ¡ ¡ Service Name = SIF Object Name +’s’ (plural form) A zone may have more than one provider for the same SIF Object (i. e. Student. Personal) 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 Ref. Id for the same Object! l l One Ref. Id 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. Training Course SIF 3: Env. , Zone & Context November 20 © Systemic Pty Ltd

7 Environment XML –Example (snippet) <provisioned. Zone id=" Demo. Zone"> <services> <service name="Student. Personals" context. Id="DEFAULT" type="OBJECT"> <rights>. . . </rights> </service> <service name="School. Infos" context. Id="DEFAULT" type="OBJECT"> <rights>. . . </rights> </services> </provisioned. Zone> <provisioned. Zone id=" District. Zone"> <services> <service name="Student. Personals" context. Id="DEFAULT" type="OBJECT"> <rights>. . . </rights> </service> <service name="Student. Personals" context. Id="Special. Ed" type="OBJECT"> <rights>. . . </rights> </service>. . . Training Course SIF 3: Env. , Zone & Context November 20 © Systemic Pty Ltd

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 l ¡ Exercise in next session will showcase this The Environment Provider (DIRECT or BROKERED) will respond with a full environment XML l Exercise in next session will showcase this Note: The SIF 3 Frameworks make all the interactions listed above completely transparent to the consumer Training Course SIF 3: Env. , Zone & Context November 20 © Systemic Pty Ltd

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 l l l Service type Context ACLs for each service Training Course SIF 3: Env. , Zone & Context November 20 © Systemic Pty Ltd

1 0 Environment: Metadata & Default Zone <session. Token>919 f 2 b 2 a-e 57 f-41 a 1 -9969 -088 e 9 c 173 acf</session. Token> <solution. Id>test</solution. Id> <default. Zone id="Demo. Zone"> Default Zone Info <description>AU Demo Zone: Default Zone</description> </default. Zone> <authentication. Method>Basic</authentication. Method> Metadata <consumer. Name>Student Consumer</consumer. Name> <application. Info> <application. Key>Test. SIS</application. Key> <supported. Infrastructure. Version>3. 0. 1</supported. Infrastructure. Version> <data. Model. Namespace>http : //…/au/datamodel/1. 3</data. Model. Namespace> <transport>REST</transport> <application. Product> <vendor. Name>Systemic Pty Ltd</vendor. Name> <product. Name>Demo Consumer</product. Name> <product. Version>1. 0. 6</product. Version> </application. Product> </application. Info> Training Course SIF 3: Env. , Zone & Context November 20 © Systemic Pty Ltd

1 1 Environment: Infrastructure URIs <infrastructure. Service name="environment"> http: //. . . /SIF 3 Demo/sif 3 Demo/environments/{environment. Id} </infrastructure. Service> <infrastructure. Service name="requests. Connector"> http: //. . . /SIF 3 Demo/sif 3 Demo/requests </infrastructure. Service> Main Interest for <infrastructure. Service name="provision. Requests"> this training course http: //. . . /SIF 3 Demo/sif 3 Demo/provision </infrastructure. Service> <infrastructure. Service name="events. Connector"> http: //. . . /SIF 3 Demo/sif 3 Demo/events. Connector </infrastructure. Service> Events and Delayed <infrastructure. Service name="queues"> Responses use these http: //. . . /SIF 3 Demo/sif 3 Demo/queues </infrastructure. Service> <infrastructure. Service name="subscriptions"> http: //. . . /SIF 3 Demo/sif 3 Demo/subscriptions </infrastructure. Service> Training Course SIF 3: Env. , Zone & Context November 20 © Systemic Pty Ltd

1 2 Environment: Service ACLs ¡ There are 7 permissions each service can set: l l l l ¡ QUERY CREATE UPDATE Permissions for Consumer only DELETE SUBSCRIBE Only permission for Provider (brokered)! PROVIDE ADMIN (not used, yet) Each permission can have 3 values: l l l 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 Training Course SIF 3: Env. , Zone & Context November 20 © Systemic Pty Ltd

1 3 Environment: Service ACLs (cont. ) <service name="Student. Personals" context. Id="DEFAULT“ type=“OBJECT”> <rights> <right type="QUERY">APPROVED</right> <right type="CREATE">APPROVED</right> <right type="UPDATE">APPROVED</right> <right type="DELETE">APPROVED</right> <right type="PROVIDE">REJECTED</right> <right type="SUBSCRIBE">APPROVED</right> <right type="ADMIN">REJECTED</right> </rights> </service> Training Course SIF 3: Env. , Zone & Context November 20 © Systemic Pty Ltd

1 4 Question Time… Questions? Note: Next Session is about SIF Environment Management. Training Course SIF 3: Env. , Zone & Context November 20 © Systemic Pty Ltd