To select HyperDoc database to be used by HyperDoc Online open HDocASP.ini file located in Program subdirectory of the installation directory. Enter information in [Database Settings], [Access Settings], [Options], [ODBC Settings] sections as appropriate for your installation. These setting are analogous to respective settings in HDoc.ini file in standard HyperDoc product. Please refer to HyperDoc manual for further details.

IMPORTANT: Please note that HDocASP.ini file contains confidential information like user name and password used to access databases. So it is of utmost importance to remove read permissions to this file. It can be performed using Internet Service Manager after completing configuration.

User name and password in the [Access Settings] or [ODBC Settings] section must always be supplied, since HIS uses them to connect to the database and they determine database rights of all HyperDoc Online users. Their application access rights can be determined in one of two other ways. HyperDoc Online either works in anonymous mode (user defined in the [anonymous user] section determines application rights for all users) or uses credentials supplied via the Web browser for each user separately.

When using SQL Server databases appropriate system data source must be defined and its name entered in HDocASP.ini file.

Example settings for Microsoft Access database.

[Database Settings]
DBType=Access

[Access Settings]
MainDatabase=C:\Program Files\Tessel Software Line\HyperDoc\DemoDB\NetMan.mdb
UserName=Admin
Password=admin

[Options]
SystemDB=C:\Program Files\Tessel Software Line\HyperDoc\DemoDB\System.mda

Example settings for Microsoft SQL Server database.

[Database Settings]
DBType=ODBC

[ODBC Settings]
MainDatabase=DRIVER={SQL Server}; PROVIDER=SQLOLEDB; Database=database_name; SERVER=server_name
RDO=0
UserName=admin
Password=admin

HyperDoc Online supports running multiple HyperDoc databases on the same server. This can be achieved thanks to HyperDoc Online feature of reading HDocASP.ini from Config subdirectory of ASPPages, if one exists. You must perform the following steps to enable more than one database.

Alternatively you can use obsolete method of cloning whole ASPPages directory.

To enable IIS 6 Management Compatibility please perform following steps:

To enable ASP on Windows Server 2003:

To enable ASP on Windows Server 2008:

To use HyperDoc Online you must configure the Internet Information Server.

  1. Start Internet Service Manager (located in Programs/Windows NT 4.0 Option Pack/Microsoft Internet Information Server folder).

  2. Select the web site you want to use (usually this is Internet Information Server/*your-host/Default Web Site).

  3. Right-click on it and select New/Virtual directory. The New Virtual Directory Wizard should show on the screen.

  4. Enter the name for Alias to be used to access virtual directory (e.g. HyperDoc Online) and press the Next button.

  5. Enter path with content - this should be full path to ASPPages subdirectory of HyperDoc Online installation directory - and press the Next button.

  6. Set required access rights to Read and Script and press the Finish button.

  7. Right-click on the new virtual directory, select Properties, check the Run in separate memory space box and press Apply button.

  8. Switch to the Documents tab, make sure that Enable Default Document box is checked and add either hismain.html or hislogin.asp as the default document - depending on the desired login mode (see the section called “Login modes” for more information).

  9. Switch to Directory Security tab and press Edit button in Anonymous Access and Authentication Control.

  10. In Authentication Methods dialog make sure that Anonymous Access is checked, Integrated Windows authentication and Basic authentication are unchecked and press Edit button for Account used for Anonymous Access.

  11. In Anonymous User Account dialog:

    1. select appropriate user account - this user should be able to access HyperDoc database and document store - if the database or the document store reside on a separate computer this should be a domain account,

    2. make sure that Enable Automatic Password Synchronization is not checked,

    3. make sure that the password for this user is entered correctly.

    This user password should not be changed or each password change should be appropriately reflected in IIS configuration.

  12. Press OK button.

  13. Verify that the user specified in previous step has access to the HyperDoc Online installation directory.

  1. Start Internet Services Manager (located in Programs/Administrative Tools folder).

  2. Select the web site you want to use (usually this is Internet Information Services/*your-host/Default Web Site).

  3. Right-click on it and select New/Virtual directory. The Virtual Directory Creation Wizard should show on the screen.

  4. Enter the name for Alias to be used to access virtual directory (e.g. HyperDoc Online) and press the Next button.

  5. Enter path with content - this should be full path to ASPPages subdirectory of HyperDoc Online installation directory - and press the Next button.

  6. Set required access rights to Read and Run scripts and press the Next button.

  7. Press the Finish button.

  8. Right-click on the new virtual directory, select Properties, choose High (isolated) item from Application Protection combo box and press Apply button.

  9. Switch to the Documents tab, make sure that Enable Default Document box is checked and add either hismain.html or hislogin.asp as the default document - depending on the desired login mode (see the section called “Login modes” for more information). NOTE: Added item should be first on list.

  10. Switch to Directory Security tab and press Edit button in Anonymous Access and Authentication Control.

  11. In Authentication Methods dialog make sure that Anonymous Access is checked, Integrated Windows authentication and Basic authentication is unchecked and press Edit button for Account used for Anonymous Access.

  12. In Anonymous User Account dialog:

    1. select appropriate user account - this user should be able to access HyperDoc database and document store - if the database or the document store reside on a separate computer this should be a domain account,

    2. make sure that Allow IIS to control password is not checked,

    3. make sure that the password for this user is entered correctly.

    This user password should not be changed or each password change should be appropriately reflected in IIS configuration.

  13. Press OK button.

  14. Verify that the user specified in previous step has access to the HyperDoc Online installation directory.

  1. Start Internet Information Services (IIS) Manager (located in Programs/Administrative Tools folder).

  2. Select Web Service Extensions branch and allow Active Server Pages).

  3. Select Application Pools branch (Internet Information Services/*your-host/Application Pools).

  4. Right-click on it and select New/Application pool.... The Add New Application Pool dialog box should show on the screen.

  5. Enter the name for Application pool ID (e.g. HyperDoc Online) and press the OK button.

  6. Right-click on the new application pool, select Properties, choose Identity tab, select Configurable Application pool identity select appropriate user account - this user should be able to access HyperDoc database and document store - if the database or the document store reside on a separate computer this should be a domain account

  7. Select the web site you want to use (usually this is Internet Information Services/*your-host/Web Sites/Default Web Site).

  8. Right-click on it and select New/Virtual directory. The Virtual Directory Creation Wizard should show on the screen.

  9. Enter the name for Alias to be used to access virtual directory (e.g. HyperDoc Online) and press the Next button.

  10. Enter path with content - this should be full path to ASPPages subdirectory of HyperDoc Online installation directory - and press the Next button.

  11. Set required access rights to Read and Run scripts and press the Next button.

  12. Press the Finish button.

  13. Right-click on the new virtual directory, select Properties, choose Application Pool created previously in Application pool combo box and press Apply button.

  14. Switch to the Documents tab, make sure that Enable Default Document box is checked and add either hismain.html or hislogin.asp as the default document - depending on the desired login mode (see the section called “Login modes” for more information). NOTE: Added item should be first on list.

  15. Switch to Directory Security tab and press Edit button in Anonymous Access and Authentication Control.

  16. In Authentication Methods dialog make sure that Anonymous Access is checked, Integrated Windows authentication and Basic authentication is unchecked and press Edit button for Account used for Anonymous Access.

  17. In Anonymous User Account dialog:

    1. select appropriate user account - this user should be able to access HyperDoc database and document store - if the database or the document store reside on a separate computer this should be a domain account (it should be the same user account as used as Application Poll identity),

    2. make sure that Allow IIS to control password is not checked,

    3. make sure that the password for this user is entered correctly.

    This user password should not be changed or each password change should be appropriately reflected in IIS configuration.

  18. Press OK button.

  19. Verify that the user specified in previous step has access to the HyperDoc Online installation directory.

  20. Right-click on new application in Internet Information Services/*your-host/Web Sites/Default Web Site/your_application) and select New/Virtual directory. The Virtual Directory Creation Wizard should show on the screen.

  21. Enter config as a name for Alias to be used to access virtual directory and press the Next button.

  22. Enter path to folder with HDocASP.ini file and press the Next button.

  23. Uncheck Read right and press the Next button.

  24. Press the Finish button.

  25. Right-click on new application once again and select New/Virtual directory. The Virtual Directory Creation Wizard should show on the screen.

  26. Enter lang as a name for Alias to be used to access virtual directory and press the Next button.

  27. Enter path to folder with particular language in ASPPages folder of HyperDoc Online installation folder and press the Next button.

  28. On next page simply press the Next button.

  29. Press the Finish button.

  30. Using the same method create virtual directory called manual. it should point to manual subfolder of language folder selected in previous steps.

  1. Start Internet Information Services (IIS) Manager (located in Programs/Administrative Tools folder).

  2. Make sure ASP is enabled.

  3. Select Application Pools (*your-host/Application Pools).

  4. Right-click on it and select Add Application pool....

  5. Enter the name for Application Pool (e.g. HyperDoc Online) select No Managed Code in .NET Framework version combo box. Click OK.

  6. Right-click on the new application pool, select Advanced Settings..., choose Identity and select appropriate user account - this user should be able to access HyperDoc database and document store - if the database or the document store reside on a separate computer this should be a domain account

  7. Please note that if the operating system is in 64-bit edition then to make HyperDoc Online working, application pool for given HIS site should be enabled to run 32-Bit applications. Setting Enable 32-Bit Applications can be set in Advanced Settings options panel for the application pool.

  8. Select *your-host/Sites and right-click on it and select Add Web Site.

  9. Enter the site name for your application (e.g. HyperDoc Online), select application pool defined in previous steps and define path with content - this should be full path to ASPPages subdirectory of HyperDoc Online installation directory. Click on Connect as... button to select user account - this user should be able to access HyperDoc database and document store - if the database or the document store reside on a separate computer this should be a domain account (it should be the same user account as used as Application Poll identity),

  10. Verify that the user specified in previous step has access to the HyperDoc Online installation directory.

  11. Right-click on new application in *your-host/Sites/your_application) and select Add Virtual directory.

  12. Enter config as Alias a name and enter path to folder with HDocASP.ini file and press the OK button.

  13. Right-click on new application in *your-host/Sites/your_application) and select Add Virtual directory.

  14. Enter lang as Alias and enter path to folder with particular language in ASPPages folder of HyperDoc Online installation folder and press the OK button.

  15. Right-click on new application in *your-host/Sites/your_application) and select Add Virtual directory.

  16. Using the same method create virtual directory called manual. it should point to manual subfolder of language folder selected in previous steps.

HyperDoc Online can now work in two login modes: anonymous and verified.

In anonymous mode users do not need to authenticate to use HyperDoc Online. There are two ways to use this mode:

  1. hismain.html

    To use this mode, make hismain.html page a default page for the IIS application and add section like the following one to HDocASP.ini.

    [anonymous user]
    Username=JohnDoe
    Password=Xyz123!@#
    

    This section defines a database user whose application rights will be given to all anonymous HyperDoc Online users. You cannot connect to HyperDoc Online using hismain.html without a valid [anonymous user] section.

  2. HISAutoLogin.asp.

    It could be used for start UI. It does not require authentication, but must be enabled and IP Restriction is recommended.

    To enable this page, set in INI file, in section [Configuration] parameter:

    HISRestrictedAutoLogin=1;

    When it is enabled, it requires user name and password for anonymous access. Add following section:

    [HIS Restricted Access User]
    UserName=JohnDoe
    Password=Xyz123!@#
      

    Please remember, that this page give unauthorized access to HyperDoc Online, so you should use it with caution - enable IP Restriction.

    To open HIS using HISAutologin.asp type into browser:

    http://HIS_Server_Name/HisAutologin.asp

    This will open HyperDoc Online with Find Object window that will allow you to search and go to desired Object.

    You can also use parameters of specific object or document and add them to url to open using HOPA parameters to open HIS already on this specific object:

    http://HIS_Server_Name/HisAutologin.asp?ObjID=HDocHierarchyDef2|1|HDV_H2_FLOOR|283
    http://HIS_Server_Name/HisAutologin.asp?DocID=2145533

    Using HISAutologin.asp gives you the possibility to open HIS in a Subtree mode (hierarchical tree is narrowed only to the desired object and it's parents up to the root).

    Example use of this parameter can be as following one:

    http://HIS_Server_Name/HisAutologin.asp?ObjID=HDocHierarchyDef2|1|HDV_H2_FLOOR|283&subtree=1&HierName=HDocHierarchyDef2

    This will enable subtree mode as subtree=1 was used (subtree can be added after HierName too if needed). For now subtree value can only be "1".

    You can also use additional parameters in this mode:

    Parameters are:

Proprietary groups and users memberships can be managed from within HyperDoc Admin tool or using hisUsers.asp and newly added hisGroups.asp web pages.

Groups functionality in HyperDoc controlled via hisusers.asp and hisgroups.asp

HyperDoc has been extended with possibility of using proprietary groups with already implemented Proprietary User List mode.

MSSQL users and groups can be also managed using HyperDoc Admin tool and HIS sites described above. But in this case, there are some limitations.

Here are some of them: fixed database roles couldn't be deleted, public role and dbo user shouldn't be managed using above tools. User used by HyperDoc Internet Server needs to have enough rights for users and groups handling (please refer to Microsoft MSDN to check rights requirements).

To enable using of proprietary groups with proprietary users one has to use “Check and Create Extra Tables” option from HyperDoc Configuration Manager's File menu. Then they would be available after setting Proprietary User List mode in HyperDoc Admin from User list mode menu.

There are many possibilities to make web application to use Windows Authentication and cooperate with Active Directory and MS SQL Server. Here is a proposed configuration which could be set for HyperDoc Online.

  1. Follow needed actions from ??? related to Window's domain, domain groups and users, SQL server, logins and rights

  2. HIS application must work under Network Service account.

  3. Network Service account must have access to INI file (check Security of INI file).

  4. Find out what is HDOC's Common Login (by using Database or HDOC Admin)

  5. In INI file in section [ODBC Settings] add username and password parameters using common login credentials.

  6. Open SQL Server Management Studio.

    In chosen Database do:

    • check and create user in master database

      USE [master]; GO;
      CREATE USER [CommonLogin] FOR LOGIN [CommonLogin]
    • add needed execute rights

      USE [master]; GO;
      grant execute on sys.xp_logininfo to [CommonLogin]
  7. On domain controller computer set web server's (IIS) computer account to be trusted for delegation in Active Directory: "Trust this computer for delegation".

  8. Make sure that there are proper Service Principal Names set in Active Directory domain for web server and database server computers (if they are separated – if not only one SPN should be checked).

    Please notice that SPNs should be registered for both servers (ISS server and Database server). If given service works on domain account then it should be registered for this specified account, if not it should be registered for computer account. Additionally SPNs should correspond for names used to access servers (specified in browser url when accessing HIS application, or in HdocAsp.ini where we specify database server name).

  9. Add HIS url to Local Intranet zone in Internet Explorer settings used by client.

    IE should also have Enable Integrated Windows Authentication option enabled (Internet Options/Advanced/Security).

Warning

If you use domain groups in your configuration, they will be also visible in hisgroups.asp page of HIS site. But as they are only users for SQL, you cannot add members to them from this page. This can only be done in domain controller.

Problems with configuring Integrated Windows Authentication for web application, especially when we need to consider "double hop" issue is a really broad topic. Many things could be configured wrong. There are also some limitations for usage scenarios.

For diagnosing problems with Windows Authentication we strongly suggest usage of DelegConfig application. It can be downloaded from here.

It is widely used by IT community. The main thing is to install this test application just alongside HyperDoc Online – on same IIS server and with application pool working on behalf of the same user as for HIS. Then you could use it's reporting and testing capabilities. Please refer to download package with this application for additional instructions on its installation.

We strongly recommend using the section called “Automatic application configuration” with Create HIS Application program. Manual procedure is much more error prone.

When starting HIS client on Windows Vista you can get a message:

Cannot access applet testing Java version.
The HyperDoc Online must be viewed with Java 1.1.4 from Microsoft Corp. or Java 1.4.2 from Sun Microsystems Inc.
To install Java on your computer, please visit the Java Web site to download Java Virtual Machine.

Or similar saying that there is no Java installed.

Installing Java in IE7/XP solves the problem.

Unfortunately it does not help for IE7/Vista. Java installation online within IE7 (from here) apparently succeeds and gets confirmed by this, that announces:

Verifying Java Version
Congratulations!
You have the recommended Java installed (Version 6 Update 13).

However, IE7 on Windows Vista may work different:

  • In Tools/Manage Add-ons it reports Java add-on as installed and enabled (sometimes many times)

  • In Tools/Internet Options/Advanced Java is not shown, although Vista help says it should

  • Interestingly, if you completely uninstall Java, IE7 will show it in the Advanced Settings but I dont expect it working.

This work all Java-dependent sites inaccessible for IE7/Vista users.

To fix it please perform following steps:

  • Uninstall Java and remove all traces of it

  • Reboot and check results of Java uninstallation until positively there is no sign left, not in Windows, not in IE.

  • Start IE and try to open HIS client (i.e. here).

  • Admit that you don't have Java and follow link to install it.

  • It will redirect you to java site where you must click the Free Java Download and say: I was sent from MS.

  • This time it will work and you may enjoy HyperDoc Online.

This section of HDocASP.ini is used only by HyperDoc Online. Please note, that the syntax of this section is compatible with the syntax of JavaScript.

auto_show_document

When set to true a first document from the document list is shown automatically when current object is changed in the hierarchy pane. When set to false the user must click the document on the list to view document content - this mode is useful for slow connections when displaying document content when not necessary may take significant time. Default = true

bit_depth

is responsible for number of bits per pixel in a created bitmap when using Print to PDF or Print to File(PNG or JPG output format) option from Print panel in HIS.

Possible values are only 8 and 24.

bit_depth = 8; - means that the palette bitmap is created (PNG) bit_depth = 24; – true color bitmap is created (JPG)

Default value is 8.

color_background

Defines background color of all HyperDoc Online windows, format "rrggbb". Default = "#F1F7FF"

See the Color codes table in ??? for all colors in RGB and BGR format.

color_button_active

Defines background color of active (selected) buttons, format "rrggbb". Default = "#C5A217"

color_button_inactive

Defines background color of inactive (not-selected) buttons, format "rrggbb". Default = "#C5D1DF"

color_current

Defines color fill of selected spot in HIS, format "rrggbb". Default = "#C0C0C0" (grey).

Also possible values are:

  • "transparent",

  • "" - empty. Value will be taken from relevant Stamps.TVD.

Example:

color_current = "#dfff7f"
color_doc_table_title_text

Defines color of title text in document table, format "rrggbb". Default = "#506682"

color_doclist_title_back

Defines background color for the document list title. Default = "#CDE3FF"

color_frame_border

Defines color of frame border, format "rrggbb". Default = "#c2d9f0"

color_highlight

Defines color of highlighted spots, format "rrggbb". Default = "#C0C0C0"

color_print_pane

Defines background color of the print pane in the document view pane, format "rrggbb". Default = "#DDECFF"

color_selected_back

Defines background color of the selected item - in the hierarchy or in various lists like document list, found items list. Default = "#EFD779"

color_table_back

Defines background color of the odd lines in tables (usually slightly darker than default background to make tables easier to read). Default = "#DDECFF"

color_table_title_back

Defines background color for table titles. Default = "#506682"

color_table_title_text

Defines text color for table titles. Default = "#FFFFFF"

color_text_active

Defines text color of active (selected) buttons, format "rrggbb". Default = "#FFFFFF"

color_text_inactive

Defines text color of inactive (not-selected) buttons, format "rrggbb". Default = "#000000"

color_zoom_pane

Defines background color of the zoom pane in the document view pane, format "rrggbb". Default = "#CDE3FF"

CopyViewMode

Defines how will Copy View option will work. Possible values are:

  • 1 - copy directly to clipboard,

  • 2 - copy to new window,

  • 3 - copy both to clipboard and to new window.

CustomMenuUrl_DocList

One of the parameter needed to enable functionality: customized profiles for menu bars.

For description of this functionality, please see the section called “Customized profiles for menu bars”.

CustomMenuUrl_Hierarchy

One of the parameter needed to enable functionality: customized profiles for menu bars.

For description of this functionality, please see the section called “Customized profiles for menu bars”.

CustomToolbarsURL_DocView

One of the parameter needed to enable functionality: customized profiles for menu bars.

For description of this functionality, please see the section called “Customized profiles for menu bars”.

documentis_spot_zoom_enabled

Defines if HIS should zoom around spot after clicking in object in infoscope. Default = true

dynamic_legend

Dynamic/static legend, (true/false). Default = false

environment_flags

Environment flags (used to code HIS working in embedded window = 1). Default = 0

FC_NumberOfValues

This parameter tells how much values are to be displayed in the Filter Values list. Parameter for FilterCreator HIS addin. Default = 100

fill_colors_palette

Defines your own color palettes for fills in Measurement mode.

Default and example:

fill_colors_palette="1,000000,White;2,FFFFFF,Black;3,FF9933,Orange;4,99CC00,Grass;5,66CCFF,Blue;6,99FFFF,Cyan;7,CC99CC,Magenta;8,FFFF99,Yellow;9,666666,DarkGray;10,999999,Gray;11,CC3333,Ruby;12,33CC00,Green;13,003399,Navy;14,99CCCC,Steel;15,993399,Violet;16,CCCC66,Khaki";

For more information see HyperDoc Online manual, the section called “Color palette configuration in Measurement mode”.

foreign_document_autoopen

Select between true or false to set if foreign documents should open automatically.

foreign_document_external

Select between true or false to set if foreign documents should open in external window.

general_scales

Allows to define general scale used in HyperDoc Online for printed documents.

This parameter is only used when standard_scales parameter cannot be used with displayed image.

Sample entry looks like:

general_scales="1.0,3.3,4.7,5.8,6.5,7.6,8.3";

Default values are: "1.0,2.0,3.0,4.0,5.0,6.0,7.0,8.0,9.0".

For more info see the section called “Customizable "standard scales" with INI parameters in Hyper Doc Online” in HyperDoc Online manual.

general_scales_hopa

Allows to define general scales used in HOPA calls (GetPrint4Doc, GetPrint4Object, GetPreview4Object and Ex calls) for printed documents.

This parameter is only used when standard_scales parameter cannot be used with displayed image.

Sample entry looks like:

general_scales_hopa="1.0,2.5,3.7,4.3,5.9,7.5,8.8";

Default values are: "1.0,2.0,3.0,4.0,5.0,6.0,7.0,8.0,9.0".

For more info see ??? in HOPA manual and search for GenScales parameter.

help_params

Defines browser attributes for the help window. Default = "status,toolbar,menubar,location,resizable,scrollbars"

help_url_doc_is

Defines URL used when the user clicks on the Help button or menu option in document infoscope. This can be a relative URL or an absolute URL. The base for relative URL is the ASPPages directory. Default = "Manual/HIS-Manual.html"

help_url_docedit

Defines URL used when the user clicks on the Help button or menu option in document edit pane. This can be a relative URL or an absolute URL. The base for relative URL is the ASPPages directory. Default = "Manual/HIS-Manual.html"

help_url_doclist

Defines URL used when the user clicks on the Help button or menu option in document list pane. This can be a relative URL or an absolute URL. The base for relative URL is the ASPPages directory. Default = "Manual/HIS-Manual.html#Doc-list-pane"

help_url_docview

Defines URL used when the user clicks on the Help button or menu option in document view pane. This can be a relative URL or an absolute URL. The base for relative URL is the ASPPages directory. Default = "Manual/HIS-Manual.html#ViewPane"

help_url_hier

Defines URL used when the user clicks on the Help button or menu option in hierarchy pane. This can be a relative URL or an absolute URL. The base for relative URL is the ASPPages directory. Default = "Manual/HIS-Manual.html#Hierarchy-pane"

help_url_obj_edit

Defines URL used when the user clicks on the Help button or menu option in object edit pane. This can be a relative URL or an absolute URL. The base for relative URL is the ASPPages directory. Default = "Manual/HIS-Manual.html"

help_url_obj_is

Defines URL used when the user clicks on the Help button or menu option in object infoscope. This can be a relative URL or an absolute URL. The base for relative URL is the ASPPages directory. Default = "Manual/HIS-Manual.html"

help_url_print_adv

Defines URL used when the user for the first time selects advanced print mode (with special binary component) in Internet Explorer 5.5. Default = "Manual/HIS-Manual.html#PrintAdv"

help_window

Defines the initial size of the help window. Default = "height=400,width=600"

hide_empty_doc_tabs

Indicated, whether hiding empty document tabs is enabled. Default = true

HIS_print_advanced

indicates whether Advanced print mode is enabled (IE only) in Printing option menu of Print Preview panel.

On Internet Explorer if advanced print is enabled and simple print is disabled, simple print is automatically enabled.

Integer value range is 0-1. Default is 1 (On).

HIS_print_advanced = 0;
HIS_print_simple

indicates whether Simple print mode is enabled in Printing option menu of Print Preview panel.

Integer value range is 0-1. Default is 1 (On).

HIS_print_simple = 0;
HIS_print_to_file

indicates whether Print to file mode is enabled in Printing option menu of Print Preview panel.

Integer value range is 0-1. Default is 1 (On).

HIS_print_to_file = 0;
HIS_print_to_pdf

indicates whether Printing to PDF mode is enabled in Printing option menu of Print Preview panel.

Integer value range is 0-1. Default is 1 (On).

HIS_print_to_pdf = 0;
HISRestrictedAutoLogin

Enables login to HIS via new page HISAutoLogin.asp.

This page does not require authentication. IP Restriction is recommended.

Value of 1 enables this feature but it requires user name and password for anonymous access.

See ???.

HISRestrictedAutoLogin=1;
horizontal_split

Defines width of left and right panes of the main HyperDoc Online window. Default = "3*,10*"

javascripts2Include

Path to user javascript with functions, wich could be used on HIS client start or in custom commands. Path should be in format javascripts2Include="MyAddInFolder/MyAddIn.js"; instead of javascripts2Include="http://myserver.com/his/MyAddInFolder/MyAddIn.js";

legend_with_areas

Legend with areas/without areas, (true/false). Default = true

legend_with_quants

Legend with quantities/without quantities (true/false). Default = false

line_colors_palette

Defines your own color palettes for lines in Measurement mode.

Default and example:

line_colors_palette="1,000000,White;2,FFFFFF,Black;3,FF9933,Orange;4,99CC00,Grass;5,66CCFF,Blue;6,99FFFF,Cyan;7,CC99CC,Magenta;8,FFFF99,Yellow;9,666666,DarkGray;10,999999,Gray;11,CC3333,Ruby;12,33CC00,Green;13,003399,Navy;14,99CCCC,Steel;15,993399,Violet;16,CCCC66,Khaki";

For more information see HyperDoc Online manual, the section called “Color palette configuration in Measurement mode”.

line_hit_sensitivity

Contains select and highlight tolerance for 'segment' and 'polyline' spot.

Tolerance is presented in percents of image size.

'1.0' is 100%, '0.01' is 1% etc. It is advised to input values around '0.005' (0.5%) - default value.

line_hit_sensitivity = 0.003;
LinkToSpot_enabled

Defines whether function Copy Link To Spot is enabled or not. Functionality is enbled when 'LinkToSpot_enabled = "true"'. 'LinkToSpot_enabled' is set to 'false' by default.

LinkToSpot_hopa_page_name

Here you can define which HOPA .asp file you want to evoke while using Copy Link To Spot functionality in HIS.

measure_drw_units

Units of measurement drawing. Default = "7"

number_of_decimals

Number of decimal digits, (0-10). Default = "2"

Warning

Abandoned parameter.

Value given in this parameter is not used by HyperDoc Online any more. It's ignored and value is taken from HDocParam table in HDoc Database - see parameter DecimalDigits in ???.

number_of_decimals_angle

Decimal digits in angles, (0-10). Default = "2"

Warning

Abandoned parameter.

Value given in this parameter is not used by HyperDoc Online any more. It's ignored and value is taken from HDocParam table in HDoc Database - see parameter DecimalDigitsAngle in ???.

number_of_decimals_area

Decimal digits in areas, (0-10). Default = "2"

Warning

Abandoned parameter.

Value given in this parameter is not used by HyperDoc Online any more. It's ignored and value is taken from HDocParam table in HDoc Database - see parameter DecimalDigitsArea in ???.

number_of_decimals_line

Decimal digits in coordinates and lengths, (0-10). Default = "2"

Warning

Abandoned parameter.

Value given in this parameter is not used by HyperDoc Online any more. It's ignored and value is taken from HDocParam table in HDoc Database - see parameter DecimalDigitsLine in ???.

objectis_spot_zoom_enabled

Defines if HIS should zoom around spot after clicking in object in infoscope. Default = true

open_is_onclick

Object InfoScope can be automatically opened, when object set is loaded as a result of making current an object with object set connected to it. Possible values:

  • O - do not open IS automatically

  • 1 - open IS automatically

  • 2 - do not open IS automatically and DO NOT select first object from object set

  • 3 - open IS automatically and DO NOT select first object from object set

Default = 0

os_auto_load

When set to true an object set connected to the current object is loaded automatically (if any) when current object is changed in the hierarchy pane. When set to false the user must use Object Set / Open Attached command from the hierarchy pane menu to load object set. Default = true

password_status

Defines if users are able to change password. Default = "enabled"

QSearch_Enabled

Indicated, whether Quick Search is enabled. Default = 0.

For more info on Quick Search please refer to the section called “Quick Search in HyperDoc Online” of HyperDoc Online manual.

QSearch_Hierarchy

Hierarchy name used for search.

QSearch_HierarchyN

Value is hierarchy name used for search.

This parameter can be added if you want to use Quick Search in more than one hierarchy. If there is only one hierarchy it's not needed.

N should be replaced with a number in range from 1 to 10. It's a number that needs to be same as in QSearch_TargetN for corresponding hierarchy.

QSearch_LabelMode

Defines the way that search results are displayed. Option 1: found object label is used (it does not correspond to searched string). Option 2: searched filed value is used – searched string was found in that field. Default = 1

QSearch_Match

Indicates matching mode. Possible values:

  • 0 – BOP_EQ (equals)

  • 2 - BOP_LIKE

  • 4 - BOP_BEGINS_WITH

  • 5 - BOP_CONTAINS (default value)

QSearch_MinNrOfChar

Minimal number of characters that triggers search. Possible values are numbers between 2 and 5. Default = 3.

QSearch_PageSize

Indicates the maximum number of results displayed per object class. For example - if two object classes are specified result can have up to 100 hits. Possible values are between 2 and 50. Default = 5.

QSearch_Target

Object classes and fields used for search. Any reasonable number of object classes and fields can be specified using this formatting. Between multiple fields for given object class OR logical operation is used.

Sample: “ObjectClass:field1,field2;ObjectClass2:field1”

QSearch_TargetN

Object classes and fields used for search. Any reasonable number of object classes and fields can be specified using this formatting. Between multiple fields for given object class OR logical operation is used.

This parameter can be added if you want to use Quick Search in more than one hierarchy. If there is only one hierarchy it's not needed.

Sample: “ObjectClass:field1,field2;ObjectClass2:field1”

N should be replaced with a number in range from 1 to 10. It's a number that needs to be same as in QSearch_HierarchyN for corresponding hierarchy.

For more info on Quick Search please refer to the section called “Quick Search in HyperDoc Online” of HyperDoc Online manual.

QuickPrintOption

Sets printing mode when printing via Print (QuickPrint) button. Possible values: Simple (default value), Advanced, PrintToFile and PrintToPdf

QuickPrintOrientation

Sets printout orientation when printing via Print (QuickPrint) button. Possible values:

  • P – portrait orientation (default value)

  • L - landscape orientation

QuickPrintOrientationPdf

Sets printout orientation when printing to PDF via Print To PDF (QuickPrintToPDF) button. Possible values:

  • P – portrait orientation (default value)

  • L - landscape orientation

QuickPrintResolution

Sets print resolution in dpi when printing via Print (QuickPrint) button. Possible values: 150, 300, 400, 600 (default value).

QuickPrintResolutionPdf

Sets print resolution in dpi when printing to PDF via Print To PDF (QuickPrintToPDF) button. Possible values: 150, 300, 400 (default value), 600.

QuickPrintScale

Sets printout scale for printing via QuickPrintButton when QuickPrintScalingMode is set to SV or MV.

QuickPrintScalePDF

Sets printout scale for printing via QuickPrintButton when QuickPrintScalingModePDF is set to SV or MV.

QuickPrintScalingMode

Sets scaling mode for printouts when printing via Print (QuickPrint) button. Possible values:

  • FD - fit drawing (default value)

  • MD - match drawing

  • SV - scale view

  • MD - match view

Note

Scale View and Match View modes require defining specific scale in QuickPrintScale parameter.

QuickPrintScalingModePdf

Sets scaling mode for printouts when printing to PDF via Print To PDF (QuickPrintToPDF) button. Possible values:

  • FD - fit drawing (default value)

  • MD - match drawing

  • SV - scale view

  • MD - match view

Note

Scale View and Match View modes require defining specific scale in QuickPrintScalePDF parameter.

QuickPrintTemplate

Print template name for use when printing via Print (QuickPrint) button. Print Template should be chosen from available print templates in folder defined in TemplateDirectory parameter.

If QuickPrintTemplate is not present or it's value is empty, blank template will be used instead.

Example:

QuickPrintTemplate = "A4_template";

This parameter is not case sensitive.

QuickPrintTemplatePdf

Print template name for use in printouts to PDF when printing via Print To PDF (QuickPrintToPDF) button. Print Template should be chosen from available print templates in folder defined in TemplateDirectory parameter.

If QuickPrintTemplatePDF is not present or it's value is empty, blank template will be used instead.

Example:

QuickPrintTemplatePdf = "A4_template";

This parameter is not case sensitive.

readonly

This parameter has meaning only for installations with special 'Read/Write' license. Setting to true forces to HyperDoc Online to operate in 'Read Only' mode overriding license mode. Default = true

root_auto_expand

Defines whether the root node should automatically expand. Default = false

root_auto_load

When root object has document connected, with this option set to true the document will be automatically presented in Document View pane. Default = false

show_detailed_errors

When set to true more detailed error descriptions are shown. Default = true

show_subsegments_length

Show subsegments length when generating measurement labels (true/false). Default = false

spot_highlighted_line_width

Defines width of line on selected or highlighted spot - only applicable for 'polyline', 'segment' and 'circarc' spots.

Width is presented in percents of image size. '1.0' is 100%, '0.01' is 1% etc. It is advised to input values around '0.005' (0.5%) - default value.

standard_scales

Allows to define scale used in HyperDoc Online for printed documents.

Sample entry looks like:

standard_scales="10,100,200";

For values values smaller or greater than edge values on the list, general scales rules will be used.

Default values are: "1,2,5,10,20,50,100,200,400,500,800,1000".

For more info see the section called “Customizable "standard scales" with INI parameters in Hyper Doc Online” in HyperDoc Online manual.

standard_scales_hopa

Allows to define scales used in HOPA calls (GetPrint4Doc, GetPrint4Object, GetPreview4Object and Ex calls) for printed documents.

Sample entry looks like:

standard_scales_hopa="10,100,200";

For values values smaller or greater than edge values on the list, general scales rules will be used.

Default values are: "50,100,200,400,500".

For more info see ??? in HOPA manual and search for StdScales parameter.

upd_priv_redl_layers_only

Param allows to transfer of measurements to own redlining layers only. Default = false

use_field_width

Choose document list layout. Possible values:

  • 0 - free layout - fields in Document List fit to their contents - no line wrapping occurs

  • 1 - fixed width - text that does not fit is clipped (according width in HyperDoc configuration - if available)

  • 2 - fixed width, but multiline - whole text is visible (according width in HyperDoc configuration - if available)

  • 3 - free layout, but multiline - whole text is visible; browser actively adjust column widths, wrapping lines when needed

Default = 0

use_os_member_tools

Defines whether HIS fills spots connected to current ObjectSet. It uses tool ObjSetMember. Default = false

use_subtree

Makes the sub-tree mode (enables partial loading of sub-trees from whole tree on demand) effective in given HyperDoc Online application.

Example:

use_subtree=true

Default is set to false

The sub-tree mode was licensed by phrase SUBTREE=1; existing in FEATURE HDocWeb line in license.dat file.

In XML licences (used from HDoc 4.95), phrase SUBTREE=1; is value of attribute vendor that is a part of element License version for product HDocWeb.

Using this parameter will make use HIS always use this mode. But you can use HISautologin.asp calls to enable subtree, only in chosen situations. See the section called “Login modes” for more information.

vertical_split_is

Defines height of top and bottom panes on infoscope window. Default = "12*,4*"

vertical_split_left

Defines height of hierarchy and object properties panes. Default = "12*,3*"

vertical_split_right

Defines height of document list and document view panes. Default = "4*,10*"

write_vectors

Enable writing (transferring) measurement drawing to redlining layer. Default = false

zoom_factor

Allows to define default value for HOPA SpotMarginPercent parameter when it's not used in HOPA call url. If not set here or in HDocParams table value 1.1 (110%) will be used as described in HOPA Manual.

Sample entry looks like:

[CONFIGURATION}
zoom_factor=1.5;

where 1.5=150% of zoom around spot and 0.6=60%.

loading table of contents...