SIF Infrastructure (Global) 3.2

environments

http://www.sifassociation.org/infrastructure/3.2

Documentation

The Consumer Environment Service is the gateway to all other services. It scopes the Consumer’s possible interactions with the infrastructure and any Provider Services accessible from it. The Environment Service provides the set of (possibly customized) information the Application needs to interoperate successfully.

Tree

environments0@type1@id2sessionToken3solutionId4@id5description6@name7property7--68properties8--79defaultZone9--49--59--810authenticationMethod11instanceId12userToken13consumerName14applicationKey15supportedInfrastructureVersion16dataModelNamespace17transport18vendorName19productName20productVersion21iconURI22applicationProduct22--1822--1922--2022--2123vendorName24productName25productVersion26iconURI27adapterProduct27--2327--2427--2527--2628applicationInfo28--1428--1528--1628--1728--2228--2729@name30infrastructureService30--2931infrastructureServices31--3032@id33@name34@contextId35@type36@type37right37--3638rights38--3739service39--3339--3439--3539--3840services40--3941provisionedZone41--3241--4042provisionedZones42--4143environment43--043--143--243--343--943--1043--1143--1243--1343--2843--3143--4244environments44--43

Download: .dot .svg .png

Table

Name Mandatory Characteristics Type Description XPath Format
@type environment​Type​Type ​/environments​/environment​/@type DIRECT, BROKERED
@id uuid​Type ​/environments​/environment​/@id [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[14][a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}
sessionToken O token ​/environments​/environment​/sessionToken
solutionId O token The solution the Application would like to participate in. This is optional only, is advisory, and may be ignored by the Administrator. If processed it may be reflected in the URLs of the infrastructure services which are provided in the consumerEnvironment. ​/environments​/environment​/solutionId
@id token ​/environments​/environment​/defaultZone​/@id
description O normalized​String A short (possibly multi-sentence) description of the Zone ​/environments​/environment​/defaultZone​/description
@name * M string Name/Value pair. ​/environments​/environment​/defaultZone​/properties​/property​/@name
property * M string Name/Value pair. ​/environments​/environment​/defaultZone​/properties​/property
authenticationMethod M token Defines the way in which the applicationKey can be used to enforce security. ​/environments​/environment​/authenticationMethod
instanceId O token ​/environments​/environment​/instanceId
userToken O string ​/environments​/environment​/userToken
consumerName M string A descriptive name for the application that will be readily identifiable to Zone Administrators if it becomes a Registered Consumer ​/environments​/environment​/consumerName
applicationKey M string An opaque (to the SIF standard) element which contains any required Consumer authentication information. The content of this element is site-specific. For a Direct Environment which accepts Consumer Registration Requests from a mobile application, this element might contain a combination of the User ID and Password. ​/environments​/environment​/applicationInfo​/applicationKey
supportedInfrastructureVersion M string The version of the SIF infrastructure which the Consumer supports. ​/environments​/environment​/applicationInfo​/supportedInfrastructureVersion
dataModelNamespace M any​URI The namespace of the data payloads conveyed by this environment. Returns may be of a diffrent minor version. Utility payloads will be of the infrastructure namespace. ​/environments​/environment​/applicationInfo​/dataModelNamespace
transport O string The transport which the Consumer expects the infrastructure to use to interoperate with it. The default is whichever transport the create request was issued on ​/environments​/environment​/applicationInfo​/transport
vendorName O string The name of the company supplying this Product. ​/environments​/environment​/applicationInfo​/applicationProduct​/vendorName
productName * M string The name of the Product ​/environments​/environment​/applicationInfo​/applicationProduct​/productName
productVersion O string The format of this field is undefined, but it should match the format used in the agent's conformance statement, if the agent is SIF Certified. ​/environments​/environment​/applicationInfo​/applicationProduct​/productVersion
iconURI O any​URI HTTP URL referencing an icon for graphical representation of the application/agent. Should range from 16x16 pixels to 128x128 pixels and be of an image MIME type commonly supported by Web browsers (e.g. PNG, JPEG, GIF). ​/environments​/environment​/applicationInfo​/applicationProduct​/iconURI
vendorName O string The name of the company supplying this Product. ​/environments​/environment​/applicationInfo​/adapterProduct​/vendorName
productName * M string The name of the Product ​/environments​/environment​/applicationInfo​/adapterProduct​/productName
productVersion O string The format of this field is undefined, but it should match the format used in the agent's conformance statement, if the agent is SIF Certified. ​/environments​/environment​/applicationInfo​/adapterProduct​/productVersion
iconURI O any​URI HTTP URL referencing an icon for graphical representation of the application/agent. Should range from 16x16 pixels to 128x128 pixels and be of an image MIME type commonly supported by Web browsers (e.g. PNG, JPEG, GIF). ​/environments​/environment​/applicationInfo​/adapterProduct​/iconURI
@name infrastructure​Service​Names​Type ​/environments​/environment​/infrastructureServices​/infrastructureService​/@name environment, provisionRequests, requestsConnector, eventsConnector, queues, subscriptions, servicesConnector
infrastructureService * infrastructure​Service​Names​Type ​/environments​/environment​/infrastructureServices​/infrastructureService
@id * M string The unique id of the Zone, and the key to the Zone element in the Zone Registry. ​/environments​/environment​/provisionedZones​/provisionedZone​/@id
@name * string The name of the Service. For utilities, this is fixed to one of the defined set of Utility Service Names. For objects and functions, it is defined by the Data Model. ​/environments​/environment​/provisionedZones​/provisionedZone​/services​/service​/@name
@contextId * string The unique identity of a context element, which is associated with a Provider of this name and type operating in a Zone with this ID. All Services with the same name in the same Zone must have different Context IDs. Only one such Service can have no Context. ​/environments​/environment​/provisionedZones​/provisionedZone​/services​/service​/@contextId
@type * service​Type​Type ​/environments​/environment​/provisionedZones​/provisionedZone​/services​/service​/@type UTILITY, OBJECT, FUNCTIONAL, SERVICEPATH, XQUERYTEMPLATE
@type * M string The type of the requested Access Right ​/environments​/environment​/provisionedZones​/provisionedZone​/services​/service​/rights​/right​/@type QUERY, CREATE, UPDATE, DELETE, PROVIDE, SUBSCRIBE, ADMIN
right * M string The type of the requested Access Right ​/environments​/environment​/provisionedZones​/provisionedZone​/services​/service​/rights​/right APPROVED, SUPPORTED, UNSUPPORTED, REJECTED, REQUESTED

Download: .xlsx

XML Structure

<environments xmlns="http://www.sifassociation.org/infrastructure/3.2"> <environment type="" id=""> <sessionToken/> <solutionId/> <defaultZone id=""> <description/> <properties> <property name=""/> </properties> </defaultZone> <authenticationMethod/> <instanceId/> <userToken/> <consumerName/> <applicationInfo> <applicationKey/> <supportedInfrastructureVersion/> <dataModelNamespace/> <transport/> <applicationProduct> <vendorName/> <productName/> <productVersion/> <iconURI/> </applicationProduct> <adapterProduct> <vendorName/> <productName/> <productVersion/> <iconURI/> </adapterProduct> </applicationInfo> <infrastructureServices> <infrastructureService name=""/> </infrastructureServices> <provisionedZones> <provisionedZone id=""> <services> <service name="" contextId="" type=""> <rights> <right type=""/> </rights> </service> </services> </provisionedZone> </provisionedZones> </environment> </environments>

Download: .xml