XPages Extension Toolkit Installation

Lance Spellman | President, WorkFlow Studios

Find Extlib Project on OpenNTF

Go to http://openntf.org

Find the Xpages Extension Library projectLook in Featured Projects scroller

Or, go to Projects tab numerous ways to locate it there

Download from Releases Page

Go to Releases, download latest to DesktopALREADY DONE FOR LAB

Open Download from Desktop

Go to the Windows desktop

Locate the file XpagesExtensionLibrary.zip (top-left corner)

Double-click and extract to c:\extlib-extract

Extracting to new folder c:\extlib-extract

Verify file extraction

Should have files like the picture below

Install Eclipse Plugin to Domino Designer

For Domino Designer, the Extension Library is deployed as an Eclipse Plugin

The updateSite.zip file in the extract contains the plugin

Turn on ability to install plugins in Domino DesignerIn Domino Designer, go to File Preferences

Select Domino Designer

Checkmark option for Enable Eclipse plug-in install

File | Application | Install menu available

Now, a new menu option under File | Application should be available Install

Search for New Features

A dialog box for Install/Update appears with choice for Search for Updates or Search for New Features

Choose radio button for Search for New Features...

Add Zip File Location

For Application Locations dialog, choose Add Zip/Jar Location

Choose UpdateSite.zip file

Go to the c:\extlib-extract directory and locate the UpdateSite.zip file

Verify the updateSite location

The dialog should now have the updatesite.zip file in the Location list and be checkmarked

Click the Finish button on the dialog

Select features to install

A new dialog appears with a prompt to select the features to install

Check the box for the updateSite.zip

Click the Next button

Accept the License terms

Click the radio button for I accept the terms in the license agreements

IMPORTANT! Features won't install if not selected and it is NOT by default

Click Next

Click Finish on the last screen

Verify install from Help Menu

To make sure the install was successful, go to Help | About IBM Lotus Domino Designer

About IBM Lotus Domino Designer

Choose the Plug-In Details button

Verify Plugins are Installed

Scroll down the 2nd column (plug-in name) and look for entries starting with Extended Components Library

Create New Domino Application

From the Designer Home PageClick button for Create a New Application

Extension Library Test

Choose local server

Title: Extension Library Test

Filename: extlib.nsf

Open Application Properties

In the application navigator, open Application Properties

On Advanced Tab, Check Ext Library

In the Xpage Libraries Section, there should now be an entry for com.ibm.xsp.extlib.library

Check it

Save

Create Sample XPage

Go to Xpages in the application navigator and double-click Xpages

Click New Xpage button

Controls View

Far right column of Designer should have a view called Controls

If not, use menu Window | Show Eclipse Views | Controls to display it

Go to Extension Library section

In the Controls view, there are several sections

Near the bottom of the view, there should be a section for Extension Library

If there, congratulations, you've installed the Extension Library into Domino Designer

Server Installation

Installing to Domino Designer just makes the controls available to the Designer client

It doesn't make the controls available at runtime for the Domino server

The same plugins have to be installed on the Domino server

Unfortunately, the server isn't based on Eclipse so we can't use a plugin installer and updateSite.zip to automatically install them

Unzip updateSite.zip

updateSite.zip is in the c:\extlib-extract folder created earlier

Double-click it

Extract to update-site-extract subdir

Extract the files to a new subdirectory under c:\extlib-extract\update-site-extractThese exact paths aren't necessary. We are doing this just to have a reference for this guide

Move Files to Domino Server Directory

Locate your Domino data directorye.g. c:\IBM\Lotus\Domino\Data

Navigate to domino\workspace\applications\eclipes

Full path example: C:\IBM\Lotus\Domino\Data\Domino\Workspace\Applications\Eclipse

From the update-site-extract\features folder, copy the contents into the ...\Eclipse\Features directory

See next slide for screenshot

Repeat for plugins directory

Verify Installation

There should be 1 file that was copied into features directory

There should be 8 files that were copied into plugins directory

At the Domino server consoleType tell http quit

Load http

Verify ext lib loaded

At server command prompt, type:tell http osgi ss com.ibm.xsp.extlib

Results should look like this:

Install Mobile Controls

For the mobile components of the Extension Library to work, it requires the dojox/mobile library from Dojo 1.5

Domino 8.5.2 ships with Dojo 1.4.3

Dojo 1.5 has to be downloaded and then a subset of it moved into the Domino subdirectories

Download Dojo 1.5

Go to http://dojotoolkit.org/download(not necessary for lab, file has been put on desktop)

Download the Dojo Toolkit Release zipfile not Dojo Base

Extract Dojo Files

Double-click the dojo-release-1.5.0-zip file to c:\dojo-extract

Copy mobile.js file

Copy C:\dojo-extract\dojo-release-1.5.0\dojox\mobile.js to

C:\IBM\Lotus\Domino\data\domino\js\dojo-1.4.3\dojox\mobile.js

Copy dojox\mobile

Copy the entire Mobile subdirectory into the dojox folder on the Domino server

Mobile is a new module in dojo 1.5 that did not exist in 1.4, therefore the entire dojox\mobile subdirectory is new, and we copy it into the 1.4.3 dojox folder

Copy c:\dojo-extract\dojo-release-1.5.0\dojox\mobile to

C:\IBM\Lotus\Domino\data\js\dojo-1.4.3\dojox

Install Mobile Themes

Xpage theme files for iPhone, Android, and Blackberry are included in the extension library download

Theme files must be put into the Domino subdirectories

In c:\extlib-extract, open the src.zip file and extract it to c:\extlib-extract\src-extract

Locate and copy .theme files

In the src-extract folder, navigate to\eclipse\plugins\com.ibm.xsp.extlib.mobile\resources\mobile\themes

There are 3 .theme files located there

Copy them toc:\IBM\Lotus\Domino\xsp\nsf\themes

Tell http restart at server console

Congratulations!

The Extension Library is now installed on both the Domino server and client

The next step is to get the Demo database on the server and try it out to see the new controls at work

Copy Demo Database

In the c:\extlib-extract there is a Notes database called XpagesExt.nsf

Copy it to the data directory on the Domino server

Open the database with the Designer client

Sign the database

Open Demo Database in Browser

http://127.0.0.1/XPagesExt.nsf

Login as Domino Admin, passw0rd

Go to the Mobile Tab

Click the Tab for Mobile and then choose iPhone from the Navigator

If the Mobile components are installed correctly, an iPhone frame will appear on the screen

Legal Disclaimers

WorkFlow Studios 2010. All Rights Reserved.

The information contained in this publication is provided for informational purposes only. While efforts were made to verify the completeness and accuracy of the information contained in this publication, it is provided AS IS without warranty of any kind, express or implied. WorkFlow Studios shall not be responsible for any damages arising out of the use of, or otherwise related to, this publication or any other materials. Nothing contained in this publication is intended to, nor shall have the effect of, creating any warranties or representations from WorkFlow Studios or its suppliers or licensors, or altering the terms and conditions of the applicable license agreement governing the use of IBM software.

References in this presentation to IBM products, programs, or services do not imply that they will be available in all countries in which IBM operates. Product release dates and/or capabilities referenced in this presentation may change at any time at IBMs sole discretion based on market opportunities or other factors, and are not intended to be a commitment to future product or feature availability in any way. Nothing contained in these materials is intended to, nor shall have the effect of, stating or implying that any activities undertaken by you will result in any specific sales, revenue growth or other results.

IBM, the IBM logo, Lotus, Lotus Notes, Notes, Domino and Lotusphere are trademarks of International Business Machines Corporation in the United States, other countries, or both.

Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both.

Dissemination or reuse of this presentation is allowed provided full attribution to WorkFlow Studios is made by retaining the title slide and this legal disclaimer slide in their original form.

Click to edit the title text format

Click to edit the title

Click to edit the outline text formatSecond Outline LevelThird Outline Level