• Share
  • Email
  • Embed
  • Like
  • Save
  • Private Content
IBM Lotus iNotes 8.5 Customization
 

IBM Lotus iNotes 8.5 Customization

on

  • 14,771 views

A presentation regarding Lotus iNotes customization shown at Lotusphere 2009 in Orlando,Florida.

A presentation regarding Lotus iNotes customization shown at Lotusphere 2009 in Orlando,Florida.

Statistics

Views

Total Views
14,771
Views on SlideShare
14,722
Embed Views
49

Actions

Likes
3
Downloads
0
Comments
0

5 Embeds 49

http://www.slideshare.net 38
http://www.apurva.com 6
http://www.linkedin.com 2
http://www.docshut.com 2
http://www.slashdocs.com 1

Accessibility

Categories

Upload Details

Uploaded via as Microsoft PowerPoint

Usage Rights

© All Rights Reserved

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment
  • -

IBM Lotus iNotes 8.5 Customization IBM Lotus iNotes 8.5 Customization Presentation Transcript

  •  
  • IBM® Lotus® iNotes™ Customization
      • Eric Spencer | Advisory Software Engineer | Lotus iNotes Development | IBM
      • Ronald Ledwich | Staff Software Engineer | Lotus iNotes Development | IBM
    AD216
  • Agenda
    • How customizable is Lotus iNotes?
    • Basic customizations
      • demo
    • Skins and skin components
      • demo
    • Lotus iNotes page generation
    • Summary
    • Q & A
  • How customizable is Lotus iNotes?
    • All content sent to browser is governed by design elements
      • Modifying these design elements alters Lotus iNotes
    • Different from Traditional Domino® Web Applications
      • Uses WebHybrid processing (mixture of Quickplace® and Domino processing)
      • Uses limited set of Domino Web Commands and some special URL arguments
      • Uses tag-based textual markup to govern responses
      • Uses tags to determine what fields are permitted on a subsequent post from this page
      • Uses special server side formulas and custom tag mechanism
      • Doesn’t utilize many Agents (though provides means to use them as part of a customization)
      • Designed to be performant
    • Need to understand what to modify and how to extend Lotus iNotes with it’s design patterns in mind
  • Template and Forms File mail85.ntf mailJUser.nsf iNotesForms85.nsf References Lotus iNotes Page View Design Data Most Design: CSS, JavaScript, Images, HTML Inherits
  • Special Icon Note items
    • These items propagate from a Template file (.ntf) to a specific database (.nsf) during Design refresh/replace:
    Note: Only a hard coded list of Forms Template File values are presently supported on the server. The following NOTES.INI setting provides a means to override: iNotes_WA_FormsFiles=iNotes/Custom85.nsf, iNotes/Forms85.nsf,iNotes/Forms8.nsf,iNotes/Forms7.nsf,iNotes/Forms6.nsf DB which houses common design elements “ iNotes/Forms85.nsf” $FormsTemplateFile Enable Lotus iNotes variations within Quickplace page generation “ 1” $WebHybridDb Enable Quickplace page generation logic “ 1” $HaikuFlags
  • Ways to customize Lotus iNotes
    • Policies
    • Disable certain Functional Areas
      • iNotes_WA_Areas INI var – will still work but policy takes precedence
    • Special Forms (Custom_*) provided for basic customizations
      • Modify action bar menu items
      • Modify existing view columns
      • Add masthead
      • Modify banner logo
      • Add fonts
    • Edit skins and stylesheets
    • Modify forms
  • Policy support Right double-click to close Mark documents read on preview Save sent mail Sign sent mail Encrypt sent mail Mail notification Internet mail format Mail basics Followup Attention indicators Message recall Calendar basics Calendar display Notices Scheduling Automatic processing Rooms and resources Mail & Calendar delegation User UI mode Functional areas Functional area at login Maximum attachment size Mail threads Remote image display Browser cache management Logout scrubbing Allowing attachments Instant messaging features Default spell check dictionary iNotes ActiveX Enabling feeds Widget enablement Lotus Quickr™ integration Calendar subscriptions Offline settings Shared Desktop Policies Shared Mail Policies iNotes Mail Policies
  • New architecture in 8.5
    • “ full” mode now uses the “lite” architecture that was introduced in 8.0.1
    • Tabbed UI
    • Uses widgets
    • Some forms still use the “classic” architecture
      • Full mode Mail, Calendar, Contact, To Do, Notebook entry forms
      • Lite mode Calendar and Contact entry forms
      • Home page
      • Preferences
    • Forms, etc. that are new for the “lite” architecture have “_Lite” in the name
  • Custom_JS_Lite subform
    • JavaScript form introduced to centralize most customizations
    • Static external script file which will be used for all main pages
    • Script page is cached on server with rest of static common user script and available with every page
    • Also a location to store your own script so that it is available from various pages you wish to customize
        • Note: Add stuff to l_SessionInfo/f_SessionInfo/s_SessionInfo form if you need per user or per mail file formula computations
    • Custom_JS and Custom_JS_Lite are now subforms
  • Some functions in Custom_JS_Lite Form Callbacks and Functions Set which columns get displayed when alternate name is enabled API_ GetWhoAndAltWhoColNamesForView_ Lite Set which columns get displayed for the Mail portlet. New in 8.0 API_SetPortalMailViewColumns_Lite Add additional time zones API_TimeZones_Lite Invoked prior to submitting an action to the server Scene_PreSubmit_Lite Invoked after each widget is initialized Scene_PostLoad_Lite Add, remove or change actions Scene_Actions_Lite
  • More functions in Custom_JS_Lite Helpers Custom_ActionsHelper _Lite subform Returns URL path up to and including “.nsf” API_GetMailfilePath_Lite Returns true if view page API_IsView_Lite Returns array of strings representing UNIDs API_GetSelectedDocs_Lite Display menu position numbers - “classic” forms checkActionPositions Display menu IDs checkActionIDs Changes position of menus or submenus repositionActionsLite Remove menus or submenus from action bar removeActionsLite Add new menus or submenus to action bar addActionsLite
  • Additional customization forms and subforms Modify the displayed banner Custom_Banner_Lite Add additional CSS styles Custom_CSS Add a masthead at the top of the page Custom_Masthead Add new fonts in the rich text editor Custom_JS_Edit Add additional web sites for Web page panel choices Custom_Welcome
  • checkActionIDs and checkPositions functions
    • Call these functions to display IDs or position numbers of action bar menu items.
    • checkActionIDs( s_MenuID ) - new architecture views and forms
      • Displays the menu ID in the hover text of “MENU ID” item
      • Displays the menu item ID in the hover text
    • checkActionPositions(s_TopBranchId) - “classic” forms
      • Displays the position number next to the menu item.
  • How do you edit Lotus iNotes markup?
    • Forms and Subforms
      • Domino Designer
    • Images
      • Domino Designer within Shared ResourcesFiles
    • Skin elements
      • Domino Designer within Shared ResourcesFiles
        • l_ShimmerSkin-xxx for Lite mode
        • f_ShimmerSkin-xxx for Full mode
        • h_ShimmerSkin-xxx for:
          • “ classic” forms
          • 8.0.x Full mode
          • 7.x and earlier releases
      • iphone.css and standard.css for Ultralite mode
  • Demo 1: Basic customizations
  • Scene names
    • For widgets, scene name is: element_id:widget_class
      • Example: e-switcher-mail:com_ibm_dwa_ui_switcher
    Page s_SceneName s_NotebookPage Notebook entry s_Contact Contact entry s_ToDo To Do item s_Appointment Calendar entry Memo Mail message - Lite mode s_MailMemo Mail message
  • Some submit actions (“classic” forms only) s_SubmitAction Description Insert image h_Image Insert link h_Link Spell check h_SpellCheck Save (without closing window) h_TempSave Save h_Jump Send and file message h_ShimmerSendAndFile Send message h_ShimmerSend Cancel h_Exit
  • Skin groups and types
    • Skin Group
      • A set of skins sharing the same stylesheets
      • Primary skin groups: h_ShimmerSkin (IE), h_ShimmerSkin_Gecko (Mozilla), h_ShimmerSkin_Safari (Safari)
        • Contents of the groups are identical except for stylesheets
      • Two less significant skin groups: h_ShimmerSkin_UB (unsupported browser), h_ShimmerSkin_ACC (accessibility…not used)
    • Skin Type (Skin)
      • Member of a skin group set
      • Contains HTML markup to emit within the page body to govern overall page layout
      • Special Skin type: h_Stylesheet (CSS file)
        • Contains CSS definitions
    Example: f_ShimmerSkin-h_ListFolder
  • Stylesheets
    • h_StylesheetView
      • Used for views
    • h_StylesheetDocuments
      • Used for documents – mail and meeting notice in Lite mode only
    • h_StylesheetOverride
      • Used for “classic” forms
    • h_Stylesheet
      • Used for things not specific to view or documents
    • h_StyleSheetPortal
      • Used for WebSphere® Portal
    Example: f_ShimmerSkin_Gecko-h_StyleSheetDocuments
  • Which skin is used?
    • Skin type h_ListFolder is always used
      • unless h_SkinTypeOverride is set – by URL arg or NotesVar
    • h_MailPage ....
    • Other skins are not used
      • They are there for compatibility with “classic” code
  • Skin components - h_ListFolder Modepanel_ SkinComponent_Lite ShimmerSwitcher_ SkinComponent_Lite SceneLabel_ SkinComponent_Lite ShimmerMainTabs_ SkinComponent_Lite Search_ SkinComponent_Lite PageContent_ SkinComponent_Lite ServerTitleAndMailQuota_ SkinComponent_Lite Custom_Banner_ Lite
  • Sample skin HTML segment
    • Other elements you will see:
      • com_ibm_dwa_ui_widget_class
        • widget definition
      • <v:fill> (IE) or <canvas> (Mozilla) tags
        • grad fills
    <div id=&quot;e-maintabs-container&quot; class=&quot;s-toppanel&quot;> <InsertNotesSubForm name=&quot;ShimmerMainTabs_SkinComponent_Lite&quot;> </div> <div class=&quot;s-toppanel&quot; style=&quot;height:1.5em;&quot;> <InsertNotesSubForm name=&quot;Modepanel_SkinComponent_Lite&quot;> </div> Skin components
  • Demo 2: Skin customization
  • Ultralite skin customization
  • Customizing Ultralite mode
    • Styles:
      • iphone.css – for iPhone
      • standard.css – for desktop browser (only Firefox is supported)
    • Does not use skins
    • No JavaScript
    • Layout and code are combined in m_xxx forms
    • Images are in mxxx files in Shared ResourcesFiles
  • Referring to new resources
    • Added to the Forms file
      • Add the file to Shared ResourcesFiles
      • src=&quot;/iNotes/Forms85.nsf/LotusSoftware.png&quot;
      • background-image:url(@{s_FF}/act-hyper-hover-images.gif?OpenFileResource&MX);
    • File on Domino server
      • Put file into <Domino data directory>html
      • src=&quot;/file.html&quot;
    • On another server
      • src=&quot;http://www.server.com/file.gif.&quot;
  • More on skin customization
    • Grad fills
      • Specified in the skins and in the code
      • See wiki article for more details
    • Consolidated icons
      • One image file that contains many icons
      • Icons are selected by x, y coordinates in the styles
      • Files: basicicons.gif, commonactionicons.gif, commonactionicons.gif,mailoutlineicons.gif, viewactionicons.gif
  • Lotus iNotes Web page construction
    • All Forms/Subforms use pass-thru HTML
    • Special tags are interpreted by server to:
      • Insert skin
      • Insert skin components
      • Insert subforms
      • Evaluate computed blocks (@formulas)
      • Determine persisted and computed-only items
    • Full mode is now using Lite mode architecture
      • use combination of skin components (loaded by server) and widgets (client)
      • More AJAX (lazy loading, etc).
  • iNotes code/forms
    • Loaded by InsertNotesSubForm
    • Browser specific:
      • xxxCode – IE
      • xxxCode_Gecko – Mozilla
      • xxxCode_Safari – Safari
    • f_xx – used by Full mode only
    • l_xx – used by Lite and Full mode
    • INI setting iNotes_WA_Debug_SubForms=1 – subform names are displayed on the server console as they are loaded
  • Subforms used by “classic” forms
    • Prefix: s_MailMemo, s_MeetingNotice, s_Appointment, s_Contact, s_ToDo, s_Notebook
    • <prefix>+Dictionary: defines “schema”
    • Read forms
      • <prefix>+Read_Init : <head> portion
      • <subscene prefix>+Read : <body> portion
    • Edit forms
      • <prefix>+Edit_Init : <head> portion
      • <subscene prefix>+Edit : <body> portion
    Example: s_AppointmentEdit_Init
  • Widgets
    • There are UI and non-UI widgets
    • UI widgets have a root element (usually <div>) and have attribute “com_ibm_dwa_ui_widget_class”
    • Widget code is in l_JSBase subform or subforms included by l_JSRead and l_StdPageOperations forms
    • To customize a widget, add code to Scene_PostLoad_Lite callback function.
      • Example:
        • if (s_SceneName == 'e-switcher-mail:FZM') {
        • // customize view switcher widget (FZM = com_ibm_dwa_ui_switcher)
        • }
    • See wiki article for more details
  • Special server-side tags
    • <InsertNotesSubForm Name=SubFormName>
      • Name may be a computed value
        • <InsertNotesSubForm Name=@{...} >
        • Conditional insertions by using @If and specifying empty string
    • <QuickPlaceSkin>
      • Inserts contents of skin type for current skin group
    • <QuickPlaceSkinComponent Name=xxx>
      • Inserts contents of subform named xxx_SkinComponent
      • Optional Format and Argument attributes (used by some skin components):
        • Translates to JavaScript arg which is accessible by skin component
        • Format support special <Item> tag to allow means of excluding some markup if tag is determined at runtime to be not displayed. Real tag contents are emitted there
        • Example:
          • <QuickPlaceSkinComponent Name=&quot;Logout&quot; Argument=“0”
          • Format={<td class=&quot;s-toptoolbar-text s-toptoolbar-bg-middle&quot; nowrap><Item></td>}>
    Insert content from other design elements
  • Special server-side tags
    • <NotesDictionary>…</NotesDictionary>
      • Block which may contain NotesVar and NotesField tags
    • <NotesField Name=ItemName>
      • Define persisted field
        • Type=Text|TextList|RichText|Mime|Number|NumberList| Time|TimeList
        • InitialValue=
          • Evaluated if item doesn’t exist within document
        • Value=
          • Evaluated as page is generated and as page is saved
      • Example:
        • <NotesField Name=Subject>
    • <NotesVar Name=ItemName>
      • Define a computed for display only item
      • Same element attributes as Notes field
    • All support an includeif={ @formula } attribute for conditional inclusion
    Persisted and computed for display items
  • To add a new field to an existing object
    • New NotesField needs to be added to xxxDictionary subform
    • Visual representation on xxxRead and xxxEdit subforms
    • HTML representation needs to get the value of the field
    • For edit forms: may need to initialize before display and validate before submit
    • More detail in Manipulating Data in Domino Web Access developerWorks article
  • Special server-side tags
    • <NotesComment>…</NotesComment>
      • Block which contains content which should not be emitted back to the client with any responses
      • Useful for commenting purposes
    Comments
  • Special server-side tags
    • @{….}
      • Domino Web-based formula may be specified within this computed text tag
      • May also run output through special filters
        • jsdata: JavaScript String data (apostrophes are escaped)
        • html: valid html data
        • xml: valid xml data (new in 8.0)
        • @{{...};jsdata;html}
      • Example:
        • haiku.CalendarProfileOwnerName = '@{{@Name([Canonicalize]; @GetProfileField(&quot;calendarprofile&quot;;&quot;Owner&quot;))};jsData}';
    Computed text block
  • Special custom formulas Additional formulas to support Lotus iNotes applications
    • @DbCommand(“Haiku”;”<command name>” [;”Arg1”;”Arg2”;…])
    • Some key commands:
      • h_Vars : Emits all non-system items in document as JavaScript vars with values
        • Optional Args
          • Arg1: UNID of document in current DB being processed (Current document if not specified)
          • Arg2: prefix string (string to prepend to each item…useful if desire to put items as properties of another JavaScript object) (default: “var “)
          • Arg 3: “1”: emit all items on current note (default)
          • “ 0”: emit only if specified in a NotesDictionary block
      • h_RunAgent : Runs specified agent (which can contribute to page output)
        • Required Args
          • Arg 1: Name of agent
        • Optional Args
          • Arg 2: Common agent -- “1”: agent is in Forms file; “0”: in current DB being processed (default)
          • Arg 3: Empty context – “1”: run agent in empty context; “0”: in context of note specified by url (default)
  • dwa: tags
    • Used in cases where only a custom formula is being called
    • Removes need to invoke formula evaluator (improves performance)
    • Built to be extensible
      • Tags defined in dwa_tags form
      • Example definition:
        • <tagdefinition name=&quot;getvars&quot; outputformat=&quot;jscript&quot;>
        • <description>Provide access to the h_Vars functionality. </description>
        • <argument type=&quot;text&quot; optional=&quot;yes&quot; name=&quot;unidstring&quot; />
        • <argument type=&quot;text&quot; optional=&quot;yes&quot; name=&quot;prefixstring&quot; />
        • <argument type=&quot;text&quot; optional=&quot;yes&quot; name=&quot;includeall&quot; value=“1” />
        • <bodyfunction namespace=&quot;haiku&quot; builtin=&quot;h_Vars&quot; />
        • </tagdefinition>
      • Example usage:
        • <dwa:getvars includeall=“0” />
        • <dwa:getvars unidstring=“{ComputedItemContainingUnid}” />
  • Miscellaneous
    • String resources now in separate file
      • File: dwa_xx.properties
        • In Shared ResourcesFiles
      • Easier to add / modify strings
      • Customizers can add new languages
    • INI setting: iNotes_WA_PortalStylesheet=0
      • Always use the normal iNotes stylesheet even on WebSphere Portal
    • Log messages to the iNotes console
      • Example: AAA.EVI.sr(level, “”,&quot;message”);
        • level:
          • 0 = error
          • 1 = warning
          • 2 = info
          • 3 = detail
  • QueryOpen/QuerySave agents
    • Lotus iNotes doesn’t use these within core application
    • Add iNotes_WA_QueryAgents=1 to NOTES.INI to enable this functionality
    • Two NotesVars are used to invoke agents
      • $$QueryOpenAgent
      • $$QuerySaveAgent
      • Example:
        • <NotesVar NAME={$$QuerySaveAgent} INITIALVALUE={“YourAgent”}>
    • Please refer to the Manipulating Data in Domino Web Access developerWorks article for a working example of QueryOpen and QuerySave agents
  • Debugging tools
    • Firefox
      • Venkman
      • Firebug
    • IE
      • Visual InterDev
      • Visual Studio
      • Developer Toolbar
    • Obfuscation table
      • ObfuscationList.txt
      • In Shared ResourcesFiles
  • Summary
    • Some ways to make basic customizations are provided
      • Policies
      • Using Custom_* forms and subforms
    • Look of Lotus iNotes pages can be customized by editing skins, skin components, and stylesheets
    • For more complex customizations, you need to understand how Lotus iNotes pages are generated
    • Useful tools for examining page layout and debugging JavaScript are available
  • Future possibilities
    • Move customization forms to a separate forms file
    • Provide easier way to customize grad fills
    • Add/honor your own policy settings
    • Consolidate skin groups and stylesheets
    • Make it easier to change Forms file reference
    • Make it easier to customize Preferences
  • Related sessions/resources
    • ID216: What's New in IBM Lotus iNotes 8.5 -- and Beyond
    • ID217: IBM Lotus iNotes for the Apple iPhone
    • ID218: Best Practices for your Lotus iNotes infrastructure
    • AD201: IBM Lotus Domino Designer 8.5: A New Beginning
    • BOF: iPhone development and Ultralite
    • Lotus iNotes Team in the Meet the Developers Lab & User Experience Lab
    • Session examples available in the lab
  • On-line resources
    • Lotus Notes and Domino wiki
      • http://www-10.lotus.com/ldd/dominowiki.nsf
      • Lotus iNotes, Customization
    • Wiki article
      • http://www-10.lotus.com/ldd/dominowiki.nsf/dx/all-you-want-to-know-about-domino-web-access-customization
    • developerWorks forum
      • http://www-10.lotus.com/ldd/nd8forum.nsf
      • Product area: DWA, Technical Area: Customization
  • Questions?
  • Legal disclaimer
    • © IBM Corporation 2008. 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. In addition, this information is based on IBM’s current product plans and strategy, which are subject to change by IBM without notice. IBM 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 IBM 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 IBM’s 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, Quickr, WebSphere, PartnerWorld and Lotusphere are trademarks of International Business Machines Corporation in the United States, other countries, or both.
    • All references to Renovations refer to a fictitious company and are used for illustration purposes only.