Skip to main content link. Accesskey S
  • Log In
  • Help
  • IBM Logo
  • IBM Notes and Domino wiki
  • All Wikis
  • All Forums
  • Home
  • Product Documentation
  • Community Articles
  • Learning Center
  • IBM Redbooks
  • API Documentation
Search
Community Articles > Lotus iNotes > iNotes Programmatic URL Usage
  • New Article
  • Share Show Menu▼
  • Subscribe Show Menu▼

About the Original Author

Click to view profileIBM contributorGerard Ottaviano
Contribution Summary:
  • Articles authored: 1
  • Articles edited: 1
  • Comments Posted: 0

Recent articles by this author

iNotes Programmatic URL Usage

iNotes Programmatic URL Usage to enable customers more UI flexibility in iNotes, the iNotes portlet in WebSphere Portal, widgets, and gadgets
Community articleiNotes Programmatic URL Usage
Added by Gerard Ottaviano | Edited by IBM contributorGerard Ottaviano on September 29, 2010 | Version 39
expanded Abstract
collapsed Abstract
iNotes Programmatic URL Usage to enable customers more UI flexibility in both iNotes and the iNotes portlet in WebSphere Portal
Tags: 8.5.1, customization, customizing, inotes, Lotus iNotes, Notes 8.5.1, Notes8.5.1, portal, url patterns., URL
ShowTable of Contents
HideTable of Contents
  • 1 Implementation
  • 2 State Values
  • 3 Location/Direction Values
  • 4 Delimiters
  • 5 Integrating the Programmatic URL Enhancements with the iNotes Portlet in WebSphere Portal

In an effort to make the user experience and user interface more flexible and customizable for customers, the iNotes team has implemented a new URL argument, &layout. It has been available since Domino 8.5.1.



Implementation


Use the &layout URL argument to refine the skin components. This is preferred when you want to enable/disable/modify a set of layout components in the current skin used for the page without introducing a new static skin. For example, you want to control the preview pane or sidebar option when using h_SkinTypeOverride;h_Portal skin using &layout. If &layout values contain a component not in the current skin, it will simply be ignored.
  • Define &layout with a similar pattern as &PresetFields, component!State Location(Direction)
  • Use 2-character component symbols such as SB for sidebar, PP for Preview Pane. See the table below.
  • Use up to 2 character state/location symbols. The 1st character to represent the state of the component and the 2nd character (if necessary) to identify the component location/direction.

State Values


C = Closed
O = Open
D = Default , use iNotes preference if any.
H = Hide

Location/Direction Values


None - Location value is optional and it may not be required.
B - Location = Arrange the component on the (B) bottom side, s-bottompanel
R - Location = Arrange the component on the (R) right side, s-rightpanel
S - Location = Arrange the component on the (R) right side, s-rightpanel (works the same as previous R)
L - Location = Arrange the component on the (L) left side, s-leftpanel
T - Location = Arrange the component on the (T) top side, s-toppanel
W - Location = Whole area (s-basicpanel)
D - Location = Use iNotes preference by default.

Delimiters


The exclamation point (!) serves as a delimiter to separate the component and its state.
The asterisk (*) serves as a delimiter to separate multiple component and state pairs.


Note: Using semi-colons or commas, like the PresetFields URL pattern, and other reserved characters as delimiters, is not advised, as it will require proper encoding and can easily double the URL length. For example, &layout=SB;0,LP;0 becomes &layout=SB%3B0%2CLP%3B0 after encoding is applied.

To display a one day calendar view showing 20090128 with the sidebar open and the left panel displayed but closed, the url would be look like this:

http://{mail file path}/iNotes/Calendar/?OpenDocument&PresetFields=s_CalView;D, s_CalDate;20090128&layout=SB!O*LP!C

When it's used with h_SkinTypeOverride;h_Blank, &layout values will be ignored since the blank skin does not contain the sidebar/left panel.

The global layout values are used to refine the skin components. The following table defines supported values for &layout query argument.
Supported layout component symbolsSupported layout state valueSupported layout location valueComment
SB
(SideBar)
C - Display sidebar collapsed(default)

O - Display sidebar open

D - Display sidebar from iNotes preference, if any.

H - Hide sidebar (No display)
N/A



Display options for Sidebar. It will be right sidebar only and if not specified, it displays sidebar collapsed by default.

When it's hidden, Show\Sidebar & its related right-click menus should be hidden(or disabled at least)
LP
(Left Panel)
C - Display left panel collapsed
O - Display left panel open by default (default)
H - Hide left panel(No display)
N/ADisplay options for Left Panel. If not specified, it displays left panel open by default.
SW
(Functional Area Switcher)
S - Show (default)
H - Hide
N/ADisplay options for mode switcher. If not specified, it displays the mode switcher by default.
LV
(List View)
V - Virtual list
P - Paged list
D - display from iNotes preferences, if any. (default)
N/ADisplay options for list view

It should be only honored when it's used in full mode.
TB
(Managed Tabs)
S - Show (default)
H - Hide
N/ADisplay options for managed tabs. If not specified, it displays the tab by default.
BN
(Banner)
S - Show(default)
H - Hide
N/ALogo

Display options for banner area(logo). If not specified, it displays by default.
MH
(Masthead)
S - Show(default)
H - Hide
N/AMasthead

Display options for masthead. If not specified, it displays by default.
MS
(Mode Switcher action)
S - Show(default)
H - Hide
N/AGlobal Actions area will be hidden if none of the actions available.
PF
(Preferences action)
S - Show(default)
H - Hide
N/A
OF
(Online/Offline action)
S - Show(default)
H - Hide
N/ANote: it is also controlled by policy/preferences/feature availability.
LO
(Log out action)
S - Show(default)
H - Hide
N/A
HL
(Help actions)
S - Show (default)
H - Hide
N/A
PP
(Preview Pane)

C - Display collapsed
O - Display open
H - Hide
D - Display from iNotes preference, if any. (default)
B - Display at the bottom
S - Display on the side(right)
R - Display on the side(right)

Ignored when first state symbol value is D.
Display options for preview pane. If not specified, it displays preview based on iNotes preferences by default.

When it's disabled, Show\Preview & its related right-click menus should be hidden(or disabled at least)

Example of usage with multiple values (when including a Location value) PP!OB = Preview Pane Open Bottom



Integrating the Programmatic URL Enhancements with the iNotes Portlet in WebSphere Portal


WebSphere Portal contains "Out Of The Box" pages that contain portlets with which to access your Domino data backends. One in particular is the iNotes/DWA portlet, an iFrame portlet, which appears on the Applications->Messaging->Mail page. Before using this and some of the other Domino & Sametime portlets, your administrator must first do the Portal<->Domino integration step that is included in the WebSphere Portal Help topics. Once that is done and you can access your Domino data thru the iNotes portlet, you are ready to further customize your user experience by using the aforementioned &layout parameter through the portlet. Please follow the steps below to implement that and get started. It should be noted here that it is available in WebSphere Portal releases that support Domino 8.5.1 and greater. Those are 6.013, 6.1, and 7.0 and all greater releases in those version streams.
  1. Login to portal as an administrator
  2. Select Administration
  3. Select Portlets
  4. Search for portlets beginning with Domino or iNotes (portlet name should change to iNotes in Portal Release 7.1 or 6.106)
  5. This should result in a single entry (unless you have previously created copies of the iNotes portlet)
  6. Make a copy of the portlet and rename it, thus preserving the original. (Copy button outlined in red)
  7. Click on the "wrench" icon to view/edit the configuration parameters of the newly copied portlet (Wrench button outlined in red)
  8. Enter CustomURLArgs (parameter name is case sensitive) in the edit field at the top for the name of the parameter and in the value field you want to enter the URL fragment that will be appended to the base URL (after the .nsf of your mailfile)

Note: In the example below, the CustomURLArgs parameter has already been added to the configuration parameters. It should be entered in the New Parameter edit field and then the URL value in the New Value field, and then click Add..

Steps 4-6


Step 7


Step 8
expanded Attachments (0)
collapsed Attachments (0)
expanded Versions (72)
collapsed Versions (72)
Version Comparison     
VersionDateChanged by              Summary of changes
72Oct 13, 2010, 2:21:16 PMGerard Ottaviano  IBM contributor
70Oct 13, 2010, 2:19:54 PMGerard Ottaviano  IBM contributor
69Oct 13, 2010, 2:11:58 PMGerard Ottaviano  IBM contributor
68Oct 13, 2010, 2:09:53 PMGerard Ottaviano  IBM contributor
67Oct 7, 2010, 12:48:28 PMGerard Ottaviano  IBM contributor
67Oct 13, 2010, 1:56:29 PMGerard Ottaviano  IBM contributor
66Oct 7, 2010, 12:37:54 PMGerard Ottaviano  IBM contributor
65Oct 7, 2010, 12:23:48 PMGerard Ottaviano  IBM contributor
64Oct 6, 2010, 4:02:52 PMGerard Ottaviano  IBM contributor
63Oct 6, 2010, 4:02:06 PMGerard Ottaviano  IBM contributor
62Oct 6, 2010, 4:01:00 PMGerard Ottaviano  IBM contributor
61Oct 6, 2010, 3:54:47 PMGerard Ottaviano  IBM contributor
60Oct 6, 2010, 3:53:54 PMGerard Ottaviano  IBM contributor
59Oct 6, 2010, 2:24:10 PMGerard Ottaviano  IBM contributor
58Oct 6, 2010, 1:41:45 PMGerard Ottaviano  IBM contributor
57Oct 6, 2010, 1:41:38 PMGerard Ottaviano  IBM contributor
56Oct 5, 2010, 4:27:46 PMGerard Ottaviano  IBM contributor
55Oct 5, 2010, 4:23:29 PMGerard Ottaviano  IBM contributor
54Oct 5, 2010, 4:21:21 PMGerard Ottaviano  IBM contributor
53Oct 5, 2010, 4:18:46 PMGerard Ottaviano  IBM contributor
52Oct 5, 2010, 4:10:49 PMGerard Ottaviano  IBM contributor
51Oct 5, 2010, 4:09:52 PMGerard Ottaviano  IBM contributor
50Oct 5, 2010, 4:09:01 PMGerard Ottaviano  IBM contributor
49Oct 5, 2010, 4:08:06 PMGerard Ottaviano  IBM contributor
48Oct 5, 2010, 4:07:06 PMGerard Ottaviano  IBM contributor
47Oct 5, 2010, 4:05:28 PMGerard Ottaviano  IBM contributor
46Oct 5, 2010, 4:01:01 PMGerard Ottaviano  IBM contributor
45Oct 5, 2010, 3:53:11 PMGerard Ottaviano  IBM contributor
44Oct 5, 2010, 3:48:21 PMGerard Ottaviano  IBM contributor
43Sep 30, 2010, 2:12:54 PMGerard Ottaviano  IBM contributor
42Sep 29, 2010, 4:44:16 PMGerard Ottaviano  IBM contributor
41Sep 29, 2010, 3:36:58 PMGerard Ottaviano  IBM contributor
40Sep 29, 2010, 3:35:25 PMGerard Ottaviano  IBM contributor
This version (39)Sep 29, 2010, 3:31:35 PMGerard Ottaviano  IBM contributor
38Sep 29, 2010, 3:26:20 PMGerard Ottaviano  IBM contributor
37Sep 29, 2010, 3:09:42 PMGerard Ottaviano  IBM contributor
36Sep 29, 2010, 2:20:34 PMGerard Ottaviano  IBM contributor
35Sep 29, 2010, 2:05:17 PMGerard Ottaviano  IBM contributor
34Sep 29, 2010, 9:26:36 AMGerard Ottaviano  IBM contributor
33Sep 29, 2010, 9:24:43 AMGerard Ottaviano  IBM contributor
32Sep 28, 2010, 5:42:56 PMGerard Ottaviano  IBM contributor
31Sep 28, 2010, 5:41:59 PMGerard Ottaviano  IBM contributor
30Sep 28, 2010, 5:40:50 PMGerard Ottaviano  IBM contributor
29Sep 28, 2010, 5:39:57 PMGerard Ottaviano  IBM contributor
28Sep 28, 2010, 5:37:53 PMGerard Ottaviano  IBM contributor
27Sep 28, 2010, 4:29:16 PMGerard Ottaviano  IBM contributor
26Sep 28, 2010, 4:27:53 PMGerard Ottaviano  IBM contributor
25Sep 28, 2010, 4:21:21 PMGerard Ottaviano  IBM contributor
24Sep 28, 2010, 4:20:43 PMGerard Ottaviano  IBM contributor
23Sep 28, 2010, 4:18:33 PMGerard Ottaviano  IBM contributor
22Sep 28, 2010, 4:17:21 PMGerard Ottaviano  IBM contributor
21Sep 28, 2010, 4:12:59 PMGerard Ottaviano  IBM contributor
20Sep 28, 2010, 4:07:32 PMGerard Ottaviano  IBM contributor
19Sep 28, 2010, 2:51:28 PMGerard Ottaviano  IBM contributor
18Sep 28, 2010, 2:31:32 PMGerard Ottaviano  IBM contributor
17Sep 27, 2010, 5:00:32 PMGerard Ottaviano  IBM contributor
16Sep 27, 2010, 12:53:03 PMGerard Ottaviano  IBM contributor
15Sep 27, 2010, 12:37:53 PMGerard Ottaviano  IBM contributor
14Sep 24, 2010, 4:48:56 PMGerard Ottaviano  IBM contributor
13Sep 24, 2010, 4:48:22 PMGerard Ottaviano  IBM contributor
12Sep 24, 2010, 4:47:40 PMGerard Ottaviano  IBM contributor
11Sep 24, 2010, 4:42:13 PMGerard Ottaviano  IBM contributor
10Sep 24, 2010, 4:39:01 PMGerard Ottaviano  IBM contributor
9Sep 24, 2010, 4:35:03 PMGerard Ottaviano  IBM contributor
8Sep 24, 2010, 4:33:07 PMGerard Ottaviano  IBM contributor
7Sep 24, 2010, 3:53:06 PMGerard Ottaviano  IBM contributor
6Sep 24, 2010, 3:44:07 PMGerard Ottaviano  IBM contributor
5Sep 24, 2010, 3:40:46 PMGerard Ottaviano  IBM contributor
4Sep 24, 2010, 3:32:19 PMGerard Ottaviano  IBM contributor
3Sep 24, 2010, 3:28:58 PMGerard Ottaviano  IBM contributor
2Sep 24, 2010, 3:18:24 PMGerard Ottaviano  IBM contributor
1Sep 24, 2010, 3:00:30 PMGerard Ottaviano  IBM contributor
Copy and paste this wiki markup to link to this article from another article in this wiki.
Go ElsewhereStay ConnectedHelpAbout
  • IBM Collaboration Solutions wikis
  • IBM developerWorks
  • IBM Software support
  • Twitter LinkIBMSocialBizUX on Twitter
  • FacebookIBMSocialBizUX on Facebook
  • ForumsLotus product forums
  • BlogsIBM Social Business UX blog
  • Community LinkThe Social Lounge
  • Wiki Help
  • Forgot user name/password
  • Wiki design feedback
  • Content feedback
  • About the wiki
  • About IBM
  • Privacy
  • Accessibility
  • IBM Terms of use
  • Wiki terms of use