content is currently being developed by IBM®
back frequently to see this information as we develop it. Lotus
and IBM® Redbooks®
have partnered together to populate this section of the wiki information
to help you customize this product.
A site map PlaceBot
Our client, Millennia, wanted to be able to see all documents in the current
room at once. They were also interested in seeing statistical data about
the room, while still maintaining their corporate look and feel.
The option for mapping links to rooms was discussed but decided against,
because it would allow members without access to a particular room to see
a link to that area. It must be stressed that the list of items in the
room presented by the PlaceBot are only links, and the user will still
need access rights to read the document. However, QuickPlace’s established
structure is to not show links to which the user does not have access.
The other reason for not putting room links in was that the map was essentially
for the purpose of showing documents.
Links were kept in, as we decided that this PlaceBot would make a good
basis later for a special HotLinks page, and we wanted to keep the code.
Millennia was also interested in being able to impose QuickPlace Theme-like
technology on the page. They wanted to be able to change the images, and
the look of the text, without having to involve a programmer.
Figure 70. The SiteMap Page as it appears in the Millennia QuickPlace
Functional features for the Mapperizer Placebot
The PlaceBot has the following list of functional features:
• Graphical display of folder/page relationships
• Alphabetical list of pages
• Theme-like customization of the map page
- Easily modification of folder and page images
- Full control over fonts, sizes, colors and so on
- Ability to wrap the document in any HTML required
• Selective page mapping - Pages and Links, but not Room links
• Map document could be switched off if decided by the Manager
• Map document could appear wherever the Manager decided
• Map document would be updated whenever a new Page document was added
Components in the Mapperizer
Together with the actual PlaceBot code our solution has the components
listed in Table 28:
Table 28. Components of the Mapperizer
||The placebot Code. |
This is the actual PlaceBot that will perform the functions. To change
this PlaceBot, you can use a text editor. For more complex changes, it
is best to copy/paste it into a Domino agent in the Domino Designer.
||This file positions and presents the data. This file works
in the same way a layout file used in Themes works. For a better understanding
of Themes, see Chapter 4, “Creating Themes” on page 47.
SiteMap.htm can be modified or replaced with a customized file. We find
it easier to simply modify this file for each new application. This filemust
be named SiteMap. If you want to change this name, you need to change the
variable sMapDocName in theMapperizer PlaceBot. This string can contain
|Folder.gif , |
|The images that appear in the SiteMap page.
To change these, simply modify the images in an image editor program and
save them with the same name. These images cannot be renamed unless you
modify the Mapperizer PlaceBot.
||Optional Style Sheet definitions for the Mapperizer PlaceBot,
containing special tags for the SiteMap page. When creating your own Theme,
add these to your CSS file, normally called StyleSheet.css.|
Installing the Mapperizer PlaceBots and files
The source files for our Mapperizer solution are available for download
from the IBM Redbooks Web site. Before looking at the code in the PlaceBot,
we will describe the steps to install PlaceBot so you can look through
the actual code yourself while reading through this chapter. See Appendix
L, “Additional Web material” on page 425 for information on how to get
the sample files.
In the following section we describe:
• Importing the sitemap HTML layout page
• Uploading the LotusScript PlaceBot
• Testing the PlaceBot
Create the SiteMap QuickPlace page
1. Click the New... button
to create a new page.
2. Select ImportedPage
3. Name the Page "SiteMap". You must call it this or the Mapperizer
will not work.
4. Turn off: Show the title, author and date on page?.
5. Press the Browse button to open a file dialog box.
6. Find and open the SiteMap.htm file.
7. Click Publish
8. Choose a location for the file. We recommend placing it in the sidebar
near the Index, as the last elements here are used for managing Places,
las the Mapperizer is.
9. Click Next
to save the document
10.Look at the document. If this is the first time you have installed the
Mapperizer, the following message will appear in the page:
Run the Mapperizer Placebot to see a site map here...
11.If you cannot see the page, make sure that you have followed all of
the previous steps.
Upload the Mapperizer.lss PlaceBot
1. Enter the Customize section of your Place.
2. Scroll down and click the PlaceBots link, and you will be taken to the
PlaceBot creation area.
3. Call the PlaceBot Mapperizer.
4. Enter a description. We entered: Creates a map
of a QuickPlace room
5. Enter the section entitled: When should this PlaceBot run?. Go to the
section entitled: When a form is submitted:, and choose Page
can also be run on schedule, but this will make the content of the PageMap
page not as accurate.
6. Go to section 4 and click the button that looks like a folder called
7. Locate Mapperizer.lss PlaceBot, and click Open
8. Click Done
and the PlaceBot will be uploaded.
9. You will be taken into the PlaceBots Area. Make sure that you can see
the Mapperizer agent listed on the page with a radio button next to it.
Test the PlaceBot
1. If you are not in the PlaceBots area of your Place, enter the Customize
section of your Place. Scroll down and click the PlaceBots link; you will
be taken to the PlaceBot creation area.
2. Click the radio button next to the Mapperizer link.
3. Click Run Placebot
4. A message will appear telling you that the PlaceBot was set to run on
schedule, and that it may cause problems if you run it manually.
5. The Log page will appear, telling you of the results of attempting to
run the agent. If it was successful, you will see the following message:
Started running agent 'Mapperizer' on 09/20/2000 01:02:15 AM
09/20/2000 01:02:17 AM: Mapperizer: IBM Redbook Example
09/20/2000 01:02:17 AM: Mapperizer: Run agent: Mapperizer
09/20/2000 01:02:24 AM: Agent Mapped 18 documents
Ran LotusScript code
Done running agent 'Mapperizer' on 09/20/2000 01:02:25 AM
6. If you have not loaded the SiteMap page, the following error message
Started running agent 'Mapperizer' on 09/20/2000 12:33:49 AM
09/20/2000 12:33:49 AM: Mapperizer: IBM Redbook Example
09/20/2000 12:33:49 AM: Mapperizer: Run agent: Mapperizer
09/20/2000 12:33:49 AM: Mapperizer: Document SiteMap not found
Ran LotusScript code
Done running agent 'Mapperizer' on 09/20/2000 12:33:49 AM