What's New and Next in OpenNTF Domino API (ICON UK 2014)

UKLUG 2012 – Cardiff, Wales 1

Presenter: Paul Withers Company: Intec Systems Ltd

ICON UK 2014 What’s New And Next in OpenNTF Domino API


Paul Withers

XPages Developer since 2009

IBM Champion

Author of XPages Extension Library

Co-Developer of OpenNTF Domino API


Agenda

• Implementation Review

• M4.5 and M5 Enhancements

• Future Directions


Implementation Last Year

• Upload org.openntf.domino.xsp update site into UpdateSite.nsf

• Save org.openntf.domino JAR to <domino>\jvm\lib\ext

• Modified Update Site to deploy jar to server

• Javadoc support was broken


Implementation In M5

• Upload server release update site into UpdateSite.nsf

• Install client release update site in DDE

• Includes source code

• Or use OpenNTF Essentials (currently M4.5)

• Javadoc support post-M4.5


Java Agents

• Not really supported for agents

• Plugin jar in jvm\lib\ext breaks use in

XPages

• XOTS will replace this

SO WHAT’S XOTS?


Still Designed for Domino 9.0.1

BUT

• 9.0.0 versions are available

• Some additional functionality was added to IBM Domino 9.0.1, just needs removing • NotesCalendarEntry

• NotesCalendarNotice

• AdministrationProcess.setEnableOutlookSupport

• Additional NotesCalendar method in FP2


Enable Library for NSF

Remember to add it to Xsp Properties


Agenda





Enhancements

OpenLog enhancements

• xsp.openlog.suppressEventStack=true

• xsp.openlog.expireDate=30

• More SSJS error types caught

• openLogBean.addError(e, this)

automatically gets context


Enhancements – Database

ALL methods that take integers are overloaded to take enums

• FTSearch(String, int, FTSortOption, Set<FTSearchOption>)

• compactWithOptions(Set<CompactOption>)

Same for other classes


Enum Example


Enhancements – Database

• Database.getMail()

• Also Session.getMailDatabase()

• Database.openMail()


Serialization of Database Locations

• Database.getApiPath()

• Supported by Session.getDatabase(String)


Metaversal ID

• Document.getMetaversalID()

• ReplicaID + UNID

• Also Document.getMetaversalID(String)

• Get metaversal ID for the document on

a specific server

• ServerName + “!!” + ReplicaID + UNID


Serialization of Document Locations

Session.getDocumentByMetaversalID

• One or two parameters

• String – metaversal ID

• For single parameter, uses server in

metaversal ID or current server

• String – server name

• If using this parameter, metaversal ID

must not include server name


Serialization of Database Locations

• Database.getMetaReplicaID()

• Also supported by Session.getDatabase(String)

• Also supports passing database Replica

ID


DominoEmail

• In org.openntf.domino.email package

• Based on http://openntf.org/XSnippets.nsf/snippet.xsp?id=create-html-mails-in-ssjs-using-mime

http://openntf.org/XSnippets.nsf/snippet.xsp?id=create-html-mails-in-ssjs-using-mime















Simple Text Two-Line Example


DominoEmail

• Setters and getters for building up contents

• EmailAttachment class for attachments / inline images

• Document attachment (addDocAttachment) not yet implemented

• Future directions intend to allow Embedded Experiences


Index Database

• Indexes

• All appropriate fields

• On all Forms

• In all Databases

• Takes a while to run!

• Stores index in the database

• Allows you to interrogate all text fields on server


Views

• isTimeSensitive

• Interrogate the $Index field for other info

• Index type

• Index refresh information

• Index discard information

• Hide empty categories


Recycling

• Complete overhaul of recycling since M4.5

• Thanks to Roland Praml and Nathan

• Quicker recycling

• Outstanding issue with removing temporary files when dealing with embedded objects


Formula Parsing

• Previously in org.openntf.domino.helpers.Formula

• Overhauled and extended by Roland Praml

• New plugin – org.openntf.domino.formula

• Better performance than session.evaluate


Pickers

• Fixed issues with NAPI getViewEntryByKeyWithOptions in M4.5

• OpenNTF Name Picker dataProvider

• Allows you to define return name format

• Additional Value Picker dataProviders

• Map Picker

• Collection Picker (Lists / Sets)

• Enum Picker


dataProvider Enhancements

• SearchStyle

• jumpTo – show all from first match

• restrictToSearch – show only options

matching search criteria

• SearchType

• startFrom but also ftSearch, and match

• Specify case sensitive or case insensitive


NSA

• New flag, org.openntf.domino.xsp=nsa

• Keep track of

• Applications

• Modules

• Sessions

• NSA.INSTANCE.getReport() for plain text report


Names

• Considerable work on Names by Devin Olsen and Nathan T Freeman

• Name.getGroups(String serverName)

added

• Name class now uses

org.openntf.arpa.NamePartsMap to

parse elements


XOTS

• XPages + DOTS = XOTS

• Threaded tasks in their own session

• Trigger and run

• Trigger from custom events

• Scheduled in future

• Code is in the NSF

• So you can reuse your XPages code in

situ

http://nathantfreeman.wordpress.com/2014/07/10/me-me-me-me-me-too/


XOTS Builder

• Domino Designer extension by Keith Smillie

• Allows you to see all tasklets in database

• Allows you to enable / disable tasklets

• Help file embedded into Domino Designer Help


XOTS Builder


Agenda





ODA development team’s statements regarding its plans, directions, and intent are

subject to change or withdrawal without notice at ODA development team’s sole

discretion.

Information regarding potential future products is intended to outline our general

product direction and it should not be relied on in making a purchasing decision.

The information mentioned regarding potential future products is not a commitment,

promise, or legal obligation to deliver any material, code or functionality. Information

about potential future products may not be incorporated into any contract. The

development, release, and timing of any future features or functionality described for

our products remains at our sole discretion.


XOTS

• Progress bar

• Easier access to session etc

• Scheduled tasklets

• RIP Amgr

• Persistence of tasklets

• Run the same tasklet every x minutes /

hours / days

• Knows what on previous runs


XOTS

• More work on contexts

• XSPBARE – “XPages-aware agent”

• XSPFORCED – run as if from browser

• Access to scopes

• XSPSCOPED to Application / Session

• XOTS + Listeners


XOTS

• DominoSessionTypes

• NAMED

• Use this.setRunAs(String user)

• NATIVE – run as server

• MANUAL

• NONE


Graph Databases Extended

• Current implementation in Index database

• See session from MWLUG

• Lots of interest at MWLUG

• Better for Big Data

• Query performance outstrips RDBMS

• Framed, shared graphs coming soon

http://www.slideshare.net/ktree19/mwlug-2014-modern-domino-workshop


Classes for ALL Design Elements

• XPages and Custom Controls done

• Consistent approach

• E.g. jar, XPage, Custom Control, Xsp Properties

• Include xsp-config.xml in Custom Control class?

• Make properties like view index flags read-write?


NsfDataStructs

• Classes already in release, but not currently used

• NSFDatabase, DXLDatabase

• NSFNote, DXLNote

• Structs, Structs/cd

• Intended to better deal with:

• DXL documents

• Composite Data (CD) information


NSFDataStructs

• Access e.g. $REF-style fields

• Access Seq Num

• Rich Text manipulation

• Making “pseudo NSFs” from DXL files / folders of Note DXLs / ODPs

• Better compatibility with non-NSF databases

• Potentially accessing C API directly


3rd Party Libraries

• The following are under investigation

• Google Guava already being used

• Javolution

• Speed, e.g. javolution.util.FastCollection

• Struct and Union classes for direct

interoperability with C/C++ applications

• OSGi compliant

• Lucene

http://javolution.org/




Domino Admin

• Let’s use the API to make admins’ lives easier

• Interact with Domino Directory configuration

• Long term

• XPages Admin Client?


Get Involved!

• Develop

• Document

• Add demos

• Test

• Use

• Suggest features

• Spread the word!


Thank You

• Paul Withers

• [email protected]

• http://www.intec.co.uk/blog

• @paulswithers

• https://github.com/OpenNTF/ org.openntf.domino

mailto:[email protected]

http://www.intec.co.uk/blog

https://github.com/OpenNTF/org.openntf.domino



What's New and Next in OpenNTF Domino API (ICON UK 2014)

Technology

Transcript of What's New and Next in OpenNTF Domino API (ICON UK 2014)