Professional Documents
Culture Documents
The OMNINET
Problem and Request Tracking System
Microsoft, Windows, Win32, Windows NT, Windows 95, Visual Basic , Visual C++ are registered trademarks of
Microsoft Corporation.
Other brand and product names are either trademarks or registered trademarks of their respective holders.
Contents
Table of Contents
Foreword
Part I Introduction
Part II Installation
10
1 Installation
................................................................................................................................... 10
12
1 Login
................................................................................................................................... 12
URLs
......................................................................................................................................................... 12
Login Page
......................................................................................................................................................... 15
Defining a.........................................................................................................................................................
filter
17
Single Sign-On
......................................................................................................................................................... 20
External Authentication
......................................................................................................................................................... 21
Basic Authentication
......................................................................................................................................................... 24
Basic Authentication
.........................................................................................................................................................
w ithout passw ord
28
2 Main
...................................................................................................................................
Page
34
Introduction
......................................................................................................................................................... 34
Object list.........................................................................................................................................................
usage
40
List Layout
.........................................................................................................................................................
Definition Page
43
Tree Layout
.........................................................................................................................................................
Definition Page
45
View Save.........................................................................................................................................................
Page
48
Notifications
.........................................................................................................................................................
Page
49
Calendar View
.........................................................................................................................................................
Types
51
Introduction
.................................................................................................................................................. 51
Month View
..................................................................................................................................................
Type
53
Week View..................................................................................................................................................
Type
54
Day View ..................................................................................................................................................
Type
56
3 Object
...................................................................................................................................
Page
58
Introduction
......................................................................................................................................................... 58
Drop-Dow n
.........................................................................................................................................................
Lists
61
Quick Search
......................................................................................................................................................... 62
Send Em ail
......................................................................................................................................................... 63
Attachm ents
......................................................................................................................................................... 70
Rich-Edit Toolbar
......................................................................................................................................................... 72
4 Search
...................................................................................................................................
Forms and Filters
73
Default Search
.........................................................................................................................................................
Form
73
Edit Filter Param
.........................................................................................................................................................
eters
75
Perform ing
.........................................................................................................................................................
a Search
76
Search and
.........................................................................................................................................................
execute task
78
Filter Edit Page
......................................................................................................................................................... 80
Filter Save.........................................................................................................................................................
Page
81
Filter Organize
.........................................................................................................................................................
Page
82
5 Date/Time,
...................................................................................................................................
Currency and Number formats
82
Part IV Configuration
86
6 Web
...................................................................................................................................
Forms
126
Web Form
.........................................................................................................................................................
Editor Window
126
Web Form
..................................................................................................................................................
Editor Window
126
Tab Properties
..................................................................................................................................................
Subpanel
136
Section Properties
..................................................................................................................................................
Subpanel
137
Field Properties
..................................................................................................................................................
- General Subpanel
140
Field Properties
..................................................................................................................................................
- Columns Subpanel
141
Field Properties
..................................................................................................................................................
- Extended Subpanel
143
Field Properties
..................................................................................................................................................
- Attachments Subpanel
143
Field Properties
..................................................................................................................................................
- Reference Subpanel
145
Field Properties
..................................................................................................................................................
- Size Subpanel
149
Field Properties
..................................................................................................................................................
- Values Subpanel
150
Field Properties
..................................................................................................................................................
- HTML Wrapper Subpanel
151
Field/Text..................................................................................................................................................
Properties - Display Subpanel
152
Field/Text..................................................................................................................................................
Properties - Design Subpanel
153
Text Properties
..................................................................................................................................................
- General Subpanel
154
Create Object
..................................................................................................................................................
Button Properties Subpanel
154
Fill Object..................................................................................................................................................
Button Properties Subpanel
156
Task Button
..................................................................................................................................................
Properties Subpanel
157
Command..................................................................................................................................................
Buttons Properties Subpanel
157
Search +..................................................................................................................................................
Execute Task Button Properties
158
Search Form
..................................................................................................................................................
Checkbox Properties
159
Send Email
..................................................................................................................................................
Button Properties Subpanel
160
Search Reference
..................................................................................................................................................
User Field Properties
161
Web Form
.........................................................................................................................................................
Button Configuration Window
163
Web Form
.........................................................................................................................................................
Preview Window
166
7 Web
...................................................................................................................................
Themes
168
Introduction
.........................................................................................................................................................
to Web Them es
168
Organize.........................................................................................................................................................
Web Them es
170
Web Them
.........................................................................................................................................................
e Editor
172
8 Arbitrary
...................................................................................................................................
HTML formatting for lists
175
Web List .........................................................................................................................................................
Layout Editor Window
175
Defining Custom
.........................................................................................................................................................
Layouts
178
9 Scripting
................................................................................................................................... 188
Introduction
......................................................................................................................................................... 188
Global Properties
.........................................................................................................................................................
and Methods
188
Overview.................................................................................................................................................. 188
Properties.................................................................................................................................................. 189
ActiveFilter
........................................................................................................................................... 189
Contents
ActiveFolder
........................................................................................................................................... 190
ActiveObject
........................................................................................................................................... 191
ActiveSearchFilter
........................................................................................................................................... 191
ActiveSession
........................................................................................................................................... 193
ActiveUser
........................................................................................................................................... 193
CombineFilterAndSearch
........................................................................................................................................... 193
RecursiveSearch
........................................................................................................................................... 194
ServerLanguage
........................................................................................................................................... 194
Methods .................................................................................................................................................. 194
CancelAction
........................................................................................................................................... 194
CloseObject
........................................................................................................................................... 195
GetSelectedObjects
........................................................................................................................................... 195
GetTabLabel
........................................................................................................................................... 196
LogMessage
........................................................................................................................................... 196
OpenObject
........................................................................................................................................... 196
OpenNew...........................................................................................................................................
Object
197
ResultMessage
........................................................................................................................................... 198
Save
........................................................................................................................................... 198
Search ........................................................................................................................................... 200
SetTabLabel
........................................................................................................................................... 200
StatusText
........................................................................................................................................... 201
Hints about
.........................................................................................................................................................
scripting
201
10 Invoking
...................................................................................................................................
Combo Scripts from JavaScript
204
Introduction
......................................................................................................................................................... 204
JavaScript
.........................................................................................................................................................
Functions
204
11 Speeding
...................................................................................................................................
up the Web Gateway using HTTP compression
209
Part V Troubleshooting
214
1 Limitations
................................................................................................................................... 214
2 Hints
...................................................................................................................................
for Troubleshooting
215
Index
229
Part
Introduction
The OMNITRACKER Web Gateway allows OMNITRACKER users or guests to access the
OMNITRACKER database by using an ordinary Web browser.
Features
Browsing through folders and object lists
Searching for objects, using the full-text search engine or search forms
Filtering for objects
Adding, modifying and deleting objects
Downloading and uploading attachments
Providing guest logins for your customers, partners, etc.
Sending emails
The OMNITRACKER Web Gateway can be adapted to your own needs as described in the
Configuration chapter.
Part
II
10
Installation
2.1
Installation
Installing the OMNITRACKER Web Gateway
Please see the OMNITRACKER Installation Guide for the necessary steps to install the
OMNITRACKER Web Gateway.
Part
III
12
3.1
Login
3.1.1
URLs
This page describes the URLs that you can use to start the Web Gateway. In all URLs, the
placeholder <hostname> means the name of the host on which the Web server and the
OMNITRACKER Web Gateway is running, and <virtualroot> means the name of the virtual directory
under which the Web Gateway has been installed (see Installation).
If optional parameters are used make sure that the first parameter always is prefaced with an "?"
character. All further parameters must be prefaced with the "&" symbol. All white spaces used in the
URLs are for better readability and must be removed. Optional parameters are embraced with square
brackets in the examples below.
Hide Language:
The optional hidelanguage parameter allows to hide the language dropdown list in the Login page.
Login Language:
The optional lang parameter lets you set the display language using one of the ISO 639-1
shorthands (e.g. 'en' for English), overwriting any browser settings.
Locale
Number, currency and date/time formats depends on the Language setting in the browser. It is
possible to override the browser settings by using the optional locale parameter. Possible values
are for example: "en-US", "en-GB", "de-DE", "de-AT"...
Login Name
The optional "user=<login name>" parameter can be used to fill the given name into the login field
automatically.
13
Readonly Licenses:
If you have purchased "Read only" licenses for your OMNITRACKER system, you can use the
parameter "readonly=1" to log in with a read-only license.
Guest Logins:
The optional guestlogin=<id> parameter performs a guest login. The number <id> specifies which
guest login setting is used (see Guest Login Properties Window). If authentication is required for the
guest login, the Login Page will be displayed. Otherwise, the login page will be skipped and the Main
View or the Object Page will be displayed.
The optional parameter "showLoginObject=1" can be used with Guest Logins. After login the user
can edit his own object (for example to modify his address data).
Singleton Login:
The Singleton Login displays a single object. Three modes are possible (1,2 or 3).
singleton=1 means that the user will automatically be transferred to the URL for Singleton Logout
(s. Web Configuration options for details) when clicking OK (the button "Save" is not available in this
mode).
14
Note:
If the object with the specified <id> does not exist in the database, logging in will not be possible if
singleton 1 or 2 is used!
Note:
If the filter does not return any object, logging in will not be possible if singleton 1 or 2 is used!
If the filter returns more than one object you will be informed by a message box. Afterwards the main
page is displayed for all singleton modes.
15
Note:
The white-spaces between the parameters in the URLs above are for better readability and
must be removed!
3.1.2
Login Page
Layout
16
Description
Enter your user name and password into the corresponding fields, and press Login.
The login information will remain valid until you close your Web browser, until you press the "Logout"
button on the main page, or until the session timeout has expired (see "Configuration File" for setting
the session timeout).
Note:
The IIS must be configured that no anonymous login is allowed for the Web Gateway website.
The integrated windows authentication must be enabled.
The line "<identity impersonate="true"/>" must be added to the <system.web> section of the
Web.config file if not present.
For further informations see "Single Sign-On" in the administrator online help.
Read-only login
17
If you have purchased "Read only" licenses for your OMNITRACKER system, the checkbox "Readonly login" will be visible in the third line. Check the box to login using a read-only license. You can
also append "?readonly=1" (resp. "&readonly=1" as second parameter) to the URL, in this case the
checkbox will not be visible and you are logged in with a read-only license.
Your read-only license is converted to a write-enabled license if you perform one of the following
actions:
clicking the "New" button to create an object
clicking "Save" or "OK" to modify an object
saving a filter
modifying a column layout
executing a combo script
If there are no free write-enabled licenses at the moment, the current action (create/modify) will fail
and you are informed of this. As administrator, you can configure the message a user receives in
this case. If the conversion succeeds, you can continue using the Web Gateway as if you had
logged in the usual way. You cannot convert a write-enabled license back to a read-only license.
Language
Select your preferred language for the Application.
The preselected language depends on the browsers language settings and can be overwritten by the
optional "lang" parameter in the url.
(When using Internet Explorer 7 you can change the language in the menu by clicking 'Tools' ->
'Internet Options' -> 'Languages'.)
Note: Only languages that are installed on the OMNITRACKER server can be selected.
3.1.3
Defining a filter
If the URL parameters singleton or openuniquematch are used in the login url, then it is possible
to define a filter as described here.
Singleton
The filter must return exactly one object. Then this object is opened if the login succeeds.
If the filter returns more then one object, an error message is shown. The last visited folder is
displayed.
If the filter does not return any object, logging in will not be possible (singleton 1 and 2) or an error
message is displayed.
18
OpenUniqueMatch
If the filter returns exactly one object, then this object is opened if the login succeeds.
Otherwise the filter result is displayed on the main page.
Singleton URL:
http://<hostname>/<virtualroot>/Login.aspx ?&singleton=<singleton> &folder=<folderpath>
&filterfield1=<filterfieldname1> &filterparam1=<filterparamvalue1> [more parameters]
[&includesubfolders=1]
OpenUniqueMatch URL:
http://<hostname>/<virtualroot>/Login.aspx ?openuniquematch=1 &folder=<folderpath>
&filterfield1=<filterfieldname1> &filterparam1=<filterparamvalue1> [more parameters]
[&includesubfolders=1]
Description
folder
filter
yes, if
filterfield1 is
not used
filterfield1
You may enter any number of user fields to filter for. You
can identify the user fields either by their label or by their
alias name. The following user field types are valid:
Autonumber
Boolean
Byte
Currency
Date/Time
Dropdown list
Float (single/double)
Integer (long/short)
Text
Workflow
yes, if filter
is not used
yes, if filter
filterfield2
...
filterfieldN
filterparam1
Required
yes
filterparam2
...
filterparamN
19
no
The other parameters are described in the section of the singleton login with a unique ID.
A few notes
If you enter multiple filter fields, the fields are combined with "and".
Every field is compared for equality.
An object is only opened if it is the single object which matches the given filter. So typical user fields
to search for are autonumber fields or the identifying fields of a folder.
Logging in will not be possible if singleton 1 or 2 is used and if the filter as invalid parameters or if the
filter does not return any object.
You have to escape certain characters (in the folder path, userfield names and field values) due to
URL specifications. Below, there is a list of characters which have to be replaced in your URL:
Character
Escape
symbol
Character
Escape
symbol
Character
Escape
symbol
%24
%7E
%23
&
%26
%3F
%25
%2B
%40
%7B
%2C
Space
%20
%7D
%2F
"
%22
%7C
%3A
<
%3C
%5C
20
%3B
>
%3E
%5B
%3D
%5E
%5D
` (Grave
accent)
%60
An important warning: It is strongly recommended that you do not use non-ASCII characters
(characters 128-255, this includes German umlauts) in the folder path or in the search parameters.
Use the folder alias if necessary and select appropriate search fields. Handling of these characters
is not defined in the HTML specification and may vary depending on your browser and the selected
character set.
3.1.4
Single Sign-On
If Single Sign-On is used for authentication, the user uses his Windows credentials for logging in.
On the login page, when single sign-on shall be performed, the user selects the check box "Use
Windows Login".
In order to use single sign-on, the following conditions must be fulfilled:
If Windows user "MYDOMAIN\joe" shall be able to log in, then there must be an OMNITRACKER
user account with login name "joe".
For all single sign-on user accounts in the OMNITRACKER user special folder(s), the
authentication method must be "Windows".
The Web Gateway Configuration Option "Allow Single Sign-On" must be set to true.
In Internet Information Services (IIS), the authentication method of the Web Gateway must be set
to Windows-Authentication. Anonymous Login must be disabled and ASP.NET Impersonation
must be activated.
If the OMNITRACKER server is in a different Windows domain than the user that logs on, the field
"Windows Domain Name" of the corresponding OMNITRACKER user account must contain the
name of the Windows domain to which the user belongs. E.g. if user "MYDOMAIN\joe" logs in,
and the OMNITRACKER server is in domain "OTHERDOMAIN", then the value "MYDOMAIN"
must be stored in the field "Windows Domain Name". For users from the domain
"OTHERDOMAIN", however, the field "Windows Domain Name" can be left empty.
When the Web Gateway is installed on a different machine than the OMNITRACKER server, the
web server computer must be marked in Active Directory as trusted for delegation. Furthermore,
service principal names (SPNs) for the OMNITRACKER server must be defined in the Active
Directory. For example, if the OMNITRACKER server is running on host
"myserver.mydomain.com" under port numbers 5085 (normal) and 443 (SSL), then you should use
setspn to define the following SPNs:
setspn -A
setspn -A
setspn -A
setspn -A
OMNITRACKER/myserver.mydomain.com:5085 domain\username
OMNITRACKER/myserver:5085 domain\username
OMNITRACKER/myserver.mydomain.com:443 domain\username
OMNITRACKER/myserver:443domain\username
21
Here, domain\username is the user account under which the OMNITRACKER server is running. If
the OMNITRACKER server is running under LocalSystem, use the computer name of the
OMNITRACKER server instead of domain\username.
Generally, the OMNITRACKER server's SPN has the following format:
OMNITRACKER/hostname:portnumber
You also should define the above mentioned SPNs if you want users to log on using the Kerberos
authentication protocol, instead of the NTLM protocol which is used as a fallback if Kerberos is not
available. In the OMNITRACKER log file, you can see whether a user logged in using Kerberos or
NTLM.#
In order to solve any problems regarding single sign-on, please see Single Sign-On Troubleshooting
in the Administrator Guide
3.1.5
External Authentication
External authentication allows the user to log in the Web Gateway directly, without entering
username and password. To do so, additional credentials must be added to the login URL of the
Web Gateway. These credentials may be username, password, session tokens or other information.
The credentials are passed to an external server, which returns a xml document to the
OMNITRACKER. This document must contain the information whether the login is successful as
well as the login name of the OMNITRACKER user. As an additional information the document can
define the login language and the locale information for the web session.
External Authentication can be used for normal logins as well as for guest logins.
22
For the example above, the following URL has to be specified as Remote Authentication URL:
https://app.mycompany.com/webinterfaces/checklogin_goid?ticketId=[auth1]
("auth1" will be replaced by the information which is passed as "auth1"parameter to the Web
Gateway in the login URL)
If the Remote Authentication Server requires a certificate for authenticating the OMNITRACKER
server, the certificate name can be specified using the configuration option "Client Certificate for
Remote Authentication". Necessary certificates are determined automatically if this option is left
empty.
If the returned xml document has not exact the format which is supported by the OMNITRACKER,
the document can be converted into the supported format by performing a XSLT transformation.
Therefore a XSL Style Sheet can be specified.
23
<reply>
<success>true</success>
<user>JohnDoe</user>
<locale>en-us</locale>
<errormessage></errormessage>
</reply>
URL
One or more parameters called authN can be added to the URL. For each parameter, N must be
different, and the parameters must be numbered starting with 1, e.g. auth1, auth2, and so on.
According to the example above, the following login URL must be used:
Login.aspx?auth1=CC05703D-748E-4c84-9A12-C3DC9A681535
If the login language is not forced by the external server (locale specified in the xml document), it
can be set in the URL using the parameters "lang" and "locale":
Login.aspx?lang=en&auth1=CC05703D-748E-4c84-9A12-C3DC9A681535&locale=enUS
24
The following XSL style sheet must be added to Web Gateway Configuration to convert the given
document into the correct format:
<?xml version="1.0" encoding="UTF-8"?>
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<xsl:template match="Login">
<result>
<success><xsl:if test="error='false'">true</xsl:if><xsl:if test="error='true'">false</xsl:
if></success>
<user><xsl:value-of select="user"/></user>
<locale><xsl:value-of select="translate(language, '_', '-')"/></locale>
</result>
</xsl:template>
</xsl:stylesheet>
Security hint
If external authentication is used, all authentication relevant information is contained within the URL.
This URL can be visible in the browsers address bar. In addition, the information is transferred as
cleartext through the network if SSL (https) is not configured for the Web Gateway. To minimize the
risk that a third person can misapply a valid login, https should be used. In addition, the session
tokens which are transferred as URL parameter to the Web Gateway should only be valid for a small
period of time (ideally they should become invalid directly after the OMNITRACKER server has
checked if the session tokens are valid).
3.1.6
Basic Authentication
The Web Gateway supports basic authentication. This means the authentication data are passed to
the Web Gateway within the header of the HTTP request.
WARNING:
The login credentials are passed as plaintext from the client browser to the Web Gateway server and
can be intercepted. It's strongly recommended that this authentication mode only is used, if the
HTTP connection is encrypted (https):
25
Depending on the defined security level (see below) the Browser will ask for the user name and
password and pass them to the Web Gateway.
26
Security Level
There are three security levels available. It defines under what circumstances the Web Gateway
asks for the authorization data using basic authentication.
Security Level
0
Description
The highest security level.
The Web Gateway will never ask for the login credentials.
This means that the first request which is sent to the Web Gateway already
must contain the authorization header. If this header is not present, the error
message "Missing authorization header" is displayed.
Its recommended if for example a web portal is used which supplies the login
credentials to the Web Gateway. After successful login the web portal must act
as a proxy. The user can directly access the Web Gateway without entering his
user name or password.
27
The Web Gateway will ask for the login credentials only if an encrypted HTTP
connection is used (https)
This means that if the login page is opened and if the authorization header is not
present, the browser shows an dialog and asks for user name and password.
Troubleshooting
Problem
The error
message
"Missing
authorization
header" is
displayed
Solution
The HTTP request does not contain the required Authorization header. This
header is not added automatically if the security level is "0" or if the security
level is "1" and the connection is not encrypted (https).
Solution:
If you were redirected from a web portal which manages the login, this portal
must add the Authorization header to the request.
If you want to access the Web Gateway directly using basic authentication, the
security level must be reduced, or an encrypted HTTP connection must be used
28
The HTTP request does not contain the user name header which was specified
in the Web Configuration Options. This header must be added by a web portal.
If you want to access the Web Gateway directly using basic authentication, you
must not specify a user name header.
The error
message
"Wrong user
name or
password" is
displayed
The browser
asks several
times for user
name and
password
Basic authentication is enabled in IIS and the user is not listed in the active
directory.
Solution: disable "Basic/Standard Authentication" and enable "Anonymous
Authentication" in IIS
or
The error "401
Unauthorized"
is displayed
3.1.7
This authentication method was introduced to support the usage of external access managers and
works as shown in the picture below.
29
An access manager is located on a machine between the client machines (User Browser) and the
web server (Microsoft IIS). The clients cannot connect directly to the IIS. The machine where the
access manager is installed on works as a proxy.
Function:
1. The user opens the Web Gateway login url.
2. The request is cached by the access manager.
If the user is not yet authenticated, this is done by the access manager automatically (e.g. a login
in mask which is provided by the access manager is displayed to the user)
3. The original request which was cached in step (2) now is sent to the Web Gateway (on the IIS
machine). In addition the access manager has added a custom user name header to the request,
which contains the login name of an OMNITRACKER user. A password is not required.
4. + 5. The login is performed automatically and the Web Gateways main page is displayed in the
user browser.
WARNING:
The OMNITRACKER server does not perform a separate authentication. Therefore it must be
assured that only the access manager has access to the Web Gateway server.
30
31
Enter the IP address of the machine where the access manager is installed on here. This restricts
the number of proxies which can connect to the Web Gateway using Basic Authentication without
Password.
Note: At least one IP address must be specified here, otherwise Basic Authentication without
Password cannot be used. Several IP addresses must be comma separated.
Security Level
This option does not has any meaning if the option "Authentication without password" is used.
32
Security Hints
WARNING: Enabling this feature is a security risk. The OMNITRACKER does not perform any
authentication and allows to login without any password. An aggressor only must know existing
login names to gain access to the system. Therefore the access to the web server and to the
OMNITRACKER server must be restricted.
Separate Web Server
If this feature is used, a separate web server should be used which supplies exclusively this login
method. Only the access manager (which must be installed on a separate machine) may have
access to this web server.
NEVER user this feature on a public web server!
Use Firewalls and separate network cards
The connection between access manager and web server should be established using a separate
network card. A firewall on the web server must block incoming requests from other machines
except the access manager.
Use client certificates
Setup a secure connection to the web server (https) and force the usage of a client certificate
which must be installed on the access manager.
Authenticate the user account which is used by the access manager.
The access manager should be authenticated by the IIS using windows authentication or basic
authentication.
Restrict the access by defining allowed and forbidden user names
If possible restrict the access as far as possible, e.g. lock out superusers and persons with
administration privilege.
Troubleshooting
Problem
Solution
The error
message
"Missing
authorization
header" is
displayed
The error
message
"Missing user
name header"
is displayed
The HTTP request does not contain the user name header which was specified
in the Web Configuration Options. This header must be added by the access
manager.
The error
If an IP is defined, the address of the access manager may be wrong. To find out
the correct IP please enable the "OT_LogLoadTimes"-log in the web.config file.
Set the value to an existing file path. In the created log file an error should be
displayed with the IP address of the access manager. LogLoadTimes should be
disabled afterwards.
message
"Wrong user
name or
password" is
displayed
33
34
3.2
Main Page
3.2.1
Introduction
After logging in, the main page will be displayed.
Layout
Description
The header contains buttons for general features (e.g. Logout)
The column on the left contains the shortcut bar.
The second column from the left side displays all available folders for the current user. Whenever
the user selects a folder, the object list on the right pane will be updated.
The right pane on displays the search form on the top, if there is one defined in the displayed
folder.
Below the search form is the main button bar, which allows to create/open/delete objects, perform
tasks and change layouts and views. The folder specific Shortcut bar is attached here.
Below the button bar is main list which shows the objects in the current folder which matches the
current filter selected in the search form.
35
By clicking on an entry in the list, objects can be selected. The in combination with the buttons
CTRL or SHIFT, several objects can be selected.
Selected objects can be opened or deleted by clicking the appropriate button.
An object also can be opened with a double click or by selecting it and pressing ENTER
(STRG+ENTER if the objects in the list are editable).
Columns can be re-sized with the mouse: click and hold the right border of a column in the lists
header, drag it to the desired width and release.
Use the checkbox on the left side of the header to select/unselect all objects displayed in the list.
More details about the view types "List View" and "Tree View" can be found in the User Guide
(chapter "Concepts / View Types").
36
Calendar View
The Calendar View itself supports three different subtypes:
Calendar View Description
subtype
Month View
The objects are displayed in a month calendar. (See the topic Month View Type
for a screenshot and more detailes)
Week View
Day View
The objects are displayed as appointments in a day view. The entries of this
date can be optional grouped according to the content of an object attribute.
(See the topic Day View Type for a screenshot and more details)
More details about the Calendar View type can be found in the topic Calendar View Types Introduction.
Panes Control
It's possible to keep multiple objects open simultaneously. All open objects are displayed in the
header as link buttons. The objects which cannot be accessed directly (due to insufficient space)
can be reached by clicking the "overflow" button.
Multiple objects can be opened with one click by selecting them and clicking the "Open" button. But
there is a limit of max. ten objects which can be opened at once.
For a better clearness the size of unselected pane tab buttons is limited and the label is shortened.
If the mouse cursor is moved over a pane button the width is enlarged to a certain degree.
37
The dynamically enlarged pane tab button is supported by Internet Explorer 10 or newer and most
other browsers. It can be disabled by adding the following attribute to the <appSettings> section in
the web.config file:
<add key="OT_DynPaneButtonWidth" value="false"/>
Note:
The images are displayed either in 16x16 or 24x24 pixels.
The shortcut bar uses 32x32 pixel images. For best appearance icons should be used which contain
all three sizes (16x16px, 24x24px and 32x32px).
Control
Description
Use this button to navigate to the first page in the object
list.
38
39
40
If a filter that contains "ask user" parameters is selected, a dialog to access these parameters will
open. The new parameters will be applied by clicking "Ok", while "Cancel" continues to use the
original parameters.
3.2.2
Paging
If the current folder contains a lot of objects, more than the object list display per page, then the
navigation buttons in the toolbar will get available (they turn black).
41
If a sublevel contains too many objects, the navigation buttons will be displayed in the headline
obove the objects:
If the option "show object name only" is selected in the "layout definition dialog", then you must
click on the button "more" to display all available items. Paging is not possible.
Select Objects
To select an object, simply click the corresponding row. The row now is highlighted
If you want to select different rows, hold down the "shift" or the "ctrl" key and select the rows in the
list. To select all displayed objects you can click the checkbox in the header of the list. Analogous
you can select an object and press the keys "ctrl"+"a".
42
You can use the paging buttons and select objects on other pages too. (Press the "ctrl" key to
select objects on different pages.)
cursor down
page up / cursor
right
page down /
cursor lef
ctrl + mouse
click
shift + mouse
click
Selects all rows between the current and the previous selection
enter
double click
keypad +
keypad -
del
3.2.3
Layout
To open this dialog, switch to "List view" and click "Edit layout..." on the Main Page.
43
44
Columns
These columns currently are visible in the list layout. It's possible to override the name of the column
by entering a new text in the column "Header". On the right the width of the columns can be
adapted. Its possible to add further columns or to remove existent.
Sort Columns
The sort columns are listed here. The list is sorted by the columns listed here. The sort order can be
changed here.
Window Description
Title
Add...
Description
Opens the "Add Column" window which allows to add further columns to the list
layout.
As sort
column
Up
3.2.4
Down
Delete
Toggle
direction
45
46
Layout
Control
Description
Check the name of a referenced field to have it displayed in the tree, if you
uncheck it, it will not be visible in the main view, including its subelements.
Up
Down
Select an element in the tree and click "up", so that the selected element will
be moved one step up. Click "down" to move it down. You cannot move the
topmost element upward or the lowest element downward.
Note: The order of unchecked elements is undefined. Checked items are saved
in their defined order.
Select All
Unselect All
Edit Layout...
Click "Select all" to have all the elements on the currently selected item's level
checked. Click "Unselect all" to remove the checkmark from all these
elements.
Select an element and click "Edit Layout..." to open the List Layout Definition
Page.
Note: If more than one userfield refers to the same folder, these userfields all
have the same list layout.
Reset Layout...
Select an element and click "Reset Layout..." to remove the element's layout
definition. The element will then be displayed in the folder's default list layout.
You cannot reset the root element's list layout.
Check or uncheck these boxes to define general display options:
Draw Line between "Draw line between items": Draws lines indicating the connections between the
Items
items (see pictures below, left = unchecked, right = checked)
47
Draw Grid
Show column
headers
Show object name
only
"Draw grid": Draws a grid between the items (see pictures below, left =
unchecked, right = checked)
"Show object name only": Displays only the object name and the names of its
referenced objects. Ignores the "Show column headers" flag (see example
below)
48
OK
Cancel
3.2.5
Click OK to confirm your changes and to apply the changes to the main view.
Click Cancel to exit the editor and to discard all changes.
The Save View Window allows you to Save user defined Views. (See the User Guide for details).
Pick the name from the list or enter an new one.
Administrators are allowed to define public Views.
3.2.6
49
Notifications Page
Introduction
"Notifications" are email-like messages, which can be read using the Web Gateway. When a user
logs in, and there are new Notification messages, then the following page is displayed.
New messages are highlighted in boldface. By expanding a list item or double-clicking an entry of
the list, the whole notification text can be read.
Notification messages normally are sent automatically by OMNITRACKER-internal actions.
Currently it's not possible to send notifications directly from the Web Gateway.
Layout
Description
Title
Description
Open
Delete
Refresh
Open
associated
object...
Mark as read
50
New Notifications
If a user logs in and if there are new (unread) Notification messages, then the notification page is
displayed. The notification page cannot be displayed if the Singleton Logins 1 or 2 are used.
The Web Gateway periodically checks if new Notifications arrived. By default this happens once
every 15 minutes. If a user gets new Notifications, then the Notification tab becomes highlighted after
the next page refresh which is caused by the user (e.g. if the user clicks on a shortcut bar link).
"Immediate" delivery
If the Web configuration option "Always close session" is enabled, then a polling mechanism
becomes active, which also is used to check if new Notifications are available (the notification time
interval is respected anyway).
If new Notifications arrive, then the Notifications tab becomes highlighted immediately, without page
51
Note:
Too small intervals can have a negative impact on the performance.
The notifications page can be hidden for all users. See the Web Gateway Configuration dialog (Main
view options | Hide Notifications).
3.2.7
3.2.7.1
Introduction
In the OMNITRACKER Web Gateway the objects of a folder can optionally be displayed in a
calendar view. Currently the following calendar view type are supported:
Calendar View
subtype
Description
Month View
The objects are displayed in a month calendar. (See the topic Month View
Type for a screenshot and more detailes)
Week View
Day View
The objects are displayed as appointments in a day view. The entries of this
date can be optional grouped according to the content of an object attribute.
(See the topic Day View Type for a screenshot and more details)
In order to display the objects in one of the calendar view subtypes a so called calendar view setting
is required. This calendar view setting specifies - among other things - which of the attributes shall
be used as the start or end date when displaying the object in the calendar. The calendar view
setting can only be configured using the WPF client (see also "Calendar View Settings - "General"
Subpanel" of the WPF Client UserGuide).
The subject of an appointment can not be set inside the calendar view setting. Instead it will be
52
General Aspects
For all three calendar view subtypes the calendar control contains a header. The header itself
contains controls for navigation and for switching between the calendar view subtypes.
Window Description
Title
Description
1. Go back one day/week/month (depending on selected subtype)
2. Go forward one day/week/month (depending on selected subtype)
Day view
Week view
Month view
Opens a date picker control to select a specific day. Depending on the selected
subtype, the appointments of the selected date, the week which contains the
selected date or the month which contains the selected day will be displayed.
1. Switch to day view
2. Switch to week view
3. Switch to month view
53
Keyboard Behaviour
No keyboard behaviour is supported (except the ones mentioned in Mouse Behaviour)
Mouse Behaviour
When the mouse hovers over an appointment, a tool tip is displayed that shows the start and the
end time and the complete subject of the appointment. The tool tip will be removed as soon as
any key is pressed or when the mouse is moved outside the appointment.
When the mouse hovers over an appointment, the delete icon
will be displayed in the top right
corner. If the user clicks this icon, the appointment will be deleted. This icon will only appear if the
user has writing permissions and the appointment is not from a working time calendar or from a
personal calendar.
When the user double-clicks at an appointment with the left mouse button, the appointment is
opened in the object form.
When the user left-clicks at any free area in the background (at the same height of the 00:0024:00 vertical ruler in day or week view), the half hour in which the user clicked is selected in day
view. In week view the complete day (i.e. the day column) is marked as selected. In month view
the day which is clicked is marked as selected. If next the view subtype is changed to day view,
the new selected day will be displayed.Any previously selected area is unselected; any previously
selected appointments also are unselected.
If the user held down the SHIFT key while pressing the mouse button, the time area between the
currently selected half hour and the previously selected half hour is selected.If the user moves the
mouse while keeping the left mouse button depressed, the time area between the currently
selected half hour and the half hour over which the mouse is hovering is selected.
If the mouse hovers over the bottom border of an appointment, the mouse cursor changes to
(This indicates that the user can change the end time of the appointment.)
If the user presses the left mouse button while the cursor is over the bottom border of an
appointment and moves the cursor up or down while keeping the left mouse button pressed, the
end of the appointment is changed to the half hour on which the cursor currently is positioned.
If the user presses the left mouse button while the cursor is over the appointment and moves the
cursor, the appointment is moved to the nearest corresponding half hour, and to the corresponding
column. The total height of the appointment is not changed (this is only possible for the day and
week view).
3.2.7.2
54
The selected day (or today if the calendar view is visible for the first time) will be marked (in this
example the 14. of March 2012). Up to two entries per date can be displayed at once in the month
view. If the mouse hovers over an appointment a tool tip will appear. This tool tip contains the start
and end date of the appointment (date and time) and a subject. If an appointment is double-clicked
the object form with all object data will be opened (analogue to double-clicking of an object in list or
tree view, see ). If a day is single-clicked, this day wil be selected and marked. If a day is doubleclicked the calendar control will switch to day view and the new selected date will be displayed.
If a calendar entry is displayed without a time value preceeding its title (e.g. like the entry
"SpecialHoliday") then it lasts the whole day (i.e. from 0:00 to 24:00). Otherwise the time value
indicates the time the calendar entry starts or ends. If a calendar entry covers more than one day
(does not have to be more than 24 hours), the entry will cover more than one day in the calendar
view (e.g. like the entry "Room 1: test - allday one" which starts at March, 21 at 1:00 AM and ends
at March 25, at 1:00 AM.
Navigating to a distinct date in the month view
In order to navigate to a special date in the month view either use the back/forward navigation
buttons to move backward/forward one month or use the today button to move to today (if today is in
the displayed month, this date will be selected) or use the
(s. Introduction).
3.2.7.3
55
Can be used to directly select the date that shall be displayed in the week
calendar (or rather the week which contains this date). Every day in the date
selection control that contains at least one appointment (an object from the
folder or an element of the working time calendar or the personal calendar)
will be displayed with a bold font.
Calendar Entries List Contains all elements of the selected day (which is marked in the week
(right side, bottom) calendar, Wednesday the 13th in the example above). Entries in this list
which do not contain at start and/or end time are multi-day appointments
(e.g. the first entry in the list).
Additionally to the week calendar the calendar entries list can be used to
open appointments (with a double-click of a list entry) or to delete an entry
(with a single-click of a list entry and afterwards a single-click of the
button).
56
3.2.7.4
57
Date Selection Control Can be used to directly select the date that shall be displayed in the day
(right side, top)
calendar. Every day in the date selection control that contains at least one
appointment (an object from the folder or an element of the working time
calendar or the personal calendar) will be displayed with a bold font.
Calendar Entries List
(right side, bottom)
Contains all elements of the selected day. Entries in this list which do not
contain at start and/or end time are multi-day appointments (e.g. the first
entry in the list).
Additionally to the week calendar the calendar entries list can be used to
open appointments (with a double-click of a list entry) or to delete an entry
(with a single-click of a list entry and afterwards a single-click of the
button).
58
Using Grouping
If grouping is enabled the entries of this date are grouped into different categories. Every category
will be displayed in a own column. In order to use the grouping option you can specify a drop-down
or reference object user field in the Calendar View Setting that defines the column for grouping.
Important:
All objects of an OMNITRACKER folder for which the grouping field is empty will/can not be
displayed using grouping.
3.3
Object Page
3.3.1
Introduction
Introduction
The object page displays the fields of a single object, its attachments, and its history.
59
Layout
Description
By default, all fields of the current object are displayed. The administrator of the OMNITRACKER
Web Gateway can, however, hide one or more fields from some or all users, change the order they
appear on the page, arrange them on a Tab Strip and in Sections, specify one- or two-column layout
for every row and customize the field labels (see Web Form Editor).
Saving modifications:
The user can save the modifications of the current object by clicking the Save or the Apply button.
If the user has been referred here by URL (see URLs), clicking this button will redirect the user to a
configurable Logout Page (see the configuration option "URL for End of Session" in the Web
Gateway Configuration Window).
60
The user can return to the main view by clicking the folder name:
3.3.2
61
Drop-Down Lists
Introduction
Drop-Down lists in the Web Gateway offer a comfortable way to find a specific item if the list of items
is very long:
If the Drop-Down list was opened, it's possible to enter text to search for a specific item in the list.
Click into the drop-down control or click the cursor down key if the drop-down list has the focus
2. Type in text
62
Note:
The search is performed on client side. There occurs no communication with the Web Server.
By default the search feature only is available if the number of items in a Drop-Down list reaches a
limit and does not exceed a maximum. This range can be configured in the Web Gateway
Configuration dialog.
This search also is available on quick search fields, if the result of the quick search is displayed.
The speed of the search can vary and depends on the following factors:
Number of items in the list (The search can be slow if there are hundreds of items in the list)
Used Browser (some Browsers are very slow (e.g. IE6 and IE7)
Clients machine speed
3.3.3
Quick Search
Introduction
Fields of the types "Reference to object", "List of references" and "Reference to user" can be
configured to allow Quick Searches.
This feature must be enabled in the Web Form Editor for the according fields.
how to enable Quick Search for reference to object fields
how to enable Quick Search for reference lists
how to enable Quick Search for reference to user fields
Quick Search fields are identifiable on their magnifier symbol on the left.
To perform a Quick Search, simply enter the Text you are searching for and press enter.
63
If the Quick Search returns exactly one result, the object name is filled in the text field immediately:
If the Quick Search returns more than one result, a drop-down list with the search results is
displayed.
The User can select the desired object with the mouse or by using the cursor keys and pressing the
ENTER key.
If a quick search is used for fields of type "Reference list of objects", then it is possible to select
multiple items in the search result list. In this case a check box is displayed on the left side of each
list item.
A checkbox can be checked with a mouse click or by pressing the SPACE key. The selection will
be applied after ENTER was pressed.
If the number of items of a quick search result exceeds the Drop-Down filter range minimum, it's
possible to enter text to search a specific item within the search result.
If the Quick Search returns more results than defined as Quick Search Limit in the Web
Configuration, the Select Object dialog will be opened to display the quick search result.
3.3.4
Send Email
Introduction
On web forms, buttons for sending emails can be placed. These buttons can be configured to use a
specific message template, or the user can select the desired message template himself.
64
Window Description
This dialog is opened when the Web Gateway user has to select the message template himself.
65
Window Description
Title
Description
To...
Cc...
Bcc...
HTML
Plain Text
66
Add...
Remove
Default
67
68
Window Description
Title
Description
Recipients
User
Group
69
Open Addressbook...
Note:
Due to performance reasons, the "User" combobox is replaced by a quick search control, if the list
contains more than 200 users.
Simply add the name of the user which shall be added (enter display, login or last name)...
Multiple items can be selected with the mouse or with the cursor and space keys:
Press enter to add the selected users to the recipients list. If the quick search returns exactly one
result, the user is immediately added to the recipients list. If the search returns too many results,
only the first N users are displayed.
70
The quick search can be configured by adding the following key to the web.config <appSettings>
section:
<add key="OT_AddRecipient_UseQuicksearch" value="extended"/>
The following values are possible:
Value
false
Description
Never use quick search, independent of the
number of users.
Warning: this can lead to performance
problems if a very large number of Users is
displayed.
3.3.5
standard
extended
Attachments
Introduction
Attachments can be uploaded and downloaded in the Web Gateway.
Note: The maximum file size that can be sent to the web server is restricted by the
"maxRequestLength" setting in the web.config file. This value can be changed by using the
WebConfig Editor.
71
Attachment field
The Attachments of a field are listed in a table. To open a file or a link, simply click on the name.
Then the browser will ask your if you want to open or save the file. If you try to open a file type that is
by default opened with your browser you should click the attachment with the right mouse key and
open the attachment in a new window. Otherwise it's not possible to navigate back to the object form
that is currently open.
Add Attachments
Click on the "Add..." button to upload a file or to add a new web link.
72
Delete Attachments
If you want to delete an attachment, the checkbox on the left must be selected. Click "Delete" to
remove the selected attachments.
Modify description
If you want to modify the description of an attachment, the checkbox on the left must be selected.
Click "Modify description..." to change the text.
Move Attachments
Attachments can be moved to other attachment fields on your web form. Click the checkbox on the
left to mark the attachments you want to move.
Note: The user must have the permission to move attachments. Furthermore this feature must be
enabled for the attachment field in the web form editor.
3.3.6
Rich-Edit Toolbar
Introduction
The Rich-Edit toolbar gets visible, if an object was opened which has at least one formatted text
field.
The toolbar gets enabled if the formatted text field has the focus. Some of the controls only get
enabled, if text was selected with the mouse cursor.
73
Layout
Window Description
Title
Description
1. Font family
2. Font size
1. Increase font size
2. decrease font size
1. Format selected text bold
2. Format selected text italic
3. Underline selected text
1. Change the background color
2. Change the text color
1. Align paragraph to left
2. Align paragraph to center
3. Align paragraph to right
1. Decrease indentation
2. Increase indentation
Start or end a list:
1. Bullet list
2. Numbered list
Insert a picture (the upload is restricted to max 1MB per image)
Insert a hyperlink
3.4
3.4.1
74
If the Web Gateway Configuration option "Hide Filter" is set to true, the first two rows will not be
displayed.
If the Web Gateway Configuration option "Hide Full-Text Search" is set to true, the full-text search
will not be displayed.
If both options are set to true, the default search form will not be visible in the Web Gateway.
This form contains the "filter menu button" for managing the filters in the current folder. By clicking
the dropdown box you can edit, save and organize your filters.
In the dropdown box on the right you can select an specific filter. After a filter is selected, the object
list will update it's content and shows only the objects matching the filter.
If a filter with parameters is selected, the button "Edit filter parameters" will be editable. In the box
right to this button the selected filter parameters will be displayed.
The third row in the search form contains the full-text search field.
The small Button in the upper right corner is the "minimize" button. If clicked, the search form will be
hidden.
3.4.2
75
Note:
Fields of the type "Reference to object" and "List of references" are usually displayed as dropdownlists. If the amount of selectable objects is greater than specified in the Web Gateway Configuration,
a textbox with a select button is displayed instead to avoid performance issues (see the first row
"Incidents" in the image above...).
Quick Search
It's possible to use the Quick Search feature for the following field types:
Reference to object
List of references
To enable this feature the option "Filter Parameter use Quick Search" must be enabled in the Web
Gateway Configuration dialog. Furthermore in the "Field Properties" dialog a default quick-search
field must be specified (see the image below).
76
3.4.3
Performing a Search
Full-text search
To perform a full-text search, simply type in the text in the desired full-text search field and press the
associated "search" button.
77
Afterwards the page will reload and the object list will only display the objects that matching the
search. To reset the search, simply press the "Reset" button right to the "Search" button.
Search
To perform a search, simply fill all fields you want to include in your search and click the "Search"
button.
All not empty search fields in the search form are included in the search. As well the fields, that are
placed on another tabs.
Search Elements
Button
"Search"
Button
"Reset"
78
Full-text searches can alternatively be closed by clicking the respective "Reset" button.
3.4.4
Three kinds of "Search and execute task" buttons can be placed on a search form.
Select Task
The task and the output format can be selected by the user himself:
79
80
3.4.5
Description
The top porting shows all the conditions the filter rule consists of.
The lower section allows you to edit a single condition. Clicking on a condition from the rule lets you
edit the selected condition.
A condition consists of for components:
A boolean operator, AND or OR. This is requires only if you're combining more than one
condition.
A property.
A comparison. Which comparisons are available depends on the type of property. (See the
User Guide for details)
Possibly a value the property is compared to. This, too, depends on the type of property you're
comparing. (See the User Guide for details)
Once you've edited the condition, you can use the buttons in the bottom to
Add the condition to the rule or
Change the currently selected condition - this requires that you select a condition in the rule.
You can also remove the currently selected condition from the rule by clicking the "Delete"
button.
81
In order to change the operator precedence, you can select a range of conditions from the rule and
use the "Add (...)" and "Remove (...)" buttons on the right to add and remove brackets, respectively.
3.4.6
Description
The Filter Save Page allows you to Save user defined Filters.
Pick the name from the list or enter an new one.
82
3.4.7
Description
This Page allows you to change and delete existing named filters.
3.5
What is affected?
Date/Time values
Currency values (e.g. the decimal separator or the currency symbol)
Numeric values (e.g. the thousands separator if displayed)
83
http://localhost/OTWG/Login.aspx?locale=en-GB
Part
IV
86
Configuration
4.1
Configuration Overview
The Web Gateway can be configured using the following means.
The Configuration File contains basic information needed to connect to the OMNITRACKER
Server, information about email notifications and redirection URLs (if the OMNITRACKER
server is unavailable), and some general web application settings.
The WebConfig Editor tool can be used to edit the configuration file.
The Style Sheet File contains formatting information, such as fonts and colors, that defines
the look of the Web Gateway's pages.
Most configuration settings that apply to the Web Gateway in general (not folder-specific) are
stored in "Web Configurations" in the OMNITRACKER database. These configurations can be
edited in the OMNITRACKER Client, using the Web Gateway Settings Window.
The layout of the Object Page can be defined in a folder-specific way by creating web forms.
These web forms are stored in the OMNITRACKER database as part of the folder definition.
They can be edited in the OMNITRACKER Client, using the Web Form Editor.
Note:
Do not change any *.aspx or *.js files. Doing that might cause the Web Gateway to malfunction;
furthermore, any changes in these files will be overwritten during a version upgrade.
4.2
Configuration File
The Web Gateway's configuration file is named web.config and is located in the Web Gateway's
installation directory (usually C:\inetpub\wwwroot\OTWG). It contains general web application
settings and information that can be adapted by the administrator.
Here are some of the settings that are defined in the configuration file:
Session timeout
Maximum request length (limits the maximum attachment size that can be uploaded)
Connection to the OMNITRACKER server (hostname and port)
Used Web Configuration
Email notification settings (if OMNITRACKER server is not reachable)
Redirection of users if OMNITRACKER server is not reachable
Used Crystal Reports version
All important settings can be easily adapted by using the WebConfig Editor tool.
NOTE:
The Web Gateway will be restarted after saving changes. All existing web-session will be terminated!
Configuration
87
Location
Attribute
Description
web.config
OT_Hostname
<configuration>
<appSettings>
<add>
OT_configuration
OT_emailSender
OT_emailRecipients
OT_smtpServer
OT_redirectionUrl
88
OT_ErrorLogDirectory
OT_showStackTrace
OT_PollingInterval
OT_MissingPingLogoutTimer
Configuration
89
Response.Cache.SetCacheability
(HttpCacheability.NoCache);
Combinations of multiple values are
possible (the values must be added
up).
CrystalImageCleanerAutoStart / Sleep / Age
more information
OT_CheckNotificationsInterval
OT_UserSamlPki
OT_SmartAccess
The following Attributes can be used for virtual Web Gateways separately by appending
"_<NameOfTheVirtualWebGateway>" to the attribute:
OT_Hostname
OT_Port
OT_configuration
OT_redirectionUrl
For example you can use "OT_Hostname_OTWG2" to configure this setting for a virtual Web
Gateway with the name "OTWG2"
90
Location
Attribute
Description
web.config
timeout
cookieless
<configuration>
<sessionState>
4.3
maxRequestLength
WebConfig Editor
In the "Tools" subdirectory of your Web Gateway installation directory, there is a file named
"ConfigEditor.exe". You can use this application to simply change settings in the web.config file.
This Tool furthermore checks your web.config file after the Web Gateway installation has finished
and can add missing entries that are important for the Web Gateway to work correctly.
NOTE:
The Web Gateway will be restarted after saving changes by clicking "Apply". All existing websession will be terminated!
To use this tool on IIS 7 machines, the windows feature "IIS Metabase and IIS 6 configuration
Configuration
91
Window Description
Title
Timeout after
inactivity
Description
Here you can specify how long a Web Gateway user can be inactive, before
the OMNITRACKER session is closed automatically.
Note: There is another timeout setting in the Internet Information Service (IIS).
This option should be set to the same value. Otherwise the smallest timeout
92
setting is used.
Warning: This timeout will not work on the main page, if an auto refresh
interval is defined for the object list. (see Web Gateway Configurtion Window)
Max. request
Length
This is the maximum size in KB, that a user can upload to the web server. If
you want to allow the users to upload attachments that are larger than 4 MB,
than you must enlarge the max possible file size here.
Warning: Only change this setting if necessary to prevent denial of service
attacks caused by users posting large files to the server.
Use Cookies
This feature should be enabled avoid that the session id is displayed in the
url. This increases the security.
Furthermore some Web Gateway features need this option to be checked.
For example the size of the email dialog will be stored in cookies.
Enable Single
Sign-On
This option must be checked if you want to use the OMNITRACKER Single
Sign-On feature.
Load defaults
Crystal Reports
Version
Please specify here which Crystal Reports Runtime Components you have
installed on the web server.
You can click the button "Test" to check if the specified version of the Crystal
Reports Runtime components is installed.
Sender
Recipients
SMTP server
Send test email
Log Directory
Configuration
93
Window description
Title
Name
Description
The name of the virtual Web Gateway that shall be configured.
(All Web Gateways that have an item with the key "OT_Hostname_xxx" in
the "appSettings"-section of the web.config file are listed in the dropdown
list.)
Create new
94
After clicking OK the new Web Gateway will be added to the IIS and to the
web.config file.
Select the option "Only add to web.config" if you don't want the application to
be added to the IIS.
Delete
Hostname
Port number
Defines the number of the TCP port of the OMNITRACKER server process to
which the Web Gateway shall connect. This port number must be identical to
the number as defined in the "Server Port Subpanel" window.
Test connection
Redirection URL
If an URL is specified here, users that try to log in the Web Gateway will be
redirected to this URL if the OMNITRACKER server is not reachable.
If no URL is defined, users will get an error message like: "Cannot connect to
Configuration
95
Layout - Timings
96
Window Description
Title
Description
Polling interval
The client browser can send a small data package to the Web Gateway
Server every N seconds. N is the time interval which is specified here (default
is 60 seconds).
This polling mechanism ONLY becomes active, if the feature "Always close
session" was enabled in the Web Configuration Options dialog.
Browser closed
logout
Missing polling
logout
If no polling data package was received from the client for the specified time,
a logout is performed. This interval should be at least 10 seconds larger than
the specified polling interval. This is the fallback mechanism for browsers
which do not support the "Browser closed logout".
Auto-Notification
interval
The Web Server contacts the OMNITRACKER server to find out if new
Notifications are available at most every N seconds. The time interval N can
be specified here. A small time interval can cause performance problems if
many users are connected to the Web Gateway. The default value is every 15
Minutes.
The OMNITRACKER Server is contacted during postbacks (if the clients
browser page is updated) or by the polling mechanism, but only if the AutoNotification interval has expired since the last check.
The polling mechanism only can be used if "Always close session" was
enabled (see description of "Polling interval").
Restore default
timings
4.4
Restores the default settings which are recommended for most applications.
Configuration
97
System_StyleSheet files
Files which contain default formatting information. Please do not change the contents of these files.
When updating the Web Gateway, these files will be overwritten.
OTWG_StyleSheet.css
This file can be used to overwrite the formatting of the System_StyleSheet files. The file can be
modified by an administrator an is not overwritten when the Web Gateway will be updated. To
overwrite a style, simply copy the according class from the System_StyleSheet file into the
OTWG_StyleSheet file and adapt the property.
It's recommend that only modified properties are stored in the OTWG_StyleSheet.css file, so please
remove all unchanged properties from the class.
PLEASE NOTE that the elements a Web Gateway page consists of, their styleable attributes and
their structure may change in future versions of OMNITRACKER. In particular, future versions might
replace existing or add additional visual elements that your custom stylesheets do not address.
Example
Let's assume you want to change the background color of the shortcut bar into red and the color
gradient shall be removed. Please open the System_StyleSheet.css file with a simple text editor and
search for "shortcutbar".
You will find the following class:
body.shortcutbar
{
back ground-color: #009EE0;
back ground-image:url(images/bg_shortcutbar.gif);
back ground-position:bottom;
back ground-repeat:repeat-x;
color: White;
}
Now please copy the complete class and paste it into the file OTWG_StyleSheet.css file. Remove
all properties that do not want to change.
body.shortcutbar
{
back ground-color: #009EE0;
98
Now you can adapt the color. Replace the value #009EE0 with the new color (e.g. Red or #FF0000
for a red color). To remove the background-image change the value to "none".
body.shortcutbar
{
back ground-color: Red;
back ground-image: none;
}
Now save the OTWG_StyleSheet.css file and login the Web Gateway. The changes should take
effect immediately. If not please press the F5 key for a refresh of the page.
4.5
Web Configurations
4.5.1
Configuration
99
Layout
Window Description
Title
Description
Configurations
Add
Configuration...
Edit
Configuration...
Delete
Configuration
Export
Import
Import Config
Files...
Description
Required
100
4.5.2
Window Description
Title
Name
Description
Guest Logins
Description
Required
YES
Configuration
101
Window.
Add Guest
Login...
Opens the Guest Login Properties Window to add a new guest login.
Edit Guest
Login...
Opens the Guest Login Properties Window to edit the selected guest
login.
Delete Guest
Login
Options
Edit Value...
General Options
These options apply to the Web Gateway in general and are not specific to the main view or object
forms. Some of these options also apply when no user is currently logged into the Web Gateway,
therefore their values cannot depend on the current user. This is indicated by the word "NO" in the
column "Multiple Values", meaning that this option can only be set to one fixed value. "YES" means
that multiple values are allowed for this option.
Option Name
Description
Multiple
Values
Allow deletion of
objects
YES
Always Close
Session
YES
102
Note:
This option also affects the update mechanism of
Notifications.
Drop-Down filter range Allows to filter the list of drop-down items if the number of
items is within the specified range. By default the range is
15-1500.
Click here for more information.
Error Message if no
Write-Enabled
License is available
If a user with a read-only license will change to a writelicense it can be, that for the moment no write-license is
available. In this case an error message can be shown that
is defined here
Limit date/time/
number formats
YES
This option can be used to limit the number tabs which are
used to switch between the main list and all open objects.
Value
Behaviour
There is no limit.
Configuration
103
NO
YES
Show bookmarking
link on login page
(normal users)
NO
Show bookmarking
link on login page
(guests)
NO
Show username in
object is locked
message
NO
Note: This option can only be set to one fixed value with
an <always> rule.
Show User Portraits
YES
NO
NO
104
Label
Specific stylesheet
NO
NO
YES
NO
NO
YES
Description
Multiple Values
Configuration
Disable Appearance
Settings
YES
YES
YES
YES
YES
YES
105
106
Hide Filter
YES
YES
YES
YES
Hide Notifications
YES
YES
YES
YES
Hide Views
YES
Show Task
YES
YES
YES
YES
YES
Show Tasks
YES
Configuration
107
is displayed.
You may want to remove this flag for
performance reasons. (see "Hints for
Performance Optimization" in the
administration online help for details.
Example how it is displayed in the object list:
Objects 1 - 45 of 52 out of 104 (50.00%)
The current filter or search returned 52 objects.
The total number of objects is 104.
Description
Multiple Values
YES
YES
YES
YES
YES
Display Terminology
YES
Displayed References
YES
YES
OK
Save
Cancel
108
YES
YES
YES
Popup Forms
YES
YES
YES
YES
Configuration
on controls.
Show Tooltip on Label
YES
Image URLs
These options specify URLs of images used for icons and buttons.
Option Name
Description
Multiple Values
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
109
110
Button (Disabled)
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
Configuration
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
111
Description
Multiple Values
NO
Client Certificate for Remote Specifies which client certificate shall be used
Authentication
for authenticating the OMNITRACKER server.
NO
NO
112
by OMNITRACKER..
Basic Authentication Options
These options define the settings if basic authentication is used
Option Name
4.5.3
Description
Multiple Values
NO
NO
NO
Security Level
NO
Configuration
113
Layout
Window Description
Title
Description
Required
ID
Unique numeric ID to identify this guest login setting. This number must
be used in the Web Gateways Login URL to access the
OMNITRACKER through this guest login.
YES
Name
YES
Root
Folder
Restricts access through this guest login to the specified folder and its
subfolders. Pressing "..." opens a window to select a root folder.
Pressing "x" removes the root folder setting, meaning that all folders can
114
User
The OMNITRACKER user associated with this guest login. This user will
be the current user in all sessions established through this guest login,
meaning that this user's privileges and permissions define what
information can be accessed and/or modified through this guest login.
Login
Mode
YES
Anonymous (any user will be able to use this guest login and
assume the associated user's privileges without having to enter any
login name or password.)
Password (the users have to enter name and password into the
login dialog)
Windows Login (the authentication is handled automatically using
the Windows user name as login name and the domain name as
password. The login page will not be displayed to the user. In this
case, the login field and password field in the login folder (see
below) must contain the Windows user names and domain names
of all users that will use this guest login.)
LDAP Profile (the users have to enter their LDAP user name and
password into the login dialog. The login field in the login folder must
contain the LDAP user name of all users that will use this guest
login.
The user name must be unique for all objects in the login
folder!)
Windows Login:
If you want to use this option, make sure that the following options are
set correctly:
The option "Automatic login using current user name and password"
(open "Tools | Internet options | Security", select the respective
zone and click "Adjust settings") is set in the Internet Explorer.
The client computers from which users try to log on is in the same
domain as the OMNITRACKER server
The IIS does not allow anonymous logins. Deactivate this in the IIS
Manager (inetmgr.exe), in the properties dialog of your Web
Gateway directory, open the tab "Directory security" and deactivate
the option "Anonymous login", activate "Integrated Windows
authentication" instead.
Login
Folder
Login Limit This field is optional and specifies how many concurrent sessions a
Field
guest may use.
Configuration
Leave this setting empty if you don't want to limit the sessions. Press
the "..." button to select a field that contains a limit for this guest. Only
fields of the types byte, integer and long are supported.
When the fields value is 0, the guest never can login the Web
Gateway
When the fields value is greater than 0, the guest can login as many
times the value is.
When the fields value is empty, the guest may always login.
When a guest wants to login and the login limit is reached, the user is
redirected to a page that tells him that the maximum number of
sessions has been reached. The url of this page can be modified in the
Web Gateway Configuration Window under "General Options".
Login Field The field in the login folder (or a referenced folder) containing the login
names for the guest login. The login field must be specified if "Login
required" is checked. Pressing "..." opens a window to select a login
field.
Login
Label
Optional label for the login edit box on the login page. If no label is
specified, the login box is labeled "Login" (or the equivalent in the
current language).
Password
Field
Optional field in the login folder (or a referenced folder) containing the
passwords for the guest login. If no password field is specified, users will
be able to log in using only the login name and no password. Pressing
"..." opens a window to select a password field. Pressing "x" removes
the password field setting.
Password
Label
Optional label for the password edit box on the login page. If no label is
specified, the password box is labeled "Password" (or the equivalent in
the current language).
Recursive
Show
Name of
Guest in
History
and in
Memo
Sections
If this box is checked, the name of the guest login object (naming
scheme of login folder) will be displayed in the history and the header of
memo section entries.
If this box is not checked, the name of the OMNITRACKER user which
is associated to this guest login will be displayed.
Important Notes:
After changing this setting, the existing history and memo sections
will not altered. Additionally id a guest login object is deleted, existing
history/memo entries will not be adapted.
To create the name of the guest login object, the naming scheme of
the login folder will be used. Therefore it should be checked, that the
naming scheme of the login folder does not contain the same fields
which are used as guest login and/or guest password (if so, this
information will be displayed in the history entries).
Create
If this box is checked, the object page for creating a new object will be
115
116
new object
in folder...
displayed to the user right after logging in. The folder in which the object
will be created must be selected below. If a root folder is defined, you
can only select folders below the root folder as the folder for object
creation.
Note: If an anonymous login is used, then the login is treated as a
singleton login. This means the user only has the possibility to create
one new object in the specified folder, afterwards a logout is performed.
In versions before 8.1, this folder was the last selected folder for the
OMNITRACKER user defined for this guest login. During migration, the
last selected folder of the user is copied to the web guest login
definition.
If this box is not checked, the main page will be displayed after logging
in.
Restriction Set the radio button to "Use folder base filter" if you want the active web
of active
guests to be restricted by the base filter which is active for the user
guest
selected above.
users
This might be unwanted, so you have the possibility to define a separate
filter to determine the active guests. In this case, select "Ignore base
filter and use this rule".
Important Note:
We recommend you strongly to use a separate filter for the active
guests. In future versions, the flag "use folder base filter", will be
removed, so you should set the flag to "Ignore base filter and use this
rule" as soon as possible.
Edit rule...
Click this button to define a rule by which the objects in the "Login
folder" are filtered. The default filter is an empty filter. The text
representation of the filter is displayed below the button.
Apply web
guest
base filters
also in
server side
actions
Base
Filters
List of base filters, which restrict the objects that the user can access
through the guest login. These base filters are applied in addition to the
base filters in the folder definition. The following columns are shown:
Folder: Name of the folder to which the base filter applies. If the
folder contains subfolders, the base filter also applies to them.
Rule: The rule which is used to restrict the objects in the given
folder. You can use any property of the web guest login object and
Configuration
any property of the filtered objects for your rule. Note: If you change
the login folder, all base filters will be deleted.
Field mapping: The field mapping used to create a new object in the
given folder. The web guest login object will be used as the source
object for this field mapping. If there is another mapping for the
creation of new objects (for example, if the guest creates a new
object from the shortcut bar), the field mapping on the base filter is
applied afterwards, overwriting existing field entries.
If Anonymous login mode is selected, it's not possible to define base
filters, because the rule editor offers some special comparisons which
require an authenticated person (guest object). Rules for anonymous
guests must be defined in the folder definitions base filters. To make a
base filter valid for a specific guest login, it must be combined with the
Ot-User account which is used in the guest login definition.
Notes: If you migrate from a version before 8.1, existing web base filters
will be transformed to the new form. If these base filters used a reference
field for matching, this reference field was filled with the web guest login
in earlier versions. In this case, a field mapping will be generated and
used for the new base filter.
Unfortunately, earlier versions allowed the user to define inconsistent
web base filters:
It was possible to define multiple base filters for one folder. The
order in which they were evaluated was undefined. Therefore, if such
a case is detected during migration, all the base filters are
combined (with "AND") and there is a message in the server control
panel. You have to resolve this ambiguity later.
It was possible to define a base filter which compares uncomparable
fields, for example "Reporting Person (which is a reference) = Last
Name (which is a text field)". These filters always returned 0
matches, therefore such base filters are converted to a rule "Unique
ID = 0". There is also a message in the server control panel which
informs you that you have to resolve this manually.
If the base filter tries to match a reference field of the filtered folder
with the web guest login object, a new object cannot be filled with
the web guest login object if the folders don't fit. In this case, no
field mapping is created.
Add Base
Filter...
Opens the Guest Login Base Filter Window to add a new base filter.
Edit Base
Filter...
Opens the Guest Login Base Filter Window to edit the selected base
filter.
Delete
Deletes the selected base filter(s).
Base Filter
117
118
4.5.4
Window Description
Title
Description
Required
Display an object in
the folder ...
The folder to which this base filter applies. If the folder contains
subfolders, the base filter also applies to them. Pressing "..."
opens a window to select a folder.
YES
YES
Edit rule...
Edit...
Configuration
4.5.5
119
For options that do not allow multiple values, the window is somewhat simplified:
120
Window Description
Title
Option
Description
Values
Description
Required
Edit Rule...
Delete Value
Configuration
121
New Value
Add Value
Adds a new entry to the list of values, with the rule <always> and
the value specified in "New Value".
This button is only available for configuration options that allow
multiple values.
Change Value
Set Value
Reset Value
4.5.6
122
Layout
Window Description
Title
Web.config
Description
Required
OTWebGW.co
nfig
Name
Description
Modify
Web.config ...
YES
Configuration
123
4.5.7
124
Layout
Window Description
Title
The following
items ...
Description
Required
Configuration
Guest Logins: Contains the guest login settings defined in
the <guestlogins> section of the OTWebGW.config file. They
will be imported into the web configuration that you specified
on the Settings Page.
If you are importing into an existing web configuration, any
existing guest login settings will be replaced only if they
have the same ID value.
Hidden fields: Represents the information from the
<hiddenfields> section of the OTWebGW.config file. This
information is split into two different types of importable
items:
Options: The elements <hiddenfilter>, <hiddenfoldertree>
and <hiddenfulltextsearch> from the OTWebGW.config file
will be imported as the corresponding configuration options
("Hide Filter", "Hide Folder Tree" and "Hide Full-Text
Search") into the web configuration that you specified on
the Settings Page.
If you are importing into an existing web
configuration, the three options mentioned above will
remain unchanged if you uncheck this item.
Visible Permissions: The <hiddenfield> elements from
the OTWebGW.config file will be imported as "visible"
permissions into the corresponding folders (see the
Permissions Subpanel in the folder definition).
Permissions are not part of the web configuration,
but the permission rules will contain a condition
referring to the configuration that you specified on
the Settings Page. This ensures that the
permissions remain unchanged for users using the
Windows client or any other web configuration.
Forms: Represents the information from the <fields> section
of the OTWebGW.config file. Each <folder> element of that
section will be imported as a web form into the
corresponding folder (see the Forms Subpanel in the folder
definition).
Web forms are not part of the web configuration, but they
will be associated with form conditions referring to the
configuration that you specified on the Settings Page. This
ensures that the newly imported web forms will not
interfere with any other web configurations.
Since web forms need to have unique names, the wizard
automatically generates names like
"ImportedWebFormNNN" (where NNN is a number). You
can change these names using the "Form Name" box and
the "Change Name" button (see below). Existing web
forms are never overwritten. If you enter a name that
already exists, you will get an error when you press the
"Finish" button, and you will get a chance to enter a
different name and try again.
Error Details...
125
126
Allows you to enter a new name for the selected web form. This
field is only enabled if a web form is selected in the list.
Change Name
Changes the name of the selected web form to the name you
entered in the "Form Name" box. This button is only enabled if a
web form is selected in the list.
Back
Finish
4.6
Web Forms
4.6.1
4.6.1.1
Configuration
127
Layout
Window Description
Title
Description
Current Language
Allows you to select the language in which the form is currently displayed
and edited. The available choices depend on which languages are defined
in the form. Press the "Select Languages..." button to add or remove
languages.
Translations
Allows you to select the theme which defines the design of the form.
Add Theme...
Edit Theme...
If this box is not checked, all text in the form (including labels, text
elements etc.) will be displayed just like you enter it, no matter what
characters it contains. Any HTML tags you enter will also be displayed
literally and not have the intended effect.
If this box is checked, any HTML tags you enter will have the intended
effect. Please make sure to check the box before entering any HTML
tags. This allows you to specify special formatting in your texts. However,
you will have to take special care not to use the characters "<" and ">"
outside of HTML tags, and not to use the "&" character by itself. You
have to replace these characters by the following codes:
128
Character
Replaceme
nt
<
<
>
>
&
&
Fullscreen mode
If this box is checked, the form title will not be displayed in the Web
Gateway object form if "Popup Forms" is enabled.
(The title always is displayed on the corresponding panes tab button)
If checked, the Form will be opened in "fullscreen mode" (comparable with
a modal dialog). This means that other elements like the shortcut bar or
the pane tabs are hidden. The user cannot switch to another page (except
child forms if a referenced object is opened) until the object is closed.
If multiple objects are displayed in the breadcrumb bar, and if at least one
of the displayed objects uses the "fullscreen mode", then all objects are
shown in "fullscreen mode".
If a comboscript is invoked on a form which uses "fullscreen mode" and if
the script causes a redirect to another page, then the current object is
cancelled and closed. (The following PerformAction methods are causing
redirects: change_to_folder, open_object and open_new_object)
If checked, the "enabled if" flag from the field definition is respected in
web forms. Then it will not be possible to define "Enabled if" rules on the
tab "Display". Whether controls are enabled or not depends on the
"Enabled if" rule or script which was defined on the field definition page.
Add/Modify "OnOpen"
script
Add/Modify "OnSave"
script
Add/Modify
Configuration
"OnSearch" script
129
Click this button to switch from "Edit form mode" (this is the default) to
"Edit visibility mode" (see below for details) and back.
Clear Form
Deletes the contents of the form in all languages. You will be asked to
confirm this step.
(Header) ...
This part of the Web Form Editor represents the web form itself. The form
always has a header (shown as "(Header)"). Optionally, it may contain
one or more tabs. The Web Gateway will display the form header near the
top of the page, and any tabs will be displayed below the header (see the
Object Page for an example).
The contents of the header or the currently selected tab are shown in a
hierarchical grid. The tabs contain sections, which may in turn contain
fields, text elements, task buttons, command buttons, attachments and
history. The header may contain the same types of items. The different
types of items are represented by the following icons:
Ico
n
Meaning
Tab
Section
Text element
Button
Boolean Field
Currency Field
Date/Time Field
Dropdown List Field (when displayed
as dropdown list)
Reference to object Field (when
displayed as dropdown list)
Reference to user Field (when
displayed as dropdown list)
Workflow Field (when displayed as
dropdown list)
Dropdown List Field (when displayed
as radio buttons)
Reference to user Field (when
displayed as dropdown list)
Workflow Field (when displayed as
dropdown list)
130
Memo Field
Reference to user Field
Timestamped Memo Field
Other Field
History
When an item is selected, its properties are shown in the properties box
near the bottom of the window.
Double-clicking a tab, section, field or task button opens the Edit
Multilingual Text Window to edit the item's label.
(Footer) ...
Available Items
This part of the Web Form Editor is placed below the header. It can
contain the same types of items as the header, but no tabs.
Shows all items that you can insert into the form. You can insert an item
by double-clicking it, or by selecting it and then clicking "Add". The
following items are available:
New Tab: Creates a new tab.
New Section: Inserts a new section at the end of the current tab.
This item is not available in the form header and also not in search
forms.
New Text: Inserts a new text element after the currently selected
item.
New Task Button: Inserts a new task button after the currently
selected item. This item is only available in object forms.
New Object Create Button: Inserts a new object create button after
the currently selected item. This item is only available in object
forms.
New Object Fill Button: Inserts a new object fill button after the
currently selected item. This item is only available in object forms.
OK/Apply/Cancel Buttons: Inserts the command buttons to save or
cancel the modifications. These buttons can be used instead of the
Toolbar in the Web Gateway. This item is only available in object
forms.
Send Email Button: Inserts a send email button after the currently
selected item. This item is only available in object forms.
History: Inserts an item representing the object's history after the
currently selected item. This item is not available if it was already
added to the form. This item is only available in object forms.
For object forms, fields can be placed multiple times on the form. If a
field is added to the form, the number of occurrences on the form is
displayed behind the field name (number in brackets).
Note:
Only the local fields from the current folder can be placed multiple
times on web forms. Referenced fields, and quick search fields for
reference lists can only be added once to the form.
There are different icons for different field types:
Configuration
Ico
n
131
Meaning
Attachments Field
Currency Field
Date/Time Field
Dropdown List Field
Workflow Field
Memo Field
Reference to user Field
Timestamped Memo Field
Other Field
132
Configuration
133
Remove
Adds the selected item from the "Available Items" list to the form. Local
fields from the current folder can be added multiple times. The number of
occurrences of a field on the form is displayed behind the field name in
the "Available Items" list.
Removes the selected item from the form.
Toggle Width
Toggles the selected item's width between single column width and whole
page width. Only fields and task buttons can have single column width, all
other items always cover the whole page width.
Arrow buttons
These buttons move the selected item in the direction of the arrow.
The left and right arrow buttons can only be used for tabs and for fields or
buttons with single column width. To move a tab left or right (changing the
order of the tabs), click on the tab and select the line with the tab icon
, then click the left or right arrow button.
... Properties
This box is used to display and edit the properties of the currently
selected item in the form. Depending on the type of the selected item, the
following subpanels are displayed:
Ic Item Type
on
Subpanel(s)
Tab
Tab Properties
Section
Section Properties
Field
134
Text
Button
History
Recursive full-text
search
Recursive Filter
AND Combination
Combine Filter
and Search
Recursive search
For field items, not all the subpanels listed above are shown. Which of
them are shown depends on the field type.
Button Configuration...
Preview...
Opens the Web Form Preview Window to show how the form will be
displayed by the Web Gateway (only available for object forms)
Manage Themes...
Keyboard Navigation
The Web Form Editor can also be controlled using the keyboard. In addition to the standard keys for
window navigation, the following keys are supported. Some of them have different meanings
depending on the current focus location within the window.
Key
Focus Location
Ctrl + Tab
Ctrl + Shift +
Tab
Description
Switches between the header and each tab of
the form
Configuration
Ctrl + Tab
Ctrl + Shift +
Tab
135
Arrow keys
Form contents
Ctrl + arrow
keys
Form contents
Return
Form contents
Return
"Available Items"
Esc
Del
Form contents
136
If you select multiple items in the tree view, the visibility section below automatically displays only
the rules that can actually be applied to all selected items. If all selected items use the same rule,
the common rule is displayed in the text field. Otherwise, "<multiple rules>" is displayed.
By clicking "Edit rule...", you can edit the enabling or visibility rule for all selected items.
4.6.1.2
Configuration
137
Window Description
Title
Label
Tooltip
Description
Required
The tab's label in the current language. Pressing "..." opens the
Translation Dialog to edit the different language versions of the
tab's label.
The tab's tooltip in the current language.
Break row
Check this box to have the following tabs displayed in the next
after this tab row.
Display this
tab if the
following
rule applies
This text box contains the rule which must evaluate to true for the
current object in order for this tab to be visible.
Enable this
tab if the
following
rule applies
This text box contains the rule which must evaluate to true for the
current object in order for this tab to be enabled.
Edit rule...
Section
4.6.1.3
138
Layout
Window Description
Title
Description
Required
Label
The section's label (i.e. the text for the section header) in the current
language. Pressing "..." opens the Edit Multilingual Text Window to edit
the different language versions of the section's label.
Left
column
width
By default the left and the right column have the same size. The size of
the left column can be overwritten here. Absolute (pixel) and relative
(percentage) statements are possible.
Example:
If the value "80%" is entered here, the right column will only use 20% of
the whole object form width.
This text box contains the rule which must evaluate to true for the current
object in order for this section to be visible.
By default, this rule is empty, which is equivalent to "<always>", i.e. the
section is always visible.
Enabled if
This text box contains the rule which must evaluate to true for the current
object in order for this section to be enabled.
By default, this rule is empty, which is equivalent to "<always>", i.e. the
Configuration
139
Click these buttons to edit the respective rule. Depending on the form
type and on the rule type, different properties are available:
Search Forms
o Expanded by Default / Visible / Enabled rules:
Current user (or proxy)
Web Configuration
Object Forms
o Expanded by Default rules:
Current user (or proxy)
Web Configuration
All condition types except Context and <Local Object>
o Visible / Enabled rules:
Current user (or proxy)
Web configuration
Unique ID of the current object
User fields of the current object of the type Boolean, DropDown,
Workflow, Reference to user or Reference to object. Referenced
fields are also allowed.
For object forms the rules can contain old and new field values. Old means the field values
stored in the database; New means the field values that the user has entered in the form. There is
one exception: When the rule is evaluated when loading the form initially or when reloading the form
after a Save operation, the New and Old field values are identical and both refer to the values
from the database.
For example, suppose that
the object is in state New
the Visible if rule for the section is State (new) <> New
the Expanded by default rule is State (new) = In Progress
the "Expandable" checkbox is selected and
the checkbox left of the "Expanded by default" rule is selected:
Then the section is invisible when the object is opened; when the user changes the state to In
Progress, the section becomes visible and it is expanded because the new state is In Progress
and therefore State (new) = In Progress evaluates to true. (If the rule were State (old) = In
Progress, the section would be collapsed after it became visible.)
140
4.6.1.4
Window Description
Title
Label
Tooltip
Description
Required
The field's label in the current language. Pressing "..." opens the Edit
Multilingual Text Window to edit the different language versions of the
field's label.
The field's tooltip in the current language. Pressing "..." opens the Edit
Multilingual Text Window to edit the different language versions of the
field's tooltip.
Note: Multiline text can be entered here. In this case the label is
displayed as a link in the Web Gateway. By clicking on the label, the
tooltip text is displayed in a message box.
In addition, a link to an external web site can be opened by clicking the
label in the Web Gateway. In this case the prefix "link:" followed by the
url can be entered as tooltip.
Example:
The tooltip text "link:http://myserver/help/default.aspx" opens the site
"http://myserver/help/default.aspx" in a new browser tab/window, if the
web form label is clicked.
A combination of both (show text and open link) is not possible! Either a
text can be displayed, or a link can be opened.
Label
position
Add/Modify
"OnChange
" script
Read-only
Specifies the position of the field's label. Possible values are "Left",
"Top" or "Hidden".
Allows to add or modify a script which is executed if the field was
modified by the user.
Before using "OnChange" scripts, please read the scripting hints.
If checked, this field will be displayed as read-only, i.e. the user will not
Configuration
141
This checkbox appears only for text fields. If set, the field will appear as
a password field. The box is checked by default for encrypted text fields.
Important note: Although the field's value is not directly visible to the
user, the field's content is transferred in plain text to the client.
Therefore, the user can see the field's content in the page source code.
You should only use this option for fields where users might enter
hidden information, never for fields which should not be seen by the
user.
Enable
Quick
Search
Button
Show
'Move'
Button
If set, the users can perform Quick Searches for this field in the Web
Gateway. In the dropdown list on the right of this button, the
administrator must select on which field of the referenced objects the
search will be performed. Only text- and dropdown fields are listed.
If set, a button will appear on the web form allowing you to move an
attachment from one attachments field to another attachments field
inside the same object.
The row is only enabled if there are at least two attachments fields on
the current web form.
In the dropdown list, you can define the target field for the "move"
operation. The dropdown list contains all attachments fields except for
the current one which are present on the web form. In addition to this, a
"(select field)" option is offered. In this case, a dialog is displayed to the
user asking him to select a target field.
If the current user doesn't see the target field (due to permissions, for
example), the move button is disabled. If the target field is "(select field)"
and the user doesn't see any possible target field, the move button is
also disabled.
4.6.1.5
142
Layout
Window Description
Title
Description
Columns to be
displayed...
Add Column...
Delete Column
Up/Down
arrows
Required
Height in pixels Sets the height of the reference list. The default is 200 pixels.
List layout
context
Force list
layout
Configuration
4.6.1.6
143
Window Description
Title
Sort items:
4.6.1.7
Description
Required
Layout
144
Window Description
Title
Options for the button
array / Position
Display
Description
This option sets the position for the button array. Available options
are
Option
Meaning
Default
Left
Right
Top
Bottom
This option sets the display style for the button array. Available
options are
Option
Meaning
Default
Icon only
Configuration
Text only
4.6.1.8
145
Window Description
Title
Description
Display field as
146
It allows you to select how this field will be displayed by the Web
Gateway.
Hide buttons
These checkboxes allow you to hide certain buttons that the Web
Gateway usually displays for reference fields. By default, all buttons
described in the Object Page for modifying reference fields are
shown.
The checkboxes have the following meanings:
Default if empty
Checkbox
Meaning
All
Remove reference
The default button for fields of the type "Reference to object" can be
defined here.
All visible buttons (show, add, add new, remove and delete) are
combined to a single "Split button". This means only the default
action can be performed with a single mouse click. For all other
actions the sub menu of the button must be opened, then the action
can be clicked.
The default action for non-empty fields always is the "Show
referenced object" button (if this button is not hidden).
The default action for empty fields however can be defined here.
Either "Add reference to existing object" or "Add reference to new
object" can be selected.
Configuration
Source Object
147
If one of the following options is set, then the new object is created
from a source object using the field mapping when clicking the "Add
reference to new object" button.
Option
Meaning
Current object
Select object
Selected object
Selects the field mapping which is used to map the fields between
the source object and the destination object when clicking the "Add
reference to new object" button. For more details on field mappings,
see the OMNITRACKER Administrator Help.
Note:
If a Source Object is selected and if no Field Mapping is used (if "No
Mapping" is selected), then a default mapping is performed. This
means that fields with identical alias/label are mapped
automatically. If the fields are not of the same type, the value is
converted if applicable.
148
Field mapping
Selects the field mapping which is used to map the fields between
the source object and the local object when clicking the "Add
reference to new object" button or the "Add reference to existing
object" button. As source object always the selected referenced
object is used. Make sure that the field mapping uses source
objects from the referenced folder. For more details on field
mappings, see the OMNITRACKER Administrator Help.
Display
This option sets the position for the button array. Available options
are
Option
Meaning
Default
Left
Right
Top
Bottom
This option sets the display style for the button array. Available
options are
Option
Meaning
Default
Icon only
Text only
Configuration
4.6.1.9
149
Window Description
Title
Description
Control Height
Required
Note: If you check this box and the item is smaller than
the given size, it will use up this space anyway. The
height is measured in pixels
Override item height
150
Window Description
Title
Description
Display values as
radio buttons
If this option is selected, the Web Gateway will display this field as a group of
radio buttons, with one button for each possible value. Otherwise, the field will
be displayed as a drop-down list.
You can define aliases only if this box is checked.
Display field as
Configuration
151
Drop-down list
Display field as
text box with
Quick Search on
Display Name
Display field as
text box with
Quick Search on
Display, Login and
Last Name
The field is displayed as a text box that supports Quick Search. The search
will be performed on the field "Display Name" only.
The field is displayed as a text box that supports Quick Search. The search
will be performed on the fields "Display Name", "Login Name" and "Last
Name"
Alias list
Contains alias definitions for the possible values of this field. To define or
change an alias, select an entry in this list, enter a new alias in the "Alias
text" box and press "Change Alias".
Alias text
Contains the alias for the selected value in the "Alias list". You can edit the
alias in this box and then press "Change Alias" to update it in the "Alias list".
Change Alias
Sets the alias for the selected value in the "Alias list" to the value specified in
the "Alias text" box.
Delete Alias
Deletes the alias definitions for the selected values in the "Alias list".
Note:
It's not possible to edit the fields value in any way. The fields value can only be displayed readonly
by using an arbitrary design.
Layout
152
Window Description
Title
Wrap field values
inside HTML
Description
Allows you to define a custom HTML code which is displayed on object
forms. The fields value can be integrated into the HTML code by using the
placeholder "$(VALUE)".
In addition placeholders for the fields label and it's tooltip are available
( $(LABEL), $(TOOLTIP) )
Suppress HTML
code...
Variable...
Important Note: If items are hidden with this functionality, their data is still contained in the HTML
page which is transferred to the client browser. Therefore, this feature is not suitable for hiding
sensitive data from underprivileged users, as the user can read the data from the page source. The
intent for this feature is convenience, not security. Use permissions to hide data from underprivileged
users.
Layout
Window Description
Title
Display this item if
the following rule
Description
This text box contains the rule which must evaluate to true for the current
object in order for this item to be displayed.
Configuration
153
applies
Enable this item if
the following rule
applies
This text box contains the rule which must evaluate to true for the current
object in order for this item to be enabled.
This is only available for field and quicksearch items, as there is no
difference between an enabled and a disabled text item.
If a field is not enabled, it is read-only; i.e. you can see the field value, you
can copy text, you can scroll multiline text, and you can open referenced
objects from read-only reference (list) fields.
The only thing you cannot do when the field is not enabled is to change the
field's value.
Edit rule...
Layout
Window Description
Title
Current Web
Theme
Add...
Description
Allows you to select a theme for a field or a text item. If a theme is assigned
to the whole form, the design of a single item can be overwritten here.
Allows you to add a new theme.
154
Edit...
Window Description
Title
Description
Required
Label
Window Description
Title
Description
Required
Configuration
Label
Tooltip
155
Reference Field The new created object will be attached to the field selected
here. Fields of the type "reference to object" and "list of
references" can be selected here.
Folder
YES
YES
The object will then be created in the selected subfolder, not the
folder specified in the "Folder" field.
Field mapping
Source object
If you chose a field mapping other than "(No mapping)", you must
also supply a source object setting:
Value
Meaning
(No object)
Current object
Select object
YES
156
Window Description
Title
Description
Required
Label
Tooltip
Field mapping
YES
YES
Configuration
157
Window Description
Title
Label
Tooltip
Task
Description
Required
YES
If this box is checked, then the object will be closed after the
button was clicked and the task executed.
158
Layout
Window Description
Title
Visible buttons
Labels
Alignment
Description
Only the checked buttons will be displayed on the web form.
Specifies the text that shall be displayed on the buttons.
Specifies the alignment of the command buttons.
Possible choices are:
Right
Left
Center
Translate labels...
Opens the Translation dialog to allow the translation of the buttons labels.
Note:
You must place at least one OK- and Cancel-Button if you have selected the Option "Hide Toolbar in
Objectform" in the Web Gateway Configuration Window
Layout
Configuration
159
Window Description
Title
Label
Output type
Description
The element's label. See here.
This control's visibility and content depends on
the type of the given task. For Action Lists, this
control is hidden. For Report Tasks and Export
Tasks, you can select from the appropriate
output types. You can also select "Ask user", in
this case, a dialog pops up asking the user for
the output format.
Layout
160
Window Description
Title
Description
Label
Hidden
Checked by default
Layout
Configuration
161
Window Description
Title
Description
Label
Tooltip
Message Template
Layout
162
Window Description
Title
Label
Display mode
Description
The element's label. See here.
Here you can select whether to display the reference field as a text field
with buttons or as a dropdown list.
The dropdown mode is only available if the reference field is located
directly in the current folder.
Selection Tree
This dropdown list enabled if the display mode "Text field with buttons" is
selected.
Instead of the default "Select Object" dialog, a selection tree can be
displayed, if the select object button of the search form item is pressed
in the Web Gateway.
More information about selection trees can be found in the Admin Guide.
Display field
Display as
If you select the dropdown list mode, you can select either the object's
name or a text or drop down field of the target folder to be displayed for
each referenced object.
Check this box "Use restriction filter" to have the drop down list's
content restricted by the field's restriction filter. The restriction filter is
updated dynamically depending on other fields of the current search
form. See example below.
Here you can select whether to display the boolean field as a combo box
or a checkbox
Example
Let's assume we are in the folder Incidents of an ITIL template. There is a reference to the folder
"Master Data\Persons" named "Reporting Person" and a reference to the folder "Master
Data\Companies" named "Reporting company". The restriction on the field "Reporting Person" is
defined as "Company = Local object.Reporting company" so that you can only select a person as
the "Reporting person" if it belongs to the "Reporting company".
Now put two items on the form, one for "Reporting Company" and one for "Reporting Person" and
check the "Use restriction filter" box for the "Reporting Person".
You can see that at the beginning, all persons in the folder are contained in the drop down list. Now
select a company. After this action, the drop down list only contains the persons who belong to the
selected company.
Configuration
4.6.2
163
Window Description
Title
Description
Required
164
Translations
Configuration
165
166
4.6.3
Window Description
Title
Description
Required
Configuration
Language
Automatic Login
Password
Start
YES
167
168
Close
4.7
Web Themes
4.7.1
Configuration
169
Several Web Themes can be configured and a theme contains several sets of style definitions.
These style definitions can be applied to web forms in general or to separate items on the web form.
To organize different web themes see chapter Managing Web Themes.
That means the default style definitions, which are defined in several style sheet class files, can be
overwritten by a global Web Theme (i.e. a Form Theme) and these style definitions itself also can be
overwritten by one or several Form Item Themes.
Furthermore it is possible to configure one or several Form Item Themes to specify the design of
several items on an object form without the configuration of a global Form Theme. That means the
configurations in the Form Item Themes will overwrite the default definitions in the style sheet
classes.
170
4.7.2
Configuration
171
Layout
Window Description
Title
Type
Add Theme...
Edit Theme
Delete Theme
Rename
Theme
Description
Specifies the theme type which is displayed in the list below.
Allows you to add a new theme.
Opens the Web Theme Editor to edit the current selected theme.
Deletes the selected theme(s).
Allows you to rename the current selected theme.
Export
Import
Required
172
4.7.3
Depending on the theme type you are currently editing, different items can be selected in the tree
control on the left side. The tree contains all elements which can obtain a custom style. If an
element is selected, a current description about is displayed in the box below the tree control.
Depending on the current selected element, the font, the color, the border and/or the background
can be configured.
Configuration
173
Layout
Window Description
Title
Description
Font color
Specifies the color of the font. "Default" means that the color is
not changed by this theme.
Font family
Font size
Font weight
Required
174
Font style
Font
decoration
Border color
Specifies the color of the border. "Default" means that the color
is not changed by this theme.
Border width
Border style
Background
Color
Image URL
Examples:
Not allowed: "C:\images\background.gif"
Allowed: "http://mainserver/images/background_blue.jpg"
Allowed: "../own_images/bg.gif"
Instead of using background images you can click the button
"default" to use the default setting or click the button twice if you
don't want to use an image.
Image position
Image repeat
Custom CSS
text
Configuration
Preview...
175
Opens the Web Form Preview window to show how the form will
be displayed by the Web Gateway.
NOTE: Before changes will take effect in the preview window,
they must be applied in the Web Theme Editor.
If you log in the Web Gateway directly, changes in web themes
will first take effect after a re-login .
4.8
4.8.1
176
Configuration
177
Layout
Window Description
Title
Show the object list...
XML style sheet
Description
Enables the custom layout. Otherwise the
default list layout is used.
Specifies the style sheet which is used to
transform the XML representation of the objects
to HTML.
Regarding the use of JavaScript, please see the
IMPORTANT NOTE in chapter JavaScript
178
Functions.
Load from file...
Save to file...
Page Size
NOTE:
If this layout is used for reference lists on object
forms, this setting has no effect. Please set the
max. number of displayed objects in the Web
Form Editor window (tab "columns" of the
reference list item).
4.8.2
Configuration
179
It must be possible to open the objects by clicking a link and it must be possible to select several
objects to execute reports.
Furthermore sorting shall only be possible on the fields "Title" and "Description".
Which object data shall be displayed and how to prevent sorting for separate columns?
Only the values of the fields which are included in the column layout can be displayed in the Web
Gateway. Therefore the three fields we want to be displayed must be added to the column layout:
To avoid that users can sort the list by the field "ImageURL", the header name of the column
"ImageURL" must be named to "-".
NOTE:
All columns which have the minus symbol as name are not available for sorting in the Web
Gateway.
The defined value for the column "With" has no effect on the custom list layout and can be
ignored.
180
<rows language="en">
<object id="139" selected="false" urlopen="_open(this, 139)">
<Title label="Title">Flower</Title>
<ImageURL label="ImageURL">http://localhost/OTWG/pictures/
flower.gif</ImageURL>
<Description label="Description">A flower, sometimes known as a
bloom or blossom, is the re...</Description>
</object>
<object id="140" selected="false" urlopen="_open(this, 140)">
<Title label="Title">Car</Title>
<ImageURL label="ImageURL">http://localhost/OTWG/pictures/car.jpg</
ImageURL>
<Description label="Description">A car is a type of vehicle, most
often in American English an...</Description>
</object>
</rows>
The login language of the current user can be found in the "<rows>" element by accessing the
attribute "language".
Every object begins with an "<object>" element which contains the following attributes:
"id" (the unique id of the object)
"selected" (is true if the user has selected an object. It should be used to preselect objects in
the list after a page reload)
"urlopen" (the name of the JavaScript function which must be called to open this object)
Each field of an object which is included in the column layout is a child of the "<object>" node in the
XML data (in our example these are the elements <Title>, <ImageURL> and <Description>). The
name of these elements is the alias name of the fields or - if no alias is defined - the label in server
language.
For each field the label can be accessed by using the elements attribute "label".
For each field the content can be accessed by using the elements content.
WARNING:
Configuration
181
If memo fields are displayed, the content is not limited as known from the list or tree view. To avoid
performance problems it is recommend to limit the size of memo fields in the Field Properties
window.
How to create a XSL style sheet and access the object data?
In this simple example XSL style sheet only the value of the field "Title" is accessed.
This XSL transformation creates a <div> element with a gray border for each object.
Within the <div> element, the objects title is written into a <p> element, using black font color.
182
Note:
The command "return false" is very important. Otherwise the link will not work correctly!
Configuration
183
attribute>
<p>click here</p>
</button>
The first parameter always must be "this" to identify the list control.
The second paramter (id) must be replaced by the unique id of the object you want to be selected or
deselected.
The third boolean parameter (selected) must be "true" for selecting and "false" for deselecting the
object.
Explanation:
An input element of the type "checkbox" is used (= a simple checkbox).
If the object already is selected, the attribute " checked='checked' " is added to our checkbox. This
is necessary to prevent that selections get lost after a page reload. (If the object is selected or not is
evaluated within a "<xsl:if>" element.)
Within the "onclick" event of the checkbox the selection_changed function is called. The third
parameter "this.selected" is true or false depending on if the checkbox is checked or not.
184
<xsl:attribute-set name="MyImage">
<xsl:attribute name="style">height:90px;</xsl:attribute>
<xsl:attribute name="src"><xsl:value-of select="ImageURL"/></xsl:
attribute>
</xsl:attribute-set>
<xsl:template match="object">
<div style="border:solid 1px #666666; width:200px; height: 140px;
margin:2px; overflow:hidden;display:inline-block;float:left;">
<table style="table-layout:fixed; width:100%;">
<tr>
<th style="background-color:#009EE0;color:white;font-size:10pt;
text-align:left;" colspan="2"><b>
<xsl:value-of select="Title"/> </b>
</th>
</tr>
<tr>
<td style="width:80px;vertical-align:top;">
<img xsl:use-attribute-sets="MyImage"></img>
</td>
<td>
<a style="font-size:10pt;color:#009EE0;text-decoration:
underline;">
<xsl:attribute name="href"/>
<xsl:attribute name="onclick"><xsl:value-of
select="@urlopen"/>;return false;</xsl:attribute>more info...
</a>
Configuration
185
<br/><br/>
<input>
<xsl:attribute name="type">checkbox</xsl:attribute>
<xsl:if test="@selected='true'">
<xsl:attribute name="checked">checked</xsl:attribute>
</xsl:if>
<xsl:attribute name="onclick">javascript:selection_changed
(this, <xsl:value-of select="@id"></xsl:value-of>, this.checked)
</xsl:attribute>
</input> Select Object
</td>
</tr>
</table>
<textarea style="width:100%;height:80px;overflow:hidden;border:none;
color:#222288;font-size:10pt;"><xsl:value-of select="Description"/>
</textarea>
</div>
</xsl:template>
</xsl:stylesheet>
Result:
186
Configuration
187
Some tips:
If memo fields are used in the custom layout, make sure that the content is not too long to avoid
long load times for users with a slow internet connection.
If images are displayed, the image url must never be an empty string! Some browsers try to access
the current URL if the "src"-attribute of an image is empty. In this case The Web Gateways
directory would be accessed what can cause performance problems on you web server. Therefore a
field which contains an URL should always have a default value or should be mandatory...
Image files should be as small as possible to avoid long load times.
A new XSLT style sheet should be tested with different browsers to discover display problems in
time.
Hide fields from sorting by renaming the column to "-".
If text with from memo fields which contains line breaks shall be displayed, the value must be
placed inside textareas.
See the the field "Description" in the example "A more complex style sheet" above.
It's recommended to use external tools to create or modify the XSLT style sheet. Some tools can
check the syntax or can generate the output HTML format by using the sample XML data which can
be stored in the Web List Layout Editor.
Note:
The generated output of external editors can be different from the list layout as it is displayed in the
Web Gateway. In the list control the HTML elements of a custom layout may inherit style sheets
from the Web Gateway.
188
4.9
Scripting
4.9.1
Introduction
Visual Basic scripts can be executed on search and object forms. These scripts can be triggered
by various events, e.g. if a form is opened or a button is pressed. The scripts are executed on the
web server.
An OMNITRACKER Visual Basic script may contain all language elements, which are supported
by the Visual Basic script engine of Microsoft. For details please refer to the VBScript
language reference manual of Microsoft. For those Visual Basic objects, which are specific for
OMNITRACKER please refer to OMNITRACKERs Automation interface manual.
The chapter "Reference/Global Properties and Methods" of the OMNITRACKER's Automation
interface manual only is valid for server-side scripts and for scripts in the windows clients, not for the
Web Gateway. The Web Gateway has a own set of global properties and methods (described in the
next chapter).
4.9.2
4.9.2.1
Overview
Here an overview over all script events and global properties/methods which are available in the Web
Gateway. Depending on the script event, some properties and methods may not be available.
The following table contains a list of all global Web Gateway script properties and methods and
shows where they can be used.
Property or Method
Object Forms
Search Forms
Configuration
189
ActiveFilter
ActiveFolder
ActiveObject
ActiveSearchFilter
ActiveSession
ActiveUser
CancelAction
CloseObject
CombineFilterAndSearch
GetSelectedObjects
GetTabLabel
LogMessage
OpenObject
OpenNewObject
RecursiveSearch
ResultMessage
Save
Search
ServerLanguage
SetTabLabel
StatusText
4.9.2.2
Properties
4.9.2.2.1 ActiveFilter
ActiveFilter Property
ActiveFilter As OtFilter
This property is only available in Search Form Scripts.
x
x
190
Syntax
' Get the current folder and change the active filter
Dim filt
Dim fold
Set fold = ActiveFolder
Set filt = fold.MakeFilter
filt.UserField("Responsible") = ActiveUser
ActiveFilter = filt
Access
This property is read-write.
Description
This property returns the filter which is currently selected.
If the ActiveFilter is changed, it is shown as "User Defined" filter in the Filter ComboBox on the
search form.
4.9.2.2.2 ActiveFolder
ActiveFolder Property
ActiveFolder As OtRequestFolder
This property is only available in Search Form Scripts.
Syntax
' Get the current folder and change the active filter
Dim filt
Dim fold
Set fold = ActiveFolder
Set filt = fold.MakeFilter
filt.UserField("Responsible") = ActiveUser
ActiveFilter = filt
Access
This property is read-only.
Description
This property returns the currently selected folder.
Configuration
191
4.9.2.2.3 ActiveObject
ActiveObject Property
This property is available in Object Form Scripts.
Syntax
Dim val As OtRequest
Set val = ActiveObject
Access
This property is read-only.
Description
The ActiveObject object always is up-to-date and contains the latest (unsaved) modifications the
user has made. If the object is modified by script, the changes become visible on the object form as
soon as the script execution has finished.
ActiveSearchFilter Property
ActiveSearchFilter As OtFilter
This property is only available in Search Form Scripts.
192
Syntax
' Perform a search
Dim filt
Dim fold
Set fold = ActiveFolder
Set filt = fold.MakeFilter
filt.UserField("Responsible") = ActiveUser
ActiveSearchFilter = filt
Search
Access
This property is read-write.
Description
This property returns a filter which contains the search criteria the user has specified in the search
form.
If the ActiveSearchFilter is modified by script, then the search form is updated accordingly, if
corresponding search fields exists on the form.
Please note:
It's not possible to clear search form fields in this way! Only new, non-empty values can be filled into
the form.
Example:
The user fills a search form and searches for objects with the state "New" and the priority "High".
In the OnSearch-Script the ActiveSearchFilter is cleared and changed to "Responsible" is
ActiveUser AND "Priority" is "Very High"
Now the following happens:
Only objects where the current user is responsible for with very high priority are displayed, the state
is completely ignored.
The Search form is updated:
If the search form contains the field "Responsible", it now shows the current user.
"State" still contains "New", because fields which are not included in the ActiveSearchFilter cannot
be cleared.
"Priority" now shows "Very High".
If the user now presses the Search button again and if now the ActiveSearchFilter is not changed by
script, then also the state will be included in the search result.
Configuration
193
4.9.2.2.5 ActiveSession
ActiveSession Property
Syntax
Dim val As OtSession
Set val = ActiveSession
Access
This property is read-only.
Description
This property returns the currently active session as an OtSession object.
4.9.2.2.6 ActiveUser
ActiveUser Property
Syntax
Dim val As OtUser
Set val = ActiveUser
Access
This property is read-only.
Description
This property returns the current user as an OtUser object.
4.9.2.2.7 CombineFilterAndSearch
CombineFilterAndSearch Property
This property is only available in Search Form Scripts.
Syntax
boolVal = CombineFilterAndSearch
Access
This property is read-write.
Description
This property returns or sets the flag indicating whether filter and search are combined. By default an
"AND" combination is used.
194
4.9.2.2.8 RecursiveSearch
RecursiveSearch Property
This property is only available in Search Form Scripts.
Syntax
boolVal = RecursiveSearch
Access
This property is read-write.
Description
This property returns or sets the flag indicating whether the search is recursive.
If no "Recursive Search" checkbox is on the search form, the default value of this property is false.
4.9.2.2.9 ServerLanguage
ServerLanguage property
Syntax
Dim val As String
val = ServerLanguage
Access
This property is read-only.
Description
Returns the language identifier (e.g. "de" for German or "en" for English) for the server language of
the ActiveSession.
4.9.2.3
Methods
4.9.2.3.1 CancelAction
CancelAction Method
This method is available in "OnSearch" and "OnSave" Scripts.
Syntax
CancelAction
Configuration
195
Description
Object Forms:
Prevents an object from being saved, when called within an OnSave event handler.
Search Forms:
Rejects a search action in a search form when called within an OnSearch event handler.
4.9.2.3.2 CloseObject
CloseObject Method
This method is asynchronous.
Syntax
CloseObject
Description
Performs the same actions that would happen if the user pressed the Cancel button in the form.
4.9.2.3.3 GetSelectedObjects
GetSelectedObjects method
This method is available in Object Form Scripts.
Syntax
'Get the selected objects of field "RefList"
Set fld = ActiveObject.RequestFolder
Set def = fld.UserFieldDefinitions("RefList")
field is "RefList"
Set reqs = GetSelectedObjects(def)
Return value
Returns a value of type OtRequests
Parameters
def
Description
Returns an object of type OtRequests that contains the current selected OtRequest objects.
196
4.9.2.3.4 GetTabLabel
GetTabLabel method
This method is available in Object Form Scripts.
Syntax
Dim label as String
Set label = GetTabLabel(idx as Long)
Return value
Returns a string.
Parameters
idx
The index of the desired tab button. The index must be a number between 0 and
tab count-1.
Description
Returns the specified tab button label.
4.9.2.3.5 LogMessage
LogMessage Method
Syntax
Dim strText As String
LogMessage strText
Parameters
strText
Description
Write a message to OMNITRACKERs event log.
The event log can be browsed using the "Status" tab in OMNITRACKERs server setup window.
4.9.2.3.6 OpenObject
OpenObject Method
Syntax
Dim object_id As Long
Dim modal As Boolean
Configuration
197
modal
This parameter is not regarded, if this method is used in a Search Form Script.
If TRUE, the window will be modal; otherwise, the window will be nonmodal. If an
object is opened modal, the user may not modify the parent object. But the user
may navigate to the parent object using the breadcrumb bar. The OpenObject
method will not return until the object has been closed.
read_only
Description
Opens an object in a new pane tab or as a child of an object form using the breadcrumb bar.
Restriction
In Search Forms which are displayed in the Select Object dialog, it's not allowed to use the
OpenObject method. Then an error will be displayed.
4.9.2.3.7 OpenNew Object
OpenNewObject Method
Syntax
Dim folder_id As Long
Dim modal As Boolean
object_id = OpenNewObject(folder_id [, modal])
Return value
If modal is TRUE, then the unique ID of the created request is returned, or 0 if no request has been
created.
If modal is FALSE, then 0 is always returned.
Parameters
folder_id
Unique ID of the request folder in which the new request shall be created.
modal
This parameter is not regarded, if this method is used in a Search Form Script.
198
If TRUE, the window will be modal; otherwise, the window will be nonmodal. If an
object is opened modal, the user may not modify the parent object. But the user
may navigate to the parent object using the breadcrumb bar. The OpenNewObject
method will not return until the object has been closed.
Description
Opens a window for the creation of a new object.
Restriction
In Search Forms which are displayed in the Select Object dialog, it's not allowed to use the
OpenNewObject method. Then an error will be displayed.
4.9.2.3.8 ResultMessage
ResultMessage Method
This method is asynchronous.
Syntax
Dim text As String
Dim icon As Long
ResultMessage text [, icon]
Parameters
text
icon
no icon
info icon
warning icon
error icon
question icon
Description
Displays a message box to the user after the script execution has finished. It's possible to show
multiple message boxes one after another.
4.9.2.3.9 Save
Save Method
Syntax
Save([saveFlags As Long]) As Boolean
Configuration
199
Parameters
saveFlags
Optional parameter of type "Long". This parameter defines the behaviour of the
save operation (see table below for details).
Description
Performs the same actions that would happen if the user pressed the Save button in the form.
If the "Save" action was successful True is returned, otherwise False.
For the optional parameter "saveFlags", you may provide any combination of the flags listed below:
Flag
Value
Description
otSaveDoNotCheckPermission
s
otSaveDoNotValidateInput
otSaveDoNotCheckNonAmbigu
its
otSaveDoNotExecuteActions
otSaveDoNotRecalcEscalation
Times
16
otSaveDoNotUpdateHistory
32
otSaveDoNotUpdateFullTextSe
arch
64
otSaveDoNotRecalcAutocalcul
ations
128
otSaveDoNotCheckPrivileges
256
otSaveDoNotChangeLastChang
eFields
512
Important Note
Since the usage of the optional parameter allows you to skip some of the data consistency checks
(etc.) the OMNITRACKER Server normally performs you must take care yourself that the changes
do not corrupt your data model!
200
4.9.2.3.10 Search
Search Method
This method is available in Search Form Scripts.
This method is asynchronous.
Syntax
Search
Description
Performs the same actions that would happen if the user pressed the Search button in the form.
4.9.2.3.11 SetTabLabel
SetTabLabel method
This method is available in Object Form Scripts.
Syntax
Dim idx As Long
Dim label As String
SetTabLabel idx, label
Return value
Returns a value of type OtRequests
Parameters
idx
The index of the desired tab button. The index must be a number between 0 and
tab count-1.
lbl
Description
sets the text of the specified tab button label
Configuration
201
4.9.2.3.12 StatusText
StatusText Method
Syntax
Dim strText As String
StatusText strText [, number]
Parameters
strText
number
Set this optional parameter to a number between "0" and "100" if you want to
display a progress bar
Description
Display a status text to the user while the script is executed.
This method only should be used if a long script execution duration is expected, e.g. if bulk
operations are performed or if external services are accessed. The web client by default displays a
loading symbol while a script is running. To inform the user about the current progress, a StatusText
can be defined.
Note:
In the Web Browser, the status message is updated by a polling mechanism. Depending on the
network speed and the script execution duration, the status text may not become visible in the client
browser.
Warning:
It's recommended to keep script execution times as short as possible, because an impatient User
may press "F5" if an operation takes too long. This may lead to unpredictable effects.
In addition the default request timeout, which is defined in the web.config file, must be considered.
4.9.3
202
"OnChange" scripts
"OnChange" scripts only are invoked if a field loses focus which was modified by the user.
Special case "Move Attachment"
If an attachment is moved from one to another attachment field, then only the source field fires the
"OnChange" event.
"OnChange" scripts on object forms should be avoided if possible due to the following reasons:
Performance: An OnChange script on a form causes that other fields (e.g. numeric fields) must be
validated immediately after editing. This causes a higher network traffic and Web Server load.
Depending on the network speed, the user may notice a delay before he can continue modifying
the next field. In addition an "OnChange" script requires that the whole form is reloaded after script
execution.
Usability: An OnChange script is executed if a field, which was modified by the user, looses the
focus. The focus may get lost because the user pressed a button. Before the button action can be
performed, the OnChange script must be invoked. It's possible that the users action (button
clicked) get's lost under specific circumstances (depending on the performed action or if for
example a ResultMessage is displayed by the OnChange script).
Configuration
203
Include Scripts
Global Include scripts can be imported using the following syntax at the beginning of a script:
$INCLUDE 'ScriptName'
But there is no Unique Include script which is automatically included.
File handling
All scripts are executed on the web server. It's not possible to read files on the client machine or to
store files on the client machine by script.
If it is necessary to read or write files, make sure that the identity of the application pool or the
authenticated user (if windows authentication is used) has enough privileges on the file system of the
web server.
Keep that in mind if the the following OtAut objects and methods are used in a script:
OtAttachment (WriteToFile)
OtByteArray (SaveToFile)
OtEmail (SaveHtmlBody)
OtHtmlContent (StoreDocument)
OtReportDefinition (SaveReportDefinition)
OtRequest (SaveAsXML)
OtRequests (SaveAsXML)
204
4.10
4.10.1 Introduction
Combo scripts are server-side scripts that are invoked usually from the shortcut bar or from a search
form. Inside combo scripts, you can call functions that trigger client side effects after the script
exits. Some of these effects, on their part, can trigger other combo scripts. You can find more
information about Combo scripts in the Automation Interface help.
Combo Scripts can be invoked from JavaScript on the main page and on object forms. Therefore the
JavaScript function named "invoke_combo_script(..)" must be called. On the main page for example
a button which calls this function can be placed within a custom list layout. On object forms there
are several possibilities to use Javascript.
The first two parameters define the name of the Combo script and the name of the function to be
executed.
The third parameter is optional and is available as string in the combo script.
If more than one parameter has to be passed, an array of strings can be used as third parameter.
Configuration
205
based.
sub openDoc
PerformAction.OpenDocument ScriptParameters.UserData
'PerformAction.OpenDocument ScriptParameters.UserData(0) can be used
alternatively
end sub
Here an example combo script which opens an object in the given folder with the given title:
sub openObj
dim folder
set folder = ActiveSession.GetRequestFolderByPath
(ScriptParameters.UserData(0))
for i = 0 to folder.Requests.Count -1
if folder.Requests.Item(i).UserFields("Title").Value =
ScriptParameters.UserData(1) then
PerformAction.OpenObject folder.Requests.Item(i), false, true
exit sub
end if
next
206
An example how a button which invokes a combo script can be defined in a custom list layout can
be found here.
Note:
On the main page only custom list layouts can be used to invoke JavaScript code!
Object forms
To invoke a combo script from an object form, the following functions can be called:
invoke_combo_script(script, function, parameters)
save_and_invoke_combo_script(script, function, parameters)
The parameters are the same as on the main page. The second function stores the current object
before the combo script is invoked. Only if saving the object was successful, the combo script is
invoked.
Note:
Saving is not successful and combo scripts will not be invoked if
errors occur during saving
the object was opened readonly (all fields are readonly or the object is locked by another user)
a mandatory field was not filled out by the user
get_unique_id()
Configuration
207
Returns the unique ID of the current object. Returns "0" if the object was created but not saved yet.
save()
Saves the current object.
save_and_close()
Saves the current object and returns to the main page.
cancel()
Returns to the main page without saving the current object.
logout(url)
The session is closed and the user logged out. If no url was specified the default logout url will be
opened.
save_and_logout(url)
Saves the current object and logs out the current user. If no url was specified the default logout url
will be opened.
Restrictions
Its not allowed to execute several JavaScript functions in a row! This can lead to errors or will simply
not work.
For example it's not possible to invoke a combo script and perform a logout afterwards
( ...onclick="invoke_combo_script('s1', 'f3');logout();")
If the function "save_and_invoke_javascript(...)" will only invoke the javascript if saving was
successful. This means at least one editable field must be on the form. If all fields are readonly, a
saving operation can not be performed.
If you are using variables or custom functions you should use a fixed prefix for all names.
208
IMPORTANT NOTE:
Any JavaScript code that you inject in any of OMNITRACKERs web pages must not do any of the
following:
Read or modify any DOM objects except those generated by the XSLT stylesheet of the HTML
formatting for lists feature.
Insert HTML code anywhere except in regions generated by the XSLT stylesheet of the HTML
formatting for lists feature.
Call JavaScript functions other than your own or those specified in this online help document.
Perform refreshs or reloads of the web page.
Use non-standard JavaScript extensions.
Use non-standard DOM or CSS extensions.
Configuration
209
Solution
ScriptParameters.UserData
("ActiveRequestId") returns an
error
I'm using
"save_and_invoke_combo_script
(...)" but the combo script
(sometimes) is not invoked
4.11
210
Configuration
211
<IIsCompressionScheme
Location ="/LM/W3SVC/Filters/Compression/deflate"
HcCompressionDll="%windir%\system32\inetsrv\gzip.dll"
HcCreateFlags="0"
HcDoDynamicCompression="TRUE"
HcDoOnDemandCompression="TRUE"
HcDoStaticCompression="TRUE"
HcDynamicCompressionLevel="10"
HcFileExtensions="htm
html
txt
js
css"
212
Step 4 - Browsers:
In order to use compression, the browsers must have HTTP 1.1 activated. HTTP 1.1 is usually
activated by default. Under Internet Explorer, you can activate it like this:
Extras/Internet options -> Tab Advanced -> HTTP 1.1 Settings -> Check "Use HTTP 1.1"
Part
214
Troubleshooting
5.1
Limitations
Depending on the used browser, there may be some restrictions in the usability of the Web
Gateway.
On desktop systems, we recommend to use the browser Firefox or Internet Explorer 9 or higher.
If Internet Explorer is used, there are differences in the look-and-feel depending on the used browser
version. We recommend to use at least Internet Explorer version 9.
Further down, the limitations of mobile devices are listed.
Limitation
Not supported if Internet Explorer 7 or older is used.
Only supported if Internet Explorer or Firefox (desktop versions only) is
used. On all other browsers, formatted text fields which contain formatted
text are readonly. Plain text can be edited.
Limitation
If chrome is used, it's not possible to filter items in a DropDown list
Workaround: Type in SPACE and then BACKSPACE, then the items are
filtered.
Always Close Session If the screen timeout is reached or if the device is set to sleep mode, then
it's possible that the session is closed after a short time duration. To the
Web Gateway it seems that the browser was closed.
You should enlarge the screen timeout on the mobile device or disable
"Always close session".
Horizontal scrolling in On iPads, it may be necessary to use two fingers for scrolling.
lists
Alternatively it is possible to scroll with one finger in the header of the list.
Attachment upload
On iPads it is not possible to browse the file system. Only images from the
gallery or photos can be uploaded.
Filter definition (Rule) It's not possible to select multiple lines (e.g. to add or remove brackets).
dialog
Troubleshooting
215
Note:
If you encounter any problems on a mobile device, should do the following:
Check whether the problem is solved by the current version of the browser.
Using any other browser may solve the problem.
5.2
Solution
IIS 6:
Please download and install this special
framework version which contains both, the 64bit and the 32-bit engine: Download here
Run this command: C:\%windir%
\Microsoft.NET\Framework\v4.0.30319
216
\aspnet_regiis -i
To enable IIS 6.0 to run 32-bit applications on
64-bit Windows
- Open a command prompt and navigate to the
%systemdrive%\Inetpub\AdminScripts directory.
- Execute the following command:
cscript.exe adsutil.vbs set W3SVC/AppPools/
Enable32BitAppOnWin64 true
If the steps above do not solve the problem, please
try the following:
In IIS-Manager, Web-Service Extensions please
set the ALLOW flag for ASP.NET v4.0.30319
(32-bit)
Check the user-rights (read-access) of the IIS
(NETWORK SERVICE) in the registry
HKCR\WOW6432Node\CLSID (this is the 32bit
part) and HKCR\CLSID
IIS 7
To enable IIS 7.0 to run 32-bit applications on
64-bit Windows
- Open the Web Gateways application pool in
the IIS manager. Open the properties window
and enable 32-bit Applications
make sure that the OtAut.dll is accessible by
the NETWORK SERVICE (the account which
should be configured in the application pool)
When starting the Web Gateway for the first
If IIS 7 is used, make sure that static content can
time, the login screen is not displayed correctly. be displayed.
(The images are missing)
(Control Panel | Programs and Features | Turn
Windows Features on or off | Internet Information
Services | World Wide Web Services | General
HTTP Features | Static Content)
Edit controls are missing on the "Login" page of Probably you have installed the Internet Information
the OMNITRACKER Web Gateway.
Server after you installed the .NET framework. You
have to re-install the .NET framework to fix the
problem. (%windir%
\Microsoft.NET\Framework\v4.0.30319
\aspnet_regiis -i)
On the login dialog page, an error messages
You did not install the OMNITRACKER Automation
about a missing module with CLSID {...} appears Interface before installing the Web Gateway. The
and it's not possible to log in.
OMNITRACKER Automation Interface can be
installed from OMNITRACKER Client/Server setup
using the "Client only", "Client & server" or
Troubleshooting
217
"Custom" options.
OR
The Application Pool, which is used by the Web
Gateway (see IIS settings) is not running in 32-bit
mode.
The Web Gateway does not work
HTTP Errors or other errors are displayed
Frequent reasons:
Wrong .NET Framework selected in Application
pool (.NET 4.0 required)
Application pool is not running in 32-bit mode
(only if a 32-bit Automation Interface is installed)
Automation Interface not installed on the web
server
Wrong version of Web Gateway or Automation
Interface is installed
Application pool identity has insufficient
permissions on the file system
Wrong authentication mode configured in IIS
Web Gateway is not configured as an
application in the IIS
.NET Framework not correctly installed (run
aspnet_regiis command)
IIS 6 Manager: Make sure that the .NET
Framework is enabled in the Web Service
Extensions
Firefox shows an authentication dialog if Single This is the default behaviour in Firefox. You can
Sign-On is used.
change it by performing the following steps in
Firefox:
Open the page "about:config" and add the name of
the Web Gateway server to the three following
keys:
network.automatic-ntlm-auth.trusted-uris
network.negotiate-auth.delegation-uris
network.negotiate-auth.trusted-uris
Multiple server names can be separated by ",".
Example: "localhost, ServerDev"
Internet Explorer shows an authentication dialog
if Single Sign-On is used.
218
The Web Gatway looks strange after an update The page structure of the Web Gateway or the
used visual elements may have changed. It's
possible that old style sheet information are
cached by a proxy or by the browser.
Maybe the OTWG_StyleSheet file contains
Troubleshooting
219
220
Troubleshooting
221
%windir%\Microsoft.NET\Framework\v4.0.30319
\CONFIG
with %windir% refers to your Windows installation
directory.
It's impossible to upload attachments larger than IIS 7 restricts the maximum content length to
30 MB on IIS 7 web servers.
30000000 kBytes. If you want to change this value,
the key "configuration/system.webServer/security/
The page "Server error in the application
requestFiltering/
DEFAULT WEB SITE/OTWG - HTTP-Error
requestLimits@maxAllowedContentLength" in the
404.13 - Not Found" is displayed.
file "%windir%\system32
\inetsrv\config\applicationhost.config" must edited:
Click "Run" in the windows start menu and enter
the following command:
%windir%\system32\inetsrv\appcmd set config section:requestFiltering requestLimits.maxAllowedContentLength:5000000
0
(The value "50000000" sets the max. uploadable
file size to 50MB.)
Copy & paste not possible in formatted text
fields.
222
OR
Troubleshooting
223
224
Troubleshooting
225
226
Troubleshooting
227
Example:
<add key="OT_BrowserClosedLogoutTimer"
value="70000" />
Scroll-bar not shown if mobile browsers are used Scroll-bars are by design not shown in many
mobile browsers like Safari, however scrolling is
possible. If Safari Mobile is used, scrolling is
possible with finger over the Shortcuts or Folder
228
Index
Copy & Paste - formatted text
Create a virtual Web Gateway
Create object
154
Crystal Reports
90
Crystal Reports version
86
CSS
172
Currency formats
82
Custom list layout
175
Index
-AActiveFilter
189
ActiveFolder
190
ActiveObject
191
ActiveSearchFilter
191
ActiveSession
193
ActiveUser
193
Attachments
70
Authentication (basic)
24
Authentication (external)
21
DateTime formats
12, 82
Default Folder
112
Default Search Form
73
Delete
40
Deletion of objects
34
Design Subpanel
153
Dialog Titles
100
Display Subpanel
152
-E154, 156
-CCalendar View
34
CancelAction
194
Cascading Style Sheet
172
Clipboard data
215
Close search result
76
CloseObject
195
Column layout
43
Column Layout Definition Page
43
Columns Subpanel
141
CombineFilterAndSearch
193
Combo Scripts
204
Command Button Properties Subpanel
157
Configuration
86, 90, 100, 163
Configuration File#OT_configuration
86
Configuration options
101, 119
Configuration Overview
86
Configuration Window
163
Control size
149
Cookies
90
215
90
-D-
-BBase filter
118
Base Filter Window
118
Button configuration
163
Button Properties
158
Button Properties Subpanel
229
-FField properties
140, 141, 145, 150, 152, 153
Fieldmapping
156
Fill object
156
Filter
17
Filter Edit Page
80
Filter Organize Page
82
Filter Parameter
75
Filter Save Page
81
Folder tree
34
Formatted text
Font family
72
Font size
72
Hyperlink
72
Insert Picture
72
230
Formatted text
Text align
72
-L-
215
-GGeneral Subpanel
140, 154
GetSelectedObjects
195
GetTabLabel
196
Guest Login
112, 118
Guest Login Properties Window
Guest Logins
12
112
-H-
34
-M-
Hide Filter
100
Hide Folder Tree
100
Hide Fulltext search
100
Hide Notifications
100
Hide Search Box
100
Hide Search Form
100
Hide Shortcut bar
100
Hide Views
100
Hints about Scripting in Web
201
Hints for Troubleshooting
215
Hostname
86
HTML Wrapper for field values
151
-JJavascript methods
204
Main page
34
Managing Web Themes
170
Max. request Length
90
Maximum file size
90
Modal form (Fullscreen mode)
126
-NNumber formats
12, 82
-OObject forms
58
Object Page#Modifying_reference_fields
58
OK/Apply/Cancel Button Properties Subpanel
OK/Apply/Cancel Buttons
126
OnOpen Script
126
OnSave Script
126
OnSearch Script
126
OpenNewObject
197
OpenObject
196
OpenUniqueMatch
12, 17
OT_LogLoadTimes
28
157
-PPaging
40
Panes Control
34
Performance
209
Index
Port
86
Preview Window
166
-QQuick
Quick
Quick
Quick
Search
62, 75
Search Fields
126
Search Limit
100
Search properties
152, 153
-RReadonly Licenses
12
RecursiveSearch
194
Redirection URL
86, 90
Reference Subpanel
145
Reference to object
75
Request list
34
ResultMessage
198
Results Page
123
Rich Edit control
215
Rich-Edit Toolbar
72
-SSave
198
Search
73, 76, 78, 158, 159, 200
Search and execute task
78
Search Elements
76
Search Form Checkbox Properties
159
Search Options
76
Section properties
137
Section Properties Subpanel
137
Select Objects
40
Select Task
78
Send Email
63
Send Email Button
160
Send test email
90
ServerLanguage
194
Session timeout
90
SetTabLabel
200
Settings Page
121
Setup
10
Shortcut bar
34
Show name of guest in history and in time-stamped
memo fields
112
Single Sign-On
12, 90
Singleton
17
Singleton Login
12
SMTP server
90
Sorting
143
StatusText
201
Style Sheet File
96
Submit / Submit&Copy buttons
163
-TTab properties
136
Tab Properties Subpanel
136
Task button properties
157
Task Button Properties Subpanel
Text properties
152, 153, 154
Theme Editor
172
Themes
126
Timeout after inactivity
90
Tree Layout Definition Page
45
Tree View
34
Troubleshooting
215
157
-UURLs
Usage
12
40
-VValues Subpanel
150
View Save Page
48
Virtual Web Gateways
90
-WWeb configuration
98, 119, 121, 123
Web Configuration Option Window
119
Web Form Editor Window
126
Web forms
126, 163, 166
Web Gateway Configuration
100
Web Gateway Configuration
Window#URL_End_Session
100
Web Gateway Options
100
Web Gateway Settings Window
98
Web Theme Editor
172
231
232
Web Themes
126
web.config file
86
WebConfig Editor
90
WebGW using HTTP compression
209
-XXSLT examples
XSLT list layout
178
175