ODS Facebook Integration
The Facebook API as UDT is the basis of ODS Facebook integration.
Integration Guide
- Note: The steps below must be performed from the ODS administrator, "dba", as regular users will be able to use its Facebook data without doing any of this themselves.
- Register a FB (FaceBook) account here.
- Add to the created FB account a Facebook developer application (or from this location) by performing the steps:
- Set for "Callback Url" field the value:
http://[host]:[port]/ods/fb_front.vspx.
- Specify "Canvas Page URL" field value; this is the facebook url where the application will be available.
- Check the "Use iframe" radio-box.
- After the application is created successfully, copy the generated API key and Secret values shown bellow the FB application. The Key and the Secret values could be also found here.
- Set for "Callback Url" field the value:
- Install the ods_framework_dav.vad and the rdf_mappers_dav.vad packages on a running Virtuoso database using either the Conductor UI or the iSQL tool.
- Login as the dba user.
- Click the name of the dba user, shown as a link.
- Go to "Edit My Profile"-> "Applications and Web Services" tab.
- Enter the values from above for the key={this is the API key from the FB site} and secret={this is the secret from the FB site} values in the Facebook text-area.
- Press "Save".
- After successful execution of this list of actions integration setup is complete.
User Interface
- Note: The steps below can be performed from all users of ODS after the Integration Guide has been completed by admin user (dba).
- Login as an ODS user in http://[host]:[port]/ods
- Click the ODS icon in the beginning of the ODS Navigation bar.
- As result you will be redirected to you ODS Home page (myhome.vspx) and in ODS-BAR(second line) next to the links "Edit my profile" and "My applications" there should be shown the link "My Facebook".
- Note: make sure your ODS bar is set to full mode (by clicking the arrow shown in the beginning of the ODS Menu bar).
-
- Click the link "My Facebook".
- As result you should be redirected to the Facebook front page in ODS with URL:
http://[host]:[port]/ods/fb_front.vspx
- Note:
- The link "My Facebook" will be shown for all regular users after the ODS administrator has already performed the steps from the Integration Guide
- ODS depends on the "dba" facebook setting and will ignore any regular user setting when it generates data for fb_front.vspx.
- Data generated on fb_front.vspx corresponds to user that is logged to Facebook but not to the user that has created development application.
-
- Note:
- Functionality of the fb_front.vspx page:
- user has no Facebook or ODS user, or Facebook and ODS users are not associated.
- user is given information about the Facebook user that is currently logged to facebook (using the same browser)
- user is given information about the Facebook user friends
- user is given information about status of Facebook to ODS user Integration
- user is able create new ODS user that is automatically associated with the Facebook user.
- user is able to associate
- user has Facebook and ODS user which are associated.
- user is able to disassociate Facebook from the ODS user
- user is able create ODS AddressBook and to import Facebook friends as contacts in it.
- user is able update his ODS AddressBook (that already exists) contacts based on Facebook friends info.
- data for Facebook friends of the logged-in user is automatically imported as RDF.
- Information is updated each time user goes to this page.
- After successful RDF data extraction "rdf" icons -
become anchors that will render RDF data about Facebook friends (rdf icon stands to its name) which was imported to virtuoso RDF store.
- user has no Facebook or ODS user, or Facebook and ODS users are not associated.
- Behaviour of the page "Synchronize All":
- Click the link "Synchronize" in the "ODS User info" block.
- As result the "Synchronize all" interface will be opened.
-
- Click the "Synchronize All" button.
- As a result all existing contacts will be updated (using the first contact that matches synchronization criteria) in ODS AddressBook using default/custom mapping.
- Note that the user is able to set a custom mapping for synchronization using the "Set default mapping" block. If the user does not set any mapping, then the default mapping will be used.
- Functionality of the page "all contacts to synchronize":
- Click the link "Show all contacts to synchronize".
- As result the page "all contacts to synchronize" will be opened.
-
- Note the user is offered the options to synchronize his/her contacts one by one.
- The UI presents separate blocks for each FB friend.
- The user is offered all available field values matches for Facebook friend in the ODS AddressBook contacts.
- By default the first match is selected.
- The user can change the matching criteria for the synchronization
- The Facebook and ODS AddressBook contacts are presented with links, so the data for them can be compared and to be chosen the right pair to be matched.
- There is choice to use the default or manual mapping for contact properties.
- The Default mapping can be set by clicking the link "Set Default Mapping".
- This feature offers ability to synchronize in groups.
- When the Default mapping is set, then you can click the "Default" button for contacts and proceed further.
- The Manual mapping can be set by clicking the "Manual" button from the combo button available for each user.
- As result the user will be requested to set mapping and then the contact synchronization is executed.
- The Default mapping can be set by clicking the link "Set Default Mapping".