Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Form Filling
Contents
Introduction
This document describes how the Persona Data Model 2.0 can be used to support a Javascript form filling application (app-card) making API calls into the PDS Client of an active client. We will illustrate by walking through the following scenario rom a cold start (i.e. a clean install of a browser-integrated active client):
- Alice points her browser at staples.com and proceeds to try to buy a stapler. She eventually arrives at a checkout page
- Alice fills in the form and submits it
- Active client builds context data structures from what it has observed
- Alice points her browser at bestbuy.com and proceeds to buy a new CD
- Active client attempts to assist Alice in filling the form from persona data
- Alice edits/corrects form elements and submits it
- Active client builds persona structures from what it has observed
Data structures at start
At the start only the root context shown here exists:
:_ContextSingleton rdf:type persona:RootContext . :RootMe rdf:type persona:Persona .
Step 1
Alice eventually ends up at this form:
The form filling Javascript will make a getExAttributes() call into the PDS Client API (of the active client) passing (among other parameters) the above form's submit URL.
This causes the PDS Client to
- Normalize the form submit URL into a role-name string
- Find and load the mapping context whose name matches the domain of the site (e.g. staples.com) and find within it the HTMLForm subclass whose name matches the role-name string (normalized form submit URL). For example the staples.com ontology includes the mapping rules to map staples-specific HTML form elements into the PDM.
- Find all contexts whose type is
p:Dynamic
and whosep:roleName
matches role-name - If one or more of these did exist then we would use the attributes from the persona nodes of these contexts as the source attributes for form filling. However since this is a cold start no matching contexts exist.
Root Context
The root context is unchanged.
Staples.com mapping context
We assume that the staple.com mapping context exists and is loaded. In addition to the _ContextSingleton it defines a subclass of HTMLForm called "Office-supplies-StaplesCheckoutFlow":
Note: all of the many of spin:rule attributes of the Office-supplies-StaplesCheckoutFlow class have been omitted above.
Step 2
Step 2: Alice fills in the form and submits it
Step 3
The Form Filler program calls setAttributes() and records the values Alice entered. These data are mapped into the PDM by mapping rules defined by the staples.com mapping context described above. The net result is the creation of two new contexts. One is a Buyer-class context. The other is a Recipient-class context.
Root Context
The RootMe gains two new p:subCorrelation links. The first points to the "Persona_1" node in the Buyer context. The other points to the "Persona_1" node in the Recipient context.
Note: some details omitted above.
Buyer Context
Here are the contents of the Buyer context:
:Address_1 rdf:type vcard:Address ; rdfs:label "Address_1"^^xsd:string ; vcard:extended-address "Suite 1000"^^xsd:string ; vcard:locality "Peoria"^^xsd:string ; vcard:postal-code "61604"^^xsd:string ; vcard:region "IL"^^xsd:string ; vcard:street-address "123 S Main Street"^^xsd:string . :Name_1 rdf:type vcard:Name ; vcard:family-name "Jones"^^xsd:string ; vcard:given-name "Alice"^^xsd:string . :Persona_1 rdf:type persona:Persona ; vcard:adr :Address_1 ; vcard:n :Name_1 ; vcard:tel :Voice_1 . :Voice_1 rdf:type vcard:Voice ; rdf:value "tel:+358-555-1234567" . :_ContextSingleton rdf:type persona:Dynamic , persona:Buyer ; persona:roleName "Staples.com-office-supplies-StaplesCheckoutFlow"^^xsd:string .
Recipient Context
Here are the contents of the Recipient context:
:Address_1 rdf:type v:Address ; v:locality "Wellesley Hills"^^xsd:string ; v:postal-code "02481"^^xsd:string ; v:region "MA"^^xsd:string ; v:street-address "30 Washington Street"^^xsd:string . :Name_1 rdf:type v:Name ; v:family-name "Jones"^^xsd:string ; v:given-name "Alice"^^xsd:string . :Persona_1 rdf:type p:Persona ; v:adr :Address_1 ; v:n :Name_1 ; v:tel :Tel_1 . :Tel_1 rdf:type v:Tel ; p:password "tel:+358-555-1234567"^^xsd:string . :_ContextSingleton rdf:type p:Dynamic , p:Recipient ; p:roleName "Staples.com-office-supplies-StaplesCheckoutFlow"^^xsd:string .
Step 4
Alice points her browser at bestbuy.com and proceeds to buy a new CD.
When Alice reaches the checkout page, the Form Filler program attempts to auto-fill the checkout data. It does so by calling getExAttributes().
The PDS Client implementation of getExAttributes() first attempts to load the bestbuy.com mapping context. The mapping rules require "source" contexts (and their contained personas) to use to fill in the values. To find a suitable source context, we search for a context that matches both and "external" role and has a dynamic role whose roleName matches the normalized string representation of the HTML form submit URL. The "external" role subclass is looked up on the context singleton of the bestbuy.com context. It is found to be of value "p:Ecommerce". Thus the PDS Client will try to find a context that has both the p:Ecommerce role and the p:Dynamic role and whose p:roleName is "@@@@@bestbuy.com-checkout-page."