Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "App-data vocabulary"
(→Links) |
(→UML Overview) |
||
| Line 9: | Line 9: | ||
==UML Overview== | ==UML Overview== | ||
| − | [[Image: | + | [[Image:App-data 2.0.103.png|center]] |
== Classes == | == Classes == | ||
Revision as of 19:11, 18 July 2011
{{#eclipseproject:technology.higgins|eclipse_custom_style.css}}
Vocabulary for describing the contents of an app-data context. Provides the classes and attributes to represent the (i) app-related attributes of the person entity referenced by proxy:Card's proxy:resource link and (ii) as well as the metadata and parameters needed for the app itself. Part of the Persona Data Model 2.0
Contents
Files
- Most recently published
- SVN source: app-data.owl
UML Overview
Classes
AppDataContext
A kind of context holding an AppData instance as well as the entity (usually p:Person) referenced by the proxy:resource of an proxy:Card.
- subClassOf: ctxt:Context
- 1..1 appData
AppData
The information about an app. This information is pointed to by a appData attribute held by the context holding the target of an app-card's resource-udr.
- 1..1 appId
- 1..1 description
- 1..1 version
- 1..1 eventHandlerURL
- 1..1 adminURL
- 1..1 serviceType - the type of service from which the Javascript is fetched
- 1..1 serviceURL - the Javascript service URL
- 0..1 params
- 0..N hbxFunctionsEnabled
- 0..N sites
- 0..N entityParam
AppParams
An AppParams instance is the value of an AppData's params attribute. It is a set of attributes and values used to initialize the app. Note: these attribute/values are combined with those derived from the AppData's entityParam.
AppDataContext Attributes
appData
The information about an app. This information is pointed to by the context holding the entity referenced by the proxy:resource attribute of a proxy:Proxy instance.
- domain:
AppDataContext - value:
AppData
AppData Attributes
adminURL
The URL of a webapp to load into an active client's "dashboard" (admin) UI.
- domain:
AppData - value: xsd:anyURI
appId
Uniquely identifies the app within the "developerId" (i.e. the card issuer) namespace. In other words the combination of the devID and the appId is globally unique. When using Kynetx KNS this is the ruleID with special constraint that this ruleID is globally unique.
- domain:
AppData - value: string
description
A human readable description of the app. Note: If appServer == http(s)://init.kobj.net, then the KNS "describe" API can be used by a context provider implementation to provide this attribute value.
- domain:
AppData - value: string
entityParam
The name of an attribute (e.g. p:postal-code) of the "target" entity of the app-card. The value of this named attribute of the target entity is used as a parameter to the app-card's app.
- domain:
AppData - value: URI
entityParam
The value is the (URI) name of an attribute on the AppCard's target entity. This referenced attribute and its value should be used to initialize the app.
- domain:
AppData - value: URI name of an attribute
eventHandlerURL
The URL of JS to load into an active client to provide card specific handlers for certain events in a card’s lifecycle including: onImport, onDelete, onEnable, onDisable, onExport
- domain:
AppData - value: URI
hbxFunctionsEnabled
The list of HBX functions that the JS functions associated with this card are allowed to call.
- domain:
AppData - value: string one of: {"delExAttrbutes" , "getExAttributes" , "getSuggestions" , "setExAttributes"}
params
A set of attributes used to initialize the app.
- domain:
AppData - value: AppParams
serviceURL
The URI giving the endpoint from which the Javascript should be fetched.
- domain:
AppData - value: URI
serviceType
If value is "kynetx" then the browser extension that will inject the Javascript for this app-card should construct a Kynetx-compatible <script> block and call an initialization URL based on the value of the appService attribute.
- domain:
AppData - value: string whose value is one of ("kynetx", "higgins").
sites
This is not a list of specific URIs, it is a list of strings to match in the domain name part of a URI. So urn:google would fire on maps.google.com, www.google.com, www.googleismyfavoritesite.com. For Kynetx-powered cards (i.e. if appServer = http[s]://init.kobj.net"), the values of this attribute should be dynamically fetched using the 'dispatch' method at URL: [1]<appId>.
- domain:
AppData - value: string
version
A human readable version of the app. Note: If appServer == http(s)://init.kobj.net, then the Kynetx KNS "describe" API can be used by a context Provider implementation to provide this attribute value.
- domain:
AppData - value: string
Attributes of a Person node within the context
enabledSites
The URLs of sites that the user has enabled the card to run on. Note that this augments the appSites value provided by the card developer which indicates the set of sites the app was designed to run on.
- domain is the target entity to which the underlying r-card's resource-udr points.
- value: boolean
disabledSites
The URLs of sites that the user has disabled the card from running on.
- domain is the target entity to which the underlying r-card's resource-udr points.
- value: xsd:anyURI
appEnabled
If true the Javascript of this card is enabled to run.
- domain is the target entity to which the underlying r-card's resource-udr points.
- value: xsd:anyURI
Example AppData
Example of an AppData context:
Shown above is an example AppDataContext (shown as _ContextSingleton above) with its required AppData object. Also within this context is an entity, Person_1.
Notes:
- Of particular interest is the app-card:params attribute whose value is the AppParams_1 object. The AppParams_1 in turn has two app initialization attributes, randomAttribute1 and 2.
- Since "appEnabled" = true attribute/value is not present on Persona_1 its value is assumed to be false and the card is thus disabled at present.
- The above also shows an example of a event:Verification that happened in 1969. Presumably the entire contents of the context were shared with the credit bureau and the Work_1 address was attempted to be verified with a result of "failed."
- The above also shows an example of an event:Disclosure that says that the "v:bday" attribute of the Persona_1 entity has a policy that says that the user "allow"s its disclosure to http://amazon.com.