DominoDefrag - How to build a successful OpenNTF project (AusLUG 2012)

AusLUG2012
DominoDefrag - How to build a
successful OpenNTF project

Andrew Luder | Director | NotesTools Pty Ltd
http://notestools.com.au
Meet.Share.Learn

29th & 30th March, Melbourne, Victoria, Australia

AusLUG2011
AusLUG2012

Agenda

•
About Me
•
About DominoDefrag
•
OpenNTF Initial Concepts
•
Project Creation
•
Project Update
•
Catalog
•
Project Maintenance
•
Project Feedback
•
Staying Afloat
•
Building Business
•
OpenNTF Involvement

Meet.Share.Learn 29th & 30th March, Melbourne, Victoria, Australia

AusLUG2011
AusLUG2012

About Me

•
Started my business NotesTools Pty Ltd two years ago initially providing
formal business support to DominoDefrag. Have expanded business to
provide wider range of products (e.g. DominoClusterMate) and services.

•
IBM R8.5 Certified Application Developer with over 15 years experience
in providing Lotus Domino/Notes/Sametime infrastructure and
application development services to Australian government departments
- primarily Department of Defence. Currently working on a R853
application upgrade project at the Therapeutic Goods Administration
(TGA) .
•
Many years experience in providing open source solutions such as
"DominoDefrag“ (2009) and "R5 Database Manager“ (2004) to the
Lotus Notes community. I was given public recognition in May 2010 with
"DominoDefrag" honoured by OpenNTF as project of the month,
presented at Lotusphere 2011 in Orlando and is still a featured project.


AusLUG2011
AusLUG2012

About DominoDefrag

•
DominoDefrag v3.5 is an open source solution comprising of a R853+ C
API Lotus Domino server task (DominoDefrag.exe) and a R853+ Lotus
Domino server XPages mobile database called the DominoDefrag
Administrator (DominoDefragAdmin.nsf relies on the extension library
from OpenNTF). See http://notestools.com.au/DominoDefragAdmin.nsf
•
The server task uses "contig.exe" (v1.6) to defrag Domino databases on
all Windows server 2003 and 2008 versions (32bit and 64bit) and will
also defrag a full-text index associated with a Notes database and the
Domino server’s transaction log and DAOS files. When
DominoDefrag_EnterpriseSupport=1 (on), the output is recorded to CSV
files and sent to the DominoDefrag Administrator for processing
attached to a summary.
•
DominoDefrag has the added functionality of being able to compact and
add space to a database prior to defragging and supports multi-
processing (can load multiple times to run concurrently) and use of an
indirect file (.ind) to have the same compact batch functionality.

AusLUG2011
AusLUG2012

Initial Concepts - OpenNTF Mission

•
The Mission of OpenNTF is to support the open source projects hosted
at OpenNTF.Org. OpenNTF provides the framework to develop open
source applications which may be freely distributed.

AusLUG2011
AusLUG2012

Initial Concepts - OpenNTF Organization


AusLUG2011
AusLUG2012

Initial Concepts - OpenNTF Statistics


AusLUG2011
AusLUG2012

Initial Concepts - OpenNTF Devoted To

•
“OpenNTF is devoted to getting groups of
organizations and individuals all over the world to
collaborate on IBM Lotus Notes/Domino
applications and release them as open source”


AusLUG2011
AusLUG2012

Initial Concepts – OpenNTF Value


AusLUG2011
AusLUG2012

Initial Concepts – Becoming a Contributor

•
Contributors form the backbone of OpenNTF. They develop and
manage project and code snippet activities. Any Contributor may apply
to join an ongoing Project by sending a request to the Project Lead; or
initiate a Project or Code Snippet.
•
To contribute to a project or code snippet activity:

Create an OpenNTF user account.

Complete either an Individual Contributor License Agreement
(“ICLA”) or Corporate Contributor License Agreement (“CCLA”) and
then send an email with scanned hardcopy to the IP-Manager

•
IBM Champion Declan Lynch contributes to Blogsphere V4, fileSendr,
iWatch X, jQuery Extension Library, Signature Capture Control, XPages
Sliding Login Custom Control, XPages System Alerts, xTalk Discussion
Forums...... (stop now - this guy's a machine!)


AusLUG2011
AusLUG2012

Initial Concepts – Becoming a Committer

•
Committers are the OpenNTF Release Managers. They along wit the
IP-Manager handle the release process of applications into the
Application Catalog described by the IP Policy.
•
To become a Committer you must:

First be a Contributor.

Apply to the IP-Manager who will then organise an electronic vote of
the existing Committers to accept or reject your application.
Alternatively, the Steering Committee may appoint Committers.

IBM Champion Declan Lynch was a committer for DominoDefrag


AusLUG2011
AusLUG2012

Initial Concepts – Intellectual Property Model

•
Note: Peter Tanner the OpenNTF IP Manager posted a blog called the
"Comparisons between the Apache (permissive) and GPL (restrictive)
Licensing Paradigms" recently. GPL=GNU General Public License

AusLUG2011
AusLUG2012

Initial Concepts - Catalog

•
The Catalog consists of committed release ”Rich Client Components”
(drag and drop), “Reusable Controls” and “Projects” applications. There
is an Apache and GPL version of it.
•
Uncommitted release applications have to be scanned by the IP-
Manager and Committer(s) before being committed into the Catalog.

AusLUG2011
AusLUG2012

Initial Concepts - Drag and Drop Components

•
Example: ISW’s WildFire! which is a Drop and Drop component for the
Lotus Notes 8.5 sidebar (used to update ones social network status)
won the Lotusphere 2011 Lotus Awards Open Source category.

AusLUG2011
AusLUG2012

Initial Concepts - Reusable Controls

•
Example: DominoDefrag uses the Java Charts reusable control in its
XPages Administrator database.


AusLUG2011
AusLUG2012

Initial Concepts – Projects

•
Example: DominoDefrag was the May 2010 OpenNTF Featured Project. The
Domino server THUNDERSTRUCK from domain ACDC being defragged.


AusLUG2011
AusLUG2012

Initial Concepts - Project Management
Interface

•
The Project Management Interface manages the process of development
through to uncommitted release of any "Rich Client Components" (drag and
drop), "Reusable Controls" and Projects. This is separate from the Catalog
which stores the latest application committed release.


AusLUG2011
AusLUG2012

Initial Concepts – XSnippets Code Bin

•
The XSnippets Code Bin allows approved OpenNTF contributors who have
signed CLAs (contributor license agreements) to submit code snippets for
community use.


AusLUG2011
AusLUG2012

Initial Concepts – Creating a XSnippet

•
Simply click “Create XSnippet”, insert the code, provide a meaningful Name,
select the Notes language, Preview, read the “Terms of Use” and then Save.


AusLUG2011
AusLUG2012

Project Creation – Considerations

•
While any Contributor may create new Projects, it is recommended that
the Project plan first be posted to the OpenNTF Forum to canvas the
opinions of other users. Even if the plan is just a simply idea to start
with!
•
If there is another similar project already on OpenNTF, consider teaming
up with its project member(s) so that you can get more done in less
time.
•
By creating a project, you agree to the IP Policy and to provide the full
source code for the application.
•
Check the licensing compatibility of any third party components you
want to use with the IP-Manager and recognise use and any licensing
differences in distribution Notice file.


AusLUG2011
AusLUG2012

Project Creation – Considerations Cont.…

•
The project’s distribution file should contain full source files, all target platform
binaries, release notes, licensing files and any other documentation that will
ensure the usage of the product is compliant and successful.


AusLUG2011
AusLUG2012

Project Creation - DominoDefrag Goals

•
Use free Windows Sysinternals tool called "contig.exe" on a Windows
Domino server to defragment NSFs while the server was running to
increase performance and not corrupt databases.
•
Share and advance C/C++ Notes API server add-in code and build
documentation with community as know-how scarce and limited to a
few.
•
Learn how to integrate a server add-in with new R85x technologies such
as XPages, custom controls, extension library controls and SSJS.
•
Build business to provide formal support to open source code.


AusLUG2011
AusLUG2012

Project Creation – Find and Create Projects

•
Login, simply click on the Projects tab and then click on the “Creating new
projects” link.


AusLUG2011
AusLUG2012

Project Creation – Create New Project

•
Put the name of your project simply click the Create button.
•
Once OpenNTF has accepted in effect the “project proposal”, notification is
sent the new Project Owner and the Project is added to the owner’s Project
Meet.Share.Learn
list. 29th & 30th March, Melbourne, Victoria, Australia

AusLUG2011
AusLUG2012

Project Update – Complete Overview

•
Complete the Overview document fields and then click Save.
•
Talk more about Donate button soon….


AusLUG2011
AusLUG2012

Project Update – Create Release

•
Click “Downloads / Releases” and then click “Create Release”.


AusLUG2011
AusLUG2012

Project Update – Incubator Release (Code)

•
Complete Release fields, but leave the Status at “Do not release” and then
click the Save button. This allows a final peer review of the distribution code
by only other Project Contributors who have been approved by the Project
Owner.

AusLUG2011
AusLUG2012

Project Update – Incubator Release (License)
•
This allows a final peer review of the distribution file by (only happens on
first release and not subsequent) by the IP-Manager and assigned
Committer who apply the following criteria:

Those contributing to the Project are covered by ICLAs or CCLAs;

The license under which the contribution is to be made available is
compatible with either OpenNTF’s Apache or GPL licensing models;

The licensing and Notice information is clearly noted;

The code was entirely written by the Contributor(s) or, if there is
material from third parties, that the Contributor has written permission
or a license to include such material; and

The Project Lead has the IP Manager's approval for any encryption
code that is in the Project.

•
There is no need for subsequent Releases to go through the Incubator
stage – as long as all the five above conditions continue to be met. The
now Uncommitted Release can now be accessed by everyone.


AusLUG2011
AusLUG2012

Project Update – Uncommitted Release

•
Change the Status field to “Released” and then click the Save button to be
downloaded and used by anyone through the OpenNTF website. On request
OpenNTF can then perform an IP review of the Uncommitted Release’s
distribution file for commitment into the Catalog (discussed later).

AusLUG2011
AusLUG2012

Project Update – Create Screenshot

•
Click “Screenshots” and then click “Create Screenshot”.


AusLUG2011
AusLUG2012

Project Update – Complete Screenshots

•
Complete Screenshot fields and then click the Save button.


AusLUG2011
AusLUG2012

Project Update –Screenshots Displayed

•
Use the Navigator buttons to scroll through the Screenshots.


AusLUG2011
AusLUG2012

Project Update – Create Documentation

•
Click “Documentation” and then click “Create Documentation”.


AusLUG2011
AusLUG2012

Project Update – Complete Documentation

•
Complete Documentation fields, add prepared documents and click Save.


AusLUG2011
AusLUG2012

Project Update – News

•
Create a News item and users subscribed to the project will receive that and
other projects updates such as new Releases, Screenshots and
Documentation. Users click on “Subscribe to Project (RSS)” to subscribe.

AusLUG2011
AusLUG2012

Project Update – Subscribe to Project

•
Accept defaults and click “Subscribe Now”.
•
Accept defaults in the Live Bookmark prompt box and click Subscribe.


AusLUG2011
AusLUG2012

Project Update – RSS Bookmark Feed

•
See “OpenNTF.DominoDefrag” RSS feed from Firefox Bookmarks.


AusLUG2011
AusLUG2012

Project Update – Ready To Go!

•
Click Overview and then Download latest release to obtain the of
uncommitted “Project Release” distribution file. Also the latest matching
Screenshots and Documentation should be available too.


AusLUG2011
AusLUG2012

Catalog – Process

•
To initiate a Catalog Release, simply send an email to the IP-Manager
requesting it. The IP-Manager and a Committer will then carry out an
analysis of the uncommitted Release distribution file. Issues that are
found will be posted by the IP-Manager to a Project area accessible to
the Project Lead, the Project Contributors and the Project Observers.
•
The items analysed during the IP Review :

Verification that Contributors are covered by ICLAs or CCLAs;

All 3rd party code accounted for in Notice files;

Licenses are compatible;

Documentation completed; and

Code appears to run properly.


Committer will then update the Catalog with the distribution file and flag
in the project’s Overview document.


AusLUG2011
AusLUG2012

Catalog – Third Party Components

•
DominoDefrag v3.4 started using Naveen Maurya's Java Charts custom
control v1.2 to perform graphical reporting. Acknowledgement of the
different GPL licensing for the third party components is required using a
Notice file similar to the “Notice.txt” in the DominoDefrag distribution file.


AusLUG2011
AusLUG2012

Catalog – Committed Release

•
DominoDefrag v3.5 updated by the Committer into the GPL Catalog.


AusLUG2011
AusLUG2012

Project Maintenance - Create Feature Request

•
Click “Feature Requests” and then click “Create Feature Request”.


AusLUG2011
AusLUG2012

Project Maintenance – Processing Request

•
The Project Owner can then assess the feature request and then provide
feedback and change the status from “Submitted” to “Investigating”,
“Rejected” or “Added to app” and then click Save. Contributor notification then
occurs.

AusLUG2011
AusLUG2012

Project Maintenance - Create Defect

•
Click “Defects” and then click “Create Defect”.


AusLUG2011
AusLUG2012

Project Maintenance – Processing Defect

•
The Project Owner can then assess the defect report and then provide
feedback and change the status from “Submitted” to “Investigating”,
“Rejected” or “Fixed” and then click Save. Contributor notification then
occurs.

AusLUG2011
AusLUG2012

Project Feedback – Create Discussion

•
Click “Discussions” and then click “Create Discussion”.


AusLUG2011
AusLUG2012

Project Feedback – Processing Discussion

•
Discussions can be the main driver for change. This discussion with Ulrich
Krause lead to DominoDefrag being rewritten to use the C API (changed from
C++ API).

AusLUG2011
AusLUG2012

Project Feedback – Reviews and Ratings

•
Click “Reviews” and then click “Create Review”.
•
Click “Rate Project” and give 1 to 5 stars – can do only once for each project
and owners can’t rate their projects from memory 

AusLUG2011
AusLUG2012

Project Feedback – Outside OpenNTF

•
DominoDefrag has received very positive feedback from bloggers and
presenters like Albert Buendia and Ulrich Krause presenting it at many Lotus
User Groups such as the Spanish Lotus User Group (SLUG) .

AusLUG2011
AusLUG2012

Staying Afloat– PayPal Donation Button

•
Create PayPal account and easy to get HTML generated for the Donate
button.
•
Edit the Overview document, paste the PayPal HTML code in and then click
the Save button.

AusLUG2011
AusLUG2012

Staying Afloat - Providing Formal Support

•
For example, “DominoDefrag Enterprise Edition” provides formal support for
“DominoDefrag”.

AusLUG2011
AusLUG2012

Building Business - Leveraging into similar products

•
For example, DominoDefrag v3.4 introduced a subset of the
DominoClusterMate functionality.

AusLUG2011
AusLUG2012

Building Business- Leveraging into different Products

•
For example, use DominoDefrag success to leverage into completely
different products like ExtractText.

AusLUG2011
AusLUG2012

Building Business - Lotus Greenhouse

•
For example, publishing DominoDefrag in the "IBM Lotus and WebSphere
Portal Business Solutions Catalog" @ the Lotus Greenhouse site.

AusLUG2011
AusLUG2012

Building Business – Global Solutions Directory

•
For example, registered NotesTools Pty Ltd in the IBM PartnerWorld program
and then got DominoDefrag published to the Global Solutions Directory

AusLUG2011
AusLUG2012

OpenNTF Involvement– 5 Ways to Participate

•
There is also competitions to encourage participation such as the XPages
Development Contest @ http://xpages.info

AusLUG2011
AusLUG2012

OpenNTF Involvement – Follow


AusLUG2011
AusLUG2012

Questions?


DominoDefrag - How to build a successful OpenNTF project (AusLUG 2012)

Empfohlen

Empfohlen

Weitere ähnliche Inhalte

Ähnlich wie DominoDefrag - How to build a successful OpenNTF project (AusLUG 2012)

Ähnlich wie DominoDefrag - How to build a successful OpenNTF project (AusLUG 2012) (20)

Kürzlich hochgeladen

Kürzlich hochgeladen (20)

DominoDefrag - How to build a successful OpenNTF project (AusLUG 2012)

Hinweis der Redaktion