Title: VTC Dr' Ken Pisel Dean JCDES Angela Lindsey Project Manager Greg Frederick System Architect Kathryn
1Enhanced Version Control for the ADL-R Joint ADL
Implementation Fest27 August 2008
Angela Lindsey Project Manager Northrop Grumman
2Agenda
- Introduction
- Research Strategy
- Research Results
- Best Practices
- Design Strategy
- Assumptions
- Demonstration
3Introduction
- Project Goals
- Promote sharing registry use by overcoming
currency issue - Provide visibility of version control changes
content relationships - Automate change notifications (generate custom
emails alerts) - Phase I The ADL-Registry Client (ADL-RC)
prototype - Compares registered metadata to local data
emails change alerts - Network security restrictions limit use DoD wide
- Need for alternative web-based solution
- Phase II The ADL-R Version Control System (VCS)
- IDs changes to registered metadata based on
users online profile - Determine best practices for ADL-R updates
- Design/develop VCS prototype for the registry
Both prototypes connect to the ADL Practice
Registry for testing but may be configured to
work with other registry systems.
4Research Strategy
- Collaborate w/ ADL-R team Distance Learning
Coordination Committee (DLCC) - Conduct requirements gathering study
- Solicited feedback from target audience
(Repository Managers, ADL Registry Users Group,
DLCC, etc.) - Collate analyze VCS requirements
- Research Results for the ADL Registry VCS
Requirements Gathering Questionnaire - The ADL Registry Best Practices for Updating
Registered Content
5Research Results Summary
- Registry portal
- Complicated registration process prevents
widespread adoption - 28 of study participants have content registered
- As user base grows, so will need for VCS
- Versioning practices
- Numbering system used most often
- Revisions (minor) vs. versions (significant
material updates) - Maintain metadata in ADL-R over content lifecycle
- Content management system good practice
- Proposed ADL-R enhancements
- Concept to monitor/notify users of changes
supported - Majority willing to login to the ADL-R to
customize preferences use email change
notification (requires session management) - RSS feeds less popular but still value-added (43
likely to use)
6Research Results Summary (cont.)
- Other features deemed important or very important
- supporting documentation (74)
- frequently asked questions (62)
- version history details (60)
- check for updates search (48)
- scheduled email alerts (48)
- genealogy information (47)
- communication features (44)
- user ratings comments on registered content
(44)
7Best Practices Summary
- Best Practices for Updating Registered Content
- Follow relevant guidance documentation
- Establish working groups within communities of
practice - Utilize a life cycle content management approach
- Implement a versioning approach
- Register content object metadata
- Register all version updates history
- Use the Relation element to describe content
relationships (example code provided) - Set up version notifications for relevant content
(introduces ADL-RC email alerts)
8Design Strategy
- Primary requirements
- Runs data comparison at set intervals
- Identifies changes
- Sends email alerts (user admin emails)
- Design considerations
- Open source, generic
- System requirements
- Network restrictions
- Design methodology pattern
- Supports
- Session management
- HTTP POST queries through RIM-Lite
- ADL-R search engine
9Assumptions
- Content owners should
- Employ/register meaningful metadata
- Define version, change description, relationships
- Update over content lifecycle
- Users of shared content should
- Share responsibility for content currency
- Flag items used set alerts
- Register repurposed content with relationship
data - Communities of practice should
- Define additional guidelines to promote internal
sharing version control efforts - Employ ADL-R VCS /or ADL-RC when available
- Push version changes
10Next Steps
- Transition prototype to user community
- Components must adhere to DODI requirements
- Content alerts can increase registry use
- Session management advantageous
- Expand version control initiatives
- Migrate prototype code to ADL-R
- Promote VCS use best practices to ADL community
- Potential future enhancements
- Push alerts listing all new content
- Publish additional RSS feeds
- Include alert subscription code block
11 ADL-R VCS PROTOTYPE DEMONSTRATION
12Subscribe to Alerts
- Users subscribe to email alerts, using keywords
or content ID - Frequency target content can be changed
- Alerts are saved may be edited or deleted
http//68.166.160.678070/alerts/portalexample.htm
13Alert Session Management
- Register or login to manage profile
- VCS recognizes login, changes menu populates
profile data - Member given access to manage alerts
14Manage Alerts
- Screen shows content alerts watch list items
- Alert management functions allow for edit, update
or deletion - Alert profiles watch list profiles appear
- Edit the scope, frequency, search, and/or status
15Update Registration Profile
- Users can update profile data
- Name
- Email
- Passwords
- Interests
16Search Flag Content
- Content can be flagged through an alert email or
from search results - Flagged content items are added to the watch list
17Available on Email Alerts
Flag Content Option
- New content email alerts have Flag Content option
- Flagged content items are added to the watch list
18View Metadata
- Content metadata may be viewed from search
results email links - HTML XML formats
19Version History Relationship View
Search Results
- The search results provides a link to a version
history view relationship view - The new content emails also provide access to
these views
20Version History View
- This view indicates other versions of this
content ID
21Relationship View
- This view indicates other content with
relationships to this content ID
22Subscribe to RSS Feeds
- This screen lists available RSS feeds
- Application adopters can select which topics to
include - VCS will generate the RSS feed as scheduled
- The generation frequency can be set in the
generator file
23RSS Subscription
- The user can subscribe to an RSS feed with an RSS
reader - RSS readers are incorporated in current browsers
24Help Feedback Screens
- Help section explains the basic system functions
- A temporary feedback or bug reporting function is
provided for the prototype
25 ADL-R VCS PROTOTYPE SAMPLE EMAILS
26New Content Alert Email Methodology
- Queries RIM-LITE 1.6.1 for
- KEYWORD AND SYSTEMDATE30 days ago TO current
date - Example Unmanned Aerial Vehicles AND SYSTEMDATE
070108 TO 073008 - SYSTEMDATE - date content accepted into
registry - Runs daily or as configured
27New Content Alert Email
- New Content Alerts report new content submitted
to the registry in the last frequency interval - The search is keyword-based
- Date inclusion query uses SYSTEMDATE
28Content Change Alert Email Methodology
- Queries RIM-LITE 1.6.1 for flagged content ID
metadata and newest version - contentIdentifier 4444.22/1234 AND
SYSTEMDATE30 days ago TO current date - Tests for
- ADL-R Version 1.6.1 Change in ContentIdentifier
and then - /lom/relation/resource/identifier/entry
- /lom/relation/kind/value
- Isversionof
- Ispartof
- ADL-R Version 1.7 Indexed keys needed for these
LOM elements to provide efficient query - Performs metadata element by element comparison
and highlights elements that have changed - Provides a link to the full metadata of the
original item and latest changed item - Scheduled to run daily
29Content Change Alert Email
- This email displays changed metadata based on the
selected frequency interval - A link to the last version is provided also
30Other ADL-R VCS Emails
- Alert emails for No Results
- Optional setting for mission critical items
- Determined by configuration parameter
- Workflow emails
- User notification emails
- Registration complete
- Alert created
- Admin notification emails
- Alert subscribed
- New content alerts generated
- Change alerts generated
- Member login
31 Questions?