ApplicationXtender Web Access .NET eRoom Integration

EMC® ApplicationXtender®
Web Access .NET eRoom Integration
6.0
Administrator’s Guide
300-008-282
REV A01
EMC Corporation
Corporate Headquarters:
Hopkinton, MA 01748-9103
1-508-435-1000
www.EMC.com
Copyright © 1993-2009 EMC Corporation. All rights reserved.
Published March 2009
EMC believes the information in this publication is accurate as of its publication date. The information is
subject to change without notice.
THE INFORMATION IN THIS PUBLICATION IS PROVIDED “AS IS.” EMC CORPORATION MAKES NO
REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS
PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR
FITNESS FOR A PARTICULAR PURPOSE.
Use, copying, and distribution of any EMC software described in this publication requires an applicable
software license.
For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com.
All other trademarks used herein are the property of their respective owners.
2
ApplicationXtender Web Access .NET eRoom Integration Administrator’s Guide
Contents
Preface.............................................................................................................................. 5
Chapter 1
Introduction
Overview ...........................................................................................
Pull mode ....................................................................................
Push mode ..................................................................................
Software Requirements ....................................................................
Chapter 2
Installation and Configuration
Installation Overview.......................................................................
Installation for AppXtender Web.NET Server .............................
Installing the eRoom Server Extension .........................................
Upgrading...................................................................................
Chapter 3
10
10
11
12
14
15
17
19
Using the AppXtender Web Access .NET eRoom
Integration
Overview of Functionality...............................................................
Using the AppXtender Web.NET Push Mode .............................
Adding Document Links to eRoom ........................................
Viewing eRoom Document Links Added in Push Mode ....
Using the eRoom Pull Mode ..........................................................
Viewing eRoom Document Links Added in Pull Mode ......
Document Web Links Versus Database Row Links .....................
Usage Notes .......................................................................................
eRoom State Persistence ...........................................................
Timeout Settings Information ..................................................
ApplicationXtender Web Access .NET eRoom Integration Administrator’s Guide
22
23
23
24
26
27
29
30
30
30
3
Contents
Chapter 4
Troubleshooting and Known Issues
Troubleshooting ................................................................................
ApplicationXtender Web Access .NET...................................
eRoom .........................................................................................
Known Issues ....................................................................................
Configuration Utility ................................................................
Push vs. Pull Mode....................................................................
4
ApplicationXtender Web Access .NET eRoom Integration Administrator’s Guide
32
32
32
33
33
33
Preface
This document provides instructions on ApplicationXtender Web
Access NET eRoom Integration product.
As part of an effort to improve and enhance the performance and capabilities
of its product lines, EMC periodically releases revisions of its hardware and
software. Therefore, some functions described in this document may not be
supported by all versions of the software or hardware currently in use. For
the most up-to-date information on product features, refer to your product
release notes.
If a product does not function properly or does not function as described in
this document, please contact your EMC representative.
Audience
This document is part of the ApplicationXtender documentation set,
and is intended for use by a system administrator during installation
and setup of the ApplicationXtender Web Access .NET eRoom
Integration product.
Readers of this document are expected to be familiar with the
following topics:
◆
◆
◆
ApplicationXtender Desktop
ApplicationXtender Web Access .NET
eRoom Server
ApplicationXtender Web Access .NET eRoom Integration Administrator’s Guide
5
Preface
Related
documentation
Post-release information is contained in the Release Notes for this
product. This document is available at http://Powerlink.EMC.com.
Refer to the web site periodically to view the latest Release Notes.
Related documents include:
◆
ApplicationXtender Core Components Administrator’s Guide
◆
ApplicationXtender Web Access .NET Administrator’s Guide
◆
eRoom Server documentation or online help
Most of these documents can be found in the Documentation
directory on the product media kit. All documents are in Adobe
Acrobat Portable Document Format (PDF), and can be viewed by
downloading and installing the Adobe Acrobat Reader. The Reader is
available from Adobe at www.adobe.com. To install and use the Reader
on the preferred platform, refer to the instructions on the Adobe web
site.
Conventions used in
this document
EMC uses the following conventions for special notices.
Note: A note presents information that is important, but not hazard-related.
!
CAUTION
A caution contains information essential to avoid data loss or
damage to the system or equipment. The caution may apply to
hardware or software.
!
IMPORTANT
An important notice contains information essential to operation of
the software. The important notice applies only to software.
6
ApplicationXtender Web Access .NET eRoom Integration Administrator’s Guide
Preface
Where to get help
EMC support, product, and licensing information can be obtained as
follows.
Product information — For documentation, release notes, software
updates, or for information about EMC products, licensing, and
service, go to the EMC Powerlink website (registration required) at:
http://Powerlink.EMC.com
Technical support — For technical support, go to EMC Customer
Service on Powerlink. To open a service request through Powerlink,
you must have a valid support agreement. Please contact your EMC
sales representative for details about obtaining a valid support
agreement or to answer any questions about your account.
ApplicationXtender Web Access .NET eRoom Integration Administrator’s Guide
7
Preface
8
ApplicationXtender Web Access .NET eRoom Integration Administrator’s Guide
1
Introduction
This chapter provides an overview of the ApplicationXtender Web
Access .NET eRoom integration product.
◆
◆
Overview ............................................................................................. 10
Software Requirements ..................................................................... 12
Introduction
9
Introduction
Overview
ApplicationXtender Web Access .NET eRoom integration allows you
to create links between ApplicationXtender Web Access and the EMC
Documentum eRoom product. ApplicationXtender Web Access .NET
supports eRoom Integration as a part of the server setup.
There are two modes to use for integrating ApplicationXtender Web
Access .NET with eRoom. These are known as:
◆
Pull mode (recommended method)
◆
Push mode
The steps for configuring these modes are described in “Installation
for AppXtender Web.NET Server” on page 15.
Pull mode
The pull mode is the recommended method because it allows you
create a link in eRoom to Web Access .NET and pull the document
link from Web Access .NET to the eRoom. By using the pull mode
you are not limited to using just one eRoom folder and one user, as is
the case with push mode. You can add a Web Access .NET document
link or view a document in any eRoom folder:
◆
To add a document link in eRoom to a Web Access .NET
document, you log into eRoom and use the Web Access .NET
button to access the Web Access .NET interface. Using the Web
Access .NET interface, you select the document to which you
want to create a link.
◆
To view a Web Access .NET document in eRoom, you log into
eRoom and click on the document link. The document opens in
Web Access .NET interface.
In either case, if you have not already logged into Web
Access .NET, the login screen displays and you need to enter your
username and password.
10
ApplicationXtender Web Access .NET eRoom Integration Administrator’s Guide
Introduction
Push mode
In push mode, you add links in Web Access .NET to a pre-set eRoom
location for a pre-defined user (this pre-defined user is shared
between all eRoom users). This information is configured using the
eRoom integration administration application. You log into the Web
Access .NET to add a document link to a pre-defined eRoom folder,
and you use eRoom to view Web Access .NET document links.
◆
To add a document link in eRoom to a Web Access .NET
document, you log into Web Access .NET and select the
document to which you want to create a link.
◆
To view a Web Access .NET document in eRoom, you log into
eRoom and click the document link. The document opens in Web
Access .NET interface.
In either case, if you have not already logged into Web
Access .NET, the login screen displays and you need to enter your
username and password.
Overview
11
Introduction
Software Requirements
Using the AppXtender Web.NET eRoom Integration product requires
that the following software products be installed:
12
◆
AppXtender Web.NET.
◆
eRoom version 7.22 or later. Additionally, XML (EXQL, which
stands for eRoom XML Query Language) must be enabled on the
eRoom site settings page. AppXtender Web.NET eRoom
Integration has been verified to work on eRoom Server 7.2.4 or
7.3.4.
ApplicationXtender Web Access .NET eRoom Integration Administrator’s Guide
2
Installation and
Configuration
This chapter describes the steps necessary for installing and
configuring the AppXtender Web.NET eRoom integration product.
◆
◆
◆
Installation Overview ........................................................................ 14
Installation for AppXtender Web.NET Server ............................... 15
Installing the eRoom Server Extension ........................................... 17
Installation and Configuration
13
Installation and Configuration
Installation Overview
AppXtender Web.NET eRoom Integration consists of an eRoom
administration application and an eRoom Server Extension setup:
◆
eRoom Integration Administration. This utility is used strictly for
AppXtender Web.NET push (to eRoom) mode. The fixed eRoom
folder along with eRoom credentials are set for all AppXtender
Web.NET users and all applications.
◆
eRoom Server Extension Setup. These files (an ASP and XML file)
use the eRoom Server Extensions model to customize the eRoom
user interface. A Web Access .NET button is added providing
access to AppXtender Web.NET documents.
Note: An eRoom Server Extension is a custom application you create in order
to modify how eRoom behaves in response to certain events or how eRoom
appears. For additional information on eRoom Server Extensions, refer to the
eRoom Server Extension Programmer's Guide. Consult this guide if additional
customization is required for the AppXtender Web.NET button behavior or if
you want to understand how server extensions work. You can make a change
to have AppXtender Web.NET pop-up in a new window each time the button
is clicked.
14
ApplicationXtender Web Access .NET eRoom Integration Administrator’s Guide
Installation and Configuration
Installation for AppXtender Web.NET Server
Stop all IIS services before the installation and then check to make
sure all IIS and web services are started when installation is complete.
1. Edit web.config file to visually enable the eRoom integration in
Web Access .NET. Change the value for
"EnableERoomIntegration" from false to true as shown in the
following code sample. The default location for this file is:
c:\inetpub\wwwroot\AppXtender\web.config:
…
<appSettings>
<!-- eRoom Integration -->
<add key="EnableERoomIntegration" value="true"
/>
</appSettings>
</configuration>
2. Configure eRoom to support XML and EXQL requests:
a. Open the eRoom Server Administration utility (Start >
Programs > eRoom Administration > eRoom Server
Administration).
b. On the eRoom Site Settings page, enable the "Allow XML
queries and commands from external applications" option.
3. To support the pull mode of integration, go to Step 4; to support
the push mode, go to Step 5.
4. Install the eRoom Server Extension. This procedure customizes
eRoom folders to contain the Web Access .NET button. Follow the
detailed instructions in “Installing the eRoom Server Extension”
on page 17. The following steps in this procedure are optional for
the pull mode.
5. Run the ApplicationXtender Web Access .NET eRoom Integration
- Configuration utility. The default location for this utility is:
C:\Inetpub\wwwroot\AppXtender\bin\WxErAdmin.exe.
6. Using the configuration utility dialog:
a. Enter the AppXtender Web.NET installation path. The default
path is C:\Inetpub\wwwroot\AppXtender.
Installation for AppXtender Web.NET Server
15
Installation and Configuration
b. Enter valid eRoom user credentials. These credentials
authenticate the eRoom connection and are shared by all Web
.NET users (this is per web server since the eRoom Integration
is enabled using the web.config file, which holds per-web
server settings).
c. Enter the eRoom display URL. This URL should point to the
eRoom location where you want document links from
AppXtender Web.NET to be added using the Push mode. To
determine the correct URL, open eRoom, navigate to the
folder where you want document links added, copy the URL,
and then paste the URL into the configuration utility.
d. Click on the eRoom EXQL URL text box. The correct EXQL
URL is entered automatically by the system.
Note: There are cases where this EXQL URL may need to be overridden.
If storing to the eRoom room Home Page, the URL may need to be
reformatted. For additional assistance, consult the EXQL (eRoom XML
Query Language) online help (included as a separate file on the server
where eRoom is installed). In general, you should use a sub-folder off an
eRoom home page. The folder level should be at least one level deep. A
high-level recommendation is to use the eRoom pull model, which
avoids having to adjust the EXQL (since it is passed in automatically
from eRoom).In all cases, if the target folder is undesirable the eRoom
Web Link or Database items can be freely moved -- and the URLs to these
items remain unchanged (they are managed by eRoom).
e. Test the EXQL URL by clicking Validate EXQL URL. The text
boxes for Request Data and Response Data are populated
automatically. If the data do not indicated that any errors
occurred, the EXQL URL should be valid.
f. Close and save the ApplicationXtender Web Access .NET
eRoom Integration - Configuration utility settings by clicking
Save & Exit.
Start AppXtender Web.NET. The Result Set and both Thin and
Interactive Client Document View pages should have two new
eRoom icons appended to the right edge of the AppXtender
Web.NET toolbar. One icon adds document links to eRoom as Web
Link items and the other icon adds document links to eRoom as
database rows inside an eRoom Database item.
The AppXtender Web.NET log is used for informational and
diagnostic error messages.
16
ApplicationXtender Web Access .NET eRoom Integration Administrator’s Guide
Installation and Configuration
Installing the eRoom Server Extension
Follow this procedure to use the pull mode of integration. These steps
configure an AppXtender Web Access .NET button to open a new
browser window showing the default data source and applications.
Note: The AppXtender Web.NET button does not display in the eRoom home
page. This button only displays in the details view.
When accessing AppXtender Web Access .NET for the first time from
the current eRoom session, the AppXtender Web Access .NET login
page appears unless integrated authentication is used (such as
Windows authentication). Subsequent Web Access .NET accesses use
the credentials cached in the parent browser window. The credentials
are lost if the eRoom browser window is closed.
AppXtender Web.NET runs in an 'eRoom-aware' mode that allows
AppXtender Web.NET document links to be added back into the
originating eRoom or folder without having to pass any eRoom
credentials.
To configure the eRoom server extension:
1. Open the eRoom Server Administration utility and locate the File
Server path and lock the eRoom Server. For detailed instructions
on the eRoom Server Administration utility, consult the Server
Extension Programmer's Guide in the file API.chm at the eRoom
server.
2. Make sure eRoom is configured to support XML and EXQL
requests. On the eRoom Site Settings page, enable the "Allow
XML queries and commands from external applications" option.
(If you had configured the integration for push mode, this option
was enabled during those steps as described “Installation for
AppXtender Web.NET Server” on page 15.)
3. Unzip the AppXtenderWebAccess_eRoomExt.zip file to a new
folder named Web Access .NET eRoom Customization (when
unzipping, it is important to maintain the folder structure). The
default location for the zip file is:
C:\inetpub\wwwroot\AppXtender\bin\AppXtenderWebAccess
_eRoomExt.zip. After unzipping the file, the Web Access .NET
eRoom Customization folder should contain:
• A file named eRoom WX Customization.xml
Installing the eRoom Server Extension
17
Installation and Configuration
• A folder named Script, which contains one file named eRoom
WX Customization.asp
4. Copy the entire Web Access .NET eRoom Customization folder
(and Script sub-folder) to the ~Extensions sub-folder located
under the specified shared location for the file server.
5. Highlight the Web Access .NET eRoom Customization folder
and remove the Read Only attribute from the folder and all
sub-folders and files. (This step is needed so eRoom can operate
on the custom XML and ASP files.)
6. Open the \Web Access .NET eRoom Customization\Script\
WX Customization.ASP file and customize the
WebXtenderUrlPrefix variable to point correctly to your
AppXtender Web.NET server and application name. This variable
should be on or near line 74:
WebXtenderUrlPrefix = http://<wxserver>/AppXtender
This step is needed to customize which Web .NET server eRoom
opens when the AppXtender Web.NET button is clicked. All
eRoom users share this same AppXtender Web.NET server, but
each user’s eRoom and Web .NET credentials is private (not
shared).
7. Open the eRoom Server Administration utility. The ERSAdmin
window appears. Follow these steps to set up the server
extension:
a. Right-click the eRoom Folder and select Extension Manager.
The Extensions tab of the eRoom Extension Manager dialog
appears.
b. Select the Web Access .NET eRoom Customization extension
and click Configure. The Configure dialog appears.
c. Most settings were entered automatically from the XML
configuration file included in the extension. Make sure to set
the extension to be "Always on" and DO NOT check any
additional item types as only room and folders are applicable
to the AppXtender Web.Net eRoom integration.
d. Click OK to save the extension configuration settings and
return to the Extension Manager dialog.
e. On the Extension Manager dialog, make sure that both the
Extensions and Update Server tabs have a check mark to
indicate all internal Server Extension updates are done.
18
ApplicationXtender Web Access .NET eRoom Integration Administrator’s Guide
Installation and Configuration
f. Using the Windows Control Panel, stop all IIS services.
g. In the Extension Manager dialog, click the Update Server tab
and then click Start. Both the Extensions and Update Server
tabs should have a check mark to indicate all internal Server
Extension updates are done.
h. The newly configured extension is now distributed to the
current server.
i. Using the Windows Control Panel, re-start all IIS services.
j. Close the eRoom Server Administration utility.
8. Open the eRoom site you configured to integrate with
AppXtender Web.NET. All eRoom folders and rooms (room
homepages) should show a new AppXtender Web .NET button in
the details view only.
Note: The AppXtender Web.NET button does not display in iconic or list
views of items, nor does it display in any other type of container (for
example, a Database item).
Upgrading
You cannot upgrade any of the AppXtender Web.NET eRoom
Integration components. Each component must be uninstalled before
running a setup for a new version or build.
For the eRoom Server Extension, use the Remove command in the
eRoom Extension Manager to remove the AppXtender Web.NET
eRoom Integration files before installing a new version.
Installing the eRoom Server Extension
19
Installation and Configuration
20
ApplicationXtender Web Access .NET eRoom Integration Administrator’s Guide
3
Using the AppXtender
Web Access .NET
eRoom Integration
This chapter provides information on how the AppXtender
Web .NET eRoom integration product functions and how users can
add links to eRoom that will open documents in AppXtender
Web.NET with both the push and pull modes.
◆
◆
◆
◆
◆
Overview of Functionality................................................................
Using the AppXtender Web.NET Push Mode ...............................
Using the eRoom Pull Mode ............................................................
Document Web Links Versus Database Row Links ......................
Usage Notes ........................................................................................
Using the AppXtender Web Access .NET eRoom Integration
22
23
26
29
30
21
Using the AppXtender Web Access .NET eRoom Integration
Overview of Functionality
The AppXtender Web.NET eRoom integration product provides both
a push mode and a pull mode. When using the push mode, a user
logs into AppXtender Web.NET and adds document links to eRoom
by clicking one of the icons from either the Result Set window or the
Document Display view window. When using the pull mode, a user
logs into eRoom and adds links to AppXtender Web.NET documents
by clicking the AppXtender Web.NET button within eRoom, which
opens AppXtender Web.NET, and then adding links by clicking one
of the eRoom icons from either the Result Set window or the
Document Display view window. Once added, these links (stored in
eRoom Web Link and Database items) may be freely moved within
eRoom and they will still work.
Using the AppXtender Web.NET eRoom integration product in push
mode is documented in the Using the AppXtender Web.NET Push Mode
section of this chapter.
Using the AppXtender Web.NET eRoom integration product in pull
mode is documented in the Using the eRoom Pull Mode section of this
chapter.
22
ApplicationXtender Web Access .NET eRoom Integration Administrator’s Guide
Using the AppXtender Web Access .NET eRoom Integration
Using the AppXtender Web.NET Push Mode
The AppXtender Web.NET eRoom integration product, when being
used in push mode, allows users to add links for AppXtender
Web.NET documents to a pre-configured eRoom folder.
There are two types of AppXtender Web.NET document links that
can be added to eRoom: document web links or database row links.
Adding Document
Links to eRoom
To add an AppXtender Web.NET document web link or database row
link to the pre-configured eRoom folder using push mode:
1. Log into AppXtender Web.NET.
2. Run a query on the desired application.
3. From the Result Set view for the query results just retrieved,
using either the IRC or thin client, you can:
• Select one or more documents by checking the boxes to the left
of each document row and then click either the icon for adding
document web links to eRoom or the icon for adding
document links as database rows to eRoom in the AppXtender
Web.NET toolbar (shown in Figure 1).
• Select to view one of the retrieved documents. When the
document displays in the Document Display view document
viewer, click either the icon for adding document web links to
eRoom or the icon for adding document links as database
rows to eRoom in the AppXtender Web.NET toolbar (shown
in Figure 1).
Figure 1
eRoom Document Link Icons in the AppXtender Web.NET Toolbar
Using the AppXtender Web.NET Push Mode
23
Using the AppXtender Web Access .NET eRoom Integration
A message displays indicating that the selected or viewed document
was added successfully to eRoom.
Viewing eRoom
Document Links
Added in Push
Mode
Document links added to the pre-configured eRoom root folder
through AppXtender Web.NET using the push mode are organized
according to a predefined folder structure. This folder structure
designates the data source and the AppXtender application where the
documents are stored for which links were added. However, for
document web links, after creating the links in the predefined folder
structure, the links can be moved to another location within eRoom.
The following figure (Figure 2) illustrates AppXtender Web.NET
document web links added to eRoom using the push mode:
Figure 2
24
eRoom Document Web Links Created in Push Mode
ApplicationXtender Web Access .NET eRoom Integration Administrator’s Guide
Using the AppXtender Web Access .NET eRoom Integration
The following figure (Figure 3) illustrates AppXtender Web.NET
document database row links added to eRoom using the push mode:
Figure 3
eRoom Document Database Row Links Created in Push Mode
As shown in both Figure 2 and Figure 3, the document web links or
database row links were added to a folder named for the AppXtender
application, which is a sub-folder of a folder named for the data
source that contains the application. Also, if subsequent document
links are added to the same application to which links were added
previously, duplicate folders are not created. The subsequent links are
added to the folder previously created for the same application.
eRoom users can open either document web links or database row
links by clicking on the link, which in turns opens AppXtender Web
Access .Net.
The first time a user opens a document link, the AppXtender
Web.NET login window appears and the user has to log into
AppXtender Web.NET before viewing the document in the
Document Display view. However, once that user has logged in to
AppXtender Web.NET, subsequent attempts to view documents are
facilitated without repeating the login process, as long as the
AppXtender Web.NET session has not timed out and the auto logout
option is unchecked in XSAdmin.
Using the AppXtender Web.NET Push Mode
25
Using the AppXtender Web Access .NET eRoom Integration
Using the eRoom Pull Mode
The AppXtender Web.NET eRoom integration product, when being
used in the pull mode, allows users to add links for AppXtender Web
Access .NET documents by clicking the AppXtender Web
Access .NET button from a folder within eRoom.
Like the push mode, there are two types of AppXtender Web.NET
document links that can be added to eRoom using pull mode:
document web links and database row links.
To add AppXtender Web.NET document links to eRoom using the
pull mode:
1. Open and log into eRoom.
2. Navigate to the location within eRoom to which you want to add
AppXtender Web Access .NET document links.
3. Click the AppXtender Web Access .NET button located in the
details view of the current location. The AppXtender Web
Access .NET login page appears.
4. Log into AppXtender Web Access .NET.
5. Run a query on the desired application.
6. From the Result Set view for the query results just retrieved,
using either the IRC or thin client, you can:
• Select one or more documents by checking the boxes to the left
of each document row and then click either the icon for adding
document web links to eRoom or the icon for adding
document links as database rows to eRoom in the AppXtender
Web.NET toolbar (shown in Figure 4).
• Select to view one of the retrieved documents. When the
document displays in the Document Display view document
viewer, click either the icon for adding document web links to
26
ApplicationXtender Web Access .NET eRoom Integration Administrator’s Guide
Using the AppXtender Web Access .NET eRoom Integration
eRoom or the icon for adding document links as database
rows to eRoom in the AppXtender Web.NET toolbar (shown
in Figure 4).
Figure 4
eRoom Document Link Icons in the AppXtender Web.NET Toolbar
7. A message displays indicating that the selected or viewed
document was added successfully to eRoom.
Viewing eRoom
Document Links
Added in Pull Mode
Document links added to eRoom through AppXtender Web
Access .NET using pull mode are added to the eRoom location from
which the AppXtender Web.NET button was clicked, regardless of
whether the links are web links or database row links. However, just
as with push mode, after initially adding the links to the current
folder, the document web links can be moved to another location
within eRoom.
The following figure (Figure 5) illustrates AppXtender Web.NET
document links (both web links and database row links) added to
eRoom using the pull mode. Both a document web link and a
Using the eRoom Pull Mode
27
Using the AppXtender Web Access .NET eRoom Integration
database row link were added to the same folder, which is the folder
view from which the AppXtender Web.NET button was clicked.
Figure 5
eRoom Document Links Created Using Pull Mode
Just as with push mode, eRoom users can open either document web
links or database row links by clicking the link, which in turns opens
AppXtender Web Access .Net.
The first time a user opens a document link, the AppXtender
Web.NET login window appears and the user has to log into
AppXtender Web.NET before viewing the document in the
Document Display view. However, once that user has logged in to
AppXtender Web.NET, subsequent attempts to view documents are
facilitated without repeating the login process, as long as the
AppXtender Web.NET session has not timed out and the auto logout
option is unchecked in XSAdmin.
28
ApplicationXtender Web Access .NET eRoom Integration Administrator’s Guide
Using the AppXtender Web Access .NET eRoom Integration
Document Web Links Versus Database Row Links
There are some fundamental differences between adding document
links as either web links or database row links. Because of these
differences, you should add links as database rows instead of web
links.
Because the eRoom database rows show the same indexes (field
column names and row values) as the AppXtender Web Access .NET
result set, the columns can be sorted.
With eRoom web links, there is no such sorting or homogeneity
among similar links. With the web links, only the folder gives an
indication of a common AppXtender application, whereas with
eRoom databases, the database itself both visually presents and
logically organizes AppXtender Web Access .NET document links
belonging to a given application.
One advantage of web links is they can be freely moved or copied to
any other folder or eRoom (or even renamed). The eRoom database
row items cannot be easily moved (but they can be renamed, which is
not recommended).
Document Web Links Versus Database Row Links
29
Using the AppXtender Web Access .NET eRoom Integration
Usage Notes
The following notes on using the AppXtender Web.NET eRoom
Integration may assist you with managing its implementation.
eRoom State
Persistence
The eRoom state persists between browser launches. This is because
cookies are used to persist the eRoom state for 120 minutes after the
last time the Web Access .NET button was clicked. This is regardless
of the eRoom or AppXtender Web Access .NET (or ASP.NET) session
timeout values.
Timeout Settings
Information
The timeout for the eRoom pull mode is 120 minutes (or 2 hours).
After this, anyone logging into AppXtender Web.NET will be using
the AppXtender Web.NET push mode. Also, after 120 minutes,
anyone reentering AppXtender Web Access .NET using the eRoom
AppXtender Web Access .NET button will be using pull mode (with
the timeout reset to 120 minutes).
If Web Access .NET is reentered during this 120-minute period, the
eRoom pull mode is still be in effect (regardless if any or all Web
Access .NET browser windows are closed or not).
Basically, AppXtender Web.NET push mode is in effect by default.
Once a user enters AppXtender Web.NET using the eRoom
AppXtender Web Access .NET button, the pull mode is in effect for
120 minutes and that timeout is renewed upon each AppXtender Web
Access .NET button click in any eRoom folder.
Also, the pull mode timer uses browser cookies, so different browsers
may behave differently (and perhaps based on cookie settings).
30
ApplicationXtender Web Access .NET eRoom Integration Administrator’s Guide
4
Troubleshooting and
Known Issues
This chapter provides information for troubleshooting the
AppXtender Web.NET eRoom Integration product as well as
information on some known issues that may arise when using this
product.
◆
◆
Troubleshooting.................................................................................. 32
Known Issues...................................................................................... 33
Troubleshooting and Known Issues
31
Troubleshooting and Known Issues
Troubleshooting
The following notes on troubleshooting the AppXtender Web
Access .NET eRoom Integration may assist you with addressing
certain issues that may arise.
ApplicationXtender
Web Access .NET
AppXtender Web Access .NET errors may occur when trying to add
documents to eRoom. If you get errors in AppXtender Web
Access .NET after logging in, check the eRoom Integration
Configuration utility settings. The credentials and EXQL path should
be valid and should not be empty. For the pull mode, a common error
is to forget to set the location of the AppXtender Web Access .NET
server in the eRoom Server Extension ASP file provided.
The AppXtender Web.NET log, which is used for informational and
diagnostic error messages, may provide useful information. In
addition, any debug output viewer may be used to view debug/trace
entries. For a working version of a Debug View application, see the
http://www.sysinternals.com web site.
eRoom
32
The issues described in the following sections have been known to
occur from the eRoom integration side.
The Web Access .NET
Button Does Not
Display
If The Web Access .NET button does not display, make sure that
'always on' is set under the eRoom Extension Configuration dialog.
Also make sure that the room or folder is in details view (and not icon
or list view).
Adding an Item
Generates an Error
When adding any item (as a web link or database row), you may see
the message "ERROR: You aren't allowed to do this." This usually
indicates that the source eRoom (in the browser window) or the
eRoom EXQL URL (AppXtender Web.NET eRoom Configuration) is
either malformed or points to something other than an eRoom folder
or room (container).
ApplicationXtender Web Access .NET eRoom Integration Administrator’s Guide
Troubleshooting and Known Issues
Known Issues
The following sections provide information on known issues that
may arise when using the AppXtender Web.NET eRoom Integration.
Configuration Utility
When testing the EXQL URL, examine the output to see if the text or
XML response returned a message that implied success or failure.
For sub-folders (not directly beneath an eRoom HomePage), the URL
must be manually adjusted (use the Override checkbox).
Manually change:
http://webserver/eRoomXML/Facilities/Fac1/Rooms/Room1/Ho
mePage/Items$/0_b0
To:
http://webserver/eRoomXML/Facilities/Fac1/Rooms/Room1/It
ems$/0_b00
For any folder that exists beneath the room HomePage, no
adjustment is needed.
Push vs. Pull Mode
If a user switches from eRoom pull to AppXtender Web.NET push
mode, the eRoom session cookie is stored for the remaining time
(starting duration is 2 hours). During this time-out period,
documents are added to the starting eRoom folder. The user can try
to close the original eRoom browser window or clear browser cookies
to get around this issue.
To force AppXtender Web.NET to go into push model, the following
query string parameter may be used (It is best to close all other
browser windows first, either manually or programmatically, before
issuing this URL.):
http://localhost/wx/Default.aspx?ErBypassResetPullState=
bypass
The eRoom Integration product works best in eRoom pull mode as it
has more of a natural user interface flow. The AppXtender Web
Access .NET push mode creates additional eRoom folders when
uploading links, which may be undesirable or require additional time
to reorganize.
Known Issues
33
Troubleshooting and Known Issues
The AppXtender Web Access .NET push mode creates data source
folders beneath the pre-set eRoom folder/homepage location.
Additionally, for document links (eRoom web link items),
AppXtender Web.NET creates an Application folder.
34
ApplicationXtender Web Access .NET eRoom Integration Administrator’s Guide
Index
A
P
Adding Document Links to eRoom 23
ApplicationXtender Web Access .NET eRoom
Integration - Configuration utility 15
Push vs. Pull Mode 33
S
Software Requirements 12
C
Configuration Utility 33
T
D
Timeout Settings Information 30
Troubleshooting 32
Document Web Links Versus Database Row Links
29
E
eRoom State Persistance 30
I
Installation and Configuration 13
Installation for AppXtender Web.NET Server 15
Installation Overview 14
Installing the eRoom Server Extension 17
Instroduction 9
K
U
Upgrading 19
Usage Notes 30
Using the AppXtender Web Access .NET eRoom
Integration 21
Using the AppXtender Web.NET Push Mode 23
Using the eRoom Pull Mode 26
V
Viewing eRoom Document Links Added in Pull
Mode 27
Viewing eRoom Document Links Added in Push
Mode 24
Known Issues 33
O
Overview 10
Overview of Functionality 22
ApplicationXtender Web Access .NET eRoom Integration Administrator’s Guide
35
Index
36
ApplicationXtender Web Access .NET eRoom Integration Administrator’s Guide
Download PDF
Similar pages