WebGw.pdf

March 23, 2018 | Author: bigbigbrain | Category: World Wide Web, Technology, Hypertext Transfer Protocol, Hypertext, Computer Data
Share
Report this link


Comments



Description

OMNITRACKERThe OMNINET Problem and Request Tracking System OMNITRACKER Web Gateway Manual Version 10.3 (build 6408) (C) Copyright 1996-2014 by OMNINET GmbH OMNITRACKER Web Gateway Manual © 2014 OMNINET GmbH Information in this document is subject to change without notice and does not represent a commitment on the part of OMNINET® GmbH. The software described in this document is furnished under the software license agreement distributed with the product. The software may be used or copied only in accordance with the terms of the license. The purchaser may make one copy of the software for a backup, but no part of this user manual may be reproduced, stored in a retrieval system, or transmitted in any form or by any means electronic or mechanical, including photocopying and recording for any purpose other than the purchaser?s personal use, without prior written permission from OMNINET® GmbH. Printed: Dezember 2014 in Germany (C) Copyright 1996-2014 by OMNINET GmbH All Rights Reserved. OMNITRACKER and OMNINET are registered trademarks of OMNINET® GmbH. 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 3 Table of Contents Foreword 0 Part I Introduction 8 Part II Installation 10 1 Installation ................................................................................................................................... 10 Part III Using the Web Gateway 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 © 2014 OMNINET GmbH 86 4 OMNITRACKER Web Gateway Manual 1 Configuration ................................................................................................................................... Overview 86 2 Configuration ................................................................................................................................... File 86 3 WebConfig ................................................................................................................................... Editor 90 4 Style ................................................................................................................................... Sheet Files 96 5 Web ................................................................................................................................... Configurations 98 Web Gatew ......................................................................................................................................................... ay Settings Window 98 Web Gatew ......................................................................................................................................................... ay Configuration Window 100 Guest Login ......................................................................................................................................................... Properties Window 112 Guest Login ......................................................................................................................................................... Base Filter Window 118 Web Configuration ......................................................................................................................................................... Option Window 119 Web Configuration ......................................................................................................................................................... Im port Wizard - Settings Page 121 Web Configuration ......................................................................................................................................................... Im port Wizard - Results Page 123 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 © 2014 OMNINET GmbH ......................... 214 2 Hints .................... 195 GetTabLabel ........................................................................................................................................................................................ 196 OpenNew....... scripting 201 10 Invoking ................................ 190 ActiveObject ....................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................... 196 LogMessage ....................................................................................... 198 Save .................................................. 194 CancelAction ...................................................................................... 204 JavaScript ......................................................................................................................................................................................................................................................................................................... 200 SetTabLabel .................................................................................. for Troubleshooting 215 Index © 2014 OMNINET GmbH 229 ..................................................................................................................................................................................................................................... Combo Scripts from JavaScript 204 Introduction ............................................................................................................................................................................................................................................................................................................ 193 RecursiveSearch .............................................. 194 ServerLanguage ..................................................................................Contents 5 ActiveFolder ........................................................................................................................................ 196 OpenObject ................................... 195 GetSelectedObjects .......................................................................... 198 Search ............................................................. 200 StatusText ............................................................................................................................................................................................. up the Web Gateway using HTTP compression 209 Part V Troubleshooting 214 1 Limitations ...................................... 193 ActiveUser ...................................................................................................................................................................................... 193 CombineFilterAndSearch .................................................... Functions 204 11 Speeding .................................................................................................................................. 194 CloseObject ............................................................................................................................................................................................................................................................................ 191 ActiveSession .................................................... Object 197 ResultMessage ............................................................................................ 194 Methods ................................................................................................................................................................................................... 201 Hints about .................................................................................................................................................................... 191 ActiveSearchFilter .................................................................................................................................................................................................................................... . Part I . 8 1 OMNITRACKER Web Gateway Manual Introduction The OMNITRACKER Web Gateway allows OMNITRACKER users or guests to access the OMNITRACKER database by using an ordinary Web browser. partners. Sending emails The OMNITRACKER Web Gateway can be adapted to your own needs as described in the Configuration chapter. © 2014 OMNINET GmbH . Features Browsing through folders and object lists Searching for objects. etc. modifying and deleting objects Downloading and uploading attachments Providing guest logins for your customers. using the full-text search engine or search forms Filtering for objects Adding. Part II . 10 OMNITRACKER Web Gateway Manual 2 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. © 2014 OMNINET GmbH Part III 12 OMNITRACKER Web Gateway Manual 3 Using the Web Gateway 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. Standard Login and optional parameters http://<hostname>/<virtualroot>/login.aspx [?lang=<language code>] [&readonly=1] [&autologin=<param>] [&guestlogin=<id>] [&showLoginObject=1] [&locale=<language code>] [&user=<login name>] [&hidelanguage=1] [&tzo=-60] Displays the Login Page for an ordinary login or guest logins. The optional parameters described here can be used with all login modes (standard login, single sign-on, login with filter) 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. © 2014 OMNINET GmbH Using the Web Gateway 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. TZO (timezone offset): The timezone offset of the client machine in minutes. The timezone offset is determined automatically and the "tco" parameter is added to the url. The timezone offset must be known to display the correct date/time values in the Web Gateway. If an invalid value is entered here, the web servers timezone is used instead. Example for germany (UTC+1): "timezone=-60" [or "timezone=-120" in summer (daylight saving time)] If you want to use the Web servers timezone (old behavior before 10.3.0), then an invalid value (not numeric) must be passed here (e.g. "timezone=false"). Single Sign-On and Basic authentication: The "autologin=<param>" parameter can be used when in the web configuration the option "Single Sign-On (allow)" or "Single Sign-On (hide login Window)" is enabled or if you want to use basic authentication <param> = 1 : The login window is hidden if the login attempt succeeds. If the current user cannot log in, the dialog is displayed (the option "Single Sign-On (allow)" must be enabled) <param> = 2 : The checkbox "Use Windows Login" on the login window is checked (the option "Single Sign-On (allow)" must be enabled) <param> = 3 : The login window is displayed (overrides the option "Single Sign-On (hide login window)") <param> = 4: The login window is hidden and basic authentication is used. Note: This parameter only can be used in combination with normal user accounts, not for guest logins. 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). © 2014 OMNINET GmbH It is possible to override the browser settings by using the optional locale parameter. Furthermore the singleton mode 2 and the guestlogin with the id "1" is used. Otherwise. Instead. in the folder "ServiceDesk\Incidents". Note: If the object with the specified <id> does not exist in the database. you can enter the full path of a folder and one or more filter parameters to search for.. "de-DE".aspx ?id=<id> &singleton=<singleton> The number <id> specifies the unique id of the object to display. Afterwards the main page is displayed for all singleton modes.14 OMNITRACKER Web Gateway Manual singleton=2 means that the user can intermittently save the object (by clicking the Save button) but will automatically be taken to the logout page when clicking the OK or Logout button. Example URL using singleton login with filter: The following url opens the object with the value "70127" in the field "Number". "en-GB". © 2014 OMNINET GmbH . but can return to the main page by clicking the "OK" or "Cancel" button. Possible values are for example: "en-US".aspx ?folder=ServiceDesk%5CIncidents &filterfield1=Number &filterparam1=70127 &singleton=2 &guestlogin=1 Note: If the filter does not return any object. "de-AT". The parameter <singleton> can either be 1. See the page Defining a filter for more information. 2 or 3. 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. Number. http://<hostname>/<virtualroot>/Login. This is a variant of the singleton login with a unique ID.aspx ?singleton=<singleton> &folder=<folderpath> &filterfield1=<filterfieldname1> &filterparam1=<filterparamvalue1> [more parameters] [&includesubfolders=1] Displays a single object. currency and date/time formats depends on the Language setting in the browser. logging in will not be possible if singleton 1 or 2 is used! Singleton Login with Filter: http://<hostname>/<virtualroot>/Login.. If the search you defined with this URL returns exactly one object. singleton=3 means that the user opens the object. this object is opened as if its ID was given. the user is informed that the filter is ambiguous and logged in as usual. http://<hostname>/<virtualroot>/Login. If the filter returns only one object. http://<hostname>/<virtualroot>/Login. a named filter (e.2 Login Page Layout © 2014 OMNINET GmbH . then this object is opened.aspx ?openuniquematch=1 &folder=ServiceDesk% 5CIncidents &filter=Open%20Incidents See the page Defining a filter for more information. With the parameter filter. Note: The white-spaces between the parameters in the URLs above are for better readability and must be removed! 3. the filter "Open Incidents" in the folder "ServiceDesk\Incidents") can be used: http://<hostname>/<virtualroot>/Login. but with one difference: If the specified filter returns more than one object.1.Using the Web Gateway 15 Login with filter The optional parameter openuniquematch=1 allows to specify a filter in the login URL as known from the singleton login. then this filter is used on the main page and the filter result is displayed.g.aspx ?openuniquematch=1 &folder=<folderpath> [&filter=<filtername>] [&filterfield1=<filterfieldname1> &filterparam1=<filterparamvalue1>] [more parameters] [&includesubfolders=1] Either the optional parameter filter or the optional parameters filterfieldN and filterparamN must be used to define a filter. For further informations see "Single Sign-On" in the administrator online help.16 OMNITRACKER Web Gateway Manual Description Enter your user name and password into the corresponding fields. The line "<identity impersonate="true"/>" must be added to the <system. If this box is checked. this checkbox is displayed. Read-only login © 2014 OMNINET GmbH .web> section of the Web. The login information will remain valid until you close your Web browser.config file if not present. the user will log in with his current windows credentials. 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). The integrated windows authentication must be enabled. Use Windows Login If the web configuration option "Single Sign-On (allow)" is enabled. Note: The IIS must be configured that no anonymous login is allowed for the Web Gateway website. No login name and no password is necessary. and press Login. 1. in this case the checkbox will not be visible and you are logged in with a read-only license. you can configure the message a user receives in this case. then it is possible to define a filter as described here. As administrator. © 2014 OMNINET GmbH . If the conversion succeeds. You can also append "?readonly=1" (resp. "&readonly=1" as second parameter) to the URL. you can continue using the Web Gateway as if you had logged in the usual way.Using the Web Gateway 17 If you have purchased "Read only" licenses for your OMNITRACKER system. The last visited folder is displayed. You cannot convert a write-enabled license back to a read-only license. Singleton The filter must return exactly one object. If the filter returns more then one object. (When using Internet Explorer 7 you can change the language in the menu by clicking 'Tools' -> 'Internet Options' -> 'Languages'. an error message is shown.3 Defining a filter If the URL parameters singleton or openuniquematch are used in the login url. 3. Check the box to login using a read-only license. the current action (create/modify) will fail and you are informed of this. 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 checkbox "Readonly login" will be visible in the third line. The preselected language depends on the browsers language settings and can be overwritten by the optional "lang" parameter in the url. logging in will not be possible (singleton 1 and 2) or an error message is displayed. Then this object is opened if the login succeeds. If the filter does not return any object. Language Select your preferred language for the Application.) Note: Only languages that are installed on the OMNITRACKER server can be selected. . named filter: http://<hostname>/<virtualroot>/Login. then this object is opened if the login succeeds. Otherwise the filter result is displayed on the main page. filter Enter the name of a public named filter which exists in the given folder yes. You can identify the user fields either by their label or by their alias name. if filter is not used The number of "filterparam" parameters must be the same yes.aspx ?&singleton=<singleton> &folder=<folderpath> &filterfield1=<filterfieldname1> &filterparam1=<filterparamvalue1> [more parameters] [&includesubfolders=1] OpenUniqueMatch URL: http://<hostname>/<virtualroot>/Login. if filterfield1 is not used filterfield1 You may enter any number of user fields to filter for. if filter filterfield2 .aspx ?openuniquematch=1 &folder=<folderpath> &filterfield1=<filterfieldname1> &filterparam1=<filterparamvalue1> [more parameters] [&includesubfolders=1] Using an existing filter Instead of using filterfieldN and filterparamN pairs it's possible to specify a public..18 OMNITRACKER Web Gateway Manual OpenUniqueMatch If the filter returns exactly one object. "% 5C") in which the object is located. Singleton URL: http://<hostname>/<virtualroot>/Login. filterfieldN filterparam1 Required yes © 2014 OMNINET GmbH .aspx ?folder=<folderpath> &filter=<filtername> [&includesubfolders=1] Explanation of the parameters: Name Description folder Enter the folder path (separated by backslashes "\" resp. The following user field types are valid: Autonumber Boolean Byte Currency Date/Time Dropdown list Float (single/double) Integer (long/short) Text Workflow yes. You have to escape certain characters (in the folder path. 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. So typical user fields to search for are autonumber fields or the identifying fields of a folder." includesubfolde Use the parameter includesubfolders=1 to search including rs subfolders. The following format is not used conventions apply: Autonumber: Use either the plain number or the number according to the numbering schema Boolean: "y" or "n" Date fields: Use the format YYYY-MM-DDTHH:MM: SS. Every field is compared for equality. An object is only opened if it is the single object which matches the given filter. 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 .. no This can be useful if objects may be moved to subfolders during their lifetime. %2C Space %20 } %7D / %2F " %22 | %7C : %3A < %3C \ %5C © 2014 OMNINET GmbH . filterparamN 19 as the number of "filterfield" parameters. A few notes If you enter multiple filter fields.. Below. the "T" in the middle is the letter "T" Dropdown and Workflow fields: Use either the label or the alias of the value/state Float and currency fields: The decimal separator is a ". but can lead to ambiguous filters if you identify via (for example) autonumber fields which are not shared with subfolders The other parameters are described in the section of the singleton login with a unique ID. userfield names and field values) due to URL specifications.Using the Web Gateway filterparam2 . the fields are combined with "and". service principal names (SPNs) for the OMNITRACKER server must be defined in the Active Directory. When the Web Gateway is installed on a different machine than the OMNITRACKER server.com:443 domain\username OMNITRACKER/myserver:443domain\username © 2014 OMNINET GmbH .NET Impersonation must be activated. Furthermore. %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. then the value "MYDOMAIN" must be stored in the field "Windows Domain Name".mydomain.20 OMNITRACKER Web Gateway Manual . The Web Gateway Configuration Option "Allow Single Sign-On" must be set to true. For example.1. the user uses his Windows credentials for logging in. when single sign-on shall be performed. E. the authentication method of the Web Gateway must be set to Windows-Authentication. and the OMNITRACKER server is in domain "OTHERDOMAIN". If the OMNITRACKER server is in a different Windows domain than the user that logs on.g. Anonymous Login must be disabled and ASP.com" under port numbers 5085 (normal) and 443 (SSL). the web server computer must be marked in Active Directory as trusted for delegation.mydomain. if the OMNITRACKER server is running on host "myserver. the user selects the check box "Use Windows Login". For users from the domain "OTHERDOMAIN". then you should use setspn to define the following SPNs: setspn -A setspn -A setspn -A setspn -A OMNITRACKER/myserver. then there must be an OMNITRACKER user account with login name "joe". 3. the field "Windows Domain Name" can be left empty.mydomain. In Internet Information Services (IIS). On the login page. Handling of these characters is not defined in the HTML specification and may vary depending on your browser and the selected character set. however.4 Single Sign-On If Single Sign-On is used for authentication.com:5085 domain\username OMNITRACKER/myserver:5085 domain\username OMNITRACKER/myserver. the field "Windows Domain Name" of the corresponding OMNITRACKER user account must contain the name of the Windows domain to which the user belongs. the following conditions must be fulfilled: If Windows user "MYDOMAIN\joe" shall be able to log in. For all single sign-on user accounts in the OMNITRACKER user special folder(s). this includes German umlauts) in the folder path or in the search parameters. Use the folder alias if necessary and select appropriate search fields. the authentication method must be "Windows". if user "MYDOMAIN\joe" logs in. In order to use single sign-on. you can see whether a user logged in using Kerberos or NTLM. domain\username is the user account under which the OMNITRACKER server is running. additional credentials must be added to the login URL of the Web Gateway. Generally.com/webinterfaces/checklogin_goid?ticketId=[auth1] Further. This document must contain the information whether the login is successful as well as the login name of the OMNITRACKER user. instead of the NTLM protocol which is used as a fallback if Kerberos is not available. If the OMNITRACKER server is running under LocalSystem.com/webinterfaces/checklogin_goid?ticketId=CC05703D-748E4c84-9A12-C3DC9A681535 Configuration of the OMNITRACKER All required information must be added to the Remote Authentication Options in the Web Gateway Configuration. use the computer name of the OMNITRACKER server instead of domain\username. These credentials may be username.Using the Web Gateway 21 Here. Example for external authentication Suppose that the “Remote Authentication URL” parameter is: https://app. © 2014 OMNINET GmbH . In the OMNITRACKER log file.5 External Authentication External authentication allows the user to log in the Web Gateway directly. 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. The credentials are passed to an external server. suppose that the OMNITRACKER web gateway is invoked with this URL: http://omnitracker.1. As an additional information the document can define the login language and the locale information for the web session. without entering username and password.aspx?guestlogin=1&auth1=CC05703D748E-4c84-9A12-C3DC9A681535 Then the following HTTP(S) GET query is sent to the external authentication server: https://app. session tokens or other information.com/OTWG/Login. password.mycompany. which returns a xml document to the OMNITRACKER. To do so.mycompany.# In order to solve any problems regarding single sign-on. please see Single Sign-On Troubleshooting in the Administrator Guide 3.mycompany. External Authentication can be used for normal logins as well as for guest logins. Therefore a XSL Style Sheet can be specified.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. a XSLT transformation must be performed. the certificate name can be specified using the configuration option "Client Certificate for Remote Authentication". XML format required by OMNITRACKER The following format is required by the OMNITRACKER. Please find an example for a XSLT transformation at the end of this page.mycompany. 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.0" encoding="…" ?> © 2014 OMNINET GmbH . <?XML version="1.22 OMNITRACKER Web Gateway Manual For the example above. the following URL has to be specified as Remote Authentication URL: https://app. If the document format of the external authentication server differs. Necessary certificates are determined automatically if this option is left empty. the standard server language is used (In this case an error message like "External Authentication warning: The locale 'XX-YY' is not valid and will be ignored.g. auth1. It contains the two-letter language code according to ISO-639-1.aspx?lang=en&auth1=CC05703D-748E-4c84-9A12-C3DC9A681535&locale=enUS Example for a XSLT tranformation Imagine the xml document returned by the external authentication server has the following format: © 2014 OMNINET GmbH . it can be set in the URL using the parameters "lang" and "locale": Login. If the specified language is not supported by OMNITRACKER. According to the example above. and the parameters must be numbered starting with 1. If "true". e. followed by “-“. Upper and lower case are ignored in <locale>. N must be different.aspx?guestlogin=1&auth1=CC05703D-748E-4c84-9A12-C3DC9A681535 If the login language is not forced by the external server (locale specified in the xml document). user: contains the login name of the OMNITRACKER user or the name of the Web Guest which will be logged in.Using the Web Gateway 23 <reply> <success>true</success> <user>JohnDoe</user> <locale>en-us</locale> <errormessage></errormessage> </reply> Explanation of the nodes: success: can be "true" or "false". locale (optional): Specifies the language and the regional settings for displaying texts and numeric values in the Web Gateway. and so on. errormessage (optional): This message will be displayed to the Web Gateway user if the login fails (success = "false") URL One or more parameters called “authN” can be added to the URL. auth2. the OMNITRACKER user which is specified as "user" will be logged in. For each parameter. the following login URL must be used: Login. followed by the two-letter country code according to ISO 3166-1 alpha-2.aspx?auth1=CC05703D-748E-4c84-9A12-C3DC9A681535 or for using a guest login with ID = 1: Login." is written to the OMNITRACKER Server log file). 6 Basic Authentication The Web Gateway supports basic authentication. '_'.0" encoding="UTF-8"?> <xsl:stylesheet version="1. Security hint If external authentication is used.1.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. It's strongly recommended that this authentication mode only is used. 3. if the HTTP connection is encrypted (https): © 2014 OMNINET GmbH .w3. 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). This means the authentication data are passed to the Web Gateway within the header of the HTTP request. In addition.0“ encoding=“UTF-8“?> <Login> <error>false</error> <user>JohnDoe</user> <language>de_AT</language> </Login> 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" xmlns:xsl="http://www. 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. In addition. '-')"/></locale> </result> </xsl:template> </xsl:stylesheet> Note: only XSLT 1. https should be used. This URL can be visible in the browsers address bar. all authentication relevant information is contained within the URL.24 OMNITRACKER Web Gateway Manual <?xml version=“1.0 is supported. WARNING: The login credentials are passed as plaintext from the client browser to the Web Gateway server and can be intercepted. Using the Web Gateway 25 Using basic authentication Anonymous Login must be enabled in IIS. Windows authentication must be disabled in IIS. "https://servername/OTWG/ Login. The login URL parameter "autologin=4" must be added (e. Configuration of the OMNITRACKER Basic Authentication can be configured in the category "Basic Authentication" in the Web Gateway Configuration.g. Basic authentication must be disabled in IIS. © 2014 OMNINET GmbH .aspx?autologin=4") 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. © 2014 OMNINET GmbH . Security Level 0 Description The highest security level. the string "admin" indicates that users with "admin" in their name are not allowed to log on using basic authentication. E.g. Forbidden User Names This option can contain a regular expression that specifies the raw names of users that are not allowed to log in. Fore more information read the chapter Basic Authentication without password. If this header is not present. 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. This means that the first request which is sent to the Web Gateway already must contain the authorization header. Its recommended if for example a web portal is used which supplies the login credentials to the Web Gateway. Allowed IPs (Web Servers) This option is without any meaning here. Only regular expressions with "^" and "$" are applied to the whole user name.26 OMNITRACKER Web Gateway Manual Authentication without password This option must be set to false. The Web Gateway will never ask for the login credentials. the error message "Missing authorization header" is displayed. Allowed IPs (Access Manager) This option is without any meaning here. Allowed User Names This option can contain a regular expression that specifies the raw names of users that are allowed to log in. Security Level There are three security levels available. It defines under what circumstances the Web Gateway asks for the authorization data using basic authentication. (Not recommended) User Name Header If a user name header is specified here. the browser shows an dialog and asks for user name and password. the security level must be reduced. Solution: If you were redirected from a web portal which manages the login. 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). The authorization header is added by browsers if the browser asks for the login credentials (depends on the security level) or must be added manually. The Web Gateway will ask for the login credentials even if the HTTP connection is not encrypted. If you want to access the Web Gateway directly using basic authentication. the HTTP request also must contain an "Authorization" header like this: "Authorization:Basic dXNlcm5hbWU6cHdk". this portal must add the Authorization header to the request. then the HTTP request must contain this header: "OT_USER: JohnDoe" Note: The login name within the User Name Header must be in plaintext and not base64 encoded. (Example: "username:pwd" is "dXNlcm5hbWU6cHdk" as an base64 encoded string). 2 The lowest security level. This header must contain the login name of the OMNITRACKER user. If for example the User Name Header "OT_USER" is specified here. or an encrypted HTTP connection must be used © 2014 OMNINET GmbH . Even if a user name header was specified. separated by a column.Using the Web Gateway 1 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. Troubleshooting Problem The error message "Missing authorization header" is displayed Solution The HTTP request does not contain the required Authorization header. the http request which is sent to the Web Gateway Login page must contain a header with the same name. It contains the user name and the password as a base64 encoded string. and if the OMNITRACKER User "JohnDoe" wants to log in the Web Gateway using basic authentication. 1. © 2014 OMNINET GmbH . If you want to access the Web Gateway directly using basic authentication. Solution: disable "Basic/Standard Authentication" and enable "Anonymous Authentication" in IIS or The error "401 Unauthorized" is displayed 3.7 Basic Authentication without password WARNING: Never use this feature on a public web server! Read the security hints! This authentication method was introduced to support the usage of external access managers and works as shown in the picture below. The error message "Wrong user name or password" is displayed This can have several reasons: The user does not exist in OMNITRACKER server The password is not correct The user name matches the rule which is specified in the option "Forbidden User Names" The user name does not match the rule which is specified in the option "Allowed User Names" 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. 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. you must not specify a user name header.28 OMNITRACKER Web Gateway Manual if the security level is "1". This header must be added by a web portal. which contains the login name of an OMNITRACKER user. a login in mask which is provided by the access manager is displayed to the user) 3. The machine where the access manager is installed on works as a proxy. If the user is not yet authenticated. In addition the access manager has added a custom user name header to the request. WARNING: The OMNITRACKER server does not perform a separate authentication.Using the Web Gateway 29 An access manager is located on a machine between the client machines (User Browser) and the web server (Microsoft IIS). © 2014 OMNINET GmbH . + 5. 4. A password is not required. Using basic authentication without password Anonymous login must be enabled in IIS. The user opens the Web Gateway login url. The original request which was cached in step (2) now is sent to the Web Gateway (on the IIS machine). Basic authentication must be disabled in IIS. this is done by the access manager automatically (e. The login is performed automatically and the Web Gateways main page is displayed in the user browser. Therefore it must be assured that only the access manager has access to the Web Gateway server. Function: 1. The clients cannot connect directly to the IIS.g. The request is cached by the access manager. 2. aspx?autologin=4") Configuration of the OMNITRACKER Basic Authentication can be configured in the category "Basic Authentication" in the Web Gateway Configuration. Make sure that only the access manager can connect to the Web Gateway server. Allowed IPs (Access Manager) © 2014 OMNINET GmbH . An external authentication manager must be used.g. The login URL parameter "autologin=4" must be added (e.30 OMNITRACKER Web Gateway Manual Windows authentication must be disabled in IIS. "https://servername/OTWG/ Login. Please read the security hints below. Authentication without password Set this option to true if you want to enable the feature described on this page. Security Level This option does not has any meaning if the option "Authentication without password" is used. the string "admin" indicates that users with "admin" in their name are not allowed to log on using basic authentication. This restricts the number of proxies which can connect to the Web Gateway using Basic Authentication without Password. Forbidden User Names This option can contain a regular expression that specifies the raw names of users that are not allowed to log in. Note: At least one IP address must be specified here. This restricts the number of web servers which can connect the the OMNITRACKER server using Basic Authentication without Password. Only regular expressions with "^" and "$" are applied to the whole user name. Several IP addresses must be comma separated. Allowed User Names This option can contain a regular expression that specifies the raw names of users that are allowed to log in. otherwise Basic Authentication without Password cannot be used.Using the Web Gateway 31 Enter the IP address of the machine where the access manager is installed on here. then the HTTP request must contain this header: "OT_USER: JohnDoe" Note: The login name within the user name header must be in plaintext (not base64 encoded). Note: At least one IP address must be specified here. © 2014 OMNINET GmbH . Several IP addresses must be comma separated.g. E. otherwise Basic Authentication without Password cannot be used. Allowed IPs (Web Servers) Enter the IP address of the machine where the Web Gateway is installed on here. User Name Header The user name header which is added by the access manager to the login request must be entered here. and if the OMNITRACKER user "JohnDoe" wants to log in the Web Gateway. If for example the User Name Header "OT_USER" is specified here. This header must contain the login name of the OMNITRACKER user. Authenticate the user account which is used by the access manager. Only the access manager (which must be installed on a separate machine) may have access to this web server. An aggressor only must know existing login names to gain access to the system. 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. Therefore the access to the web server and to the OMNITRACKER server must be restricted. e. a separate web server should be used which supplies exclusively this login method. The OMNITRACKER does not perform any authentication and allows to login without any password. This header must be added by the access manager. If this is the case.config file. The access manager should be authenticated by the IIS using windows authentication or basic authentication. lock out superusers and persons with administration privilege. LogLoadTimes should be disabled afterwards. Separate Web Server If this feature is used.32 OMNITRACKER Web Gateway Manual Security Hints WARNING: Enabling this feature is a security risk. Set the value to an existing file path. A firewall on the web server must block incoming requests from other machines except the access manager.g. To find out the correct IP please enable the "OT_LogLoadTimes"-log in the web. Restrict the access by defining allowed and forbidden user names If possible restrict the access as far as possible. the feature "Basic Authentication without Password" is disabled. In the created log file an error should be displayed with the IP address of the access manager. 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. © 2014 OMNINET GmbH . The error This can have several reasons: If an IP is defined. the address of the access manager may be wrong. Troubleshooting Problem Solution The error message "Missing authorization header" is displayed If this message is displayed then probably no IP address is defined for the Access Manager or the Web Servers. 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. The user name matches the rule which is specified in the option "Forbidden User Names" The user name does not match the rule which is specified in the option "Allowed User Names" Some of the problems can be identified by checking the OtServer log file (Logins and Logouts must be logged) or by enabling the "OT_LogLoadTimes"-log in the web. The allowed IP (Web Servers) is not correct. To enable OT_LogLoadTimes. © 2014 OMNINET GmbH . the value of the key must be set to an existing folder.config.Using the Web Gateway message "Wrong user name or password" is displayed 33 The user does not exist in the OMNITRACKER database A user name header was not defined. Whenever the user selects a folder.34 OMNITRACKER Web Gateway Manual 3. Layout Description The header contains buttons for general features (e. The second column from the left side displays all available folders for the current user. the object list on the right pane will be updated. the main page will be displayed.g. The folder specific Shortcut bar is attached here.1 Introduction After logging in. Logout) The column on the left contains the shortcut bar.2. © 2014 OMNINET GmbH . which allows to create/open/delete objects. Below the search form is the main button bar. if there is one defined in the displayed folder. perform tasks and change layouts and views. The right pane on displays the search form on the top.2 Main Page 3. 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. Using the Web Gateway 35 The main list supports three view types: List View Tree View (also editing objects is supported if Tree View is used) Calendar View The view type can be changed by clicking the button "View": List and Tree View If the number of objects in the list exceeds a predefined threshold (see the configuration option "Displayed Objects" in the Web Gateway Configuration Window), the list will be spread across multiple pages. The buttons on the bottom of the list allow to navigate between the pages. 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"). © 2014 OMNINET GmbH 36 OMNITRACKER Web Gateway Manual 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 The objects are displayed as appointments in a multi-day view, i.e. the weekdays Monday to Sunday are displayed in a row. (See the topic Week View Type for a screen shot and more details) 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. © 2014 OMNINET GmbH Using the Web Gateway 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"/> Main button bar The main button bar contains buttons to perform actions or tasks on the selected objects. If a free space on the button bar is clicked, a context menu is opened which allows to change the appearance of the buttons. If a folder specific shortcut bar is defined (see Admin Guide for more information), the additional buttons are displayed right to the views drop-down list. If there is not enough space to display all additional buttons, the "overflow" button (small button on the right side) allows to access the controls which are currently not displayed. 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. © 2014 OMNINET GmbH 38 OMNITRACKER Web Gateway Manual Use this button to navigate 5 pages back in the object list. Use this button to navigate to the previous page of the object list. Use this button to navigate to the next page of the object list. Use this button to navigate 5 pages ahead in the object list. Use this button to navigate to the last page in the object list. Use these buttons from the main button bar to delete objects or to restore objects from the "deleted objects" folder. Note: Deleting objects must be explicitly allowed in the Web Gateway Configuration Window. Only objects that aren't referenced by other objects can be deleted. Deleted objects are always moved into the trash bin. To remove objects permanently from the database, they must be deleted from the trash bin folder. This button opens a menu, which allows to change the users password or performs a logout. The URL defined in the configuration option "URL for End of Session" (see Web Gateway Configuration Window) will be loaded after logging out. The currently logged in user is the "superuser". Click this button if you want to display or hide one of the following panels or pages: Shortcut Bar Folder Tree Notifications page Search Form In addition the height of the search form can be limited. If this option is enabled, the max-height of the search form can be resized like the shortcut bar and the folder tree. (Not available if IE 6/7 is used) Use this button to create a new object in the current folder. © 2014 OMNINET GmbH pdf). The "Tasks" button opens a popup menu. a new window will pop up and display the report. you are immediately prompted to save the output file. calendar) Edit the list or tree layout Save the current view By clicking "Edit layout. Otherwise. For print/report tasks. different elements will be listed in this combo box. There is also a drop-down list for selecting the desired output format (e. you have the following choices: CSV MDB TXT XLS If the format you chose contains a preview. The second listbox contains all predefined public and private views..g.Using the Web Gateway 39 Use this button to Change the current view type (list."."Appearance" Subpanel" of the User Guide). you can do so by selecting the entries in the list. tree. If you have to select requests for your task. the possible output formats are: HTML (with preview) PDF (with preview) DOC PDF XLS For export tasks. If and how you can preview the report in PDF format depends on the plugins © 2014 OMNINET GmbH ."General" Subpanel" and "Calendar View Settings . You can then choose to save the output to a file. where all available print and export tasks are listed. the Tree Layout Definition Dialog or the List Layout Definition Dialog (depending on the current layout) will open. Select one to apply it to the list. Note: The following task types are not supported: Word mail merge Show results as table Export to database / interface bus Depending on the task type you selected in the "Tasks" combo box. The layout of the Calendar View can only be configured using the WPF client (see chapter "Calendar View Settings .. with additional options. These buttons allow you to move to the first page move 5 pages backward move to the previous page move to the next page move 5 pages forward move to the last page © 2014 OMNINET GmbH .2. Paging If the current folder contains a lot of objects. See the troubleshooting page for help. The new parameters will be applied by clicking "Ok". a dialog to access these parameters will open. Modify objects: Opens the "Modify Object" dialog which allows to edit multiple (all selected) objects at the same time. It might happen that the XLS option does not appear for export tasks.2 Object list usage Introduction The object list in the Web Gateway is very powerful and has many features that are available in the OMNITRACKER client too. The reason is that the IIS network service does not have the necessary rights to launch the Excel application.40 OMNITRACKER Web Gateway Manual installed in your browser. while "Cancel" continues to use the original parameters. See Search Box (User Guide) for more information If a filter that contains "ask user" parameters is selected. The "More actions" button opens a popup menu. This button is not visible if the permission "Object . 3. The Search box offers flexible means for finding OMNITRACKER objects quickly and easily.Modify via Context Menu" was not granted. then the navigation buttons in the toolbar will get available (they turn black). more than the object list display per page. Using the Web Gateway 41 If a sublevel contains too many objects. Select Objects To select an object. simply click the corresponding row. © 2014 OMNINET GmbH . 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. Paging is not possible. then you must click on the button "more" to display all available items. Analogous you can select an object and press the keys "ctrl"+"a". 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". To select all displayed objects you can click the checkbox in the header of the list. keypad + Expands the current row (treeview only) keypad - Collapse the current row.) The following keys are used by the object list: cursor up Selects the row above the current row. page down / cursor lef Move to the previous page. double click Opens the object. (Press the "ctrl" key to select objects on different pages.42 OMNITRACKER Web Gateway Manual You can use the paging buttons and select objects on other pages too. cursor down Selects the row below the current row. ctrl + mouse click Selects the row and the previous selection remains. page up / cursor right Move to the next page if more objects are available. del Delete the selected object(s) © 2014 OMNINET GmbH . shift + mouse click Selects all rows between the current and the previous selection enter Opens the current selected object. " on the Main Page.. Layout To open this dialog. switch to "List view" and click "Edit layout. you can change the column layout for each folder.2.3 List Layout Definition Page Introduction On the list layout definition page.Using the Web Gateway 3. © 2014 OMNINET GmbH 43 .. Its possible to add further columns or to remove existent. On the right the width of the columns can be adapted.. Description Opens the "Add Column" window which allows to add further columns to the list layout.44 OMNITRACKER Web Gateway Manual Columns These columns currently are visible in the list layout. Window Description Title Add. © 2014 OMNINET GmbH . The list is sorted by the columns listed here.. The sort order can be changed here. Sort Columns The sort columns are listed here. It's possible to override the name of the column by entering a new text in the column "Header". 4 Adds the current selected column to the sort column Moves the current selected column up Down Moves the current selected column down Delete Removes the current selected column from the visible/sort columns Toggle direction 45 Switches between ascending and descending order Tree Layout Definition Page Introduction On the Tree Layout Definition Page.Using the Web Gateway As sort column Up 3. you can edit the reference fields which are shown in each folder for the current view.2. © 2014 OMNINET GmbH . You can also access the List Layout Editor to edit the column layout of every referenced folder. Click "Unselect all" to remove the checkmark from all these elements. Note: If more than one userfield refers to the same folder. Click "Select all" to have all the elements on the currently selected item's level checked.. Reset Layout. left = unchecked.. You cannot move the topmost element upward or the lowest element downward. The element will then be displayed in the folder's default list layout. if you uncheck it. Select an element and click "Edit Layout. so that the selected element will be moved one step up. You cannot reset the root element's list layout." to remove the element's layout definition.. 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.... Select an element and click "Reset Layout. including its subelements. Select All Unselect All Edit Layout. Click "down" to move it down.46 OMNITRACKER Web Gateway Manual Layout Control Description Check the name of a referenced field to have it displayed in the tree. it will not be visible in the main view. Note: The order of unchecked elements is undefined.. these userfields all have the same list layout. right = checked) © 2014 OMNINET GmbH . Up Down Select an element in the tree and click "up". Checked items are saved in their defined order.." to open the List Layout Definition Page. 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) © 2014 OMNINET GmbH . left = unchecked.Using the Web Gateway 47 Draw Grid Show column headers Show object name only "Draw grid": Draws a grid between the items (see pictures below. right = checked) "Show column headers": Whether or not to display the subelements' column headers (see pictures below. left = unchecked. © 2014 OMNINET GmbH . (See the User Guide for details). Pick the name from the list or enter an new one.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. Administrators are allowed to define public Views. View Save Page Layout The Save View Window allows you to Save user defined Views.48 OMNITRACKER Web Gateway Manual OK Cancel 3.2. Notification messages normally are sent automatically by OMNITRACKER-internal actions. Delete Deletes the selected Notification(s). New messages are highlighted in boldface.Using the Web Gateway 3. Opens the attached object. and there are new Notification messages.. © 2014 OMNINET GmbH .6 49 Notifications Page Introduction "Notifications" are email-like messages. Mark as read Marks the selected Notification(s) as read. Layout Description Title Description Open Opens the selected Notification(s). By expanding a list item or double-clicking an entry of the list. the whole notification text can be read. Open associated object. Refresh Checks if new notifications are available and updates the list. When a user logs in.2.. then the following page is displayed. which can be read using the Web Gateway. Mark as unread Marks the selected Notification(s) as not read. Currently it's not possible to send notifications directly from the Web Gateway. "Date". then the notification page is displayed. if the user clicks on a shortcut bar link). then the Notification tab becomes highlighted after the next page refresh which is caused by the user (e. "From" or "Object". The Web Gateway periodically checks if new Notifications arrived.50 OMNITRACKER Web Gateway Manual Searching The search box can be used to search in the list of notifications. The notification page cannot be displayed if the Singleton Logins 1 or 2 are used.g. If new Notifications arrive. then a polling mechanism becomes active. The search starts after pressing the ENTER key in the search box. "Immediate" delivery If the Web configuration option "Always close session" is enabled. Delete the text in the search box and press enter or click on the "Close search result" button to display all notifications again. New Notifications If a user logs in and if there are new (unread) Notification messages. If a user gets new Notifications. without page © 2014 OMNINET GmbH . then the Notifications tab becomes highlighted immediately. By default this happens once every 15 minutes. It is checked if the search string is found in the columns "Subject". which also is used to check if new Notifications are available (the notification time interval is respected anyway). Note: Too small intervals can have a negative impact on the performance. The entries of this date can be optional grouped according to the content of an object attribute. (See the topic Month View Type for a screenshot and more detailes) Week View The objects are displayed as appointments in a multi-day view.among other things .2.7. This calendar view setting specifies .e. The calendar view setting can only be configured using the WPF client (see also "Calendar View Settings .Using the Web Gateway 51 reload. so the user is informed about new notifications at most 16 minutes after the notification was sent. i. The notifications page can be hidden for all users."General" Subpanel" of the WPF Client UserGuide). (See the topic Week View Type for a screen shot and more details) Day View The objects are displayed as appointments in a day view. Currently the following calendar view type are supported: Calendar View subtype Description Month View The objects are displayed in a month calendar.2. 3. (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. The subject of an appointment can not be set inside the calendar view setting. the notification interval is 15 minutes by default. The time intervals can be adapted using the WebConfig Editor tool. See the Web Gateway Configuration dialog (Main view options | Hide Notifications). the weekdays Monday to Sunday are displayed in a row. Instead it will be © 2014 OMNINET GmbH . The default polling interval is 60 seconds.7 Calendar View Types 3.1 Introduction In the OMNITRACKER Web Gateway the objects of a folder can optionally be displayed in a calendar view.which of the attributes shall be used as the start or end date when displaying the object in the calendar. even if the user currently is absent. g. Important: If the active calendar view settings does not contain an attribute as the start date and/or does not contain an attribute for the end date. If a calendar view is attached to a working times calendar it additionally displays the holidays defined for this working times calendar as well as the working times for individual dates. Depending on the selected subtype. the calendar views can additionally be attached to a working times calendar (see "Working Times Calendar" of the UserGuide) either by directly selection a distinct calendar in the Calendar View Settings or by specifying that the calendar assigned to the current use shall be used.e. Calendar Views and Working Times Calendars Apart from displaying the objects of a folder. the appointments of the selected date. Go forward one day/week/month (depending on selected subtype) Day view Display the appointments of today Week view Display the week which contains today Month view Display the month which contains today Opens a date picker control to select a specific day. off-days or different working hours). Switch to day view 2. the week which contains the selected date or the month which contains the selected day will be displayed. If a user calendar is used the calendar also displayes the "Personal Calendar Entries" of the current user (i. a holiday) or from an user calendar can neither be edited nor deleted.52 OMNITRACKER Web Gateway Manual generated using the naming scheme of the OMNITRACKER folder. Appointments from the working times calendar (e. no appointments will be displayed in the Calendar View of the OMNITRACKER Web Gateway. Switch to week view 3. Go back one day/week/month (depending on selected subtype) 2. 1. Switch to month view © 2014 OMNINET GmbH . Window Description Title Description 1. The header itself contains controls for navigation and for switching between the calendar view subtypes. General Aspects For all three calendar view subtypes the calendar control contains a header. If the user held down the SHIFT key while pressing the mouse button. respectively). the time area between the currently selected half hour and the half hour over which the mouse is hovering is selected. the day column) is marked as selected. 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. If the user presses the left mouse button while the cursor is over the appointment and moves the cursor.Any previously selected area is unselected. the half hour in which the user clicked is selected in day view.) . the time area between the currently selected half hour and the previously selected half hour is selected.7.Using the Web Gateway 53 Keyboard Behaviour No keyboard behaviour is supported (except the ones mentioned in Mouse Behaviour) Mouse Behaviour When the mouse hovers over an appointment. If next the view subtype is changed to day view. In week view the complete day (i. the mouse cursor changes to (This indicates that the user can change the end time of the appointment. the end of the appointment is changed to the half hour on which the cursor currently is positioned. © 2014 OMNINET GmbH .2. When the user double-clicks at an appointment with the left mouse button. The weekday in the first column and in the last column of this matrix depends on the current locale settings (Sunday and Saturday are the start and end weekday in the us-english locale settings. 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. The tool tip will be removed as soon as any key is pressed or when the mouse is moved outside the appointment.If the user moves the mouse while keeping the left mouse button depressed.e. the delete icon will be displayed in the top right corner. the appointment will be deleted. If the user clicks this icon. When the mouse hovers over an appointment. If the mouse hovers over the bottom border of an appointment. the appointment is opened in the object form. the appointment is moved to the nearest corresponding half hour. any previously selected appointments also are unselected. The total height of the appointment is not changed (this is only possible for the day and week view). the new selected day will be displayed. 3. and to the corresponding column. The matrix will be filled up with the last days of the previous month and the first days of the next month. 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). a tool tip is displayed that shows the start and the end time and the complete subject of the appointment.2 Month View Type In the month view the objects of the current folder are displayed in a calendar that displays all days of the current month using a 7x5 day matrix. In month view the day which is clicked is marked as selected. 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. 21 at 1:00 AM and ends at March 25. The weekday which starts depends on the current locale settings (Sunday is the start of the week for usen).g. see ). © 2014 OMNINET GmbH . of March 2012).e. this date will be selected) or use the (s. If a day is single-clicked. the entry will cover more than one day in the calendar view (e. If a calendar entry covers more than one day (does not have to be more than 24 hours).7. Introduction).g.3 button to open a date picker control Week View Type In the week view the objects of the current folder are displayed in a multiple column view with a time bar at the left (from 0:00 to 23:00). at 1:00 AM.54 OMNITRACKER Web Gateway Manual The selected day (or today if the calendar view is visible for the first time) will be marked (in this example the 14. Up to two entries per date can be displayed at once in the month view. This tool tip contains the start and end date of the appointment (date and time) and a subject. like the entry "SpecialHoliday") then it lasts the whole day (i. If a day is doubleclicked the calendar control will switch to day view and the new selected date will be displayed. Otherwise the time value indicates the time the calendar entry starts or ends. If the mouse hovers over an appointment a tool tip will appear. 3. If a calendar entry is displayed without a time value preceeding its title (e.2. from 0:00 to 24:00). this day wil be selected and marked. Every column contains the appointments of one weekday. like the entry "Room 1: test . 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.allday one" which starts at March. bottom) calendar.Using the Web Gateway 55 The Parts of the Week View The week view consists of three parts: Week Calendar (left Displays the seven days of a week as columns with allday/multiday entries side) in the first row and the hours of the day as rows (one row covers 30 minutes) and a time bar on the left. top) Can be used to directly select the date that shall be displayed in the week calendar (or rather the week which contains this date). © 2014 OMNINET GmbH . Alternatively the date selection control on the right side can be used to navigate to a special date. Entries in this list which do not contain at start and/or end time are multi-day appointments (e.g. Furthermore a day in the current displayed week can be selected with a single-click in one of the hour rows (the calendar entries list will then display all entries of this day). Wednesday the 13th in the example above). this date will be selected) or use the button to open a date picker control (s. Introduction). the first entry in the list). Navigation to a Distinct Date in the Week View In order to navigate to a special date in the week view either use the back/forward navigation buttons to move backward/forward one week or use the today button to move to today (if today is in the displayed week. Date Selection Control (right side. 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. 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). Calendar Entries List Contains all elements of the selected day (which is marked in the week (right side. All-day means the appointment starts at 0:00 and ends at 24:00. and release the left mouse button. Multi-Day means an appointment covers more than one day (i. to another column. i. If a personal calendar is attached all entries from this will be displayed also Moving and Sizing a Calendar Entry with the Mouse In order to modify the end time of a selected calendar entry . move the mouse cursor over the bottom of the entry and press the left mouse button. With this the end time of a selected calendar entry can only be modified on the same day column. Again. e.56 OMNITRACKER Web Gateway Manual The Parts of the Week Calendar In the following the most important features of the week calendar are described: The top row contains all appointments which are all-day or multi-day appointments. too.e. With this the start time and the end time will be changed. it starts at a date and ends at least on the next day. 3. again move the mouse cursor over the entry and press the left mouse button.g. Every column contains the appointments for this day (appointments which start and ends on this day and multi-day entries) Every appointment is displayed with the start and end time (if not a all-day or multi-day appointment) and a subject (generated using the naming scheme of the folder). Now move the mouse to another day in the week calendar. The complete entry can now be moved with the mouse. the duration of the moved entry will be kept. The complete entry is now at a different day. the duration of the entry will be kept. the first entry in the multi-day row).7.2.e. If the mouse is now moved downwards the end time will be changed. move the mouse cursor over the entry and press the left mouse button. The time bar on the left side displays the hours 0:00 to 24:00 in half hour steps. the start time and end time are different.4 Day View Type In the day view the objects of the current folder are displayed in a single column view with a time bar at the left (from 0:00 to 23:00). if another time row was choosen.e. i. All appointments in this row are displayed without the start and end time. To move a calendar entry to another day. © 2014 OMNINET GmbH . If you want to change the start time of the calendar entry. Using the Web Gateway 57 The Parts of the Day View The day view consists of three parts: Day Calendar (left side) Displays a single date or a single date in a group view (the appointments are grouped by a field of the OMNITRACKER folder) columns with allday/ multiday entries in the first row and the hours of the day as rows (one row covers 30 minutes) and a time bar on the left. 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). Introduction). © 2014 OMNINET GmbH . bottom) Contains all elements of the selected day.g. 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. Alternatively the date selection control on the right side can be used to navigate to a special date. the first entry in the list). Calendar Entries List (right side. Entries in this list which do not contain at start and/or end time are multi-day appointments (e. Date Selection Control Can be used to directly select the date that shall be displayed in the day (right side. Navigation to a Distinct Date in the Day View In order to navigate to a special date in the day view either use the back/forward navigation buttons to move backward/forward one day or use the today button to move to today or use the button to open a date picker control (s. e. With this the end time of a selected calendar entry can only be modified on the same day column. © 2014 OMNINET GmbH . the duration of the entry will be kept. the first entry in the multi-day row). move the mouse cursor over the bottom of the entry and press the left mouse button. 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. Multi-Day means an appointment covers more than one day (i.58 OMNITRACKER Web Gateway Manual The Parts of the Day Calendar In the following the most important features of the day calendar are described: The top row contains all appointments which are all-day or multi-day appointments. All-day means the appointment starts at 0:00 and ends at 24:00. 3. Using Grouping If grouping is enabled the entries of this date are grouped into different categories.e. it starts at a date and ends at least on the next day. Every column contains the appointments for this day (appointments which start and ends on this day and multi-day entries) Every appointment is displayed with the start and end time (if not a all-day or multi-day appointment) and a subject (generated using the naming scheme of the folder). For Multi-Day appointments a left and/or right arrow is also displayed in the appointment (e. With this the start time and the end time will be changed.g. If you want to change the start time of the calendar entry. Important: All objects of an OMNITRACKER folder for which the grouping field is empty will/can not be displayed using grouping.1 Introduction Introduction The object page displays the fields of a single object. move the mouse cursor over the entry and press the left mouse button. and its history.3 Object Page 3. its attachments. All appointments in this row are displayed without the start and end time. i.3. If a personal calendar is attached all entries from this will be displayed also Moving and Sizing a Calendar Entry with the Mouse In order to modify the end time of a selected calendar entry. If the mouse is now moved downwards the end time will be changed. The complete entry can now be moved with the mouse. e. The time bar on the left side displays the hours 0:00 to 24:00 in half hour steps.g. the first entry in the multi-day row). If the user has been referred here by URL (see URLs). add/modify or delete references to other objects by clicking one of the buttons right to the field: "Add existing" offers a list of existing requests to choose from. all fields of the current object are displayed. arrange them on a Tab Strip and in Sections. "Delete object" removes the reference and moves the object into the "Deleted Objects" folder. hide one or more fields from some or all users. © 2014 OMNINET GmbH . possibly including subfolders. possibly after determining the subfolder to create the new object in.Using the Web Gateway 59 Layout Description By default. however. Saving modifications: The user can save the modifications of the current object by clicking the Save or the Apply button.or two-column layout for every row and customize the field labels (see Web Form Editor). 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). change the order they appear on the page. Modifying reference fields: The user can open. The newly created object is then set as the references object or added to the reference list. "Add new" offers a creation form. The administrator of the OMNITRACKER Web Gateway can. specify one. a click of this button will minimize the section. Minimized section with title "Details": Maximized section with title "Details": © 2014 OMNINET GmbH . the button will expand the section. they can be expanded/minimized with a single click (see Section Properties Subpanel in chapter Web Form Editor Window). If the section is in the minimized state.e. This button will be labeled "Close" on popup forms. the keyboard shortcut Ctrl+Shift+S can be used to expand/minimize this section. If the section is in the expanded state.60 OMNITRACKER Web Gateway Manual Closing object / returning to main view: The user can save the modifications and close the object by clicking the OK Button. The user can close the object without saving by clicking the "Close Tab" button: The user can return to the main view by clicking the folder name: Expanding / minimizing of sections: It is possible to configure sections as "expandable". If a section is configured as "expandable" an additional button to expand/minimize the section is added to the title (if the title is empty. It will be disabled if the user has been referred here by URL (see URLs) or if the Object Page opened in a popup window (see the configuration option "Popup Forms" in the Web Gateway Configuration Window). Alternatively if the focus lies within one of the controls of a section. i. The user can close the object without saving by clicking the Cancel button. The tool tip of this button depends on the actual state of the section. only the button will be displayed as title). 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. 1. Open the list Click into the drop-down control or click the cursor down key if the drop-down list has the focus 2.3.Using the Web Gateway 3. Type in text © 2014 OMNINET GmbH . This range can be configured in the Web Gateway Configuration dialog. "List of references" and "Reference to user" can be configured to allow Quick Searches. 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. Only matching items are displayed Note: The search is performed on client side. There occurs no communication with the Web Server. 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. IE6 and IE7) Clients machine speed 3. This search also is available on quick search fields. 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.3. if the result of the quick search is displayed. © 2014 OMNINET GmbH .62 OMNITRACKER Web Gateway Manual 3.g. To perform a Quick Search. This feature must be enabled in the Web Form Editor for the according fields.3 Quick Search Introduction Fields of the types "Reference to object". simply enter the Text you are searching for and press enter. In this case a check box is displayed on the left side of each list item.4 Send Email Introduction On web forms. the Select Object dialog will be opened to display the quick search result. If the Quick Search returns more results than defined as Quick Search Limit in the Web Configuration. The selection will be applied after ENTER was pressed. © 2014 OMNINET GmbH . A quick search can be canceled by pressing the ESC key. If the number of items of a quick search result exceeds the Drop-Down filter range minimum. the object name is filled in the text field immediately: If the Quick Search returns more than one result.Using the Web Gateway 63 If the Quick Search returns exactly one result. A checkbox can be checked with a mouse click or by pressing the SPACE key. buttons for sending emails can be placed.3. or the user can select the desired message template himself. then it is possible to select multiple items in the search result list. 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". it's possible to enter text to search a specific item within the search result. These buttons can be configured to use a specific message template. 3. © 2014 OMNINET GmbH .64 OMNITRACKER Web Gateway Manual Select Message Template Dialog Window Description This dialog is opened when the Web Gateway user has to select the message template himself. . Opens the "Select Recipients" dialog to add/ remove recipients to/from the list of persons that shall receive a copy of the message. Opens the "Select Recipients" dialog to add/ remove recipients to/from the list of persons that shall receive a copy of the message.. Opens the "Select Recipients" dialog to add or remove direct addresses. HTML Displays the HTML content of the mail if available.. . Bcc.. Plain Text © 2014 OMNINET GmbH Displays the plain text of the mail for edit or review.Using the Web Gateway 65 Send Email Dialog Window Description Title Description To. Cc.. The name and address of the Cc recipients are visible for the other addressees. In contrast to the "Cc" recipients the name and address of the "Bcc" recipients will not be visible for the other addressees.. .66 OMNITRACKER Web Gateway Manual Add. even when HTML content is available. Add further attachments to this email. Send text only Send Sends only the plain text.. HTML and plain text content of this email. Remove Removes the selected Attachment from the list Send HTML and Text Sends both. Sends the email and closes this window © 2014 OMNINET GmbH . Using the Web Gateway Select Recipients Dialog Default © 2014 OMNINET GmbH 67 . © 2014 OMNINET GmbH .68 OMNITRACKER Web Gateway Manual Users can be added w ith the quick search control Window Description Title Description Recipients The list contains the current recipients. User You can select users and add them to the recipients list by clicking the "+" button on the right. Group You can select groups and add them to the recipients list by clicking the "+" button on the right. You can delete recipients by selecting them and clicking the red "x" button on the right. .. If the quick search returns exactly one result. This button only is enabled when at least one folder was defined as an Addressbook special folder. login or last name). Simply add the name of the user which shall be added (enter display... if the list contains more than 200 users. Opens the selection dialog which let you choose objects from the Addressbooks. only the first N users are displayed.. Note: Due to performance reasons..and press enter. the "User" combobox is replaced by a quick search control. A list with results is opened: 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. the user is immediately added to the recipients list.Using the Web Gateway 69 Name and Address You can add a new email contact to the recipients list by clicking the "+" button on the right. © 2014 OMNINET GmbH .. If the search returns too many results. Open Addressbook. which can be configured. "Login Name" and "Last Name" Attachments Introduction Attachments can be uploaded and downloaded in the Web Gateway.3.config file.70 OMNITRACKER Web Gateway Manual "N" is the quick search limit. Warning: this can lead to performance problems if a very large number of Users is displayed. To improve the search.5 standard Always use quick search. it's possible to put an asterisk ( * ) in front of the search: The quick search can be configured by adding the following key to the web. independent of the number of users. By default it is set to 200. extended Always use quick search. The search will be performed on the fields "Display Name". Note: The maximum file size that can be sent to the web server is restricted by the "maxRequestLength" setting in the web. The search will be performed on the field "Display Name" only. This value can be changed by using the WebConfig Editor.config <appSettings> section: <add key="OT_AddRecipient_UseQuicksearch" value="extended"/> The following values are possible: Value false Description Never use quick search. © 2014 OMNINET GmbH . 3. " button to upload a file or to add a new web link. A file can be added by entering the location in the field "File". You can click the browse button instead to select a file on your local computer. Then the browser will ask your if you want to open or save the file. A link can be added by entering the url in the field "Link"... To open a file or a link. © 2014 OMNINET GmbH .Using the Web Gateway 71 Attachment field The Attachments of a field are listed in a table. 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. Add Attachments Click on the "Add. simply click on the name. Otherwise it's not possible to navigate back to the object form that is currently open. Furthermore this feature must be enabled for the attachment field in the web form editor.3.. Delete Attachments If you want to delete an attachment.. © 2014 OMNINET GmbH . The toolbar gets enabled if the formatted text field has the focus. Modify description If you want to modify the description of an attachment.72 OMNITRACKER Web Gateway Manual If you want to specify a description for a file or a link. Some of the controls only get enabled. Click "OK" if you don't want to add further attachments. Note: The user must have the permission to move attachments. the checkbox on the left must be selected. it can be entered in the field "Description". Click "Modify description.6 Rich-Edit Toolbar Introduction The Rich-Edit toolbar gets visible. if text was selected with the mouse cursor. 3. Click "Delete" to remove the selected attachments. the checkbox on the left must be selected. Click the checkbox on the left to mark the attachments you want to move. After clicking "Add" you can add further links/files." to change the text. Move Attachments Attachments can be moved to other attachment fields on your web form. if an object was opened which has at least one formatted text field. 4. Align paragraph to center 3. Font size 1. Increase indentation Start or end a list: 1. Change the text color 1.1 Default Search Form If no specific search form was defined for a folder and if the option "Hide Search Form" in the Web Gateway Configuration Window is set to false. the following default search form is displayed: © 2014 OMNINET GmbH . Decrease indentation 2. Format selected text bold 2. Bullet list 2.4 Search Forms and Filters 3.Using the Web Gateway 73 Layout Window Description Title Description 1. Numbered list Insert a picture (the upload is restricted to max 1MB per image) Insert a hyperlink 3. Align paragraph to right 1. Change the background color 2. Align paragraph to left 2. Font family 2. Format selected text italic 3. Underline selected text 1. decrease font size 1. Increase font size 2. 74 OMNITRACKER Web Gateway Manual If the Web Gateway Configuration option "Hide Filter" is set to true. If the Web Gateway Configuration option "Hide Full-Text Search" is set to true. This form contains the "filter menu button" for managing the filters in the current folder. the first two rows will not be displayed. © 2014 OMNINET GmbH . save and organize your filters. In the box right to this button the selected filter parameters will be displayed. The small Button in the upper right corner is the "minimize" button. the full-text search will not be displayed. If a filter with parameters is selected. the search form will be hidden. the object list will update it's content and shows only the objects matching the filter. After a filter is selected. In the dropdown box on the right you can select an specific filter. . The third row in the search form contains the full-text search field. the default search form will not be visible in the Web Gateway. the button "Edit filter parameters" will be editable. If both options are set to true. If clicked. By clicking the dropdown box you can edit. ).Using the Web Gateway 3.2 75 Edit Filter Parameters The Edit Filter Parameters dialog allows the user to select the values for the comparison. Filters with parameters must be created in the windows client.4.. Note: Fields of the type "Reference to object" and "List of references" are usually displayed as dropdownlists. © 2014 OMNINET GmbH . The Web Gateway does not support creating or modifying filters with parameters. a textbox with a select button is displayed instead to avoid performance issues (see the first row "Incidents" in the image above. Furthermore in the "Field Properties" dialog a default quick-search field must be specified (see the image below). If the amount of selectable objects is greater than specified in the Web Gateway Configuration. 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.. 76 3.4. simply type in the text in the desired full-text search field and press the associated "search" button. © 2014 OMNINET GmbH .3 OMNITRACKER Web Gateway Manual Performing a Search Full-text search To perform a full-text search. ) AND combination (If checked. Search To perform a search. Search Elements Button "Search" If this button is clicked. the search result is addicted to the selected filter and to the filled in search fields. All fields will be emptied. Button "Reset" This button resets the search. simply fill all fields you want to include in your search and click the "Search" button. the search will be performed. that allows to manage the following options: Combine filter and search (If the filter selection changes or a search is performed. simply press the "Reset" button right to the "Search" button. As well the fields. Full-text search / search options On a search form can checkboxes be placed. that are placed on another tabs. To reset the search. All not empty search fields in the search form are included in the search.Using the Web Gateway 77 Afterwards the page will reload and the object list will only display the objects that matching the search. all search fields will be AND combined) Include subfolders in search Include subfolders in full-text search Include subfolders in filter © 2014 OMNINET GmbH . 78 OMNITRACKER Web Gateway Manual Close search result To close a search result.4. Select Task The task and the output format can be selected by the user himself: © 2014 OMNINET GmbH .4 Search and execute task If you click on a "Search and execute task" Button. The search result is not displayed in the object list. Three kinds of "Search and execute task" buttons can be placed on a search form. where the user can select the output format. Execute Task and select the Output The task was determined by an administrator. 3. If the button is clicked. a search will be performed and afterwards a task will be executed. a dialog opens. click on the white cross on the right side of the navigation toolbar. Full-text searches can alternatively be closed by clicking the respective "Reset" button. Execute Task with a determined Output The task and the output format was determined by an administrator and can't be changed. Using the Web Gateway © 2014 OMNINET GmbH 79 . AND or OR. You can also remove the currently selected condition from the rule by clicking the "Delete" button. (See the User Guide for details) Possibly a value the property is compared to. Clicking on a condition from the rule lets you edit the selected condition. (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 . A comparison. depends on the type of property you're comparing. too. Which comparisons are available depends on the type of property. This is requires only if you're combining more than one condition. This.this requires that you select a condition in the rule. The lower section allows you to edit a single condition. A property. © 2014 OMNINET GmbH . A condition consists of for components: A boolean operator.5 OMNITRACKER Web Gateway Manual Filter Edit Page Description The top porting shows all the conditions the filter rule consists of.4.80 3. Using the Web Gateway 81 In order to change the operator precedence.6 Filter Save Page Description The Filter Save Page allows you to Save user defined Filters. © 2014 OMNINET GmbH ..)" buttons on the right to add and remove brackets. respectively. 3. Pick the name from the list or enter an new one.)" and "Remove (.. you can select a range of conditions from the rule and use the "Add (...4. Users of the Internet Explorer can modify the language settings by opening the "Internet Options" window.g. the thousands separator if displayed) Overwrite browser's settings The browser's default language setting can be overwritten by specifying the desired language in the Login URL. On the "General" tab the button "Languages" must be clicked to specify the default language. What is affected? Date/Time values Currency values (e.7 OMNITRACKER Web Gateway Manual Filter Organize Page Description This Page allows you to change and delete existing named filters. Currency and Number formats The format of date/time data. Example for using the English (UK) format: © 2014 OMNINET GmbH .5 Date/Time. The optional parameter "locale" can be used to define the preferred language.4. After selecting the tab "General". currency and numerical values depends on the local browser settings and is independent of the login language. the decimal separator or the currency symbol) Numeric values (e. the languages can be defined by clicking the button "Languages". 3.82 3. Users of the Firefox browser have to open the "Options" in the "Tools" menu.g. aspx?locale=en-GB Restrict Date/Time/Currency formats Administrators can restrict the possible number formats to the languages installed on the OMNITRACKER server. Therefore the Web Gateway configuration option "Limit date/time/number formats" must be set to true.Using the Web Gateway 83 http://localhost/OTWG/Login. © 2014 OMNINET GmbH . . Part IV . Most configuration settings that apply to the Web Gateway in general (not folder-specific) are stored in "Web Configurations" in the OMNITRACKER database. any changes in these files will be overwritten during a version upgrade. These configurations can be edited in the OMNITRACKER Client. It contains general web application settings and information that can be adapted by the administrator. using the Web Gateway Settings Window. The WebConfig Editor tool can be used to edit the configuration file.2 Configuration File The Web Gateway's configuration file is named web.aspx or *.86 OMNITRACKER Web Gateway Manual 4 Configuration 4. The Style Sheet File contains formatting information. These web forms are stored in the OMNITRACKER database as part of the folder definition. Doing that might cause the Web Gateway to malfunction. and some general web application settings. The layout of the Object Page can be defined in a folder-specific way by creating web forms. 4. 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. They can be edited in the OMNITRACKER Client. that defines the look of the Web Gateway's pages. such as fonts and colors. information about email notifications and redirection URLs (if the OMNITRACKER server is unavailable).js files.1 Configuration Overview The Web Gateway can be configured using the following means.config and is located in the Web Gateway's installation directory (usually C:\inetpub\wwwroot\OTWG). All existing web-session will be terminated! © 2014 OMNINET GmbH . furthermore. using the Web Form Editor. Note: Do not change any *. NOTE: The Web Gateway will be restarted after saving changes. The Configuration File contains basic information needed to connect to the OMNITRACKER Server. config OT_Hostname Defines the name or alternatively the IP address of the host computer system on which the OMNITRACKER server process resides. WARNING: The web. OT_smtpServer The SMTP server which is used to send the notification emails.0. Exception: If the Web-Gateway runs on a node in a load-balancing cluster. OT_CrystalReportsAssemblyV Defines the Crystal Reports ersion assembly version that is used to create reports. then the DNS name of the cluster must be instead of "localhost".config file contains two more entries with the Crystal Reports assembly version. The default value is 12. OT_Port Defines the port number of the OMNITRACKER server. separated by semicolons. then "localhost" should be used as host name. OT_redirectionUrl The URL to which users are . OT_emailRecipients The email addresses to which notifications are sent. All entries must contain the same version number.0. <configuration> <appSettings> <add> If the OMNITRACKER server process resides on the same computer as the OMNITRACKER client process. Please use the WebConfig Editor tool exclusively to adapt this setting! © 2014 OMNINET GmbH OT_emailSender The email address that is used to send notification emails if the OMNITRACKER server is not reachable.2000. OT_configuration Defines the name of the Web Configuration to be used.Configuration 87 Accessing the OMNITRACKER Server Location Attribute Description web. OT_LogLoadTimes If you set this value to a valid path (on which the IIS process has write access). OT_BrowserClosedLogoutTimer Interval after that the session is closed if a "page unload" event was detected and if no other Web Gateway page was requested afterwards. the users will receive the connection error message (e. OT_PollingInterval Interval in milliseconds in which the browser sends an "alive" packet to the Web Gateway server. 2 .88 OMNITRACKER Web Gateway Manual redirected if the OMNITRACKER server is not reachable.g. Port 123. no logging is performed.") if the OMNITRACKER server is not reachable.. OT_showStackTrace If you set this value to "true" then a detailed error is displayed if an unexpected error occurs. OT_MissingPingLogoutTimer Time in milliseconds after which a session is closed if no "alive" packet was received. the Web Gateway creates a log file for every day in which it logs error messages and debug information. If an exception occurs. If the value is not set or set to an empty or invalid path.Cache. OT_ErrorLogDirectory If you set this value to a valid path (on which the IIS process has write access).Sets the Cache-Control: nocache header © 2014 OMNINET GmbH ..SetNoStore(). the Web Gateway creates a log file for every day in which it logs the time that is spent in the Web Gateway code for each requested page.Prevent the browser from caching the ASPX page Response. OT_BrowserCachingMode The following values are valid: 1 . NOTE: if no URL is defined. "Cannot connect to server 'xy'. this is also logged in the file. CrystalImageCleanerAutoStart / Sleep / Age more information OT_CheckNotificationsInterval Interval in milliseconds in which the Web Gateway server checks for new notifications on the OMNITRACKER Server. Possible values are: enable: The page OTSmart. More details can be found on the Send Email page.NoCache).SetCacheability (HttpCacheability. 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" Web Application Settings © 2014 OMNINET GmbH . OT_AddRecipient_UseQuickse Use quick search for selecting arch users on the Add Recipient dialog. Combinations of multiple values are possible (the values must be added up).Cache.aspx if Login. OT_UserSamlPki Must be set to "true" if SAML PKI Authentication shall be used.aspx allows logins disable: The page OTSmart.aspx was requested.aspx does not allow logins auto: Mobile devices are redirected to OTSmart. OT_SmartAccess Enables the mobile device optimized web application. The functional range is restricted.Configuration 89 Response. 90 OMNITRACKER Web Gateway Manual Location Attribute Description web. You can use this application to simply change settings in the web. This Tool furthermore checks your web.config timeout Session timeout in minutes cookieless Defines whether browsers must enable cookies to access the OMNITRACKER Web Gateway.config files after an version update Set time intervals necessary for some features NOTE: The Web Gateway will be restarted after saving changes by clicking "Apply".config <configuration> <system.config file after the Web Gateway installation has finished and can add missing entries that are important for the Web Gateway to work correctly. the windows feature "IIS Metabase and IIS 6 configuration © 2014 OMNINET GmbH . The main features are: Change general application settings Create new virtual Web Gateways Change settings for specific Web Gateways (e. <configuration> <sessionState> "true": Browsers do not need to enable cookies otherwise: Browser must enable cookies web.3 maxRequestLength Defines the maximum file upload size (in kBytes) supported by the Web Gateway.web> <httpRuntime> 4.config file. This limit can be used to prevent denial of service attacks caused by users posting large files to the server WebConfig Editor In the "Tools" subdirectory of your Web Gateway installation directory. the used Web Configuration) Define the Crystal Reports version that shall be used Configure the email notification (the Web Gateway can send emails to administrators if the OMNITRACKER server cannot be reached) Define a logging directory for errors Check/Update web. All existing websession will be terminated! To use this tool on IIS 7 machines.exe".g. there is a file named "ConfigEditor. Note: There is another timeout setting in the Internet Information Service (IIS). Otherwise the smallest timeout © 2014 OMNINET GmbH . before the OMNITRACKER session is closed automatically. Layout . This option should be set to the same value.General Settings Window Description Title Timeout after inactivity Description Here you can specify how long a Web Gateway user can be inactive.Configuration 91 compatibility" must be installed. than you must enlarge the max possible file size here. Use Cookies This feature should be enabled avoid that the session id is displayed in the url. The logging directory is the same for all (virtual) Web Gateways. that a user can upload to the web server. If a directory is specified here. if an auto refresh interval is defined for the object list. Warning: This timeout will not work on the main page. Click this button to check if your settings are correct and if email notifications can be sent. Please use the semicolon ( . errors will be written to a log file. The email address(es) that will receive the notification emails. ) to separate several addresses. Layout . This increases the security. Load defaults Loads the recommended application settings. The SMTP server that is used to send notification emails. You can click the button "Test" to check if the specified version of the Crystal Reports Runtime components is installed. For example the size of the email dialog will be stored in cookies.Virtual Web Gateways © 2014 OMNINET GmbH . Warning: Only change this setting if necessary to prevent denial of service attacks caused by users posting large files to the server. Furthermore some Web Gateway features need this option to be checked. request Length This is the maximum size in KB. Crystal Reports Version Please specify here which Crystal Reports Runtime Components you have installed on the web server.92 OMNITRACKER Web Gateway Manual setting is used. Sender Recipients SMTP server Send test email Log Directory The email address that is used to send a notification email. (see Web Gateway Configurtion Window) Max. If you want to allow the users to upload attachments that are larger than 4 MB. Enable Single Sign-On This option must be checked if you want to use the OMNITRACKER Single Sign-On feature. . (All Web Gateways that have an item with the key "OT_Hostname_xxx" in the "appSettings"-section of the web.) Create new © 2014 OMNINET GmbH New virtual Web Gateways can be created by clicking this button.config file are listed in the dropdown list.Configuration 93 Window description Title Name Description The name of the virtual Web Gateway that shall be configured. Enter the name of the new Web Gateway copy. Exception: If the Web-Gateway runs on a node in a load-balancing cluster. users that try to log in the Web Gateway will be redirected to this URL if the OMNITRACKER server is not reachable. 4.config file. Select the option "Only add to web. Redirection URL If an URL is specified here. Test connection Click this button to check if the specified OMNITRACKER server is reachable.config" if you don't want the application to be added to the IIS. Select the source website containing your current Web Gateway installation of which you want to create a copy. then the DNS name of the cluster must be instead of "localhost". then "localhost" should be used as host name.config file. Port number Defines the number of the TCP port of the OMNITRACKER server process to which the Web Gateway shall connect.94 OMNITRACKER Web Gateway Manual 1. the currently displayed virtual Web Gateway is removed from the IIS and from the web. If the OMNITRACKER server process resides on the same computer as the OMNITRACKER client process. If no URL is defined. This port number must be identical to the number as defined in the "Server Port Subpanel" window. 2. Delete Hostname If this button is clicked. Select the target website in which you want to create the copy. Defines the name or alternatively the IP address of the host computer system on which the OMNITRACKER server process resides. After clicking OK the new Web Gateway will be added to the IIS and to the web. users will get an error message like: "Cannot connect to © 2014 OMNINET GmbH . Select your current Web Gateway 3. " Configuration name The name of the Web Gateway Configuration that shall be used. the dropdown list is pre-filled with all defined Configurations..Timings © 2014 OMNINET GmbH .Configuration 95 server 'Server1'.. If the OMNITRACKER server is reachable. Port 8085. Layout . To find out if a redirect occurred we have to wait for the specified time. Style Sheet Files The Web Gateway has different style sheet files for different purposes and different browsers . The time interval N can be specified here. © 2014 OMNINET GmbH . that defines the look of the Web Gateway's pages. The default value is every 15 Minutes. but only if the AutoNotification interval has expired since the last check. Missing polling logout If no polling data package was received from the client for the specified time. This polling mechanism ONLY becomes active. The polling mechanism only can be used if "Always close session" was enabled (see description of "Polling interval"). Auto-Notification interval The Web Server contacts the OMNITRACKER server to find out if new Notifications are available at most every N seconds.4 Restores the default settings which are recommended for most applications. If no request occurs. The OMNITRACKER Server is contacted during postbacks (if the clients browser page is updated) or by the polling mechanism. This is the fallback mechanism for browsers which do not support the "Browser closed logout". N is the time interval which is specified here (default is 60 seconds). A small time interval can cause performance problems if many users are connected to the Web Gateway. Browser closed logout On some browsers it is possible to detect if a browser tab/window was closed or if a redirect occurs. such as fonts and colors. if the feature "Always close session" was enabled in the Web Configuration Options dialog. a logout is performed. Note: If there are network problems it may be meaningful to use a larger time interval. These files containing formatting information. to check if another Web Gateway page is requested.96 OMNITRACKER Web Gateway Manual Window Description Title Description Polling interval The client browser can send a small data package to the Web Gateway Server every N seconds. Restore default timings 4. They are located in the Web Gateway's installation directory (usually C:\inetpub\wwwroot\OTWG). This interval should be at least 10 seconds larger than the specified polling interval. a logout is performed. back ground-repeat:repeat-x. You will find the following class: body. To overwrite a style. Remove all properties that do not want to change. color: White.css This file can be used to overwrite the formatting of the System_StyleSheet files.css file. these files will be overwritten.gif). } Now please copy the complete class and paste it into the file OTWG_StyleSheet. When updating the Web Gateway. It's recommend that only modified properties are stored in the OTWG_StyleSheet. OTWG_StyleSheet. © 2014 OMNINET GmbH . their styleable attributes and their structure may change in future versions of OMNITRACKER. back ground-position:bottom.css file. PLEASE NOTE that the elements a Web Gateway page consists of.css file with a simple text editor and search for "shortcutbar". Example Let's assume you want to change the background color of the shortcut bar into red and the color gradient shall be removed. In particular. back ground-image:url(images/bg_shortcutbar. simply copy the according class from the System_StyleSheet file into the OTWG_StyleSheet file and adapt the property. Please open the System_StyleSheet.shortcutbar { back ground-color: #009EE0. so please remove all unchanged properties from the class. future versions might replace existing or add additional visual elements that your custom stylesheets do not address.shortcutbar { back ground-color: #009EE0. body. The file can be modified by an administrator an is not overwritten when the Web Gateway will be updated.Configuration 97 System_StyleSheet files Files which contain default formatting information. Please do not change the contents of these files. } Now save the OTWG_StyleSheet. Each configuration is identified by a unique name. The changes should take effect immediately. Replace the value #009EE0 with the new color (e.shortcutbar { back ground-color: Red. It is used to edit settings for the Web Gateway.5 Web Configurations 4. or if you want to switch configurations easily. You can maintain multiple configurations.98 OMNITRACKER Web Gateway Manual back ground-image:url(images/bg_shortcutbar. To remove the background-image change the value to "none". If not please press the F5 key for a refresh of the page. Red or #FF0000 for a red color).5. body. for example if you are using multiple Web Gateways with one OMNITRACKER Server. © 2014 OMNINET GmbH . back ground-image: none.css file and login the Web Gateway.1 Web Gateway Settings Window Introduction This window can be accessed through the File / Administration menu. The Web Gateway uses the configuration with the name specified in the parameter "OT_configuration" in the Configuration file. 4.g.gif). } Now you can adapt the color. . Required . Edit Configuration. Description © 2014 OMNINET GmbH Opens the Web Configuration Import Wizard to import configuration files (Web.config and/or OTWebGW. Opens the Web Gateway Configuration Window to add a new configuration. Export Exports the selected configuration(s) to a file or to the clipboard.. Add Configuration. Delete Configuration Deletes the selected configuration(s). Import Imports configurations from a file or from the clipboard. Shows a description for the selected configuration..Configuration 99 Layout Window Description Title Description Configurations List of existing Web Gateway configurations.... Opens the Web Gateway Configuration Window to edit the selected configuration.config) from previous versions of the Web Gateway into the OMNITRACKER database. Import Config Files. Configuration options control the general behavior of the Web Gateway. A configuration consists of the following information: Guest logins define a way for external users to log into the Web Gateway without having individual OMNITRACKER user accounts. Layout Window Description Title Name Description Guest Logins Description Required Unique name to identify this web configuration. with rules defining which value should be used. For the meaning of the displayed columns.100 4. List of guest logins belonging to this configuration.5. depending on the current user.2 OMNITRACKER Web Gateway Manual Web Gateway Configuration Window Introduction This window is used to edit a named configuration for the Web Gateway. Most options can be assigned multiple values. The Web Gateway uses the configuration with the name specified in the parameter "OT_configuration" in the Configuration file. YES Optional description for this web configuration. please refer to the Guest Login Properties © 2014 OMNINET GmbH . © 2014 OMNINET GmbH . Opens the Web Configuration Option Window to edit the value(s) of the selected option. Add Guest Login. If the option is not set to a specific value. the session is closed about 1-2 minutes after the browser (tab) was closed (a polling mechanism is used). meaning that this option can only be set to one fixed value. The logout is performed about 20 seconds after the browser (tab) was closed. a logout is performed. Due to technical limitations this logout is performed delayed.. In this case.Configuration 101 Window. This is indicated by the word "NO" in the column "Multiple Values"... YES There are two mechanisms: On some browsers the closing event can be detected. Some of these options also apply when no user is currently logged into the Web Gateway. If the option has different values depending on the user. If the closing event cannot be detected. Delete Guest Login Options Deletes the selected guest login(s).. Edit Value. General Options These options apply to the Web Gateway in general and are not specific to the main view or object forms. The options are grouped into several categories. if a user accidentally and unintentionally closes the browser window instead of pressing the Web Gateways logout button. the option's default value is used (indicated by the prefix <default>)... YES Always Close Session If this option is true. Option Name Description Multiple Values Allow deletion of objects Set this option to true to enable the deletion of objects in the Web Gateway. "YES" means that multiple values are allowed for this option. therefore their values cannot depend on the current user. Please refer to the following sections for a description of each category and its options. Opens the Guest Login Properties Window to edit the selected guest login. List of configuration options with the following columns: Option: The option's name Value: The option's value. you can press "Edit Value" to see the individual values and their rules. Edit Guest Login. it is displayed as <multiple values>. Opens the Guest Login Properties Window to add a new guest login. Value Behaviour 0 There is no limit. then the current object is canceled and closed. By default the range is 15-1500.0. it must be closed to return to the main list.102 OMNITRACKER Web Gateway Manual Note: This option also affects the update mechanism of Notifications. it's not possible to create or open further objects. Click here for more information. Note: This only works if Popup Forms is false. >1 The maximum displayable tabs is limited to this number. So if the user has specified languages that are not installed on the OMNITRACKER server. If an object is displayed. Such actions (change to folder. YES The number format in the Web Gateway depends on the settings of the web browser.x and older). Drop-Down filter range Allows to filter the list of drop-down items if the number of items is within the specified range. An error message is displayed that it is necessary to close at least one © 2014 OMNINET GmbH . In this case an error message can be shown that is defined here Limit date/time/ number formats Set this value to 'true' if you want to restrict the possible date/time and number formats in the Web Gateway to the languages installed on the OMNITRACKER server. 1 The behavior shall be the same as in previous versions (Web Gateway 10. Either the main list. The Notifications page is not counted (The folder tab and the Notifications tab can be visible concurrently). or an object is displayed. create new object) can be triggered by buttons on the shortcut bar or by combo scripts. 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. Limit number of pane tabs This option can be used to limit the number tabs which are used to switch between the main list and all open objects. that for the moment no write-license is available. open object. even if the object was modified by the user! All unsaved changes are refused. If the limit is reached. these languages are ignored. If an object is displayed and if action is triggered which causes that a folder or another object shall be displayed. the user will be redirected to the main page to select the object(s) from the main list. Note: At the moment. the name of the user will not be displayed. This link is only visible if the user uses Internet Explorer and if it is not a singleton login.Configuration 103 of the objects first. only Firefox browsers support this option. If the quick search result contains more objects than specified here. he only has a readonly license. NO . Single Sign-On (allow) Allows single sign-on in the Web Gateway NO Single Sign-On (hide login Window) Allows single sign-on in the Web Gateway NO Text for Guest Login The string to be displayed above the login screen when a © 2014 OMNINET GmbH The login window is not displayed and the user is logged in with his current windows credentials. the information message will contain the name of the user who locked the object. this option can be used to limit the number of browser tabs or windows. YES Deactivate this option if you experience performance problems with long user lists. NO Note: This option can only be set to one fixed value with an <always> rule. however this may be problematic if objects are closed by using the browsers "x"-button instead of the Web Gateways "Cancel" button. If this option is set to false. only for guest logins.) Login as readonly by default When a user logs in. (The Web Gateway cannot recognize if an object was closed by the browsers "x"-button. If the user wants to save changes on an object. This write license remains. he gets a write license if one is available. NO Show bookmarking link on login page (guests) Same as the previous option. NO Quick Search Limit Specifies the maximum of objects that are displayed in the quick search result window on the object form or in the filter parameter dialog. until the user logs out. so it's assumed that the object still is displayed. NO Show username in object is locked message If this option is set to true and a locked object is opened. Note: If Popup Forms is enabled. Show User Portraits Display user icons on reference-to-user fields. YES Show bookmarking link on login page (normal users) Set this option to true to have a "Bookmark this page" link displayed on the login page. Dialog Title: 'DateTime Picker' Specifies the dialog title for the 'DateTime Picker' Window. e. Option Name Description Auto Refresh Interval Specifies the time interval in minutes. NO URL for Session Timeout URL to which the browser will be redirected when the session timeout expires. Specific stylesheet The web configuration specific stylesheet.aspx). NO URL for End of Session URL to which the browser will be redirected when the user presses the "Logout" button YES URL for Login Limit Exceeded URL to which the browser will be redirected when the maximum number of concurrent sessions for a web guest has been reached. Multiple Values © 2014 OMNINET GmbH . NO Text for Singleton Logout The string to be displayed on the logout page after a single object login. Dialog Title: 'Define List Layout' Specifies the dialog title for the 'Define List Layout' Window. Note: the calender view is not refreshed. after which the object list on the main page is refreshed. Warning: Using this option can have a negative performance impact on the server! In addition the session timeout cannot occur if the list is periodically refreshed. Instead of a static text a system parameter can be used here. from an Email link (see URLs for details) and the user presses the "Logout" button.g.104 OMNITRACKER Web Gateway Manual Label guest login is used. Sessions will not be closed if the main window is displayed! Dialog Title: 'Add Attachments' Specifies the dialog title for the 'Add Attachments' Window. Dialog Title: 'Add Column' Specifies the dialog title for the 'Add Column' Window. The default value is "0" which means the auto refresh is disabled. This option is only used if the option "URL for Singleton Logout" is set to its default value (OTWGSingletonLogout. NO URL for Singleton Logout URL to which the browser will be redirected when the "singleton" option has been used to show a single object. YES Main View Options These options control the display and behavior of the Web Gateway's main page. This option only affects the list and the tree view. Dialog Title: 'Define Tree Layout' Specifies the dialog title for the 'Define Tree Layout' Window.Configuration Dialog Title: 'Define Filter' Specifies the dialog title for the 'Define Filter' Window. YES Hide 'Change Password' Specifies whether the change password button YES © 2014 OMNINET GmbH 105 . Dialog Title: 'Select Task' Specifies the dialog title for the 'Select Task' Window. Disable Appearance Settings Specifies whether appearance settings will affect the objects in the main list. Dialog Title: 'Select Output Format' Specifies the dialog title for the 'Select Output Format' Window. Dialog Title: 'Filter Parameters' Specifies the dialog title for the 'Filter Parameters' Window. Dialog Title: 'Message Of The Day' Specifies the dialog title for the 'Message Of The Day' Window. YES Display custom Icons in Folder Tree Specifies whether custom icons are displayed in the folder tree YES Filter Parameter select Reference Limit Specifies the maximum allowed count of referenced objects that are displayed in drop down lists. Dialog Title: 'Organize Filters' Specifies the dialog title for the 'Organize Filters' Window. Dialog Title: 'Move Attachment' Specifies the dialog title for the 'Move Attachment' Window. Dialog Title: 'Save Filter' Specifies the dialog title for the 'Save Filter' Window. YES Filter Parameter use Quick Search Specifies whether Quick Search can be used on reference fields in the filter parameter dialog. Dialog Title: 'Modify Attachment Description' Specifies the dialog title for the 'Modify Attachment Description' Window. Dialog Title: 'Save View' Specifies the dialog title for the 'Save View' Window. YES Hide 'Change Password' Button Specifies whether the change password button is hidden. Otherwise a text field with a select button is displayed. Dialog Title: 'Set Password Specifies the dialog title for the 'Set Password' Window. Dialog Title: 'Load Filter' Specifies the dialog title for the 'Load Filter' Window. 106 OMNITRACKER Web Gateway Manual Button for Web Guests is hidden for web guests. Hide Filter Specifies whether the filter selection box is hidden. YES Hide Folder Tree Specifies whether the folder tree is hidden. YES Show Message of the Day to Users Specifies whether the Message of the Day is displayed to users. reports) can be displayed. YES Hide Modify Objects Button Specifies whether the Modify Objects Button is hidden. YES Page Size Top Level Maximum number of top level objects displayed at a time in the object list.g. YES Page Size Sub Level Maximum number of sub level objects (tree view only) displayed at a time in the object list. the default text is displayed. The placeholder {0} can be used to display the singular term of the current folder. If empty. YES Hide Shortcut Bar Specifies whether the Shortcut Bar is hidden. Show total Numbers of Specifies whether the total number of objects YES © 2014 OMNINET GmbH . YES Hide Search Form Specifies whether the Search Form is hidden. YES Hide Search Box Specifies whether the search box is hidden. YES Hide Notifications Specifies whether the notifications page is hidden. YES Hide Full-Text Search Specifies whether the full-text search is hidden. Note: The change password button will not be displayed if the guest login uses the option 'Use Windows Login' or does not use a password field. YES Show Message of the Day to Guests Specifies whether the Message of the Day is displayed to guests. YES Hide Views Specifies whether the views dropdown list is hidden. YES Label for 'Logout' Button The string to be displayed on the 'Logout' button. Multilingual strings from System Parameters can be displayed if the following format is used: $? (<Table>.<Parameter>) Label for 'New' Button The string to be displayed on the 'New' button Show Task Specifies whether tasks (e. YES Show Tasks Specifies whether the Tasks dropdown list is hidden. Possible values are "Icon only".45 of 52 out of 104 (50. YES Default style of button array for attachments Specifies the default style of button array for attachments. YES Displayed References Maximum number of objects displayed at a time in a reference list.Configuration Objects in the Object list 107 is displayed. YES Default position of button array for reference lists Specifies the default position of the button array for reference lists. (see "Hints for Performance Optimization" in the administration online help for details. "Text only" and "Icon + Text". YES Hide Toolbar (OK/Apply/ Cancel buttons) Specifies whether the main button bar on object forms is hidden. The total number of objects is 104. Top and Bottom. YES Default style of button array for reference lists Specifies the default style of button array for reference lists. Example how it is displayed in the object list: Objects 1 . Possible values are Left.00%) The current filter or search returned 52 objects. Possible values are "Icon only". You may want to remove this flag for performance reasons. this option defines the number of objects in top and sub levels. Top and Bottom. Option Name Description Multiple Values Confirm closing Form Specifies whether there should be a message box asking the user to confirm the close action if the object has been changed. If a reference list is is displayed using the tree view. YES Display Terminology Specifies whether the terminology is displayed in the form title row. Object Form Options These options control the display and behavior of the Web Gateway's object page. The main button bar contains the following buttons: YES OK Save Cancel © 2014 OMNINET GmbH . Possible values are Left. "Text only" and "Icon + Text". Right. YES Default position of button array for attachments Specifies the default position of the button array for attachments. Right. YES Modern browsers often open popup windows in a new tab. Save and/or Canel button can be hidden. these buttons will by added automatically by the Web Gateway to the end of the object form footer.108 OMNITRACKER Web Gateway Manual Lock (depends on the locking mode of the OMNITRACKER Server) Submit and/or Submit&Copy (if added to the web form) To supply the default actions like "Save" or "Cancel" on your form. you can use the OK/ Apply/Cancel/Lock Buttons item in the Web Form Editor. YES Show Logout Button Specifies whether the Logout Button is displayed in Web Forms. Popup Forms must be activated YES Popup Forms Specifies whether a new window is displayed when an object is opened. If no OK/Apply/Cancel/Lock Buttons item was added to the form. Note: Submit or Submit&Copy buttons cannot be used. YES Lock open Objects Specifies whether objects are locked when they are opened. YES Open all Objects in the same popup Form Specifies whether only one popup window is used to display objects. This behaviour can be changed in the browser settings. Note: Also in the button configuration window the OK. Internet Explorer: Tools/Internet Options/General/Tabs/Settings/ Always open pop-ups in a new window Firefox: Tools/Settings/Tabs/Open in new window instead of new tab Show Attachment Description Specifies whether the description of the respective attachments is in Web Forms displayed instead of the filename/link-url. if the Toolbar is hidden! Highlight required Fields for Workflow Specifies whether the fields that are required for a state transition are highlighted when the transition is selected. YES Show Tooltip on Control Defines whether tooltips should be displayed YES © 2014 OMNINET GmbH . YES Image for "Move" Buttons of attachments URL of the image used for "Move" buttons of attachment lists. YES Image for Logo URL of the logo to display in the upper left corner of the main view. YES Image for "Change Description" Buttons of attachments URL of the image used for "Change Description" buttons of attachment lists. Option Name Description Multiple Values Image for "Add Attachment" Buttons URL of the image used for "Add Attachment" buttons.Configuration on controls. YES Image for "Fast Forward" Button URL of the image used for a button to go 5 pages forward in the object list. YES Image URLs These options specify URLs of images used for icons and buttons. YES Image for "Next" Button (Disabled) URL of the image used for the "Next" button. if it is disabled. Show Tooltip on Label Defines whether tooltips should be displayed on labels. YES Image for "New" Button URL of the image used for the "New" button in the main view. YES Image for Object URL of the image used for each object in the object list. YES Image for "Logout" Button URL of the image used for the "Logout" button. YES Image for Attachments URL of the image used for the attachments column in the main view. YES Image for "Add Reference" Button URL of the image used for a button in the object form for adding references to existing objects. YES Image for "Fast Forward" URL of the image used for the YES © 2014 OMNINET GmbH 109 . YES Image for "Next" Button URL of the image used for a button to go to the next page in the object list. YES Image for "First" Button (Disabled) URL of the image used for the "First" button. Image for "First" Button URL of the image used for a button to go to the first page in the object list. YES Image for "Remove Reference" Button URL of the image used for a button in the object form for removing references. if it is disabled.110 OMNITRACKER Web Gateway Manual Button (Disabled) "Fast Forward" button. if it is disabled. YES Image for "Rewind" Button (Disabled) URL of the image used for the "Rewind" button. YES Image for "Open Reference" Button URL of the image used for a button in the object form for opening a referenced object. YES Image for "Save" Button URL of the image used for the "Save" button in the object form. YES Image for "Move" Buttons of attachments URL of the image used for "Move" buttons of attachment lists. YES © 2014 OMNINET GmbH . YES Image for "Remove Attachment" Buttons URL of the image used for "Remove Attachment" buttons. YES Image for "Previous" Button (Disabled) URL of the image used for the "Previous" button. YES Image for "Main View" Button URL of the image used for the "Main View" button in the object form. YES Image for "Rewind" Button URL of the image used for a button to go 5 pages back in the object list. YES Image for "Last" Button (Disabled) URL of the image used for the "Last" button. YES Image for "Last" Button URL of the image used for a button to go to the last page in the object list. YES Image for "Previous" Button URL of the image used for a button to go to the previous page in the object list. if it is disabled. if it is disabled. if it is disabled. YES Image for the Search Form "Minimize" Button URL of the image used for the "Minimize" button in the search form.Configuration Image for "Select all matching current filter" Button URL of the image used for the button in the navigation toolbar to select all objects matching filter. YES Image for the Search Form "Search" Button URL of the image used for the "Search" buttons in the search form. YES Image for the Search Form "Reset" Button URL of the image used for the "Reset Search" buttons in the search form. YES Image for the Search Form "Add Reference" Button URL of the image used for the "Add Reference" buttons in the search form. YES Image for the Search Form "Remove Reference" Button URL of the image used for the "Remove Reference" buttons in the search form. YES 111 Remote Authentication Options These options define the settings if external authentication is used Option Name Description Multiple Values Remote Authentication URL Specifies the URL of an external authentication server NO Client Certificate for Remote Specifies which client certificate shall be used Authentication for authenticating the OMNITRACKER server. YES Image for "Unselect all" Button URL of the image used for the button in the navigation toolbar to unselect all objects. YES Image for the Search Form "Remove Reference" Button (Disabled) URL of the image used for the disabled "Remove Reference" buttons in the search form. YES Image for the Search Form "Maximize" Button URL of the image used for the "Maximize" button in the search form. NO XSL Transformation for Remote Authentication NO © 2014 OMNINET GmbH Contains an optional XSLT transformation which converts the answer of the authentication server into the XML document format expected . YES Image for the Search Form "Add Reference" Button (Disabled) URL of the image used for the disabled "Add Reference" buttons in the search form. © 2014 OMNINET GmbH . Guest logins provide access to the OMNITRACKER for external persons ("guests"). you may want to provide the possibility for your customers to read a FAQ list.112 OMNITRACKER Web Gateway Manual by OMNITRACKER.3 Description Multiple Values User Name Header Specifies the name of the request header which contains the login name (optional). 2 = lowest) Specifies under which conditions the Browser requests the login data from the user using basic authentication NO Guest Login Properties Window Introduction This window is used to edit a guest login setting for the Web Gateway. Basic Authentication Options These options define the settings if basic authentication is used Option Name 4..5. NO Forbidden User Names A regular expression which defines which users cannot use basic authentication NO Allowed User Names A regular expression which defines which users are allowed to use basic authentication NO Security Level A number from 0 to 2. (0 = highest security level. For example. or to create new incidents. This number must be used in the Web Gateways Login URL to access the OMNITRACKER through this guest login. YES Name Name for this guest login setting YES Root Folder Restricts access through this guest login to the specified folder and its subfolders.. meaning that all folders can © 2014 OMNINET GmbH ." opens a window to select a root folder. Pressing ".Configuration 113 Layout Window Description Title Description Required ID Unique numeric ID to identify this guest login setting.. Pressing "x" removes the root folder setting. The login folder must be specified if "Login required" is checked. select the respective zone and click "Adjust settings") is set in the Internet Explorer. activate "Integrated Windows authentication" instead. Default Folder The folder that is selected after login to the Web Gateway. The following modes are possible: 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. This user will be the current user in all sessions established through this guest login. Login Folder The folder containing authentication information. meaning that this user's privileges and permissions define what information can be accessed and/or modified through this guest login. The login page will not be displayed to the user. Login Mode Specifies whether authentication is requried or not.. Deactivate this in the IIS Manager (inetmgr. User The OMNITRACKER user associated with this guest login. The login field in the login folder must contain the LDAP user name of all users that will use this guest login. Pressing ". In this case.exe). make sure that the following options are set correctly: The option "Automatic login using current user name and password" (open "Tools | Internet options | Security". The user name must be unique for all objects in the login folder!) Windows Login: If you want to use this option. in the properties dialog of your Web Gateway directory.) LDAP Profile (the users have to enter their LDAP user name and password into the login dialog. © 2014 OMNINET GmbH ." opens a window to select a login folder. 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. open the tab "Directory security" and deactivate the option "Anonymous login". 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.) 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.114 OMNITRACKER Web Gateway Manual be accessed through this guest login (depending on the user's permissions). Login Limit This field is optional and specifies how many concurrent sessions a Field guest may use.. " opens a window to select a password field. If no password field is specified. the name of the OMNITRACKER user which is associated to this guest login will be displayed. Login Field The field in the login folder (or a referenced folder) containing the login names for the guest login. To create the name of the guest login object. the guest may always login.. 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. the guest can login as many times the value is. The url of this page can be modified in the Web Gateway Configuration Window under "General Options". the user is redirected to a page that tells him that the maximum number of sessions has been reached. If no label is specified. authentication information also will be searched in all subfolders of the configured login folder.. Important Notes: After changing this setting. Create © 2014 OMNINET GmbH If this box is checked. If this box is not checked. Recursive If this box is checked.. When the fields value is 0. existing history/memo entries will not be adapted. 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. Pressing "x" removes the password field setting... this information will be displayed in the history entries). If no label is specified. Press the ".Configuration Leave this setting empty if you don't want to limit the sessions. the object page for creating a new object will be 115 . Login Label Optional label for the login edit box on the login page. the password box is labeled "Password" (or the equivalent in the current language)." opens a window to select a login field. When a guest wants to login and the login limit is reached. Therefore it should be checked. Additionally id a guest login object is deleted. the guest never can login the Web Gateway When the fields value is greater than 0. users will be able to log in using only the login name and no password. the existing history and memo sections will not altered. When the fields value is empty. Password Field Optional field in the login folder (or a referenced folder) containing the passwords for the guest login.. the naming scheme of the login folder will be used. Password Label Optional label for the password edit box on the login page. Pressing "." button to select a field that contains a limit for this guest. integer and long are supported. Only fields of the types byte. Pressing ". the login box is labeled "Login" (or the equivalent in the current language). The login field must be specified if "Login required" is checked. Show Name of Guest in History and in Memo Sections If this box is checked. In future versions. these actions still do not apply web guest base filters. after migration to 8. If the folder contains subfolders. The text representation of the filter is displayed below the button. Apply web guest base filters also in server side actions In versions before 8. the flag "use folder base filter". 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. In versions before 8. Therefore.1 or later.116 OMNITRACKER Web Gateway Manual new object in folder. the main page will be displayed after logging in..1. Combo scripts and Actions which are triggered by object modifications) did not consider web guest base filters. Edit rule. displayed to the user right after logging in.. because this might be important for existing configurations to work. 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.1. Rule: The rule which is used to restrict the objects in the given folder. this folder was the last selected folder for the OMNITRACKER user defined for this guest login. If this box is not checked. The folder in which the object will be created must be selected below. If a root folder is defined. so you should set the flag as soon as possible to "true". then the login is treated as a singleton login. the base filter also applies to them. so you should set the flag to "Ignore base filter and use this rule" as soon as possible. Click this button to define a rule by which the objects in the "Login folder" are filtered. Important Note: We recommend you strongly to use a separate filter for the active guests. You can use any property of the web guest login object and © 2014 OMNINET GmbH . so you have the possibility to define a separate filter to determine the active guests. you can only select folders below the root folder as the folder for object creation. Note: If an anonymous login is used. Important Note: We recommend you strongly to have web base filters applied in server side actions after you have checked if your actions still work with web base filters enabled. The default filter is an empty filter. This flag will be removed in a future version.. During migration. In this case. select "Ignore base filter and use this rule". Base Filters List of base filters. users This might be unwanted. afterwards a logout is performed. which restrict the objects that the user can access through the guest login. will be removed.. server-side actions (this means here Tasks. This means the user only has the possibility to create one new object in the specified folder. the last selected folder of the user is copied to the web guest login definition. because the rule editor offers some special comparisons which require an authenticated person (guest object). Note: If you change the login folder. if the guest creates a new object from the shortcut bar). overwriting existing field entries. all base filters will be deleted. If the base filter tries to match a reference field of the filtered folder with the web guest login object. Add Base Filter..Configuration any property of the filtered objects for your rule. existing web base filters will be transformed to the new form. Delete Deletes the selected base filter(s)... The web guest login object will be used as the source object for this field mapping.1. It was possible to define a base filter which compares uncomparable fields. These filters always returned 0 matches. Edit Base Filter. the field mapping on the base filter is applied afterwards. The order in which they were evaluated was undefined. therefore such base filters are converted to a rule "Unique ID = 0".. all the base filters are combined (with "AND") and there is a message in the server control panel. In this case. Opens the Guest Login Base Filter Window to edit the selected base filter. If Anonymous login mode is selected. If these base filters used a reference field for matching. earlier versions allowed the user to define inconsistent web base filters: It was possible to define multiple base filters for one folder. for example "Reporting Person (which is a reference) = Last Name (which is a text field)". If there is another mapping for the creation of new objects (for example. it's not possible to define base filters. if such a case is detected during migration. Opens the Guest Login Base Filter Window to add a new base filter. There is also a message in the server control panel which informs you that you have to resolve this manually. a field mapping will be generated and used for the new base filter. In this case. Notes: If you migrate from a version before 8. Field mapping: The field mapping used to create a new object in the given folder. To make a base filter valid for a specific guest login. Base Filter © 2014 OMNINET GmbH 117 . Rules for anonymous guests must be defined in the folder definitions base filters. no field mapping is created. Therefore. Unfortunately. a new object cannot be filled with the web guest login object if the folders don't fit. it must be combined with the Ot-User account which is used in the guest login definition. You have to resolve this ambiguity later. this reference field was filled with the web guest login in earlier versions. Please refer to the Guest Login Properties Window for a detailed description of base filters.118 4..5.)". © 2014 OMNINET GmbH . the base filter also applies to them. Pressing ". YES Edit rule.... the Field Mapping Definition Dialog pops up which allows you to define a new field mapping in the target folder with the login folder as the source folder.4 OMNITRACKER Web Gateway Manual Guest Login Base Filter Window Introduction This window is used to edit a base filter for a guest login." opens a window to select a folder.... The folder to which this base filter applies.if the following rule applies: Displays the rule used for matching.. YES . Edit. Opens the rule editor to define the rule Field mapping for creation of new objects This combobox contains the list of field mappings in the folder defined above. In addition only field mappings without restriction filters are listed and can be used here. Only those field mappings whose source folder is the login folder or one of its parents are shown in the list.. Opens the Field Mapping Definition Dialog for the currently selected field mapping.. The last item of the dropdown list is "(Add new... Layout Window Description Title Description Required Display an object in the folder . If you select this item. If the folder contains subfolders. For options that allow multiple values (see the tables in Web Gateway Configuration Window). the window looks as follows: For options that do not allow multiple values. the window is somewhat simplified: © 2014 OMNINET GmbH . Please refer to the Web Gateway Configuration Window for a list of available options. depending on the configuration option that you are editing.5.5 119 Web Configuration Option Window Introduction This window is used to edit the values of a configuration option for the Web Gateway.Configuration 4. Layout There are two slightly different versions of this window. This button is only available for configuration options that allow multiple values. but it is actually not part of the web configuration and is not stored in the database. Shows a description for the option you are currently editing.120 OMNITRACKER Web Gateway Manual Window Description Title Option Description Values Description Required Shows the name of the option you are currently editing. which is essentially identical to the Filter Properties Window. Value: The value associated with the rule. Edit Rule. If this list contains more than one value. The default value cannot be changed or moved in the list. If no rule matches. To illustrate this.. Opens the "Edit rule" window.. the default value is used. Delete Value Deletes the selected value(s) from the list. List of values with the following columns: Rule: Specifies the condition under which this value applies. © 2014 OMNINET GmbH . If you are editing an option that does not allow multiple values. then this list cannot contain more than two entries (one for the actual value and one for the default value). The first rule that matches determines the value to be used. the value that applies at a given time is determined by evaluating the rules in the order specified by this list (from top to bottom). the default value is always displayed at the bottom of this list. or <default> for the default value. to edit the rule for the selected value. or a text box in which you can enter a value. with the rule <always> and the value specified in "New Value". this may be either a drop-down list of possible values. This button is only available for configuration options that allow multiple values. Reset Value Resets the configuration option to its default value. 4. This button is only available for configuration options that allow multiple values. This button is only available for configuration options that do not allow multiple values. Set Value Sets the configuration option to the value specified in "New Value". Add Value Adds a new entry to the list of values.6 Web Configuration Import Wizard . The following information can be imported: Configuration options Guest logins Hidden fields Web forms The wizard can be accessed from the Web Gateway Settings Window.config and OTWebGW. Specifies a new value that will be inserted into the list of values when you press "Add Value". This button is only available for configuration options that allow multiple values. This button is only available for configuration options that do not allow multiple values. The wizard's first page is used to specify some settings for the import process.Configuration 121 This button is only available for configuration options that allow multiple values. Up/Down arrows New Value Moves the selected value up or down in the list. "Change Value" or "Set Value".5.Settings Page Introduction The Web Configuration Import Wizard allows you to import configuration information from Web. © 2014 OMNINET GmbH . Depending on the configuration option you are editing.config files used by previous versions of the OMNITRACKER Web Gateway. Change Value Changes the selected entry in the list of values to the value specified in "New Value". config Description Required Location of the Web. Pressing "Browse" opens a file selection dialog to browse for the file. You can leave this field blank if you only want to import a Web. If you specify the name of an existing configuration. If you leave this field blank. Pressing "Browse" opens a file selection dialog to browse for the file.122 OMNITRACKER Web Gateway Manual Layout Window Description Title Web.config file. Name Name of the Web Gateway configuration into which you want to import the configuration information. this configuration will be modified with the imported information (you will be prompted to confirm this). You can leave this field blank if you only want to import an OTWebGW.config .. then the specified Web. Modify Web. the configuration's description will remain unchanged if it already exists.co nfig Location of the OTWebGW.config file will be modified as follows at the end of the import procedure: YES All recognized and imported elements in the section © 2014 OMNINET GmbH .config file to import. If this box is checked.config file to import.config file. OTWebGW. Description Optional description for the imported web configuration.. You will get a chance to review the analysis results on the wizard's Results Page before you decide to import the information into the database. Next 4.5. It allows you to review any errors that were found during analysis select which items you want to import specify names for the imported web forms No changes will be made to the OMNITRACKER database until you press the "Finish" button.Results Page Introduction This wizard page displays the results of analyzing the configuration files selected on the Settings Page. No changes will be made to the database at this time.Configuration 123 <configuration> / <appSettings> will be deleted. © 2014 OMNINET GmbH . Web Configuration Import Wizard . If you check this box. as specified in the "Name" box above.7 Starts the analysis of the selected configuration files. The following element will be added to the section <configuration> / <appSettings>: <add key="OT_configuration" value="name"/> where name is the name of the imported web configuration. it is advisable to make a backup copy of the Web. These modifications will instruct the Web Gateway to retrieve its configuration information from the web configuration that was just imported into the OMNITRACKER database.config file before proceeding. If you are importing into an existing web configuration. The item list is structured as follows (depending on the configuration files you are importing.g.124 OMNITRACKER Web Gateway Manual Layout Window Description Title The following items . which allows you to control which items will be imported. © 2014 OMNINET GmbH . the existing configuration options will remain unchanged if you uncheck this item.config: Represents all importable elements from the <configuration> / <appSettings> section of the Web.. You can also use the checkbox of a section heading (e. "Guest Logins") to check or uncheck all the items in that section at once. Description Required List of importable items that were found during analysis of the configuration files.. They will be imported as configuration options into the web configuration that you specified on the Settings Page.config file. If any errors were found during analysis. not all of these items may be available): Options from Web. they are displayed together with the corresponding item and marked with this icon: Each importable item has a checkbox. config file will be imported as "visible" permissions into the corresponding folders (see the Permissions Subpanel in the folder definition).Configuration Guest Logins: Contains the guest login settings defined in the <guestlogins> section of the OTWebGW. 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. Since web forms need to have unique names. Error Details. If you enter a name that already exists. Web forms are not part of the web configuration. Hidden fields: Represents the information from the <hiddenfields> section of the OTWebGW.config file will be imported as the corresponding configuration options ("Hide Filter". the wizard automatically generates names like "ImportedWebFormNNN" (where NNN is a number). 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.config file. but the permission rules will contain a condition referring to the configuration that you specified on the Settings Page.. the three options mentioned above will remain unchanged if you uncheck this item..config file.config file. Visible Permissions: The <hiddenfield> elements from the OTWebGW. any existing guest login settings will be replaced only if they have the same ID value. Existing web forms are never overwritten. Permissions are not part of the web configuration. 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). If you are importing into an existing web configuration. This information is split into two different types of importable items: Options: The elements <hiddenfilter>. You can change these names using the "Form Name" box and the "Change Name" button (see below). This ensures that the newly imported web forms will not interfere with any other web configurations. They will be imported into the web configuration that you specified on the Settings Page. but they will be associated with form conditions referring to the configuration that you specified on the Settings Page. "Hide Folder Tree" and "Hide Full-Text Search") into the web configuration that you specified on the Settings Page. <hiddenfoldertree> and <hiddenfulltextsearch> from the OTWebGW. If you are importing into an existing web configuration. © 2014 OMNINET GmbH Opens a window to display detailed information about the 125 . 1. This button is only enabled when you select an error (marked with the icon ) from the list. If an error occurs during import (e. This button is only enabled if a web form is selected in the list.6. which means that you cannot uncheck them anymore (because they are already in the database). if a web form with the same name already exists).126 OMNITRACKER Web Gateway Manual selected error. Finish Imports the checked items into the database. you can uncheck the item that caused the error.6.6 Web Forms 4. Change Name Changes the name of the selected web form to the name you entered in the "Form Name" box.g. © 2014 OMNINET GmbH . It is used to edit a web form. an error message is displayed and the list of items is updated.1 Web Form Editor Window Introduction This window can be accessed from the Forms Subpanel in the folder definition. Form Name Allows you to enter a new name for the selected web form. Press the "Finish" button to try importing the remaining items again. Back Goes back to the wizard's Settings Page. For example. You can also change the names of the web forms that have not been imported yet. All items that were imported successfully are marked with the icon instead of a checkbox. in order to skip importing that item. which defines how objects in this folder are displayed by the Web Gateway.1 Web Form Editor Window 4. You can also define search forms using a similar dialog. 4. This field is only enabled if a web form is selected in the list. You can still check or uncheck the remaining items. all text in the form (including labels. no matter what characters it contains.. Allow HTML tags in texts If this box is not checked.) will be displayed just like you enter it." button to add or remove languages. and not to use the "&" character by itself. Please make sure to check the box before entering any HTML tags. The available choices depend on which languages are defined in the form. you will have to take special care not to use the characters "<" and ">" outside of HTML tags. text elements etc. If this box is checked.Configuration 127 Layout Window Description Title Description Current Language Allows you to select the language in which the form is currently displayed and edited.. Translations Opens the 'Translations button' context menu with further multilingual features. Edit Theme. Add Theme. Press the "Select Languages.. Allows you to edit the current selected theme. Any HTML tags you enter will also be displayed literally and not have the intended effect. Current Web Theme Allows you to select the theme which defines the design of the form.. This allows you to specify special formatting in your texts. Allows you to add a new theme. However... You have to replace these characters by the following codes: © 2014 OMNINET GmbH . any HTML tags you enter will have the intended effect. (The following PerformAction methods are causing redirects: change_to_folder. This means that other elements like the shortcut bar or the pane tabs are hidden. Suppress Form Title Fullscreen mode If this box is checked. it is your responsibility to use the replacement codes in any text you enter after checking this box. Therefore. However. & &amp. If you change this checkbox from checked to unchecked. Add/Modify "OnSave" script Allows to add or modify a script which is executed if an object is saved (only available on object forms) Add/Modify Allows to add or modify a script which is executed if a search is © 2014 OMNINET GmbH . the Form will be opened in "fullscreen mode" (comparable with a modal dialog).128 OMNITRACKER Web Gateway Manual Character Replaceme nt < &lt. If multiple objects are displayed in the breadcrumb bar. Whether this checkbox is set on opening the web form editor does not only depend on the value you set during the last session of the form editor but also if the form contains HTML labels. they will lose their special meaning and be displayed literally. then the current object is cancelled and closed. If there is no HTML text in the form. these replacements will be done automatically in all existing text. and if at least one of the displayed objects uses the "fullscreen mode". You cannot undo this by simply checking the checkbox again (because then the replacements described above would be applied to all "<" and ">" characters. you will be asked to confirm this step. If a comboscript is invoked on a form which uses "fullscreen mode" and if the script causes a redirect to another page. (The title always is displayed on the corresponding panes tab button) If checked. and the form already contains HTML tags. the form title will not be displayed in the Web Gateway object form if "Popup Forms" is enabled. Add/Modify "OnOpen" script Allows to add or modify a script which is executed if the form is opened. Then it will not be possible to define "Enabled if" rules on the tab "Display". the box is unchecked on reload. > &gt. Whether controls are enabled or not depends on the "Enabled if" rule or script which was defined on the field definition page. If you change this checkbox from unchecked to checked. The user cannot switch to another page (except child forms if a referenced object is opened) until the object is closed. open_object and open_new_object) Use enabled flags from field definitions If checked. then all objects are shown in "fullscreen mode". the "enabled if" flag from the field definition is respected in web forms. including the ones belonging to the former HTML tags). . You will be asked to confirm this step. text elements. Clear Form Deletes the contents of the form in all languages. The Web Gateway will display the form header near the top of the page. The header may contain the same types of items. and any tabs will be displayed below the header (see the Object Page for an example). Optionally. The tabs contain sections. The form always has a header (shown as "(Header)"). it may contain one or more tabs. (Header) . command buttons.. attachments and history. This part of the Web Form Editor represents the web form itself. The contents of the header or the currently selected tab are shown in a hierarchical grid. task buttons. 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) © 2014 OMNINET GmbH . which may in turn contain fields.Configuration "OnSearch" script 129 performed (only available on search forms) Edit visibility mode/ Edit form mode Click this button to switch from "Edit form mode" (this is the default) to "Edit visibility mode" (see below for details) and back. New Task Button: Inserts a new task button 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. but no tabs. Send Email Button: Inserts a send email button after the currently selected item.. There are different icons for different field types: © 2014 OMNINET GmbH . If a field is added to the form. New Object Fill Button: Inserts a new object fill button after the currently selected item. For object forms. OK/Apply/Cancel Buttons: Inserts the command buttons to save or cancel the modifications. Double-clicking a tab. This item is only available in object forms. The following items are available: New Tab: Creates a new tab. These buttons can be used instead of the Toolbar in the Web Gateway. section.130 OMNITRACKER Web Gateway Manual Memo Field Reference to user Field Timestamped Memo Field Other Field History When an item is selected. or by selecting it and then clicking "Add". Note: Only the local fields from the current folder can be placed multiple times on web forms. This item is only available in object forms. its properties are shown in the properties box near the bottom of the window. Referenced fields. the number of occurrences on the form is displayed behind the field name (number in brackets). field or task button opens the Edit Multilingual Text Window to edit the item's label. fields can be placed multiple times on the form. History: Inserts an item representing the object's history after the currently selected item. New Section: Inserts a new section at the end of the current tab. New Object Create Button: Inserts a new object create button after the currently selected item. (Footer) . This item is only available in object forms. and quick search fields for reference lists can only be added once to the form. This item is only available in object forms. Shows all items that you can insert into the form. It can contain the same types of items as the header. This item is not available in the form header and also not in search forms. This item is only available in object forms. Available Items This part of the Web Form Editor is placed below the header. New Text: Inserts a new text element after the currently selected item. You can insert an item by double-clicking it.. These Quick Search Fields can only be added once to the form.Title" to a web form.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 Quick Search Field (only available for fields of type "list of references") If a field is a reference list on the topmost level. © 2014 OMNINET GmbH . Quick Search Fields are listed as subelements of the reference list.or dropdown fields. the field "Customers.Title" shows the title of the object which currently is selected in the reference list "Customers". it is accessed via a reference chain). If the referenced folder does no contain text. On the object form. until they are added to the form. "Customers. If no object is selected. If the web form is opened. Example: In any folder you have a reference list control to the folder "Customers". the subelements of reference lists will show data if exactly one object is selected in the parent reference list. You added the Field "Customers" and the subelement "Customers.and dropdown fields. its subelements are only available for adding if the field is on the form. no Quick Search fields are listed. Quick Search is only possible on text. In folder Customers is a Text field named "Title". If a field is a reference list on a lower level (this means. Subelements of "reference to single object" fields are always listed. the subelements of the reference list are not available.Title" is displayed as empty field. including <no filter> and . Its subelements are described below. If the checkbox is not present. "Search\Filter list" cannot be added to the form. Search\<Field path>: Adds a control (the control's type depends on © 2014 OMNINET GmbH . Filter\Filter List: Adds a drop-down list to the search form in which all visible filters of the current folder are displayed. If the checkbox is not present. All field types are supported here. "Filter" and "Search". "Full-text search". Search\Filter List: Adds a drop-down list to the search form in which all visible named filters of the current folder are displayed. Search\Search: Adds a button to the search form to initiate a search. Full-text search\Recursive full-text search: Adds a checkbox to the form indicating whether to perform the search recursive or not. Search\Reset: Adds a button to the search form to reset the search form's content. Full-text search\<Fieldname>: Adds an edit field and a button to perform a full-text search on the selected field. the fields are combined with AND. the search is performed recursive. Note: A click on the search button only performs a fulltext search on the linked field. If the checkbox is not present. If this item is on the form.if present . the search is performed non-recursive. It's not possible to combine this search with other search fields or with a filter. If the checkbox is not present the filter is applied non-recursive. If this item is on the form. "Filter\Filter list" cannot be added to the form. Search\AND Combination: Adds a checkbox to the search form to indicate whether the search fields are combined with a logical AND (if checked) or with a logical OR (if not checked). there are three top-level nodes. Search\Recursive: Adds a checkbox to the search form to indicate whether the search is performed recursively. Filter\Filter Menu: Adds a drop-down list to the search form to edit and manage filters.<user defined>. only fields of the current folder are allowed. Search\Search + Execute Task\(Select Task): Adds a button to the search form to open a dialog in which the user can select a task to perform on the objects the search returns. Full-text search\Search string: Adds an edit field and Search/ Reset buttons to the search form. Filter\Edit Filter Parameters: Adds a button to the search form to open a dialog in which the user can edit filter parameters. Filter\Display Filter Parameters: Adds a text label to the search form which displays filter parameters and their values if present.132 OMNITRACKER Web Gateway Manual For search forms. Filter\Recursive Filter: Adds a checkbox to the search form indicating whether the filter is to be applied recursively. Search\Search + Execute Task\<Taskname>: Adds a button to the search form to perform the selected task on the objects the search returns. then click the left or right arrow button. Toggle Width Toggles the selected item's width between single column width and whole page width. Currency. click on the tab and select the line with the tab icon . Only fields and task buttons can have single column width. Depending on the type of the selected item. The left and right arrow buttons can only be used for tabs and for fields or buttons with single column width. Date. Floating-Point and Integer fields. Arrow buttons These buttons move the selected item in the direction of the arrow. Date. Properties This box is used to display and edit the properties of the currently selected item in the form. Combine Filter and Search: Adds a checkbox to the form indicating whether the currently defined search should be ANDcombined with the selected filter. If the box is not present. .Configuration 133 the field type) to the form to enter a value to search for. It adds a control (dropdown or edit) to the form in which you can enter a maximum field value.General Field Properties . Add Remove Adds the selected item from the "Available Items" list to the form.Size Field Properties . Dropdown. Search\<Field path>\(Min value): This is available in Autonumber. Floating-Point and Integer fields. Removes the selected item from the form. Search\<Field path>\(Max value): This is available in Autonumber. Dropdown. all other items always cover the whole page width.Visibility Field Properties . To move a tab left or right (changing the order of the tabs). It adds a control (dropdown or edit) to the form in which you can enter a minimum field value. Currency.Columns Field Properties .Extended © 2014 OMNINET GmbH . the following subpanels are displayed: Ic Item Type on Subpanel(s) Tab Tab Properties Section Section Properties Field Field Properties ... 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.Values Field Properties Reference Field Properties . filter and search are not combined. 134 OMNITRACKER Web Gateway Manual Text Text Properties .. In addition to the standard keys for window navigation. Keyboard Navigation The Web Form Editor can also be controlled using the keyboard.Extended Recursive full-text search Search Form Checkbox Properties Recursive Filter AND Combination Combine Filter and Search Recursive search For field items. Opens the Web Themes Window to add/modify/delete/rename/export/ import themes..General Text Properties . Which of them are shown depends on the field type. 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. the following keys are supported. Button Configuration. Opens the Web Form Button Configuration Window to configure the buttons for this web form (only available for object forms) Preview. not all the subpanels listed above are shown.Visibility (object form only) Button Create Object Button Properties Fill Object Button Properties Task Button Properties Command Button Properties Search + Execute Button Properties History Field Properties .. Some of them have different meanings depending on the current focus location within the window... Key Focus Location Ctrl + Tab Outside of the properties box Ctrl + Shift + Tab Description Switches between the header and each tab of the form © 2014 OMNINET GmbH .. Leaves the properties box and sets the input focus back to the selected item in the form contents. © 2014 OMNINET GmbH . This is very useful if you want to set the visibility or enabling rule for many items as a batch. Ctrl + arrow keys Form contents Moves the currently selected form item into the direction specified by the arrow. Arrow keys Form contents Moves the selection mark through the form contents in the direction specified by the arrow. you can have the web form displayed in a hierarchical form. if possible. if there is more than one. Return "Available Items" Esc Inside the properties box Del Form contents Adds the selected item from the "Available Items" list to the form. especially if the rule is complex. Removes the currently selected item from the form. Edit visibility mode By clicking on the "Edit visibility mode".Configuration Ctrl + Tab Inside the properties box Ctrl + Shift + Tab 135 Switches between the subpanels in the properties box. Return Form contents Sets the input focus to the properties box for the currently selected item. This is equivalent to clicking the "Add" button. This is equivalent to clicking the corresponding arrow button described above. This is equivalent to clicking the "Remove" button. All tabs on a web form will be surrounded by an own expandable section.. "<multiple rules>" is displayed.136 OMNITRACKER Web Gateway Manual If you select multiple items in the tree view.6. as the user can read the data from the page source.2 Tab Properties Subpanel Introduction This subpanel is used to display and edit the properties of a tab in the Web Form Editor. If all selected items use the same rule. Layout © 2014 OMNINET GmbH . 4. this feature is not suitable for hiding sensitive data from underprivileged users. not security. The intent for this feature is convenience. Important Note: If tabs are hidden with this functionality. the common rule is displayed in the text field.. By clicking "Edit rule. Therefore.1. Use permissions to hide data from underprivileged users. you can edit the enabling or visibility rule for all selected items. the visibility section below automatically displays only the rules that can actually be applied to all selected items. Otherwise.". their content's data is still contained in the HTML page which is transferred to the user. The left side of the rules can contain the following properties: Current user (or proxy) Web configuration Unique ID of current object User fields of the current object with the type Boolean.1. Section Properties Subpanel to configure the rules).a.3 This subpanel contains the rule definitions for expanded by default. Workflow. Referenced fields are also allowed.." opens the Translation Dialog to edit the different language versions of the tab's label..Configuration 137 Window Description Title Label Tooltip Description Required The tab's label in the current language. Reference to user or Reference to request. © 2014 OMNINET GmbH . Pressing ". Section Properties Subpanel Introduction This subpanel is used to display and edit the properties of a section in the Web Form Editor. Dropdown.6. Click these buttons to edit the respective rule.. Break row Check this box to have the following tabs displayed in the next after this tab row. The tab's tooltip in the current language. Edit rule. This subpanel will contain the same configuration for all used tabs (s. visible and enabled of the surrounding section. 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. 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.. Section 4. By default. Pressing ".. Absolute (pixel) and relative (percentage) statements are possible.e.By default. Left column width By default the left and the right column have the same size. i. the section will be displayed by default as expanded by default. Expandabl This checkbox indicates whether this section can be expanded or e collapsed by the user. which is equivalent to "<always>". If this checkbox is not selected a section will always be displayed as expanded but can not be collapsed by the user. If this checkbox is not selected. If this checkbox is not selected. i. Example: If the value "80%" is entered here. 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. which is equivalent to “<always>”. i. the © 2014 OMNINET GmbH . The size of the left column can be overwritten here. the "Expanded by default if" rule and the checkbox left of the rule are not editable.e. Checkbox This checkbox indicates whether the "Expanded by default" rule has be Expanded evaluated.e. this rule is empty. regardless of the "Expanded by default" rule. the section is always visible.e. This rule will only be evaluated if the "Expandable" checkbox and the checkbox left of this rule are selected. which is equivalent to "<always>". By default. this rule is empty.. Visible if 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 checkbox is not selected. this rule is empty. Expanded This text box contains the rule which must evaluate to true for the current by default if object in order for this section to be expanded by default.138 OMNITRACKER Web Gateway Manual Layout Window Description Title Description Required Label The section's label (i. the right column will only use 20% of the whole object form width." opens the Edit Multilingual Text Window to edit the different language versions of the section's label. the section is always expanded by default. the text for the section header) in the current language. the “New” and “Old” field values are identical and both refer to the values from the database. when the user changes the state to “In Progress”. Referenced fields are also allowed. 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. the section would be collapsed after it became visible. the section becomes visible and it is expanded because the new state is “In Progress” and therefore “State (new) = In Progress” evaluates to “true”. Workflow.) © 2014 OMNINET GmbH . Click these buttons to edit the respective rule. “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. (If the rule were “State (old) = In Progress”. Reference to user or Reference to object. For object forms the rules can contain “old” and “new” field values. DropDown.. Edit rule. For example.Configuration 139 section is always editable.. “Old” means the field values stored in the database. 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. the tooltip text is displayed in a message box. Before using "OnChange" scripts.. or a link can be opened." opens the Edit Multilingual Text Window to edit the different language versions of the field's label. Possible values are "Left". If checked. Layout Window Description Title Label Tooltip Description Required The field's label in the current language. Label position Add/Modify "OnChange " script Read-only Specifies the position of the field's label. In this case the label is displayed as a link in the Web Gateway. please read the scripting hints.. Pressing ". Example: The tooltip text "link:http://myserver/help/default. Note: Multiline text can be entered here. In addition." opens the Edit Multilingual Text Window to edit the different language versions of the field's tooltip. By clicking on the label. A combination of both (show text and open link) is not possible! Either a text can be displayed..General Subpanel Introduction This subpanel is used to display and edit the general properties of a field in the Web Form Editor. Allows to add or modify a script which is executed if the field was modified by the user.4 OMNITRACKER Web Gateway Manual Field Properties .e. In this case the prefix "link:" followed by the url can be entered as tooltip.aspx" opens the site "http://myserver/help/default.aspx" in a new browser tab/window.140 4. This subpanel is available for all field types.. the user will not © 2014 OMNINET GmbH . The field's tooltip in the current language. this field will be displayed as read-only.1. a link to an external web site can be opened by clicking the label in the Web Gateway.6. Pressing ". "Top" or "Hidden". i. if the web form label is clicked. and dropdown fields are listed. the users can perform Quick Searches for this field in the Web Gateway. If set. If set. Only text. Show 'Move' Button This row only appears for attachments fields. If the target field is "(select field)" and the user doesn't see any possible target field. a dialog is displayed to the user asking him to select a target field. 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. you can define the target field for the "move" operation. In this case. If set. a "(select field)" option is offered. never for fields which should not be seen by the user. In the dropdown list. Enable Quick Search Button This row only appears for "reference to object" fields. the field's content is transferred in plain text to the client. This subpanel is only available for fields of type "Reference list of objects". the user can see the field's content in the page source code. If the current user doesn't see the target field (due to permissions. © 2014 OMNINET GmbH . The box is checked by default for encrypted text fields. The row is only enabled if there are at least two attachments fields on the current web form. Important note: Although the field's value is not directly visible to the user. the move button is also disabled. In the dropdown list on the right of this button.5 Field Properties . the administrator must select on which field of the referenced objects the search will be performed.6.1. for example).Configuration 141 be able to modify it. 4. The dropdown list contains all attachments fields except for the current one which are present on the web form. the field will appear as a password field. Password field: This checkbox appears only for text fields. In addition to this. You should only use this option for fields where users might enter hidden information. Therefore. the move button is disabled.Columns Subpanel Introduction This subpanel is used to display and edit the column layout of a reference list field in the Web Form Editor. .."). Each column is represented by a field name. the Web Gateway uses the view layout identified by the context number to display the list of references. respectively. Page size top level Determines the max. List layout context Specifies a context number that identifies a specific view layout in the OMNITRACKER database. Delete Column Deletes the selected column(s) from the list.. number of objects which are displayed in the sub levels if the tree view is used. which is defined in the Web Gateway Configuration Window (see option Displayed References) Page size sub level Determines the max. number of objects which are displayed in the list control (on top level if tree view is used) per page. Opens a window to select a field. Referenced fields are shown with the field names separated by periods (". The default is 200 pixels. Force list layout Forces a list layout if checked. which will be added to the end of the list of columns. In this case. Add Column. "0" means the default value is used. "0" means the default value is used. Up/Down arrows Required Moves the selected column up or down in the list.. which is defined in the Web Gateway Configuration Window (see option Displayed References) Height in pixels Sets the height of the reference list. The columns will be displayed by the Web Gateway in the given order. from left to right. This is used only if no columns are specified in the columns list. which will result in moving it left or right in the Web Gateway's display. The following layouts are supported on web forms: list layout tree layout editable tree layout © 2014 OMNINET GmbH .142 OMNITRACKER Web Gateway Manual Layout Window Description Title Description Columns to be displayed. Columns to be displayed in the list of references. This subpanel is available for attachments. Field Properties . Layout Window Description Title Sort items: 4.Attachments Subpanel Introduction This subpanel is used to display and edit settings related to attachment fields in the Web Form Editor.1.7 Description Required Set the radio button to "Ascending" to have the earliest events displayed first (default) or to "Descending" to have the latest events displayed first.Extended Subpanel Introduction This subpanel is used to display and edit the extended properties of a field in the Web Form Editor.1. Layout © 2014 OMNINET GmbH .6. This subpanel is available for timestamped memo fields and history items.6 143 Field Properties .Configuration 4.6. Available options are Option Meaning Default The default configuration will be used (option "Default position of button array for reference lists" in Web Gateway Configuration Window) Left The button array is displayed on the left side of the list of referenced objects (one button per row) Right The button array is displayed on the right side of the list of referenced objects (one button per row) Top The button array is displayed on top of the list of referenced objects (all buttons in one row) Bottom The button array is displayed at the bottom of the list of referenced objects (all buttons in one row) This option sets the display style for the button array. Icon only Only an icon will be displayed. Available options are Option Meaning Default The default configuration will be used (option "Default style of button array for reference lists" in Web Gateway Configuration Window).144 OMNITRACKER Web Gateway Manual Window Description Title Options for the button array / Position Display Description This option sets the position for the button array. © 2014 OMNINET GmbH . 8 145 If this option is enabled. a separate dialog is used for uploading attachments. If this check box is not checked.Reference list of objects Window Description Title Description Display field as This setting is only available for fields of type "Reference to object".1. As default this check box is checked. Text & Icon An icon and a text will be displayed together. Field Properties . © 2014 OMNINET GmbH .6. Upload attachments using separate dialog 4. single attachments/ links can be uploaded directly on the object page.Reference Subpanel Introduction These subpanels are used to display and edit settings related to reference-type fields in the Web Form Editor. These subpanels are available for the following field types: Reference to object Reference list of objects Layout .Configuration Text only Only a text will be displayed.Reference to object Layout . Delete referenced object If checked. Options for "Add reference to new object" / Select Folder If this checkbox is checked. the button for removing a reference is hidden. This option only has a meaning if the reference is defined to include subfolders. The default button for fields of the type "Reference to object" can be defined here. By default. the button for adding a reference to a new object is hidden. all buttons are hidden. Either "Add reference to existing object" or "Add reference to new object" can be selected. the button for deleting a referenced object is hidden. the user has to select the subfolder in which the new object shall be created when clicking the "Add reference to new object" button. Add reference to existing object If checked. Remove reference If checked. Show referenced object If checked. then the action can be clicked. The checkboxes have the following meanings: Default if empty Checkbox Meaning All If checked. © 2014 OMNINET GmbH . The default action for empty fields however can be defined here.146 OMNITRACKER Web Gateway Manual It allows you to select how this field will be displayed by the Web Gateway. Add reference to new object If checked. Hide buttons These checkboxes allow you to hide certain buttons that the Web Gateway usually displays for reference fields. The default action for non-empty fields always is the "Show referenced object" button (if this button is not hidden). the button for opening the referenced object is hidden. This means only the default action can be performed with a single mouse click. all buttons described in the Object Page for modifying reference fields are shown. Add as temporary object If checked. add new. For all other actions the sub menu of the button must be opened. the new object is created temporary when clicking the "Add reference to new object" button. the button for adding a reference to an existing object is hidden. All visible buttons (show. remove and delete) are combined to a single "Split button". add. Note: If a Source Object is selected and if no Field Mapping is used (if "No Mapping" is selected). Select object The user is asked to select the source object when clicking the "Add reference to new object" button. then a default mapping is performed. see the OMNITRACKER Administrator Help. the partner field in the new object will be initialized with a reference to the current object. the reference can only be selected from the target folder itself. and the user presses the button "Add reference to new object". Options for "Add reference to existing object" / Select Folder If this checkbox is checked. If it is checked. If the fields are not of the same type. defined in the referenced folder are displayed here. Options for "Add reference to existing object" / Selection Tree The available selection trees. Initial partner field by default This checkbox is only available for synchronized reference fields. Note: The "Add reference to existing object" button only is available for reference lists or if the field is displayed as text field with buttons. Instead of using the default "Select Object" dialog. For more details on field mappings. the value is converted if applicable. see the OMNITRACKER Administrator Help. 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 The current object is used as a source object. Selected object The currently selected object from the reference list will be used as a source object for the field mapping associated with the "Add reference to new object" button. a selection tree can be displayed if the "Add reference to existing objects" button is pressed on the object form.Configuration Source Object 147 If one of the following options is set. Field Mapping 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. the user can select the reference object from any subfolder of the target folder of the reference field (only if the reference field is defined to include subfolders). Otherwise. For more details on field mappings. This means that fields with identical alias/label are mapped automatically. © 2014 OMNINET GmbH . Make sure that the field mapping uses source objects from the referenced folder. For more details on field mappings. fields of the current object can be filled with values from the selected referenced object. Therefore a field mapping must be selected which is defined in the local folder. see the OMNITRACKER Administrator Help. © 2014 OMNINET GmbH . Available options are Option Meaning Default The default configuration will be used (option "Default style of button array for reference lists" in Web Gateway Configuration Window).148 OMNITRACKER Web Gateway Manual Options for "Add reference" / Fill Object If this checkbox is checked. As source object always the selected referenced object is used. 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. This field mapping must use objects from the selected folder as source. Available options are Option Meaning Default The default configuration will be used (option "Default position of button array for reference lists" in Web Gateway Configuration Window) Left The button array is displayed on the left side of the list of referenced objects (one button per row) Right The button array is displayed on the right side of the list of referenced objects (one button per row) Top The button array is displayed on top of the list of referenced objects (all buttons in one row) Bottom The button array is displayed at the bottom of the list of referenced objects (all buttons in one row) This option sets the display style for the button array. Icon only Only an icon will be displayed. Overwrite non-empty fields By default only empty fields will be overwritten by the field mapping. Text & Icon An icon and a text will be displayed together. the field mapping will also overwrite non-empty fields (even if the field was modified by the user). Text only Only a text will be displayed. If this checkbox is checked. Options for the button array / Position Display This option sets the position for the button array. attachment.6. This subpanel is available for history items. Required Note: If you check this box and the item is smaller than the given size. Check this box to set the item to a fixed size. it will use up this space anyway. scrollbars will appear. Note: The height is measured in pixels Sizing of time-stamped memo fields The following image explains how the height of time-stamped memo fields can be set. the item's size may grow unbounded (which might reduce clearness of the form).9 149 Field Properties . If you leave the box unchecked (default). read-only memo sections choose their height such that the entire text fits into them.1. Blue Arrow: The height of the whole field is restricted to the size which is defined in "Control height" Red Arrows: The height of a single section is defined in "Override item height" © 2014 OMNINET GmbH . This only applies to editable memo sections. Layout Window Description Title Description Control Height If this checkbox is unchecked (default).Size Subpanel Introduction This subpanel is used to display and edit the size properties of a field in the Web Form Editor. The height is measured in pixels Override item height This item is only available for time-stamped memo fields and specifies the height of each section. the memo sections will obtain their size from the stylesheet file. memo and time-stamped memo field types. If the item needs more space than given.Configuration 4. Otherwise.6.1.Values Subpanel Introduction This subpanel is used to display and edit settings related to the possible values of a field in the Web Form Editor. You can define aliases only if this box is checked.150 OMNITRACKER Web Gateway Manual 4. This subpanel is available for the following field types: Drop Down List Reference to user Workflow Layout 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. the field will be displayed as a drop-down list. Display field as If this option is selected.10 Field Properties . the field is displayed as a drop-down list © 2014 OMNINET GmbH . with one button for each possible value. 11 Field Properties . Login and Last Name This option is only available for reference to user fields. The search will be performed on the fields "Display Name". Display field as text box with Quick Search on Display. Layout © 2014 OMNINET GmbH . The search will be performed on the field "Display Name" only. Delete Alias Deletes the alias definitions for the selected values in the "Alias list". enter a new alias in the "Alias text" box and press "Change Alias". The fields value can only be displayed readonly by using an arbitrary design. You can edit the alias in this box and then press "Change Alias" to update it in the "Alias list". Note: It's not possible to edit the fields value in any way.1.6. Change Alias Sets the alias for the selected value in the "Alias list" to the value specified in the "Alias text" box. select an entry in this list. "Login Name" and "Last Name" Alias list Contains alias definitions for the possible values of this field. The field is displayed as a text box that supports Quick Search.Configuration 151 Drop-down list Display field as text box with Quick Search on Display Name This option is only available for reference to user fields. Alias text Contains the alias for the selected value in the "Alias list". To define or change an alias.HTML Wrapper Subpanel Introduction This subpanel is used to define a custom HTML layout for the fields value. The field is displayed as a text box that supports Quick Search. 4. the picture can be displayed in the object form. If for example a text field contains the url to an image. 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.6.Display Subpanel Introduction This subpanel is used to display and edit the visibility condition of a field. © 2014 OMNINET GmbH .. e. In addition placeholders for the fields label and it's tooltip are available ( $(LABEL).152 OMNITRACKER Web Gateway Manual Window Description Title Wrap field values inside HTML Description Allows you to define a custom HTML code which is displayed on object forms.g. This subpanel is available for all field types.1. $(TOOLTIP) ) Suppress HTML code. this feature is not suitable for hiding sensitive data from underprivileged users. as the user can read the data from the page source. for text items and Quick Search fields. if the fields value is empty. 4. The intent for this feature is convenience. Allows you to insert placeholders at the cursors position.. their data is still contained in the HTML page which is transferred to the client browser. Displays nothing. Quick Search or text item in the Web Form Editor.. The rules are evaluated and applied immediatelly after a field was modified. Therefore. not security. after changing the selected item of a dropdown list or after a modified text field looses focus.. Important Note: If items are hidden with this functionality. The fields value can be integrated into the HTML code by using the placeholder "$(VALUE)".12 Field/Text Properties . Variable. 1. If a field is not enabled. This is only available for field and quicksearch items.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. The only thing you cannot do when the field is not enabled is to change the field's value. Dropdown. it is read-only. Referenced fields are also allowed. This panel is not available on search forms and it's not available for history items on object forms. Workflow. Click these buttons to edit the respective rule. Allows you to add a new theme. If a theme is assigned to the whole form. the design of a single item can be overwritten here. you can scroll multiline text. i. Edit rule. as there is no difference between an enabled and a disabled text item. and you can open referenced objects from read-only reference (list) fields.Design Subpanel Introduction This subpanel is used to assign a theme to the field or text item on object forms. . © 2014 OMNINET GmbH Description Allows you to select a theme for a field or a text item..e. you can see the field value.. you can copy text. 4. Layout Window Description Title Current Web Theme Add.6.13 Field/Text Properties .. The left side of the rules can contain the following properties: Current user (or proxy) Web configuration Unique ID of current object User fields of the current object with the type Boolean. Reference to user or Reference to request.. 154 OMNITRACKER Web Gateway Manual Edit.1.1.. Allows you to edit the current selected theme.General Subpanel Introduction This subpanel is used to display and edit the general properties of a text element in the Web Form Editor. Layout Window Description Title Description Required Label The element's text contents. Pressing ".. which will be displayed as static text by the Web Gateway. Layout Window Description Title Description Required © 2014 OMNINET GmbH . 4.14 Text Properties .. 4..6.6.15 Create Object Button Properties Subpanel Introduction This subpanel is used to display and edit the properties of a create object button in the Web Form Editor." opens the Edit Multilingual Text Window to edit the different language versions of the elements text. Pressing ". Field mapping Let's you select a "Field Mapping" from the field mappings specified in the selected folder. you must also supply a source object setting: Value Meaning (No object) No source object." opens a window containing all the folders in the system.. see "Select subfolders") when the user clicks the button. not the folder specified in the "Folder" field. If "(No mapping)" is chosen." opens the Edit Multilingual Text Window to edit the different language versions of the button's label. Folder The folder associated with this button. Select subfolder Specifies if the user should get a chance to select a subfolder (if there are any) when clicking the button. Fields of the type "reference to object" and "list of references" can be selected here. For more details on field mappings.. Current object The current object will act a source object when the new object is created. © 2014 OMNINET GmbH YES . Works only if the source folder for the field mapping is the current folder. default values will be used.Configuration Label Tooltip 155 The button's label in the current language. Reference Field The new created object will be attached to the field selected here. The button's tooltip in the current language. Select the desired folder in the tree and then click "OK".. a "Source object" setting must be selected. Source object If you chose a field mapping other than "(No mapping)". For more details on field mappings. see the OMNITRACKER Administrator Help. the user will be asked too choose the source object when clicking the button. YES The object will then be created in the selected subfolder. An object will be created in this folder (or a subfolder. see the OMNITRACKER Administrator Help. Otherwise.. YES Pressing ". Works only with Field mapping that don't require a "(Local object)" to copy from. Select object If the field mapping requires a source object. . YES © 2014 OMNINET GmbH . Field mapping Let's you select a "Field Mapping" from the field mappings specified in the current folder.1." opens the Edit Multilingual Text Window to edit the different language versions of the button's label. For more details on field mappings. it will be applied directly.. Tooltip The button's tooltip in the current language. Layout Window Description Title Description Required Label The button's label in the current language. only those fields that were not subject to user modification will be affected.6. If the field mapping does not require a source object. default values will be used. user modification will be overwritten already modified when applying the field mapping to fill the object.16 Fill Object Button Properties Subpanel Introduction This subpanel is used to display and edit the properties of a fill object button in the Web Form Editor. YES If "(No mapping)" is chosen.156 OMNITRACKER Web Gateway Manual 4. Pressing ". the user will be asked to select one. fields If this checkbox is unchecked. Overwrite If this checkbox is checked. see the OMNITRACKER Administrator Help. If the field mapping requires a source object. 4...1.18 Command Buttons Properties Subpanel Introduction This subpanel is used to display and edit the properties of the command buttons in the Web Form Editor. If this box is checked. © 2014 OMNINET GmbH . The button's tooltip in the current language.. then the object will be closed after the button was clicked and the task executed. YES Pressing ". Select the desired task in the list and then click "OK". Layout Window Description Title Label Tooltip Task Description Required The button's label in the current language.. Please note that the Web Gateway only supports action tasks and print tasks with Crystal Reports layouts. This task will be executed when the user clicks the button.17 Task Button Properties Subpanel Introduction This subpanel is used to display and edit the properties of a task button in the Web Form Editor. Pressing ".1..6.6." opens a window containing all the tasks in the current folder.. Close object after ." opens the Edit Multilingual Text Window to edit the different language versions of the button's label. The task associated with this button.Configuration 157 4. Specifies the alignment of the command buttons.and Cancel-Button if you have selected the Option "Hide Toolbar in Objectform" in the Web Gateway Configuration Window 4. Recursive Filter. Possible choices are: Right Left Center Translate labels. AND Combination.6. Layout © 2014 OMNINET GmbH .19 Search + Execute Task Button Properties Introduction This subpanel is used to display and edit the properties of a checkbox field (Recursive full-text search. Recursive search) for search forms.. Combine Filter and Search.1. Opens the Translation dialog to allow the translation of the buttons labels. Note: You must place at least one OK. Specifies the text that shall be displayed on the buttons..158 OMNITRACKER Web Gateway Manual Layout Window Description Title Visible buttons Labels Alignment Description Only the checked buttons will be displayed on the web form. 1. Recursive search) for search forms.20 Search Form Checkbox Properties Introduction This subpanel is used to display and edit the properties of a checkbox field (Recursive full-text search. Layout © 2014 OMNINET GmbH . a dialog pops up asking the user for the output format. See here.6. in this case. AND Combination. Recursive Filter. this control is hidden. For Report Tasks and Export Tasks. You can also select "Ask user". you can select from the appropriate output types. For Action Lists. 4. This control's visibility and content depends on the type of the given task. Combine Filter and Search.Configuration 159 Window Description Title Label Output type Description The element's label. See here. 4.but not to display a checkbox. If the field is hidden.6. if there is no checkbox present .21 Send Email Button Properties Subpanel Introduction This subpanel is used to display and edit the properties of a "Send Email" button for search forms.1. Hidden Checked by default Check this box to have the field hidden.160 OMNITRACKER Web Gateway Manual Window Description Title Description Label The element's label. Special case "Recursive Filter" checkbox If the checkbox "Recursive Filter" is placed on the search form and if this option is checked by default. Layout © 2014 OMNINET GmbH .that is. the value indicated by "checked by default" is assumed. Defines whether this box is checked or unchecked by default. Its standard value depends on whether the absence of this box causes the search to assume a true or a false value. then a recursive search is started immediately when a user changes into this folder (even if the search form is minimized). This may be useful to override the default behaviour . Layout © 2014 OMNINET GmbH . Tooltip The tooltip of the button.22 Search Reference User Field Properties Introduction This subpanel is used to display and edit the properties of a reference (or reference list) field on a searchform. See here.1.Configuration 161 Window Description Title Description Label The element's label.6. Message Template It's possible to specify a specific message template here or let the user select a message template in the Web Gateway 4. Reference fields can be displayed as either a textbox with set/reset buttons or as a dropdown list. 162 OMNITRACKER Web Gateway Manual 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 Use restriction filter 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. © 2014 OMNINET GmbH Configuration 4.6.2 163 Web Form Button Configuration Window Introduction This window can be accessed from the Web Form Editor. It is used to configure the buttons for a web form. Layout Window Description Title Description Save Button Label Specifies the text to be displayed on the button for saving the object. If this is left blank, the default label "Save" (or the equivalent in the current language) is used. If the "Hide" box is checked, this button will be hidden. Main View Button Label © 2014 OMNINET GmbH Specifies the text to be displayed on the button for Required 164 OMNITRACKER Web Gateway Manual returning to the main view. If this is left blank, the default label "Main View" (or the equivalent in the current language) is used. If the "Hide" box is checked, this button will be hidden. OK Button Label Specifies the text to be displayed on the button for saving and returning to the main view. If this is left blank, the default label "OK" (or the equivalent in the current language) is used. If the "Hide" box is checked, this button will be hidden. Logout Button Label Specifies the text to be displayed on the button for logging out on the form. If this is left blank, the default label "Logout" (or the equivalent in the current language) is used. If "Hide" is selected in the dropdown list, the button will be hidden. If "Show" is selected, the button will always be shown. If you select "Use global setting" (this is the default value), showing or hiding depends on the value of "Show logout button" set in the Web Configuration. Show/hide logout button Shows or hides the logout button. When 'use global setting' is selected, it relates on the selection that is made in the Web Gateway Configuration Window (Object form options -> Show logout button). Translations Opens the 'Translations button' context menu with further multilingual features. Enable Submit Button Check this box to enable the "Submit" and/or the "Submit & Copy" buttons. To use these © 2014 OMNINET GmbH Configuration buttons, you need to specify a boolean field that is not used anywhere else in the form (see "Submit Field"). When the user presses the "Submit" button, this field will be set to "Yes" and the object will be saved. The same happens when the user presses the "Submit & Copy" button, and in addition a copy of the object is created and displayed in the form. This is useful if many similar objects need to be created in a row. Submit Field Specifies the boolean field to be used for the "Submit" and/or the "Submit & Copy" buttons. You can only select fields that are not already used elsewhere in the form. Set values in copy Allows you to specify fixed values for certain fields of a copied object. When the user presses the "Submit & Copy" button to create a copy of the current object, these fields will be set to these fixed values, while all other fields will be copied from the current object. Pressing "Edit..." opens a window to specify the fields and their values. Submit Button Label Specifies the text to be displayed on the button for submitting the object (i.e. setting the submit field to "Yes" and saving the object). If this is left blank, the default label "Submit" (or the equivalent in the current language) is used. If the "Hide" box is checked, this button will be hidden. Submit&Copy Button Label © 2014 OMNINET GmbH Specifies the text to be displayed on the button for submitting and copying the object (i.e. setting the submit 165 saving the object. creating a copy of it and displaying the copy in the form). It therefore requires a working installation of the Web Gateway using the same OMNITRACKER Server that you are currently connected to. If this is left blank.6. Layout Window Description Title Description Required © 2014 OMNINET GmbH .166 OMNITRACKER Web Gateway Manual field to "Yes". It shows the form just as it will be displayed by the Web Gateway. it uses the Web Gateway itself to display the form. If the "Hide" box is checked. In fact. 4. the default label "Submit & Copy" (or the equivalent in the current language) is used.3 Web Form Preview Window Introduction This window can be accessed from the Web Form Editor to display a preview of the currently edited web form. this button will be hidden. It is not stored in the registry or anywhere in the file system. The password you enter here is remembered until you close the OMNITRACKER Client. which will open a window to select an object in the current folder or a subfolder. © 2014 OMNINET GmbH YES 167 . It must not contain the name of a specific page such as Login. Automatic Login If this box is checked.Configuration Web Gateway URL Object for preview Specifies the URL of the Web Gateway to be used for preview. Language Allows you to select the language in which you want to view to form. If you change this selection while the form is already displayed. Password The password to be used for automatic login. If you select "(none)". Allows you to specify an object to display in the form.)". the login name and password you specified are automatically entered into the Web Gateway's login page... it will be refreshed automatically. If you change this selection while the form is already displayed. To specify an object.aspx. If "Automatic Login" is enabled. Start Starts a connection to the Web Gateway. it will be refreshed automatically. the form will be displayed just as it will look when creating a new object. so you do not need to enter them manually every time you open the preview window. pressing the "Start" button will automatically log into the Web Gateway using the specified login name and password. The URL must be of the form http://<hostname>/<virtualroot> (see URLs). select the entry "(select. which is faster because it skips the logout / login procedure. However. you can press this button to see the change in the form preview. you always have the option of entering your login name and password manually into the Web Gateway's login page. color. it is usually sufficient to press "Refresh" in this case. The font. you may experience a slight delay before the window is actually closed. Refresh Refreshes the currently displayed page. Therefore.7.168 OMNITRACKER Web Gateway Manual If there already is an open connection. If it still fails. if you make a change in the Web Form Editor. If you are still logged into the Web Gateway when closing this window (no matter if you use this button or the window's closing button). and then press "Start" to start the automatic login again. In this case you can wait for the login page to appear. Therefore. 4. Close Closes the window. it does not hurt to press "Start" when you are already logged in.1 Introduction to Web Themes Introduction With Web Themes the appearance of object forms can be easily adapted. For example. you will be logged out automatically. it simply means that the login page was not received from the Web Gateway yet. pressing "Start" closes it first and then starts a new connection.7 Web Themes 4. If you get a message box saying that the automatic login failed. border or background of almost any item on a web form can be configured. © 2014 OMNINET GmbH . ) Therefore these format options are not inherited from the global form configuration (configuration of the "form" item of the item tree in the Web Theme Editor). To organize different web themes see chapter Managing Web Themes. These style definitions can be applied to web forms in general or to separate items on the web form. Configurations in a Form Theme (to specify the design of complete object forms).Configuration 169 Several Web Themes can be configured and a theme contains several sets of style definitions. a Form Theme) and these style definitions itself also can be overwritten by one or several Form Item Themes. General Inheritance of Style Definitions The appearance of separate web items and of the web form in general depends on the defined style definitions in the following order (for defining Web Themes see chapter Web Theme Editor): 1.g. 2. which are defined in several style sheet class files. If the value is “default”. the actual value is determined as follows: For format options of type “background_*” or “border_*”. the default font color is “black”. Web Format Options Inheritance A format option is something like text color. if that is non-default.css in the OMNITRACKER Web Gateway installation directory). For format options of type “font_*”: o the corresponding value of the section item (header or footer item in the item tree in the Web Theme Editor).) Each format option contains one of the following values: “default” a specific value (“non-default value”) If the value is “non-default”. For a particular web form item (sometimes in a particular state. Configurations in Form Item Themes (to specify the design of several items on an object form). such as “disabled”. a form’s web theme can specify a format option in various places: For the whole form. Definitions in the style sheet class files (files with the ending . an implementation-defined default value is used. can be overwritten by a global Web Theme (i. border width. Normally. That means the default style definitions. 3. “mandatory”. This value is only used for the © 2014 OMNINET GmbH . That means the configurations in the Form Item Themes will overwrite the default definitions in the style sheet classes. 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. (Each web form item is contained in a section. For a section. this value is applied to the web form element to which it is applied.e. or background image. …). (E. export or import themes. It is used to add...170 OMNITRACKER Web Gateway Manual title of a section. o the corresponding value of the whole web form is used (configuration of the "form" item of the item tree in the Web Theme Editor) . A theme contains several sets of style definitions which can be applied to web forms or to separate items on web forms. the implementation-defined default value is used.". delete. If the forms value also is “default” . rename. the setting from the form is used. There is one special case. “label (disabled)”. “label (mandatory)” (configuration of the "Labels" item of the item tree in the Web Theme Editor). only if the setting in “label” also is default.2 Organize Web Themes Introduction The Organize Web Themes window can be accessed through the Web Form Editor by clicking the button "Organize Web Themes. the actual value is determined from the corresponding setting for “label”. That means if the text decoration "line-through" is configured for the whole form. for labels. If a format option for “label (xxx)” is default. if that value is non-default. o Note: The configuration of a text decoration (e.7. 4. it is not possible to undo this and use "normal" for a label or a control on this form. options can be defined for “label”. © 2014 OMNINET GmbH .g. "underline" or "line-through") can not be undone. “label (enabled)”. edit. Deletes the selected theme(s). Allows you to rename the current selected theme. Import Create a new theme based on a previously exported theme © 2014 OMNINET GmbH Required . Exporting a theme is useful for re-using a theme definition in another OMNITRACKER installation.. Allows you to add a new theme. Export Save the theme in a file/the clipboard. Opens the Web Theme Editor to edit the current selected theme. Edit Theme Delete Theme Rename Theme Description Specifies the theme type which is displayed in the list below..Configuration 171 Layout Window Description Title Type Add Theme. Currently the following theme types are supported: Form Themes (to specify the design of complete object forms) Form Item Themes (to specify the design of several items on an object form) Depending on the theme type you are currently editing. The tree contains all elements which can obtain a custom style. borders and backgrounds) of web forms and/or items. the color. © 2014 OMNINET GmbH .172 OMNITRACKER Web Gateway Manual definition file or from the clipboard. colors.7. the border and/or the background can be configured. Depending on the current selected element. different items can be selected in the tree control on the left side.3 Web Theme Editor Introduction The Web Theme Editor allows you to specify the design (fonts. the font. 4. a current description about is displayed in the box below the tree control. If an element is selected. NOTE: Controls on web forms have a fixed height! It's not possible to use any font sizes. "Default" means that the color is not changed by this theme. Required . Click "." to open a dialog which allows you to select a font which is installed on your machine directly or click "x" to use the default font. Several font names separated by commas can be declared here. Font family Specifies the used font.Configuration 173 Layout Window Description Title Description Font color Specifies the color of the font. If the first font is not available on the client machine. Font size Specifies the size of the font. Possible values are "default". "normal" and "bold". Font weight © 2014 OMNINET GmbH Specifies the weight of the font.. the next font will be used instead.. "double".gif" Allowed: "http://mainserver/images/background_blue. "inset". Image position Specifies the position of the background image. Possible values are "default". the background image should be set to "none" by clicking the button "default" twice. Possible values are "default". "groove". Possible values are "no repeat". "repeat". It's not allowed to enter file paths here. Allows you to edit the description of the current theme. Border color Specifies the color of the border. Examples: Not allowed: "C:\images\background. You can enter absolute or relative URLs here. Custom CSS text Allows you to specify any Cascading Style Sheet text.. Background Color Specifies the background color of an element. "dotted". "outset" and ridge. "center". "solid". Image repeat Specifies if the image is displayed once. © 2014 OMNINET GmbH . "normal".. Font decoration Specifies the decoration of the font. "none".. "normal" and "italic"." (custom position of the background image) "display:none" (can be used to hide an element) "border:none. border-bottom:dotted 1px black" (only display a black dotted border on the bottom) Warning: The usage of custom CSS text should be avoided whenever possible. If you want to prevent this.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.174 OMNITRACKER Web Gateway Manual Font style Specifies the style of the font. Possible values are "default"./own_images/bg. Possible values are "bottom". "repeat-x" and "repeat-y". "right". Border width Specifies the width of the border. or if it is repeated in any direction. "dashed". Description. Border style Specifies the style of the border.jpg" Allowed: ". "Default" means that the color is not changed by this theme. Image URL Specifies the background image. "top" and "left-top". NOTE: The background color can be overlapped by background images. "underlined" and "line through". It's not guaranteed that all custom CSS code will work in upcoming Web Gateway versions. Examples: "background-position:100px 50%. "left". The object data will be sent as a XML document to the browser and will be transformed into HTML code by using the XSL style sheet. XSL stands for EXtensible Stylesheet Language.Configuration Preview. and is a style sheet language for XML documents.8 Arbitrary HTML formatting for lists 4. the Web List Layout Editor must be opened by clicking the button "Web Settings. they must be applied in the Web Theme Editor. NOTE: Before changes will take effect in the preview window. To specify a custom layout. © 2014 OMNINET GmbH . changes in web themes will first take effect after a re-login ..." within the "Edit Column Settings" dialog.. 4.1 Web List Layout Editor Window Introduction For the main view and/or for reference lists on web forms any custom list layout is thinkable by using XSL transformations..8. If you log in the Web Gateway directly. 175 Opens the Web Form Preview window to show how the form will be displayed by the Web Gateway. 176 OMNITRACKER Web Gateway Manual © 2014 OMNINET GmbH . . Otherwise the default list layout is used.Configuration 177 Layout Window Description Title Show the object list. please see the IMPORTANT NOTE in chapter JavaScript © 2014 OMNINET GmbH . Specifies the style sheet which is used to transform the XML representation of the objects to HTML.. Regarding the use of JavaScript. XML style sheet Description Enables the custom layout. 8.. Please set the max.2 Defining Custom Layouts Getting started with an example: In this example we want three fields to be displayed in a custom list layout: Title (a text field which contains the title of the objects) ImageUrl (a text field which contains the URL to an image. Load an existing style sheet. Save the current style sheet.. Load from file. NOTE: If this layout is used for reference lists on object forms... The Image shall be displayed in the list control) Description (a memo field which contains long text with line breaks) © 2014 OMNINET GmbH . Save sample XML data. 4.. number of displayed objects in the Web Form Editor window (tab "columns" of the reference list item). Allows you to select objects from the current folder and save the XML representation of these objects to a file. Save to file. This setting overwrites the Page Size Top Level value in the Web Gateway Configuration Window..178 OMNITRACKER Web Gateway Manual Functions. Page Size The max number of objects which are displayed per page (if layout is used on the main page). this setting has no effect. 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. 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. © 2014 OMNINET GmbH . 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". Furthermore sorting shall only be possible on the fields "Title" and "Description".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. The defined value for the column "With" has no effect on the custom list layout and can be ignored. ." and then save the sample XML data. <ImageURL> and <Description>).the label in server language.jpg</ ImageURL> <Description label="Description">A car is a type of vehicle. 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. For each field the content can be accessed by using the elements content..180 OMNITRACKER Web Gateway Manual Which object data can be accessed? First open the Web List Layout dialog by clicking the button "Web Settings. WARNING: © 2014 OMNINET GmbH . For each field the label can be accessed by using the elements attribute "label"..</Description> </object> <object id="140" selected="false" urlopen="_open(this.gif</ImageURL> <Description label="Description">A flower. 140)"> <Title label="Title">Car</Title> <ImageURL label="ImageURL">http://localhost/OTWG/pictures/car. most often in American English an.if no alias is defined .. sometimes known as a bloom or blossom. The following text represents the XML data of the first two objects in our example: <rows language="en"> <object id="139" selected="false" urlopen="_open(this.. 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>.</Description> </object> </rows> The login language of the current user can be found in the "<rows>" element by accessing the attribute "language". 139)"> <Title label="Title">Flower</Title> <ImageURL label="ImageURL">http://localhost/OTWG/pictures/ flower. The name of these elements is the alias name of the fields or . is the re.. Configuration 181 If memo fields are displayed."><xsl:value-of select="Title"/></p> </div> </xsl:template> </xsl:stylesheet> This XSL transformation creates a <div> element with a gray border for each object.font-family:verdana. 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.w3. © 2014 OMNINET GmbH . the content is not limited as known from the list or tree view.org/1999/XSL/ Transform"> <xsl:template match="object"> <div style="border:solid 1px Gray. Within the <div> element. the objects title is written into a <p> element.color: Black. height:40px.font-size:12pt. <?xml version="1."> <p style="width:100%. using black font color.margin-bottom:2px. To avoid performance problems it is recommend to limit the size of memo fields in the Field Properties window.0" encoding="utf-8"?> <xsl:stylesheet version="2.0" xmlns:xsl="http://www. the JavaScript function which is given in the objects attribute "urlopen" must be called.182 OMNITRACKER Web Gateway Manual How to open objects? To open an object. Otherwise the link will not work correctly! Here an example how to open an object using a HTML button: <button type="button"> <xsl:attribute name="onclick"><xsl:value-of select="@urlopen"/></xsl: © 2014 OMNINET GmbH . Here an example how to open an object using a HTML link: <a> <xsl:attribute name="href"/> <xsl:attribute name="onclick"><xsl:value-of select="@urlopen"/>.</xsl:attribute>click here </a> Note: The command "return false" is very important.return false. checked)</xsl:attribute> </input> Explanation: An input element of the type "checkbox" is used (= a simple checkbox). this.Configuration 183 attribute> <p>click here</p> </button> How to select objects? If you want to select an object (e.selected" is true or false depending on if the checkbox is checked or not. If the object already is selected. selected)" The first parameter always must be "this" to identify the list control. to achieve reports or exports) you must call the following JavaScript function: "selection_changed(this.) Within the "onclick" event of the checkbox the selection_changed function is called. © 2014 OMNINET GmbH . This is necessary to prevent that selections get lost after a page reload. Here an example how to select objects using a HTML checkbox: <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. (If the object is selected or not is evaluated within a "<xsl:if>" element.g. The second paramter (id) must be replaced by the unique id of the object you want to be selected or deselected. the attribute " checked='checked' " is added to our checkbox. id. The third parameter "this. <xsl: value-of select="@id"/>. The third boolean parameter (selected) must be "true" for selecting and "false" for deselecting the object. ."> <tr> <th style="background-color:#009EE0.color:#009EE0.</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. </a> © 2014 OMNINET GmbH .font-size:10pt. The resulting layout can be found below. <?xml version="1. width:100%. text-align:left."> <xsl:attribute name="href"/> <xsl:attribute name="onclick"><xsl:value-of select="@urlopen"/>.vertical-align:top."> <img xsl:use-attribute-sets="MyImage"></img> </td> <td> <a style="font-size:10pt.float:left. height: 140px.color:white. width:200px. margin:2px.184 OMNITRACKER Web Gateway Manual A more complex style sheet Here an example with a more complex stylesheet. overflow:hidden." colspan="2"><b> <xsl:value-of select="Title"/> </b> </th> </tr> <tr> <td style="width:80px.0" xmlns:xsl="http://www.</xsl:attribute>more info."> <table style="table-layout:fixed.w3..0" encoding="utf-8"?> <xsl:stylesheet version="2.display:inline-block.text-decoration: underline.org/1999/XSL/ Transform"> <xsl:attribute-set name="MyImage"> <xsl:attribute name="style">height:90px.return false. <xsl:value-of select="@id"></xsl:value-of>.font-size:10pt.checked) </xsl:attribute> </input> Select Object </td> </tr> </table> <textarea style="width:100%."><xsl:value-of select="Description"/> </textarea> </div> </xsl:template> </xsl:stylesheet> Result: © 2014 OMNINET GmbH . color:#222288.overflow:hidden. this.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.height:80px.border:none. Here an example: <xsl:if test=".</xsl:if> <xsl:if test=". As parameter the unique id of the current object is passed.. the language attribute of the XML document must be evaluated.</xsl:if> How to invoke combo scripts? In the following example the function named "cloneObject" in the combo script named "Script1" is called../@language='de'">Weitere Details. Please read the chapter Invoking © 2014 OMNINET GmbH ../@language='en'">More Details....186 OMNITRACKER Web Gateway Manual How to add multilingual static texts? If you want to use multilingual texts. make sure that the content is not too long to avoid long load times for users with a slow internet connection. 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. Image files should be as small as possible to avoid long load times.'cloneObject'.. If images are displayed. <button type="button"> <xsl:attribute name="onclick">invoke_combo_script ('Script1'.. © 2014 OMNINET GmbH . A new XSLT style sheet should be tested with different browsers to discover display problems in time. 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. It's recommended to use external tools to create or modify the XSLT style sheet. If text with from memo fields which contains line breaks shall be displayed. In the list control the HTML elements of a custom layout may inherit style sheets from the Web Gateway. '<xsl:value-of select="@id" />')</xsl: attribute><p>execute script</p> </button> Some tips: If memo fields are used in the custom layout. Note: The generated output of external editors can be different from the list layout as it is displayed in the Web Gateway. See the the field "Description" in the example "A more complex style sheet" above. Therefore a field which contains an URL should always have a default value or should be mandatory. Hide fields from sorting by renaming the column to "-". In this case The Web Gateways directory would be accessed what can cause performance problems on you web server.Configuration 187 Combo Scripts from JavaScript for more details. the value must be placed inside textareas. 188 OMNITRACKER Web Gateway Manual 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 OMNITRACKER’s 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 Global Properties and Methods 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. These script events are available on object forms: OnOpen: Invoked once, if an object is opened. OnSave: Invoked if an object is saved (Save button clicked or method "Save" used by script) OnChange: Invoked whenever a field (attachment, integer, memo, ...) on an object form was modified OnClick: Invoked if a script button was clicked. These script events are available on search forms: OnOpen: Invoked whenever a search form is opened (after changing into a folder, even if the searchform is minimized) OnSearch: Invoked if the "Search" button was clicked or if the method "Search" was used by script OnClick: Invoked if a script button was clicked. 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 OnOpen OnSave OnChang OnClick OnOpen OnSearch OnClick © 2014 OMNINET GmbH Configuration 189 ActiveFilter x x x ActiveFolder x x x x x x e ActiveObject x x x x ActiveSearchFilter ActiveSession x x x x x x x ActiveUser x x x x x x x CancelAction CloseObject x x x x CombineFilterAndSearch GetSelectedObjects x x x GetTabLabel x x x x LogMessage x x x x x x x OpenObject x x x x x x x x x x x x x x x OpenNewObject RecursiveSearch ResultMessage x x Save x x x x Search x ServerLanguage x x x x SetTabLabel x x x x x x x StatusText 4.9.2.2 x Properties 4.9.2.2.1 ActiveFilter ActiveFilter Property ActiveFilter As OtFilter This property is only available in Search Form Scripts. © 2014 OMNINET GmbH x x x x x x 190 OMNITRACKER Web Gateway Manual 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. © 2014 OMNINET GmbH 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. The returned OtRequest object is read-only in "before/after deletion scripts". Important Note for client-side scripting in forms Never use ActiveRequest.Save or ActiveRequest.SaveEx in client-side scripts in object forms, because otherwise parts of the object form handling will be skipped. This may lead to unpredictable effects. Please use the global method Save instead. Important Note for server-side scripting in action lists Please be aware of the fact, that the returned OtRequest object may be outdated in "after creation/ modification/copy" action lists in some cases (see ActiveRequest Property and Action Lists for details about this). 4.9.2.2.4 ActiveSearchFilter ActiveSearchFilter Property ActiveSearchFilter As OtFilter This property is only available in Search Form Scripts. © 2014 OMNINET GmbH UserField("Title") = "*" filt. Description This property returns a filter which contains the search criteria the user has specified in the search form. because fields which are not included in the ActiveSearchFilter cannot be cleared.192 OMNITRACKER Web Gateway Manual Syntax ' Perform a search Dim filt Dim fold Set fold = ActiveFolder Set filt = fold. the state is completely ignored. The Search form is updated: If the search form contains the field "Responsible". then also the state will be included in the search result. 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. then the search form is updated accordingly.MakeFilter filt. it now shows the current user.AllowWildcards("Title") = True © 2014 OMNINET GmbH . A workaround for clearing a text search field is to fill it with an asterisk: filt.UserField("Responsible") = ActiveUser ActiveSearchFilter = filt Search Access This property is read-write. "Priority" now shows "Very High". If the user now presses the Search button again and if now the ActiveSearchFilter is not changed by script. Example: The user fills a search form and searches for objects with the state "New" and the priority "High". If the ActiveSearchFilter is modified by script. "State" still contains "New". 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. if corresponding search fields exists on the form. 2.2.2.2.2.Configuration 193 4.9.2. 4.6 ActiveUser ActiveUser Property Syntax Dim val As OtUser Set val = ActiveUser Access This property is read-only. 4.5 ActiveSession ActiveSession Property Syntax Dim val As OtSession Set val = ActiveSession Access This property is read-only. © 2014 OMNINET GmbH . Description This property returns the current user as an OtUser object. By default an "AND" combination is used.9. Description This property returns or sets the flag indicating whether filter and search are combined.7 CombineFilterAndSearch CombineFilterAndSearch Property This property is only available in Search Form Scripts. Syntax boolVal = CombineFilterAndSearch Access This property is read-write.9. Description This property returns the currently active session as an OtSession object. 2. Description This property returns or sets the flag indicating whether the search is recursive. "de" for German or "en" for English) for the server language of the ActiveSession.2.2.8 RecursiveSearch RecursiveSearch Property This property is only available in Search Form Scripts. filter and search are not combined by default. 4.9. Description Returns the language identifier (e.2. 4.3 Methods 4.3. Syntax CancelAction © 2014 OMNINET GmbH .9.9 ServerLanguage ServerLanguage property Syntax Dim val As String val = ServerLanguage Access This property is read-only.9. Syntax boolVal = RecursiveSearch Access This property is read-write.2.g.2. 4. the default value of this property is false.1 CancelAction CancelAction Method This method is available in "OnSearch" and "OnSave" Scripts.9. If no "Recursive Search" checkbox is on the search form.194 OMNITRACKER Web Gateway Manual If no "Combine Filter and Search" checkbox is on the search form. Search Forms: Rejects a search action in a search form when called within an OnSearch event handler.2.Configuration 195 Description Object Forms: Prevents an object from being saved. when called within an OnSave event handler.9.3. 4. Syntax CloseObject Description Performs the same actions that would happen if the user pressed the ”Cancel” button in the form.2 CloseObject CloseObject Method This method is asynchronous. 4. Description Returns an object of type OtRequests that contains the current selected OtRequest objects.UserFieldDefinitions("RefList") field is "RefList" Set reqs = GetSelectedObjects(def) 'the alias name of the Return value Returns a value of type OtRequests Parameters def The desired user-field definition or it's unique Id. © 2014 OMNINET GmbH .3 GetSelectedObjects GetSelectedObjects method This method is available in Object Form Scripts.3.9.RequestFolder Set def = fld.2. Syntax 'Get the selected objects of field "RefList" Set fld = ActiveObject. 9.4 GetTabLabel GetTabLabel method This method is available in Object Form Scripts.196 OMNITRACKER Web Gateway Manual 4.3. Description Returns the specified tab button label. Parameters idx The index of the desired tab button. 4.2. The index must be a number between 0 and tab count-1. The event log can be browsed using the "Status" tab in OMNITRACKER’s server setup window.3. Syntax Dim label as String Set label = GetTabLabel(idx as Long) Return value Returns a string.2.5 LogMessage LogMessage Method Syntax Dim strText As String LogMessage strText Parameters strText Message text to log Description Write a message to OMNITRACKER’s event log.9.2.6 OpenObject OpenObject Method Syntax Dim object_id As Long Dim modal As Boolean © 2014 OMNINET GmbH . 4.3.9. The OpenObject method will not return until the object has been closed. Parameters object_id Unique ID of the object that shall be opened. © 2014 OMNINET GmbH . if the user has the necessary privileges.9. modal] [. modal This parameter is not regarded. the window will be modal. he opened request will be read-only. otherwise. then 0 is always returned. or 0 if no request has been created. Description Opens an object in a new pane tab or as a child of an object form using the breadcrumb bar. 4. otherwise the request can be modified. Then an error will be displayed. Parameters folder_id Unique ID of the request folder in which the new request shall be created. If an object is opened modal. the user may not modify the parent object. read_only]) Return value If modal is TRUE. or FALSE if the window was aborted using the "Cancel" button. Restriction In Search Forms which are displayed in the Select Object dialog.2. then the unique ID of the created request is returned. If modal is FALSE. modal This parameter is not regarded. read_only If TRUE. modal]) Return value If modal is TRUE. If TRUE. If modal is FALSE. then TRUE is returned if the object form was closed using the "OK" button. the window will be nonmodal. if this method is used in a Search Form Script. it's not allowed to use the OpenObject method.Configuration 197 Dim read_only As Boolean Dim result As Long result = OpenObject(object_id [. if this method is used in a Search Form Script. But the user may navigate to the parent object using the breadcrumb bar.7 OpenNew Object OpenNewObject Method Syntax Dim folder_id As Long Dim modal As Boolean object_id = OpenNewObject(folder_id [. then FALSE is always returned.3. The OpenNewObject method will not return until the object has been closed. Then an error will be displayed. the user may not modify the parent object. 4.9 Save Save Method Syntax Save([saveFlags As Long]) As Boolean © 2014 OMNINET GmbH .3. Syntax Dim text As String Dim icon As Long ResultMessage text [. But the user may navigate to the parent object using the breadcrumb bar.9.9. the window will be nonmodal. Restriction In Search Forms which are displayed in the Select Object dialog. It's possible to show multiple message boxes one after another.2. otherwise.3.2. icon] Parameters text Message text to display icon An optional number for displaying an icon 0: 1: 2: 3: 4: no icon info icon warning icon error icon question icon Description Displays a message box to the user after the script execution has finished. Description Opens a window for the creation of a new object.198 OMNITRACKER Web Gateway Manual If TRUE. 4. it's not allowed to use the OpenNewObject method. the window will be modal. If an object is opened modal.8 ResultMessage ResultMessage Method This method is asynchronous. ) the OMNITRACKER Server normally performs you must take care yourself that the changes do not corrupt your data model! Important Note for server-side scripting in action lists © 2014 OMNINET GmbH . otherwise False. For the optional parameter "saveFlags". you may provide any combination of the flags listed below: Flag Value Description otSaveDoNotCheckPermission s 1 Do not check the permissions otSaveDoNotValidateInput 2 Do not validate the input data otSaveDoNotCheckNonAmbigu its 4 Do not check if another object with the same identifying fields already exists otSaveDoNotExecuteActions 8 Do not execute any before/after creation/modification actions otSaveDoNotRecalcEscalation Times 16 Do not recalculate the escalation times for this objects otSaveDoNotUpdateHistory 32 Do not add any entries to the history otSaveDoNotUpdateFullTextSe arch 64 Do not update the full-text search index otSaveDoNotRecalcAutocalcul ations 128 Do not recalculate the result fields of autocalculations otSaveDoNotCheckPrivileges 256 Do not check for enough privileges for the current user in the current folder otSaveDoNotChangeLastChang eFields 512 Do not update date/time fields with the option "Set to current date/time when saving" Important Note Since the usage of the optional parameter allows you to skip some of the data consistency checks (etc.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. Syntax Search Description Performs the same actions that would happen if the user pressed the ”Search” button in the form. Syntax Dim idx As Long Dim label As String SetTabLabel idx.2.11 SetTabLabel SetTabLabel method This method is available in Object Form Scripts. that the returned OtRequest object may be outdated in "after creation/ modification/copy" action lists in some cases (see ActiveRequest Property and Action Lists for details about this).2.3. label Return value Returns a value of type OtRequests Parameters idx The index of the desired tab button. 4.9.10 Search Search Method This method is available in Search Form Scripts.3. 4.200 OMNITRACKER Web Gateway Manual Please be aware of the fact. The index must be a number between 0 and tab count-1. lbl The new label text Description sets the text of the specified tab button label © 2014 OMNINET GmbH . This method is asynchronous.9. number] Parameters strText Message text to display 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. e. 4.2.12 StatusText StatusText Method Syntax Dim strText As String StatusText strText [. In addition the default request timeout.3 Hints about scripting Accessing controls on forms It's not possible to access controls on forms directly as known from the windows client. This may lead to unpredictable effects. must be considered.UserFields("Title"). Warning: It's recommended to keep script execution times as short as possible. which is defined in the web.9. Example for object forms: If ActiveObject. On search forms the ActiveSearchFilter must be used instead.3.Value = "This title was added by a script" © 2014 OMNINET GmbH . because an impatient User may press "F5" if an operation takes too long. Instead the ActiveObject property must be used on object forms to read or write the values in the form controls.Value = "" Then ActiveObject.g. Depending on the network speed and the script execution duration. the status text may not become visible in the client browser. The web client by default displays a loading symbol while a script is running. a StatusText can be defined. Note: In the Web Browser. if bulk operations are performed or if external services are accessed.Configuration 201 4. To inform the user about the current progress.9. This method only should be used if a long script execution duration is expected. the status message is updated by a polling mechanism.config file.UserFields("Title"). Before the button action can be performed. Depending on the network speed. numeric fields) must be validated immediately after editing.Rule. 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). © 2014 OMNINET GmbH .LeftSideFieldPath & " = " & ActiveSearchFilter.Rule. Impatient Users may press "F5" because they may think that the Web Gateway does not respond. then only the source field fires the "OnChange" event.config file). Special case "Move Attachment" If an attachment is moved from one to another attachment field. the Web Server may interrupt the script execution and an error is returned to the client.Rule. The focus may get lost because the user pressed a button.LeftSideFieldPath & " = " & ActiveSearchFilter.Count > 1 Then For i = 0 To (ActiveSearchFilter. the OnChange script must be invoked.ChildRules. The StatusText method can be used to inform the user about the current progress of a script.ChildRules.Item(i) . especially if the user does not expect that he has triggered an action which takes a lot of time.202 OMNITRACKER Web Gateway Manual End If Example for search forms: If ActiveSearchFilter is Nothing Then ResultMessage "Please enter a search criteria" ElseIf ActiveSearchFilter. the user may notice a delay before he can continue modifying the next field.ChildRules. This causes a higher network traffic and Web Server load.Rule. which was modified by the user. If the request timeout is reached (web. Usability: An OnChange script is executed if a field.Rule. "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.Rule.Count -1) ResultMessage ActiveSearchFilter.RightSideValue End If "OnChange" scripts "OnChange" scripts only are invoked if a field loses focus which was modified by the user.RightSideValue Next Else ResultMessage ActiveSearchFilter. Long running scripts On principle long running scripts should be avoided. In addition an "OnChange" script requires that the whole form is reloaded after script execution.AffectedFields.g. looses the focus.Item(i) . This may lead to unpredictable effects. but this script is shared by all occurrences of the field and invoked if one of the fields is modified. then only for one field an "OnChange" script can be defined.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. Asynchronous script methods Some of the global methods are executed asynchronous. The result will be the same in both cases. It even does not play a role if "Search" is called before the ActiveSearchFilter is set or after. 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. This applies to the following methods: ResultMessage Search CloseObject OpenObject (non-modal) OpenNewObject (non-modal) File handling All scripts are executed on 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) © 2014 OMNINET GmbH . It's not possible to read files on the client machine or to store files on the client machine by script. This means they are not invoked before the whole script has finished. If it is necessary to read or write files. If for example the method "Search" shall be used in a search form script. Field multiple times on an object form If a field is multiple times on an object form. then it does not play a role if the method is called in the beginning or as last statement in the script. Therefore the JavaScript function named "invoke_combo_script(. the following JavaScript function must be called: invoke_combo_script(script. because the index will be zero- © 2014 OMNINET GmbH . Some of these effects.2 JavaScript Functions Main Page To invoke a combo script from a custom list layout on the main page. Combo Scripts can be invoked from JavaScript on the main page and on object forms. On object forms there are several possibilities to use Javascript.UserData(0) can be used. Optional parameters can be accessed using ScriptParameters. then the following methods are not allowed: OpenObject OpenNewObject An error is displayed if one of these script methods is invoked. function. can trigger other combo scripts. If more than one parameter has to be passed.)" must be called. You can find more information about Combo scripts in the Automation Interface help. WriteSchema) (This list may be incomplete) Select Object dialog If a script is executed in a search form within the Select Object dialog. To access the first parameter of an array ScriptParameters. WriteLayout. you can call functions that trigger client side effects after the script exits.. Inside combo scripts. parameters) The first two parameters define the name of the Combo script and the name of the function to be executed.10. On the main page for example a button which calls this function can be placed within a custom list layout.1 Introduction Combo scripts are server-side scripts that are invoked usually from the shortcut bar or from a search form. 4. 4.10 Invoking Combo Scripts from JavaScript 4. on their part.UserData.204 OMNITRACKER Web Gateway Manual OtTask (Execute. an array of strings can be used as third parameter.10. The third parameter is optional and is available as string in the combo script. ScriptParameters.Item(i). Here an example combo script which opens a new document. invoke_combo_script('combo1'. sub openDoc PerformAction.'') ) Here an example combo script which opens an object in the given folder with the given title: sub openObj dim folder set folder = ActiveSession. 'subA') will invoke the function named "subA" in the combo script "combo1".Requests. 'openObj'.UserData 'PerformAction.GetRequestFolderByPath (ScriptParameters.OpenDocument ScriptParameters.Requests.UserFields("Title").UserData(0) can be used alternatively end sub Example with more than one parameter To pass more than one parameter an array must be created which contains all parameters. 'http://www. false.omnitracker. Example without parameters The function invoke_combo_script('combo1'.OpenObject folder.UserData(0) can be used to access the URL (third parameter).'Printer defect'.OpenDocument ScriptParameters.Count -1 if folder.Value = ScriptParameters.biz') will invoke the function named "openDoc".UserData(1) then PerformAction. Example with one parameter The function invoke_combo_script('combo1'. 'openDoc'.Requests.UserData or ScriptParameters. Custom parameters are not used. true exit sub end if next © 2014 OMNINET GmbH .UserData(0)) for i = 0 to folder.Configuration 205 based. new Array('ServiceDesc\Incidents'.Item(i). 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 If the function "save_and_invoke_combo_scripts(. The second function stores the current object before the combo script is invoked. the combo script is invoked. function. parameters) save_and_invoke_combo_script(script.UserData("ActiveRequestId").206 OMNITRACKER Web Gateway Manual end sub An example how a button which invokes a combo script can be defined in a custom list layout can be found here. Only if saving the object was successful.. Further JavaScript functions are available on object forms: get_unique_id() save() save_and_close() cancel() logout(url) save_and_logout(url) get_unique_id() © 2014 OMNINET GmbH .)" is used. the following functions can be called: invoke_combo_script(script. The Id is returned as string. 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 ActiveRequestId always can be accessed in combo scripts by using ScriptParameters. parameters) The parameters are the same as on the main page.. function. save_and_logout(url) Saves the current object and logs out the current user.. If you are using variables or custom functions you should use a fixed prefix for all names. save() Saves the current object.") If the function "save_and_invoke_javascript(. If all fields are readonly. © 2014 OMNINET GmbH .)" will only invoke the javascript if saving was successful. 'f3'). cancel() Returns to the main page without saving the current object. save_and_close() Saves the current object and returns to the main page. If no url was specified the default logout url will be opened. If no url was specified the default logout url will be opened.onclick="invoke_combo_script('s1'. There are several options to use JavaScript code on object forms: custom list layouts for reference lists fields static text fields (the usage of HTML code must be enabled in the web form editor) within the HTML wrapper code of fields 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 ( . Returns "0" if the object was created but not saved yet.Configuration 207 Returns the unique ID of the current object. logout(url) The session is closed and the user logged out.logout().. a saving operation can not be performed. This means at least one editable field must be on the form... © 2014 OMNINET GmbH . function f1(p1. var b = 3. b). function myfunc_f1(p1. p2) { //custom code } Use prefixes for all names: var myVar_a = 1. • Call JavaScript functions other than your own or those specified in this online help document. var myVar_b = 3. p2) { //custom code } IMPORTANT NOTE: Any JavaScript code that you inject in any of OMNITRACKER’s 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. • Use non-standard DOM or CSS extensions. • Insert HTML code anywhere except in regions generated by the XSLT stylesheet of the “HTML formatting for lists” feature. • Perform refreshs or reloads of the web page. myVar_b). myFunc_f1(myVar_a. • Use non-standard JavaScript extensions. f1(a.208 OMNITRACKER Web Gateway Manual This can help to avoid naming conflicts between your code and the JavaScript code used by the Web Gateway. Do NOT use very short names like in the following example: var a = 1. 0 and newer.com/products/ZipEnable/evaluation). we describe how to enable compression for IIS 6.. If you do not follow the above rules.11 Speeding up the Web Gateway using HTTP compression If users experience bad performance when they are connected to the Web Server via a slow connection.Configuration 209 • Access the file system or load applets or ActiveX controls. open its context menu and select "Properties". The calling the both functions "save().)". select the tab "Service" Check the items “Compress Application files“ and “Compress static files“ © 2014 OMNINET GmbH . 4.)" but the combo script (sometimes) is not invoked The combo script only is invoked if the saving action was successful. In this document. your code may cease to work in future versions of OMNITRACKER or in future web browser versions.1 and earlier. logout()" but the object only is saved without logging out. function "save_and_logout()" must be used instead. Therefore the object must not be readonly.exe Select "Website" in the tree. Step 1 . If the object is locked or if the form does not contain any writable field.Enable compression: Launch inetmgr.)" was used. Hints for Troubleshooting Problem Solution ScriptParameters.. I'm using "save_and_invoke_combo_script (. I want to save and logout by Calling more than one function in a row is not supported.UserData ("ActiveRequestId") returns an error The ActiveRequestId only can be accessed if "save_and_invoke_combo_script(... There are programs that allow compression for IIS 5. Compression will increase your transfer speed but will also place an additional load on the server and client CPUs. HTTP compression requires HTTP 1. you might want to use HTTP compression. for example "ZipEnable" by Port80 Software (http:// www. combo scripts can not be invoked by using "save_and_invoke_combo_script(. which is recommended by Microsoft. Only activate the compression if your server's average processor does not exceed 80%.port80software...1 and is available for most modern browsers. select "Web service extensions" Open the context menu in the list. select "Add new web service extension" © 2014 OMNINET GmbH .210 OMNITRACKER Web Gateway Manual Step 2 .Install gzip: In the IIS Manager. xml: Use a text editor to edit "%WINDIR%\system32\inetsrv\MetaBase.dll" HcCreateFlags="0" HcDoDynamicCompression="TRUE" HcDoOnDemandCompression="TRUE" HcDoStaticCompression="TRUE" HcDynamicCompressionLevel="10" HcFileExtensions="htm html txt js css" © 2014 OMNINET GmbH . add the file %WINDIR%\system32\inetsrv\gzip.dll (it might also be located somewhere else) and mark the extension as "Allow" Step 3 .xml" (make a copy to be safe!) Find the first two keys with the name "IisCompressionScheme" (the "location" should end with "deflate" and "gzip") Edit the keys in the following way: <IIsCompressionScheme Location ="/LM/W3SVC/Filters/Compression/deflate" HcCompressionDll="%windir%\system32\inetsrv\gzip.Configuration 211 Assign a name like "HTTPCompression".Adjust MetaBase. the browsers must have HTTP 1. you can activate it like this: Extras/Internet options -> Tab Advanced -> HTTP 1.1 is usually activated by default.212 OMNITRACKER Web Gateway Manual HcOnDemandCompLevel="10" HcPriority="1" HcScriptFileExtensions="asp dll exe aspx" > </IIsCompressionScheme> <IIsCompressionScheme Location ="/LM/W3SVC/Filters/Compression/gzip" HcCompressionDll="%windir%\system32\inetsrv\gzip.Browsers: In order to use compression. Under Internet Explorer. HTTP 1. Step 4 .dll" HcCreateFlags="1" HcDoDynamicCompression="TRUE" HcDoOnDemandCompression="TRUE" HcDoStaticCompression="TRUE" HcDynamicCompressionLevel="10" HcFileExtensions="htm html txt js css" HcOnDemandCompLevel="10" HcPriority="1" HcScriptFileExtensions="asp dll exe aspx" > </IIsCompressionScheme> Save the file and restart the IIS service.1 Settings -> Check "Use HTTP 1.1" © 2014 OMNINET GmbH .1 activated. Part V . g. we recommend to use the browser Firefox or Internet Explorer 9 or higher. Feature DropDown filtering Limitation If chrome is used. Only images from the gallery or photos can be uploaded. Limitations on Desktop systems Feature Limit Search Form Height Formatted Text Limitation Not supported if Internet Explorer 7 or older is used.214 OMNITRACKER Web Gateway Manual 5 Troubleshooting 5. the limitations of mobile devices are listed.1 Limitations Depending on the used browser. it may be necessary to use two fingers for scrolling. To the Web Gateway it seems that the browser was closed. We recommend to use at least Internet Explorer version 9. Attachment upload On iPads it is not possible to browse the file system. formatted text fields which contain formatted text are readonly. dialog © 2014 OMNINET GmbH . then it's possible that the session is closed after a short time duration. Horizontal scrolling in On iPads. it's not possible to filter items in a DropDown list Workaround: Type in SPACE and then BACKSPACE. to add or remove brackets). On desktop systems. Always Close Session If the screen timeout is reached or if the device is set to sleep mode. Plain text can be edited. there are differences in the look-and-feel depending on the used browser version. You should enlarge the screen timeout on the mobile device or disable "Always close session". we recommend to use the latest version of the browser Chrome or Firefox. Only supported if Internet Explorer or Firefox (desktop versions only) is used. then the items are filtered. there may be some restrictions in the usability of the Web Gateway. lists Alternatively it is possible to scroll with one finger in the header of the list. Filter definition (Rule) It's not possible to select multiple lines (e. Further down. On all other browsers. Limitations if a mobile device (tablet) is used On Android devices. If Internet Explorer is used. Note: If you encounter any problems on a mobile device.. Error accessing OtAut (32-bit) on a 64 bit machine The error message "Retrieving the COM class factory for component with CLSID.21 .0 framework. Using any other browser may solve the problem." is displayed on opening the Login page.0.Internal Server Error uses the .NET\Framework\v4.NET 4. should do the following: Check whether the problem is solved by the current version of the browser.30319 \aspnet_regiis -i) Make sure that the "ASPNET" and the "worker process" have sufficient (read+execute) rights on the directory where the Web Gateway is installed and on the directory where the automation interface is installed.0.NET Framework" are allowed On IIS 7 make sure that the Application pool HTTP Error 500.19 . 5.NET framework with the following command (run the command shell as administrator) (%windir% \Microsoft.Troubleshooting 215 Object/Reference List It's not possible to select multiple objects. an error appears instead of the login page.Internal Server Error Pages" and ".NET\Framework\v4.. the 64bit and the 32-bit engine: Download here Run this command: C:\%windir% \Microsoft. Handler "PageHandlerFactory-Integrated" has a On IIS 7 make sure that the Application pool bad module "ManagedPipelineHandler" in its enables 32-Bit Applications (only necessary module list if the 32-bit Automation Interface is installed) Install the . © 2014 OMNINET GmbH IIS 6: Please download and install this special framework version which contains both.2 Hints for Troubleshooting Problem Solution When starting the Web Gateway for the first Check the following: time. If Internet Information Services (IIS) 6 is used: Make sure that under "web service Example errors: extensions" the options "Active Server HTTP Error 500.30319 . be displayed. (%windir% \Microsoft.216 OMNITRACKER Web Gateway Manual \aspnet_regiis -i To enable IIS 6. Web-Service Extensions please set the ALLOW flag for ASP.0.NET v4.} appears Interface before installing the Web Gateway.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.NET framework. an error messages You did not install the OMNITRACKER Automation about a missing module with CLSID {.NET framework to fix the problem.Execute the following command: cscript. make sure that static content can time. Open the properties window and enable 32-bit Applications make sure that the OtAut. please try the following: In IIS-Manager.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 . Server after you installed the .exe adsutil.30319 \aspnet_regiis -i) On the login dialog page.. .0..Open the Web Gateways application pool in the IIS manager. OMNITRACKER Automation Interface can be installed from OMNITRACKER Client/Server setup using the "Client only". (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.NET\Framework\v4.0 to run 32-bit applications on 64-bit Windows . You have to re-install the .Open a command prompt and navigate to the %systemdrive%\Inetpub\AdminScripts directory. "Client & server" or © 2014 OMNINET GmbH .vbs set W3SVC/AppPools/ Enable32BitAppOnWin64 true If the steps above do not solve the problem. The and it's not possible to log in. the login screen is not displayed correctly. NET Framework is enabled in the Web Service Extensions Firefox shows an authentication dialog if Single This is the default behaviour in Firefox.trusted-uris Multiple server names can be separated by ". you can determine the zone by looking at IE's status bar.delegation-uris network.NET Framework not correctly installed (run aspnet_regiis command) IIS 6 Manager: Make sure that the . ServerDev" Internet Explorer shows an authentication dialog if Single Sign-On is used. the zone is displayed using the "File > Properties" menu. Example: "localhost.trusted-uris network.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 . 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. IE shows an authentication dialog if the URL refers to a web server that is not in the current Intranet zone.".NET 4. OR The Application Pool.negotiate-auth.automatic-ntlm-auth.Troubleshooting 217 "Custom" options. In IE version <= 8. The Web Gateway does not work HTTP Errors or other errors are displayed Frequent reasons: Wrong . © 2014 OMNINET GmbH By default. In IE9. which is used by the Web Gateway (see IIS settings) is not running in 32-bit mode.NET Framework selected in Application pool (.negotiate-auth. For example "http:// . In the Local intranet dialog box. In the next dialog box. It's possible that old style sheet information are cached by a proxy or by the browser.com" might refer to different security zone. type the URL of the Web Gateway Server (for example.mydomain. under Logon.218 OMNITRACKER Web Gateway Manual myserver" and "http://myserver.NET Impersonation must be enabled Anonymous Authentication must be disabled The message "Your session has timed out" is displayed. and then click OK. https:// myserver. Internet Explorer shows an error: An unexpected This problem can be caused if some special characters are used in the URL. Close the configuration dialogs by clicking OK. The message "User NT-AUTHORITY/IUSR has no permission to access OMNITRACKER" is displayed. The Web Gatway looks strange after an update The page structure of the Web Gateway or the used visual elements may have changed.mydomain. Configure Internet Explorer for automatic logon: 1. e.com". 6. 7. 5. 4. Make sure that no underscore is used in the machine or domain name. and then click Add. Maybe the OTWG_StyleSheet file contains © 2014 OMNINET GmbH . click Advanced. click Sites. In IIS Manager make sure that: Windows-Authentication is installed and enabled ASP. 2. Open the Internet Options dialog box by choosing Internet Options either from Control Panel or from the Tools menu in Internet Explorer. even if the local PC is in domain "mydomain. 3. and then click Custom Level. select Local intranet. if Single Sign-On is used. In the Internet Options dialog box. on the Security tab. underscore ("_"). In the Security Settings dialog box.com) in the Add this Web site to the zone box. select Automatic logon only in Intranet zone. The timeout settings can be changed with the WebConfig Editor. In the Internet Options dialog box on the Security Settings tab with Local intranet still selected.g the error occurred (unknown). This message is displayed if the Web Gateway wasn't used for a specified period of time (10 minutes by default). One of the following errors is displayed on the Login page: Please read the hints on the Basic Authentication page Missing Authorization Header Missing User Name Header 401 Unauthorized The upload/download of (very) large attachments Enlarge the executionTimeout attribute of the stops after one minute before it is complete. In a folder which has a custom list layout. <httpRuntime>-Tag in the web. please try the following: Change the Application Pool of the crystal reports web application (aspnet_client) to run in Classic mode 1. Reports are not displayed correctly missing buttons missing diagrams error message "Assembly not found" Make sure that you have installed the Crystal Reports Runtime Components for Visual Studio 2010 (CRVS2010) which can be downloaded here." Note: NETWORK SERVICE is in most cases configured as default identity for the Web Gateways Application Pool (please check the settings in the IIS) Make sure that your XSLT style sheet is well formed. select the Application Pool and Basic Settings 2.config file. The error message "bobj is undefined" is displayed Run the WebConfig Editor and select the Crystal Reports assembly version "2010".Troubleshooting 219 custom style attributes which cause problems after an update. the following error message is displayed: "The stylesheet does not contain a document element. External editors can be used check the syntax of the style sheet. The © 2014 OMNINET GmbH . In IIS Manager. Under Managed Pipeline Mode change from Integrated Mode to Classic Mode In addition this error may be displayed if cookies are disabled. HTML Reports are not displayed correctly Make sure that you have installed the Crystal Reports Runtime Components for Visual Studio 2010 (CRVS2010) which can be downloaded here. or it may not be a well-formed XML document. OR The upload of attachments is not possible because the path <virtual directory>\uploads is not accessible. If the problem still exists. Make sure that the user NETWORK SERVICE has The message "HTML content of memo fields cannot be displayed" is shown on object forms sufficient rights to create files in the folder <virtual with memo fields of subtype "HTML Mail Body". Run the WebConfig Editor and select the Crystal Reports assembly version "2010". directory>\uploads. The stylesheet may be empty. config file can be listed. The WebConfig Editor can be used to change the value. an event will be logged to the application log noting that aspnet_wp.exe could not be started. (%windir% \Microsoft. When you try to login for the first time.NET framework to fix the problem.config file: <add key="OT_Hostname_virtWebName" value="serverName" /> The string "virtWebName" must be replaced by the name of the virtual Web Gateway which is defined in the IIS. a .NET framework on a domain controller host. "ASP. To make existing virtual Web Gateways configurable with the WebConfig Editor the following entry must be added to the "appSettings" section in the web.0. The 4 MB.NET installation.220 OMNITRACKER Web Gateway Manual default value for this tag is 60 seconds.NET\Framework\v4. Instead. The HRESULT for the failure will be 80004005. All I get is one of the following error messages: "page not found" To change this behaviour. There are two workarounds for this problem: Set the userName attribute to SYSTEM in the <processModel> section of the Machine.config of your .config file. WebConfig Editor to create new virtual Web Gateways. © 2014 OMNINET GmbH . In addition.NET framework.30319 \aspnet_regiis -i) It's impossible to upload attachments larger than This is. framework does not accept HTTP-requests (and therefore uploads) larger than 4096 KB. The WebConfig Editor does not display (all) the Only the Web Gateways that are defined in the virtual Web Gateways which are listed in the web. the site could not be accessible (see Microsoft Knowledge Base Q315158. the Probably you have installed the Internet Information Browser offers you to download the login page or Server after you installed the .NET framework default. the account must be an Administrator account. This configures the worker process to run as the SYSTEM identity. there could be a serverwide setting that will overwrite your application setting. look for the <httpRuntime> in the machine. To configure an arbitrary account for the process.config file (The WebConfig Editor can be used to change the value).config file. If you try to install the .NET Does Not Work with the Default ASPNET Account on a Domain Controller"). You asks for the application for this type of file. You should use the Internet Information Services (IIS) Manager. again. You can configure an arbitrary account for the process in the <processModel> section of the Machine. have to re-install the . To verify and possibly change this. edit the "Maximum request length exceeded" maxRequestLength attribute of the <httpRuntime>tag in the web. © 2014 OMNINET GmbH Check your IIS configuration.) After I close a popup object form. the object is still locked. Configuration File). 30000000 kBytes.30319 \CONFIG with %windir% refers to your Windows installation directory. It's not possible to upload/download attachments. The Web Gateway seems to halt unexpectedly at times. To verify this. Please make sure you have the latest service pack for the . It's not supported by Firefox. There are inexplicable error messages.NET framework installed. Accessing the clipboard only is possible with Internet Explorer. uploadable file size to 50MB. This could be caused by a known issue with the Microsoft .HTTP-Error requestLimits@maxAllowedContentLength" in the 404.maxAllowedContentLength:5000000 0 (The value "50000000" sets the max. All locked objects will be unlocked as soon as you either log out (s . the key "configuration/system.) Copy & paste not possible in formatted text fields. a. The option "Always close session" available under "File | Web Gateway settings" might fix the problem. Please make sure you have the latest Service Pack installed (s.Main Page) or your session times out (s. You probably closed the browser window using the window's closing button. the object remains locked.Troubleshooting 221 %windir%\Microsoft. file "%windir%\system32 \inetsrv\config\applicationhost. It's impossible to upload attachments larger than IIS 7 restricts the maximum content length to 30 MB on IIS 7 web servers.NET\Framework\v4. Use the Button (s.NET framework. Make sure that the user NETWORK SERVICE (which is per default .Not Found" is displayed. Since there's no way for the server to know when a client window is closed.webServer/security/ The page "Server error in the application requestFiltering/ DEFAULT WEB SITE/OTWG .13 . If you want to change this value. Object Page) instead to close forms.0.config" must edited: Click "Run" in the windows start menu and enter the following command: %windir%\system32\inetsrv\appcmd set config section:requestFiltering requestLimits. please follow the instructions in this Knowledge Base article. other browsers do not support windows authentication) The option "Automatic login using current username and password" (open "Tools | Internet options | Security". activate "Integrated Windows authentification" instead.g. c:\windows\temp) and is configured to be world-writeable in case your operating system utilizes NTFS or a similar permission-capable file system .exe). You can confirm this by looking at the event log. service can't launch the Excel application due to insufficient rights. respectively). if there is an error (with code 10002) whenever a user logs into the Web Gateway. The following error message appears: "CS0013: Unexpected error writing metadata" The system variables "TEMP" or "TMP" do not refer to an existing directory or the directory is not accessible by the user "ASPNET" You try to log in using a WebGuest login Check your configuration for the following: account with Windows login authentication. the XLS output type The most likely reason is that your IIS network is not listed. but You are using the Internet Explorer (most the login page appears nevertheless. select the item "Microsoft Excel" Open properties © 2014 OMNINET GmbH . do the following: Launch DCOMCNFG. If you select a export task. Deactivate this in the IIS Manager (inetmgr. section "System". select the respective zone and click "Adjust settings") is set The client computer from which you try to log on is in the same domain as the OMNITRACKER server The IIS does not allow anonymous logins. make sure a temporary directory exists on the server (e. in the properties dialog of your Web Gateway directory. Furthermore.EXE Open the category "Component services/ Computer/My Computer/DCOM configuration" in the tree. access" on the <virtualdirectory>\uploads and <virtualdirectory>\icons directories (usually c: \inetpub\wwwroot\OTWG\uploads and c: \inetpub\wwwoot\OTWG\icons.222 OMNITRACKER Web Gateway Manual OR configured in the Application Pool) has "Full Error messages about inaccessible files appear. open the tab "Directory security" and deactivate the option "Anonymous login". To grant the network service the necessary rights. The main list displays wrong content.css" contains updated. This could happen if the database recently changed. See the event log for details on which rights to grant. OR Check that your Browser is configured to search for new versions of the page on each access of the page. conflicting CSS code after an update. The Web Gateway works rather slow on slow internet connections. Click "Edit" and make sure that the verbs are limited to "GET. Configuration. Not all images are displayed in the Web Gateway or an icon with a red X on it is displayed instead of the intended icon. The appearance of the Web Gateway user Try to clear the browsers cache. the cause. A guide for installation of HTTP compression is located here.Troubleshooting 223 In the security tab. Try restarting the Internet Information Service (IIS). Mappings the extension ". also check if Microsoft Excel is installed on the computer running the Web Gateway. so check the following: Is there a shortcut bar defined for the current user in the Web Gateway? Does the user have the right to see at least one group? Does the user have the right to see at least one item in a visible group? Does the user have the rights to perform the action associated with one of these items (e. interface is defective after the Web Gateway was Maybe the file "OTWG_StyleSheet. There is no shortcut bar for some users although If there are no items to display for a particular user. the web configuration option "Hide shortcut bar" the entire shortcut bar is hidden.axd" exists. set the "Launch permissions" and "Access permissions" such that the local user for the network service (German: NETZWERKDIENST) (Windows 2003 server) or the local user ASPNET (Windows XP) has sufficient access rights. Try using HTTP compression. The option "verify that file exists" must not be selected. "create object" permissions for the folder to which a "create new object" shortcut link points)? Sometimes Field Mappings with the option "selected object" do not work correctly.g. Restart the Internet Information Service (IIS) Although it may sound obvious. The following error message appears: "UnauthorizedAccessException: Retrieving the © 2014 OMNINET GmbH Check that the Automation Interface is installed on the Web Server. This is probably is set to false.POST. Make sure that under Directory. Pictures in the shortcut bar and/or in the folder tree are not displayed. .HEAD. Check your IIS configuration.DEBUG". Select the tab "Folder security" and click the button to edit the anonymous access and authentication. This Windows Vista computer with IIS 7. RPT file!" or executing exports fails with the message "The directory name is invalid".. Anonymous Access must be disabled Use integrated windows authentication must be enabled Open the web. but Make sure that the web configuration option not in the Web Gateway "Single Sign-On (allow)" is enabled (under general options). make sure that the feature "Windows Authentication" is installed.0. (Control Panel | Programs and Features | Turn Windows Features on or off | Internet Information Services | World Wide Web Services | Security | Windows Authentication) Check the IIS settings: Open the properties dialog of the Web Gateway website.config file: The line "<identity impersonate="true"/>" must be added to the <system. In order to solve any problems regarding single sign-on.. the WebGW The IIS has no write access on the directory returns the error "Could not create directory for containing the local language files.web> section if not present. the required files are copied during the first login 3. If IIS 7 is used. executing option is located in the IIS Manager under the reports fails with the message "Could not write application (OTWG)/Authentication. Error 80070005" The following error message appears: "Access denied" The IIS_WPG Process must have access to the Automation Interface (C: \Programme\OMNITRACKER\OtAut. deactivate "Impersonating". 2. Single Sign-On works in the Windows client.224 OMNITRACKER Web Gateway Manual COM class factory for component with CLSID.. The easiest way: Login with a OMNITRACKER client on the web server computer When the Web Gateway is installed on a In the IIS settings." when a user tries possibilities: to login with this language 1. You have three server specific languages: .dll) After creating a new language. Create the directory in the error message manually. please see Single Sign-On Troubleshooting in the Administrator Guide © 2014 OMNINET GmbH . Grant the IIS user full access to the "Languages" subdirectory of the OMNITRACKER installation directory on the web server.. <location path="Report.web> <identity impersonate="false" /> </system. if the windows authentication is enabled in IIS for the editable grid is used to modify an object.. When the process is recycled.web> </location> <location path="Export.aspx"> <system. Open the properties dialog and click the tab "Recycling". Possible workarounds: Make sure that in Internet Explorer a proxy is configured. Web Gateway.Troubleshooting 225 An error message like "User Check that the web. All other settings are not selected.web> <identity impersonate="false" /> </system.aspx"> <system. Gateway.config contains the following <MACHINENAME>/. The session is not closed although the Web Gateway wasn't used for a longer time than specified as session timeout © 2014 OMNINET GmbH The session cannot be closed automatically if the main page is displayed and if an automatic refresh interval is defined for the object list. The users are redirected Application-Pool that is configured for the Web to the login page.web> </location> <location path="PrintReport. .aspx"> <system. Use Firefox instead... which is NOT bypassed if the Web Gateway is accessed. not found" appears when lines within the "<configuration>" section: you try to execute reports. The error message "Request status: 12015 This is a known problem of the Internet Explorer.web> <identity impersonate="false" /> </system. all active Sessions will be closed. Disable windows authentication and enable anonymous login in the IIS for the Web Gateway. if unknown" is displayed in Internet Explorer.web> </location> Sometimes all open Web Gateway sessions are If IIS 6 is used please check the settings of the closed simultaneously. The default setting is that the worker process is recycled every 1740 Minutes. 2. Since version 10. The best approach is to use a tool like "Process Monitor" to check which files/folders are accessed by the w3wp.config: <add key="OT_Icon_Default_Size" value="16"/> (value="16" means the the default size shall be 16x16px) The default size also can be disabled: <add key="OT_Icon_Default_Size" value="disabled"/> Downloading Attachments not possible. For the best appearance all used images of type icon should contain the following sizes: 16x16px. The temporary file folder depends on the operating system. 24x24px and 32x32px. then most browsers use the smallest size.exe process.226 OMNITRACKER Web Gateway Manual Note: This interval can be configured in the Web Gateway Configuration Window Images of type "icon" are displayed in wrong size. OMNITRACKER trys to extract the picture in 32x32 pixels. The default size (32x32px) can be changed by adding the following key to the web. © 2014 OMNINET GmbH . If icons are used which contain different sizes. (A timeout may occur) The attachment download may fail due to insufficient file system permissions of the Application pool identity. Otherwise the images will be scaled from the next available resolution. however scrolling is possible. (The polling mechanism will still be used to detect closed browsers) Example: <add key="OT_BrowserClosedLogoutTimer" value="70000" /> (If this key is missing in the web. it can be added. Scroll-bar not shown if mobile browsers are used Scroll-bars are by design not shown in many mobile browsers like Safari. Check if this problem is caused by the Web Configuration Option "Always Close Session" by disabling this feature temporarily. scrolling is possible with finger over the Shortcuts or Folder © 2014 OMNINET GmbH . please try the following: Search the key "OT_BrowserClosedLogoutTimer" in the web. Make sure that there is no PROXY which caches information between client and web server. If Internet Explorer is used. make sure that a new version of the page is searched every time a page is accessed (check IE Cache settings) supervise the process ID of the W3WP process to find out if the IIS was restarted. If this problem is caused by the Feature "Always Close Session".config's <appSettings> section.config file. The default value is "20000") Scroll-bar not visible if Safari browser is used In order to show the vertical Scroll-bar in safari the next System Preference is necessary: Go to: System Preferences -> General -> Set the option to Always: Show scroll bars: Always. If Safari Mobile is used. Set the value to a higher value than 10000 ms (useful if the network is slow) OR Set the value to "false" to disable it.Troubleshooting Sporadic session timeouts 227 Please try to clear the browser cache on the affected machine. Due to cross domain policies of browsers it may be possible that some browser cannot access the session cookie. For Grids with many columns. It has to be clicked multiple times. Not all browsers are affected. Sometimes the DateTime picker does not open. Make sure that there is no proxy server defined in the browser settings which caches content of the Web Gateway. with a finger over the columns header.228 OMNITRACKER Web Gateway Manual area. Try to clear the browser cache Use the IE caching setting "load new version every time the web site is accessed" Unknown exception if the Web Gateway is embedded inside an IFRAME. Please check if disabling cookies in the WebConfig Editor Tool solves this problem. © 2014 OMNINET GmbH . 119 Configuration Overview 86 Configuration Window 163 Control size 149 Cookies 90 © 2014 OMNINET GmbH 215 90 -D- -BBase filter 118 Base Filter Window 118 Button configuration 163 Button Properties 158 Button Properties Subpanel 229 Edit Filter Parameters 75 Editable Grid 34 Editing in the Tree View 34 Email Notification 90 Enable Quick Serach 140 Errors 215 Execute Task 78. 150. 145. 100. 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. 163 Configuration File#OT_configuration 86 Configuration options 101. 82 Default Folder 112 Default Search Form 73 Delete 40 Deletion of objects 34 Design Subpanel 153 Dialog Titles 100 Display Subpanel 152 -E154. 90. 158 -FField properties 140. 141. 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 . 152.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.Index Copy & Paste . 123 Installation 10. 154 GetSelectedObjects 195 GetTabLabel 196 Guest Login 112. 90 Introduction 8 invoke combo scripts 178 -JJavascript methods Limit Search form height List of references 75 List View 34 Locale setting 12 Log directory 90 Logging 90 Logging errors 90 Login Language 12 Login page 15 Login with filter 12 LogMessage 196 204 Main page 34 Managing Web Themes 170 Max. 123 Import Wizard 121.copy & paste Fullscreen mode 126 Full-text search 76 215 -GGeneral Subpanel 140. 17 OT_LogLoadTimes 28 157 -PPaging 40 Panes Control 34 Performance 209 © 2014 OMNINET GmbH . 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 -IIcon default size 215 Icon quality 215 IIS 215 Image qualiy 215 Import 121.230 OMNITRACKER Web Gateway Manual Formatted text Text align 72 -L- Formatted text . 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. 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. 119. 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. 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. 76. 123 Web Configuration Option Window 119 Web Form Editor Window 126 Web forms 126. 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 . 75 Search Fields 126 Search Limit 100 Search properties 152. 78. 159. 163. 121. 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 © 2014 OMNINET GmbH Single Sign-On 12. 153 -RReadonly Licenses 12 RecursiveSearch 194 Redirection URL 86. 158.Index Port 86 Preview Window 166 -QQuick Quick Quick Quick Search 62. 232 OMNITRACKER Web Gateway Manual Web Themes 126 web.config file 86 WebConfig Editor 90 WebGW using HTTP compression 209 -XXSLT examples XSLT list layout 178 175 © 2014 OMNINET GmbH .
Copyright © 2024 DOKUMEN.SITE Inc.