You are on page 1of 38

OpenText™ Imaging Viewers and

DesktopLink

Installation and Administration Guide

This manual describes the local and mass installation and


administration of Windows Viewer, DesktopLink, and Imaging
Configuration.

CL220400-IGD-EN-01
OpenText™ Imaging Viewers and DesktopLink
Installation and Administration Guide
CL220400-IGD-EN-01
Rev.: 2022-July-28
This documentation has been created for OpenText™ Imaging Viewers and DesktopLink CE 22.4.
It is also valid for subsequent software releases unless OpenText has made newer documentation available with the product,
on an OpenText website, or by any other means.

Open Text Corporation

275 Frank Tompa Drive, Waterloo, Ontario, Canada, N2L 0A1

Tel: +1-519-888-7111
Toll Free Canada/USA: 1-800-499-6544 International: +800-4996-5440
Fax: +1-519-888-0677
Support: https://support.opentext.com
For more information, visit https://www.opentext.com

Copyright © 2022 Open Text. All Rights Reserved.


Trademarks owned by Open Text.

One or more patents may cover this product. For more information, please visit https://www.opentext.com/patents.

Disclaimer

No Warranties and Limitation of Liability

Every effort has been made to ensure the accuracy of the features and techniques presented in this publication. However,
Open Text Corporation and its affiliates accept no responsibility and offer no warranty whether expressed or implied, for the
accuracy of this publication.
Table of Contents
1 Installation overview ................................................................. 5
1.1 Installation requirements .................................................................... 5
1.2 Upgrading Windows Viewer and DesktopLink ..................................... 6

2 Installing Windows Viewer ....................................................... 7


2.1 Download configuration profile ........................................................... 9

3 Installing DesktopLink ............................................................ 11


3.1 Installing DesktopLink ...................................................................... 11
3.2 Installing DesktopLink on a 64-bit system ......................................... 12
3.2.1 Installing OpenText Imaging PDF and TIFF Converter on a terminal
server ............................................................................................. 13
3.2.2 Configuring settings ........................................................................ 13

4 Installing Imaging Configuration ........................................... 15

5 Using a silent installation and mass rollout ......................... 17


5.1 Configuring a silent installation ......................................................... 17
5.1.1 Prepare the installation files ............................................................. 17
5.1.2 Configuring the install.ini file ............................................................ 18
5.1.3 Starting the silent installation ............................................................ 23
5.2 Using central software distribution .................................................... 25

6 Installing additional languages .............................................. 27

7 Configuring and monitoring Windows Viewer and


DesktopLink ............................................................................. 29
7.1 Configuring Windows Viewer and DesktopLink .................................. 29
7.2 Configuring single sign on ................................................................ 30
7.3 Configuring user permissions ........................................................... 30
7.4 Working with desktop scan .............................................................. 31
7.5 Working with a proxy connection ...................................................... 31
7.6 Displaying Content Server documents .............................................. 31
7.7 Monitoring DesktopLink and OpenText Imaging ODMA ..................... 32

8 Troubleshooting ...................................................................... 33
8.1 General recommendation ................................................................ 33
8.2 Troubleshooting installation ............................................................. 34
8.3 Troubleshooting Windows Viewer and DesktopLink ........................... 34
8.3.1 Error messages and Imaging Clients Message Box ........................... 35
8.3.2 Windows Viewer and DesktopLink log files ....................................... 36
8.3.2.1 Setting log levels ............................................................................. 36
8.3.2.2 Log file settings ............................................................................... 37

CL220400-IGD-EN-01 Installation and Administration Guide iii


Chapter 1
Installation overview

The software is available in OpenText My Support. For more information, see


https://knowledge.opentext.com/knowledge/llisapi.dll/Open/13056789.

You can install the software in the following ways:

• Local installation on one computer.


Use a local installation if you want to install Windows Viewer and DesktopLink
on a dedicated computer. For more information, see “Installing Windows
Viewer“ on page 7.
• Mass rollout or distribution on a large number of computers.
You can install Windows Viewer and DesktopLink as well as additional
languages silently and then distribute them on user computers within the
company. To do so, you copy the installation files to a file server, configure the
configuration files to define what will be installed, and provide a command to start
the preconfigured installation on the user computers. For more information, see
“Using a silent installation and mass rollout“ on page 17.

1.1 Installation requirements


Notes

• Only the products and versions specified in the Release Notes are supported.
Other versions have not been tested and are therefore not officially
supported for this version. The Release Notes contain the definitive list of
supported versions. Any other versions mentioned in the product
documentation are superseded by the versions specified in the Release
Notes.
• If no service pack, maintenance level, or similar is explicitly mentioned for a
specific software version, OpenText supports each service pack and
maintenance level released for a third-party product version, unless
explicitly stated otherwise. If details of a specific service pack and
maintenance level are given, the current and subsequent versions are
supported.

Before you start the installation or upgrade, see the Release Notes for detailed
information on:

• Supported operating systems.


• Supported SAP systems and SAP GUI versions.
• Compatibility of Windows Viewer and DesktopLink and Archive Center versions.

CL220400-IGD-EN-01 Installation and Administration Guide 5


Chapter 1 Installation overview

The communication between the Imaging Clients and Archive Center uses the
HTTP protocol only.
• Software and hardware requirements and restrictions.
• Required software that must be installed on the computer on which you want to
install Windows Viewer and DesktopLink.

You can find the latest version of the Release Notes in My Support at https://
knowledge.opentext.com/knowledge/llisapi.dll/open/15882279.

Before you start to install Windows Viewer and DesktopLink:

• OpenText recommends that you copy the <installation medium> to a permanent


network share and install from this network location.
• Terminate or stop all applications, processes, services and devices.
• Sign in as a user with local administrator rights.

1.2 Upgrading Windows Viewer and DesktopLink


The installation provides an upgrade from version 16.0.0. The settings will be
automatically converted to the new version.

To upgrade Windows Viewer and DesktopLink:

• The steps for upgrading are the same as the steps for a new installation of
Windows Viewer and DesktopLink. For more information, see “Installing
Windows Viewer“ on page 7.
The local installation automatically installs the same features that were already
installed on the computer.
For silent installation, you select all features in the install.ini file, no matter
if they were installed in the older version or not.

6 OpenText™ Imaging Viewers and DesktopLink CL220400-IGD-EN-01


Chapter 2
Installing Windows Viewer

Before you start to install Windows Viewer, make sure you fulfill the “Installation
requirements” on page 5.

• Terminal Server
You can install Windows Viewer on Windows terminal servers as an ordinary
installation if you are in install mode. For supported terminal servers, see the
Release Notes.
• Prerequisites
.NET framework 4.0 or higher is available on the Windows operating system.

Tip: If you want to install further client components, for example DesktopLink
and OpenText Imaging Configuration, you can install them within the same
installation procedure. To do so, select the relevant components during
component selection in the Select the applications and components you want
to install dialog box. Ensure that you fulfill the installation requirements for all
components.

To install Windows Viewer:

1. Start the installation. Run Windows Viewer 22.4.msi.

2. In the Welcome dialog box, click Next.

3. If a previous version of Windows Viewer is installed on your computer, the


Windows Viewer Upgrade dialog box opens. Click Next.

4. In the License Agreement dialog box, read the license agreement, select the I
accept the terms in the License Agreement check box, and then click Next.

5. In the Customer Information dialog box, type your user name and
organization, and select whether this installation will be available to all users or
only to yourself, and then click Next.
This dialog box appears only if Windows Viewer is installed for the first time.

6. In the Setup Type dialog box, select the action you want to perform, and then
click Next.
If Windows Viewer is installed for the first time the setup proposes a complete
or custom installation.

• New installation
Complete
Performs a full client installation.

CL220400-IGD-EN-01 Installation and Administration Guide 7


Chapter 2 Installing Windows Viewer

Custom
Performs an installation where you can select the components to be
installed. You can find the appropriate installation parameters in the
corresponding installation chapters.

If Windows Viewer has already been installed, setup will modify, repair or
remove the current installation.

• Program maintenance
Modify
Modifies a previous installation. You can change the components to be
installed.

Note: Due to limitations of the Windows Installer, some


parameters must be entered again each time the Modify mode is
used. For more information, see below in the installation
procedure.
Repair
Tries to repair a corrupted installation.
User settings which have already been customized are kept.
Remove
Removes Windows Viewer from your computer.

7. If you have selected a Custom installation, select the applications and


components you want to install, and then click Next.

a. To expand or collapse a subcomponent tree, click on the or symbols left


to it.

Note: Subcomponents are automatically selected or cleared due to


their dependencies. Expand all subcomponent trees and check the
selection status of each subcomponent individually.
b. Click on the icon located to the left of the component, and then select the
applications and components you want to install.
OpenText Imaging Windows Viewer and OpenText Imaging ODMA is
selected by default. For more information, see “Monitoring DesktopLink
and OpenText Imaging ODMA” on page 32.
Select SAP Icon Support to display SAP icons in printlists.

Important
If you select “This application or component will not be available.”
and if these applications or components were previously installed,
they will be removed by the setup program.
c. If you install the software for the first time, you can choose the installation
directory. Click Change to select the folder.

8 OpenText™ Imaging Viewers and DesktopLink CL220400-IGD-EN-01


2.1. Download configuration profile

d. If you install the software for the first time, you can check how much disk
space is required for the installation of the selected components. Click Disk
Space.

8. In the File Associations dialog box, select the file types that you want to open
with Windows Viewer, and then click Next.

9. In the OpenText Archive Center dialog box, enter the hostname of your
OpenText Archive Center, and then click Next.

10. In the Ready to Install OpenText Imaging Windows Viewer dialog box, click
Install.
The installation will copy all the necessary files, configure the registry and
update the configuration files.

Tip: This is the last opportunity to cancel the installation without making
any changes on the computer.

11. In the Installation Wizard Completed dialog box, click Finish.

12. Optional The installation of English for GUI and Online Help is part of the
installation. If you need other languages, you must install them additionally.
For more information, see “Installing additional languages“ on page 27.

If the installation fails or you get an error message, see “Troubleshooting


installation” on page 34.

2.1 Download configuration profile


Download Configuration Profile is a new feature in the Windows Viewer 32–bit
installer, which enables a user to download configuration profiles from the Archive
Center. The Download Configuration Profile option is set to false by default
during custom installation. A user can enable this feature after custom installation, if
required.

To enable downloading configuration profiles:

1. Select Change in the Control Panel.

2. Select Modify in the installer.

3. Select Download Configuration Profile.

Note: To disable Download Configuration Profile, clear the selection.


Based on the selection, all the required EXE or other files are added to or
deleted from the system.

CL220400-IGD-EN-01 Installation and Administration Guide 9


Chapter 2 Installing Windows Viewer

When Download Configuration Profile is enabled, configuration profiles are


automatically downloaded at the startup of Windows Viewer-installed systems. The
following file should be used for this feature: C:\Program Files (x86)\OpenText\
Viewer\bin\CfgDownload.exe. Also, when this feature is enabled, the
CfgDownload.exe path gets automatically added to the following registry paths in
Windows Viewer-installed systems:

• All users: HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Microsoft


\Windows\CurrentVersion\Run
• Single user: HKEY_CURENT_USER\SOFTWARE\WOW6432Node\Microsoft
\Windows\CurrentVersion\Run

Note: Currently, it is not possible to Deactivate the cfgDownload


parameter to run automatically during system startup. cfgDownload is only
used for customers using automatic profile distribution.

10 OpenText™ Imaging Viewers and DesktopLink CL220400-IGD-EN-01


Chapter 3
Installing DesktopLink

Notes

• Before you start to install DesktopLink, make sure you fulfill the
“Installation requirements” on page 5.
• Microsoft Office must already be installed.
• SAP GUI and SAP Logon must already be installed. For SAP packages and
configuration, see OpenText Archiving and Document Access for SAP Solutions -
Installation and Upgrade Guide (ER-IGD).

Tip: If you want to install further client components, for example Windows
Viewer and OpenText Imaging Configuration, you can install them within the
same installation procedure. To do so, select the relevant components during
component selection in the Select the applications and components you want
to install dialog box. Make sure that you fulfill the installation requirements
for all components.

3.1 Installing DesktopLink


Note: Make sure that the general requirements are fulfilled. For more
information, see “Installation requirements” on page 5.

Tip: If you want to install further client components, for example Windows
Viewer, you can install them within the same installation procedure. To do so,
select the relevant components during component selection in the Select the
applications and components you want to install dialog box. Make sure that
you fulfill the installation requirements for all components.

To install DesktopLink:

1. Start the installation. Run Windows Viewer 22.4.msi.

2. Follow the wizard until it requires component specific entries. For a step-by-
step description, see “Installing Windows Viewer“ on page 7.

3. Select OpenText DesktopLink, expand the tree to select the scenarios according
to your needs, and then click Next.

• Save to SAP Solution

– OpenText Imaging PDF and TIFF Converters

4. In the SAP R/3 Connection Parameters dialog box, enter the parameters to
connect SAP, and then click Next.

CL220400-IGD-EN-01 Installation and Administration Guide 11


Chapter 3 Installing DesktopLink

This dialog box appears only if you have selected the Save to SAP Solution
scenario.

Important
If you use the Modify installation mode, enter all parameters in all dialog
boxes again even if they are already displayed.

Message server
Name of the server on which the SAP message service runs. It may be the
same as the SAP application server.

Port No.
This number is unique to your SAP message server. The default value is
3600/tcp.

Application server
Name of the SAP application server to which DesktopLink connects.

System No.
Instance number of the SAP system, for example 00.

System ID
Three character code for the SAP database, also known as the SAP SID.

5. Finish the installation as described in “Installing Windows Viewer“ on page 7.

3.2 Installing DesktopLink on a 64-bit system


To use the OpenText PDF Converter and the OpenText TIFF Converter on a 64-bit
system, you must install the DesktopLink - 64-bit printer driver.

Local TIFF/PDF conversion on 64-bit Terminal Server platforms in SAP


scenarios – In SAP scenarios, you can convert documents to TIFF/PDF on 64-bit
operating systems. For more information, see “Installing OpenText Imaging PDF
and TIFF Converter on a terminal server” on page 13.

To install OpenText Imaging PDF and TIFF Converter on a 64-bit system:

1. Start the installation. Run DesktopLink 22.4 - 64bit.msi.

2. Follow the installation procedure described in “Installing Windows Viewer“


on page 7. The following exceptions apply to this description:

Setup type
The selection dialog box for Complete or Custom installation is not
displayed because there is only one component to be installed.

Program Maintenance
You can choose between Repair and Remove only. Modify is not supported
for OpenText Imaging DesktopLink - 64-bit.

12 OpenText™ Imaging Viewers and DesktopLink CL220400-IGD-EN-01


3.2. Installing DesktopLink on a 64-bit system

Select applications and components


This dialog box is not displayed. There is only one component to be
installed.

3. Finish the installation as described in “Installing DesktopLink” on page 11.

3.2.1 Installing OpenText Imaging PDF and TIFF Converter on


a terminal server
To install OpenText Imaging PDF and TIFF Converter on a terminal server:

1. Change the terminal server from execution mode to install mode by using the
CHANGE USER/INSTALL command.

2. Start the Windows Viewer installation as an administrator. Run Windows Viewer


22.4.msi.

3. Start the DesktopLink installation as an administrator. Run DesktopLink 22.4 -


64bit.msi.

4. After the installation, switch back to execution mode using the CHANGE USER/
EXECUTE command.

3.2.2 Configuring settings


To modify the printing preferences, for example to change file formats:

1. Right-click the OpenText PDF Converter printer driver icon, and then click
Printing Preferences.

2. In the OpenText PDF Converter Printing Preferences dialog box, click the File
Formats tab, and then choose the file format in the File format area.

Note: Modifying the printing preferences on Terminal Server platforms is not


supported. The default supported conversion setting produces monochrome
data on Terminal Server platforms. OpenText recommends to use the default
printer settings for optimal results.

To change the PDF compression settings:

1. Click PDF Settings.

2. In the PDF Settings dialog box, click the Compression tab, and then choose the
compression settings.

CL220400-IGD-EN-01 Installation and Administration Guide 13


Chapter 4
Installing Imaging Configuration

Note: Before you start to install Imaging Configuration, make sure you fulfill
the “Installation requirements” on page 5.

Tip: If you want to install further client components, for example Windows
Viewer, you can install them within the same installation procedure. To do so,
select the relevant components during component selection in the Select the
applications and components you want to install dialog box. Make sure that
you fulfill the installation requirements for all components.

To install Imaging Configuration:

1. Start the installation. Run Windows Viewer 22.4.msi.

2. Follow the wizard until it requires component specific entries. For a step-by-
step description, see “Installing Windows Viewer“ on page 7.

3. In the Setup Type dialog box, select Custom, and then click Next. For more
information, see Step 6.

4. Select OpenText Imaging Configuration. For more information, see Step 7.

5. Finish the installation as described in “Installing Windows Viewer“ on page 7.

CL220400-IGD-EN-01 Installation and Administration Guide 15


Chapter 5
Using a silent installation and mass rollout

You can perform all installations provided in the installation wizard silently and
distribute them to user computers. Create the install.ini file for configuration of
the installation settings as per the details mentioned in “Configuring the install.ini
file” on page 18.

Language in- The silent language installation does not need a configuration file. You can add an
stallation additional language on the user computers with a simple command. For more
information, see “Installing additional languages“ on page 27.

5.1 Configuring a silent installation


You can configure several different installations for different user groups.

Notes

• Make sure you have write permissions for the computer you will be
installing on.
• Before starting the installation, install the msiexec program.

To configure a silent installation:

1. Copy the installation files. For more information, see “Prepare the installation
files” on page 17.
2. Configure the installation components and parameters in the install.ini file.
For more information, see “Configuring the install.ini file” on page 18.
3. Distribute the start command, and then start the installation. For more
information, see “Starting the silent installation” on page 23.

5.1.1 Prepare the installation files


There are two ways to prepare the installation files:

Create the install.ini file


Create the install.ini file as per the details mentioned in “Configuring the
install.ini file” on page 18.
This method saves disk space but requires the installation media for the
installation procedure. You can configure several install.ini files to prepare
different installations. Rename them, for example install01.ini.
Copy all files
Copy all software components from the installation media to the shared folder,
which is further referenced as the <shared_installation_folder>.

CL220400-IGD-EN-01 Installation and Administration Guide 17


Chapter 5 Using a silent installation and mass rollout

With this method, installations are performed using the <shared_


installation_folder>. You do not need the installation media for the
installation procedure. You must copy all files in the root directory to the
<shared_installation_folder>, but at least the directories Win32Cln and
redist under the root directory.
You can configure several install.ini files to prepare different installations.
Rename them, for example install01.ini.

5.1.2 Configuring the install.ini file


The install.ini configuration file controls the installation procedure, and is a
template that you can use to create your own ini files for installation. You can
configure several install.ini files to prepare different installations. Before you
start the installation on user computers, OpenText recommends a test installation
with the configured install.ini file. The different startup modes for running
preconfigured installations are described in “Starting the silent installation”
on page 23.

Make sure the files are writable before you start. You can edit the files with any
ASCII editor, such as Notepad or WordPad. You can set default values for all
parameters in the install.ini file and you can configure the installation so that no
entries from users are requested. This avoids potential user input errors and allows
an unattended installation on a large number of computers using the setup
commands or a software distribution tool.

Important
Change only the values, and do not change section names and value
identifiers. This would affect the installation and may prevent client
functioning after installation.

The installation procedure works according to the following scheme:

1. It uses a default value.


2. If a value is set in install.ini, it will overwrite the default value.
3. If a value is not set in install.ini and a registry key is set, it will overwrite the
default value.

The install.ini file is divided into sections for the various installation dialogs and
parameters. There are detailed comments in English for each section in the file. All
parameters are described in the file as well. Lines with descriptions start with a
semi-colon (“;”).

The install.ini file contains the following sections:

[Common]
Defines the installation target directory setting INSTALL_ROOT and creates the
registry entry . If INSTALL_ROOT is empty, the default value %PROGRAMFILES%
\OpenText\Viewer is used.

18 OpenText™ Imaging Viewers and DesktopLink CL220400-IGD-EN-01


5.1. Configuring a silent installation

The configured installation directory is written as registry entry [HKLM\


SOFTWARE\IXOS\IXOS_ARCHIVE\CLIENT_INST_DESKTOP]\INSTALL_ROOT.

ErrorMessage=YES
Shows severe errors, that is errors that will abort the installation.

ShowUpgradeDialog=YES
Shows the upgrade dialog.
If the user selects NO, the registry trees will be deleted.
If no upgrade dialog is shown, the registry trees are not deleted.

UpgradeFromLastVersion=YES
Defines the upgrade:

• UpgradeFromLastVersion=YES upgrades from an older version of


OpenText Clients and preserves your settings.

• UpgradeFromLastVersion=NO initiates a new OpenText Clients installation


which deletes registry settings.

Note: This dialog works only if ShowUpgradeDialog=NO is set and the


user interface level is silent or basic.

LaunchCFGDownload=NO
If this value is set to YES, the installation will run CfgDownload.exe. This value
is used only during the first installation of OpenText Imaging Clients.
The value is written as registry entry [HKLM\SOFTWARE\IXOS
\IXOS_ARCHIVE\CLIENT_INST\RUN_CFG_DOWNLOAD].

CFGDOWNLOAD=NO
If this value is set to YES, downloading configuration profile is enabled during
Imaging Windows Viewer silent installation.

[Client Installation], [FILES_ASSOCIATION], [IXTR]


Defines the configuration settings for the installation. Fill in the parameters for
applications and sub-components. For more information, see the respective
descriptions in “Installing Windows Viewer“ on page 7. The configuration
sections will only be processed if the associated component is selected for
installation.
The parameters are written to the registry with the same parameter name under
the registry location [HKLM\SOFTWARE\IXOS\IXOS_ARCHIVE\CLIENT_INST_
DESKTOP].

[SAP R/3]
Defines the configuration settings for SAP R/3.
The parameters are written to the registry with the same parameter name under
the registry location [HKLM\SOFTWARE\IXOS\IXOS_ARCHIVE\CLIENT_INST\
SAP].

CL220400-IGD-EN-01 Installation and Administration Guide 19


Chapter 5 Using a silent installation and mass rollout

ArchiveServerList=
Defines the Archive Center name and creates the registry entry [HKLM\SOFTWARE
\IXOS\IXOS_ARCHIVE\Profile\Default\CWin\Archivelink\].
You can use multiple Archive Center and separate them by |, for example A|B.
vu_Language
Specifies default GUI language if not set within the request. Use language
identification as specified in ISO-639, for example en, de, pt, es, jp, cs. For
supported languages, see the Release Notes.
By default the system´s regional settings are used.
The default value is <empty>.
[AddProject]
Defines the path to launch additional executable batch files or registry files. For
examples, see Example 5-1, “Sample install.ini file” on page 20.
Notes

• Do not use .reg in the directory structure.


• You can only use the values ExecuteableFilePath1 to
ExecuteableFilePath9.

Example 5-1: Sample install.ini file

This sample install.ini file illustrates a preconfiguration of an installation.

[Common]
INSTALL_ROOT=
; Installation target directory
; If empty, default is: %PROGRAMFILES%\OpenText\Viewer

ErrorMessage=YES
; If this value is different than 'NO', the installation will show error or
warning message boxes.

ShowUpgradeDialog=YES
; 'Yes' if you want to see the 'OpenText Clients Upgrade' dialog.

UpgradeFromLastVersion=YES
; Doesn't apply to the selection of features for unattended (mass-rollout)
installations. For unattended installations please select appropriate features
below.
; Select 'Yes' if you want to upgrade from an older version of OpenText
Imaging Clients and
; preserv your settings. Choosing 'NO' will initiate a new, clean OpenText
Imaging Clients installation.

IntelliMirrorInstallation=NO
; This option must set to ‘YES’ if you are using installation trough the
Active Directory Users and Computers.

ODMAIntegratedApplications=OpenText_TIFF_Converter|OpenText_PDF_Converter|
Siebel

20 OpenText™ Imaging Viewers and DesktopLink CL220400-IGD-EN-01


5.1. Configuring a silent installation

; List of possible applications which are supported by OpenText ODMA,


separated by |.

AllUsers=YES
; Install for all users.
; Use 'YES' to install OpenText Imaging Clients for all users.
; Use 'NO' to install OpenText Imaging Clients for one user only.
; Use '' to install OpenText Imaging Clients through the Active Directory.

LaunchCfgDownload=NO
; If this value is set to 'YES', the installation will run CfgDownload.exe.
; This value is used only during the first installation of OpenText Imaging
Clients. If modifying or reparing
; the value is taken from the Registry value 'RUN_CFG_DOWNLOAD' of
; Registry key HKLM\SOFTWARE\IXOS\IXOS_ARCHIVE\CLIENT_INST.

[Client Installation]
; Select the feature that will be installed.
; If you set a feature to 'NO' and then set the subfeature to 'Yes',
; no settings will be applied for this subfeature.
; This is a schema of custom setup dialog where you have to select the program
features you want installed on your PC.
;******************************************************************************
**********
; Download configuration profile
;
; OpenText Windows Viewer and DesktopLink
; OpenText Imaging Windows Viewer
; support of SAP ICONS in PrintLists
; Support of PDF Documents
; OpenText DesktopLink
; Link to SAP
; OpenText Ixtractor
; OpenText Imaging TIFF and PDF Converters;
;
; OpenText Imaging Configuration
;
; Developers Tools
; OpenText Imaging ODMA SDK
;******************************************************************************
**********

; -----------------------OpenText Windows Viewer and


DesktopLink------------------
; OpenText Windows Viewer and DesktopLink

; ---OpenText Imaging Windows Viewer


VIEWER=YES

; ------Support of SAP ICONs in ALF document (printlists)


; ------ If YES, SAP_ICONs will be installed by default.
; ------ If NO, SAP_ICONs will not be installed by default
SAP_ICON=NO

; ------Support of PDF Documents


ADOBE_FONTS=NO

; ---OpenText DesktopLink
DESKTOPLINK=NO

; ------Link to SAP

CL220400-IGD-EN-01 Installation and Administration Guide 21


Chapter 5 Using a silent installation and mass rollout

R3=NO
; See the section on [SAP_R3].

; ---------OpenText Ixtractor
IXTR=NO
; See the section on [IXTR].

; ---------OpenText Imaging TIFF and PDF Converters


PRINTERS_R3=NO

; ---------Download configuration profile


; If this value is set to 'YES', downloading configuration profile is enabled
during Imaging Windows Viewer silent installation.
CFGDOWNLOAD=NO

; -----------------------Client Administration----------------
; ---OpenText Clients Configuration
CLIENT_CONFIG=NO

; -----------------------Developers Tools----------------------
; Developers Tools
TOOLS=NO

; ---OpenText Imaging ODMA SDK


ODMA_SDK=NO
; -------------------------------------------------------------

ArchiveServerList=
; List of possible archive servers to select, separated by |.
; Example: ArchiveServerList=hawaii|aria

[FILE_ASSOCIATION]
SetValues=YES
; If 'SetValues' is different to 'YES' then the preset values will not affect
the "File Association" dialog.

; File Association
; TIFF = TIFF\FAX =>> Tagged Image File Format
; JPG =>> JPEG File Format
; JP2 =>> JPEG2000 Format
; ALF =>> SAP System Printlist Format
; OTF =>> SAP Output Text Format
; PDF =>> Adobe Portable Document Format

; To have checkbox (CHCK) checked use number '1' after the equal sign.

; == File == (Extensions in file system)


CHCK_EXT_TIFF=1
CHCK_EXT_JPG=
CHCK_EXT_JP2=
CHCK_EXT_ALF=1
CHCK_EXT_OTF=1
CHCK_EXT_PDF=

[SAP_R3]
MessageServerNameSuggestion=
; Here, a suggestion for the R/3 message server name can be defined.

MessageServerPortSuggestion=3600/tcp
; Here, a suggestion for the R/3 message server port can be defined.

ApplicationServerNameSuggestion=

22 OpenText™ Imaging Viewers and DesktopLink CL220400-IGD-EN-01


5.1. Configuring a silent installation

; Here, a suggestion for the R/3 application server name can be defined.

SystemNumberSuggestion=00
; Here, a suggestion for the R/3 system number name can be defined.

SystemIDSuggestion=
; Here, a suggestion for the R/3 system ID can be defined.

[IXTR]
SapServer=
; Enter a SAP Server name.

SapGateway=
; Enter a SAP Gateway.

[AddProject]
; NOTE:
; Specify the path to additional executable, Batch files, or Registry files to
launch.
; Only 'ExecuteableFilePath1' to 'ExecuteableFilePath9' will be taken by
installation. No more values are allowed.
; Do not use '.reg' in the directory structure
; Variable '%OPENTEXT_SOURCE_DIR%' points to the installation media. Can be
used only during the first installation.
; Example1 : ExecuteableFilePath1=C:\temp\AddSetup\Sales.exe
; Example3 : ExecuteableFilePath3=%OPENTEXT_SOURCE_DIR%\registry\custom.reg
;
;ExecuteableFilePath1=
;ExecuteableFilePath2=
;ExecuteableFilePath3=
;ExecuteableFilePath4=
;ExecuteableFilePath5=
;ExecuteableFilePath6=
;ExecuteableFilePath7=
;ExecuteableFilePath8=
;ExecuteableFilePath9=

5.1.3 Starting the silent installation


To start the silent installation on user computers:

1. Use the Microsoft Windows Installer (msiexec.exe) command line parameters


as detailed below. You can also use central software distribution tools. For more
information, see “Using central software distribution” on page 25).
A number of command line options can be passed to the msiexec.exe program.
Their syntax and semantics correspond to the ones used with the Microsoft
Windows Installer in command line mode. For more information about these
command line options, see the Microsoft Windows Installer documentation.
2. For a non-silent installation, use the following command: msiexec.exe /
i "<directory_of_OpenText_Imaging_Windows Viewer 22.4.msi_file>
\Windows Viewer 22.4.msi" SILENTFILE=<directory_of_install.ini_
file>\install.ini /l*v "<directory_of_log_file>\MsiIxClientSetup.
log"

CL220400-IGD-EN-01 Installation and Administration Guide 23


Chapter 5 Using a silent installation and mass rollout

For example: msiexec.exe /i"\\server01\OpenText_Clients\Windows


Viewer22.4.msi"SILENTFILE=\\server01\OpenText_Clients\Win32Cln\
install.ini /l*v "%TEMP%\OpenText\22.4\Livelink Imaging Clients\
MsiIxClientSetup.log"

Notes

• The users see the installation assistant and can change the predefined
entries there.
• If the path to the install.ini file or the *.msi file contains any blank
spaces, enclose the path in quotation marks to indicate that the whole
path is a single parameter. It is acceptable to use quotation marks, even
if the path does not contain blank spaces.
• You can omit
SILENTFILE=<directory_of_install.ini_file>\install.ini
in the command line if the install.ini file is located in the same
directory as the msi file and you are installing for the first time.

3. For a silent installation, use the following command: msiexec.exe /


i "<directory_of_OpenText Imaging Windows Viewer 22.4_file>\Windows
Viewer 22.4.msi" SILENTFILE=<directory_of_install.ini_file>
\install.ini /qb /l*v "<directory_of_log_file>\MsiIxClientSetup.
log"
For example: msiexec.exe /i"\\server01\OpenText_Clients\Windows
Viewer 22.4.msi"SILENTFILE=\\server01\OpenText_Clients\Win32Cln\
install.ini/qb /l*v "%TEMP%\OpenText\22.4\OpenText Windows Viewer
22.4\MsiIxClientSetup.log"

Notes

• The users cannot change the installation settings, because the


installation wizard does not appear.
• If you want a fully silent installation without status bar display, use
the /qn parameter instead of the /qb parameter.
• If the path to the install.ini file or the *.msi file contains any blank
spaces, enclose the path in quotation marks to indicate that the whole
path is a single parameter. It is acceptable to use quotation marks, even
if the path does not contain blank spaces.
• You can omit
SILENTFILE=<directory_of_install.ini_file>\install.ini
in the command line if install.ini is located in the same directory as
the msi file and you are installing for the first time.

24 OpenText™ Imaging Viewers and DesktopLink CL220400-IGD-EN-01


5.2. Using central software distribution

5.2 Using central software distribution


You can use central software distribution tools like Microsoft Systems Management
Server (SMS) and ON Command CCM (CCM) for an installation on a large number of
computers. The distribution procedure depends on the tool you use. For more
information, refer to your manufacturer's handbook.

CL220400-IGD-EN-01 Installation and Administration Guide 25


Chapter 6

Installing additional languages

You can install languages other than English for GUI and Online Help. For
supported languages, see the Release Notes.

English is automatically installed with the installation of Windows Viewer and


DesktopLink. You can install other languages using the Language Setup. For each
language, a msi installation file is provided which you can install locally or with
silent rollout.

Installation files The installation files for additional languages are not included in the <installation
medium>. You can download the installation files in My Support (https://
knowledge.opentext.com/knowledge/cs.dll/Open/13056789).

Prerequisites The following prerequisites must be fulfilled:

• Installed Windows Viewer and DesktopLink.


• Signed in as a user with local administrator rights at installation.

Notes

• All command-line options described here are standard command line


options of Windows Installer used in command line mode.
• For all installations in Terminal servers enabled environments, first change
to install mode for installing the applications.

To install additional languages:

1. Open My Support (https://knowledge.opentext.com/knowledge/cs.dll/Open/


13056789), and then navigate to Windows Viewer and DesktopLink <version> >
<Language Packs> > <language> > windows viewer <version> - <language>
language.msi file.

2. Start the msi file, and then follow the wizard to the installation end.
The additional language files are copied to the <installation directory>
\bin directory.

To install additional languages as silent installation:

1. Open My Support (https://knowledge.opentext.com/knowledge/cs.dll/Open/


13056789), and then navigate to Windows Viewer and DesktopLink <version> >
<Language Packs> > <language> > windows viewer <version> - <language>
language.msi file.

2. Start the msi file for the language in command line mode:

CL220400-IGD-EN-01 Installation and Administration Guide 27


Chapter 6 Installing additional languages

msiexec.exe /i"<directory_of_msi_file>\OpenText Imaging Windows


Viewer 22.4 - <language> Language.msi" /qn
If you want to generate a log file add the following parameter at the end of the
command:
/l*v "<directory_of_log_file>\Imaging Clients Languages 22.4.msi.
log"

Tip: If you want to generate a log file, add the following parameter at the
end of the command:
/l*v "<directory_of_log_file>\Imaging Clients - 22.4 Languages.
msi.log"

If you install a new language Windows Viewer and DesktopLink does not
change the language after start. To change the default language, you must start
the language installation with the additional parameter
SETASDEFAULTLANGUAGE=1.

3. Windows Viewer and DesktopLink does not change to the new language after
start. To change the default language, you must start the language installation
with the additional parameter SETASDEFAULTLANGUAGE=1. For example
msiexec.exe /i"\\server01\OpenText_Clients\Languages\OpenText
Imaging - 22.4 German Language.msi" SETASDEFAULTLANGUAGE=1.

28 OpenText™ Imaging Viewers and DesktopLink CL220400-IGD-EN-01


Chapter 7

Configuring and monitoring Windows Viewer and


DesktopLink

Trouble-free operation of Windows Viewer and DesktopLink is dependent on the


correct installation and configuration of the following software:

• Windows Viewer and DesktopLink

• Archive Centers , and Archive Cache Servers

• Leading applications involved in the archiving and retrieving scenarios.

All archiving and retrieving scenarios require proper configuration of the leading
applications. A leading application is a software solution connected to your Archive
Center, for example SAP, OpenText Transactional Content Processing (TCP) and so
on. For more information about the scenario dependent settings of your leading
application, see the documentation of the leading application.

All archiving and retrieving scenarios require the correct configuration of the related
Archive Centers and Archive Cache Servers. For more information on the
configuration of the archives, Archive Cache Servers, and the leading application
dependent settings, see OpenText Archive Center - Administration Guide (AR-ACN).

7.1 Configuring Windows Viewer and DesktopLink


Windows Viewer and DesktopLink are installed with default or customized settings.
After installation, you can modify these settings using the OpenText Imaging
Configuration tool.

Note: Imaging Configuration is for administrators only and should not be used
by normal users. Normal users can configure some user specific settings in the
GUIs.

You can configure many types of settings. From a functional point of view, some
settings affect GUIs or functionalities, some affect the handling of documents and
some affect the communication between Windows Viewer, DesktopLink and other
components. From an administrative point of view there are two types of settings:
the ones belonging to configuration profiles, which are uploadable to Archive
Center, and the non-profile settings that are only set on the client workstation.

The Imaging Configuration tool, the use of profiles, and the various settings are
described in OpenText Imaging Viewers and DesktopLink - Configuration Guide (CL-
CGD).

CL220400-IGD-EN-01 Installation and Administration Guide 29


Chapter 7 Configuring and monitoring Windows Viewer and DesktopLink

7.2 Configuring single sign on


DesktopLink supports single sign on (SSO) based over Secure Network
Communication (SNC). With SSO, a user logs in once and gains access to all systems
without being prompted to log in again at each of them.

Note: To use the SSO functionality, the user has to set the <SNC_Lib>
environment variable manually.

To configure SAP GUI version 770 for SSO:

Note: The configuration instructions differ for different SAP GUI versions.

1. In the SAP Logon window, choose the corresponding system name, and then
right-click Properties. Alternatively press CTRL+E.

2. In the System Entry Properties window, click the Network tab.

3. Select Active Secure Network Communication, and in the SNC Name field
enter p :<Domain Name>\<your login>.

4. Click OK.

7.3 Configuring user permissions


User permissions control the users' access to notes, and annotations, sending emails
and so on, and depend on the server to which Windows Viewer is connected.

Systems using If you are working with TCP, Windows Viewer is connected to TCP Business Object
Business Layer. The user access is controlled by the access permissions stored for the
Object Layer
documents on TCP Business Object Layer. For more information about the concept,
user settings, and document's access rights, see OpenText Transactional Content
Processing - System Overview Guide (TCP-GGD).

Other systems If you are working with products, for example Archive Center set the user
permissions in the registry. These settings are listed in OpenText Imaging Viewers and
DesktopLink - Configuration Guide (CL-CGD).

30 OpenText™ Imaging Viewers and DesktopLink CL220400-IGD-EN-01


7.4. Working with desktop scan

7.4 Working with desktop scan


You can use the Desktop Scan functionality of Windows Viewer if you use a TWAIN
scanner with the appropriate driver.

The installation of the scanner driver is independent of a Windows Viewer


installation and you can do it before or after the installation.

For further information on the installation of the TWAIN scanner driver, see the
scanner manufacturer's handbook.

7.5 Working with a proxy connection


You can use Windows Viewer in proxy configurations. For supported proxy
versions, see the Release Notes.

To configure the proxy connection in Microsoft Internet Explorer:

1. Click Tools > Internet options, and then click the Advanced tab.

2. Navigate to HTTP 1.1 settings, and then select Use HTTP 1.1 through proxy
connections.

7.6 Displaying Content Server documents


You can use Windows Viewer to display documents that are stored on Content
Server. To use this functionality, you must install the OpenText Imaging Reviews
and Notes module on Content Server. For more information, see OpenText Extended
ECM - Installation Guide (LLESCOR-IGD).

To display Content Server documents:

• Navigate to the document you want to open, and then click Review Document.

Note: This option is only available for Windows Viewer supported


documents.

CL220400-IGD-EN-01 Installation and Administration Guide 31


Chapter 7 Configuring and monitoring Windows Viewer and DesktopLink

7.7 Monitoring DesktopLink and OpenText Imaging


ODMA
You can monitor the DesktopLink and OpenText Imaging ODMA activities using
OpenText Desktop Monitor. This monitoring and management tool is automatically
installed on the client workstation when you install one of the DesktopLink
components. For more information on this tool, see the OpenText Desktop Monitor
online help or OpenText DesktopLink - User Guide (CLDL-UGD).

The OpenText Imaging ODMA component is based on the Open Document


Management API and is responsible for document management. The DesktopLink
and OpenText Imaging ODMA component is used in different scenarios and
activities:

• Most archiving scenarios that do not use OpenText Document Pipeline.


• Most retrieving scenarios that display a document in Windows Viewer or in its
native application.
• Creation and extension of notes and annotations.
• Request for converting Microsoft Office documents into different formats using
the OpenText TIFF Converter or the OpenText PDF Converter.

For more information on DesktopLink capabilities and restrictions, see OpenText


DesktopLink - User Guide (CLDL-UGD) and the documentation of your leading
application.

32 OpenText™ Imaging Viewers and DesktopLink CL220400-IGD-EN-01


Chapter 8
Troubleshooting

8.1 General recommendation


This chapter provides an introduction to troubleshooting and error analysis. It
presents tools and methods that can help you find the cause of a problem.

• Follow the upgrade strategy for OpenText Imaging and other system
components. For more information, see Support Lifecycle (https://
knowledge.opentext.com/knowledge/llisapi.dll/Open/LifeCycle).
• Train administrators, operators and end-users.
• Follow the recommendations published in Release Notes and newsletters.
Release Notes are regularly updated in My Support.
• Perform regular maintenance on your hardware.

For advanced troubleshooting, use the My Support. You can either browse My
Support folders from the home page (https://knowledge.opentext.com/) or use the
search capabilities of the My Support.

Note: The content of the My Support entries is updated by OpenText


Customer Support independently of the content of this documentation. Check
that the information in the My Support entries corresponds to the version of
the OpenText products you use.

Imaging Solutions Knowledge Base in the My Support

For more information, see https://knowledge.opentext.com/knowledge/llisapi.dll/


open/15783397. From this site, you can perform a search request.

Useful My Support entries

For example: Which ports are used by the archive components? (https://
knowledge.opentext.com/knowledge/llisapi.dll/open/15529922)

CL220400-IGD-EN-01 Installation and Administration Guide 33


Chapter 8 Troubleshooting

8.2 Troubleshooting installation


The installation creates 3 log files:

Setup_OpenTextImagingWindowsViewer.log
Contains detailed information about operations performed during the
installation. You can find out which parameters have been used, which registry
keys have been written, warning or error messages.

Setup_OpenTextImaging64bitPrinterDrivers.log
Contains detailed information about operations performed during the 64 bit
installation. You can find out which parameters have been used, which registry
keys have been written, warning or error messages.

IXClient.log
Contains detailed information about operations performed during the setup.

The default location of the log files is C:\Users\ADMINI~1\AppData\Local\


OpenText\Windows Viewer\Log.

If you need support from the OpenText Customer Support after an unsuccessful
installation, you may be asked to send the OpenTextImagingSetup.log file.

Each time you run the setup, the same log file is used. New logs are added at the
end of the file.

8.3 Troubleshooting Windows Viewer and


DesktopLink
All OpenText Imaging Clients log information in log files. This information can be
used by the administrator to solve problems or can be sent to other administrators.
These log files are also used by OpenText Customer Support for advanced
troubleshooting. Different log files are written, depending on the clients and the
scenario in use.

Parts of the logging information are also displayed in the Imaging Clients Message
Box. For more information, see log messages on page 36.

Note: The main log settings of Windows Viewer and DesktopLink are stored
in the Windows registry. These settings cannot be seen in the registry before
they have been set. By default, predefined hardcoded values are used. All these
settings should be set or modified using the OpenText Imaging Configuration
tool whenever possible. Manual creation or modification of these settings in the
registry is only needed if the OpenText Imaging Configuration tool is not
available or for other special purposes such as setting and modifying user-
independent settings. For more information, see OpenText Imaging Viewers and
DesktopLink - Configuration Guide (CL-CGD).

34 OpenText™ Imaging Viewers and DesktopLink CL220400-IGD-EN-01


8.3. Troubleshooting Windows Viewer and DesktopLink

To display the build number of Windows Viewer:

1. Click Help > About OpenText Imaging Windows Viewer.

2. The version and build number is shown in the following format, for example
22.4.xxx, that is 22.4 is the version number, and xxx is the build number.

8.3.1 Error messages and Imaging Clients Message Box


The Windows clients of OpenText Imaging display log messages in case of an error.
The log messages are displayed in the language selected for the Imaging Clients.

Log messages are displayed chronologically, with the most recent at the top. The
maximum number of messages to be kept in the error message stack is 100 by
default. Only servere log messages are displayed, for example Fatal, Error,
Warning, and Note.

Trace messages are not displayed. The difference between log messages and trace
messages is explained in “Logging and tracing” on page 36.

To view log messages:

• In the log message, click Details.

Messages
Log messages contain three types of information, displayed in two columns:
Severity
Severity classes, Fatal, Error, Warning, and Note, correspond to log
message categories, FATAL, ERROR, WARNING, and IMPNOTE.
The number in brackets after the log severity class is the identifier of the
log message.
Message Text
Text of the log message, displayed in the language selected for the
Imaging Clients.

Show
You can filter the log messages to be displayed. By default, all buttons are
selected, which means that all classes of log messages are displayed.
If you disable a button, the messages of the corresponding severity class
will be removed from the message window.
Clear messages on dialog end
This option is activated by default. When the Imaging Clients Message Box
is displayed the next time, it will display only newly logged messages. If
disabled, previous log messages will be shown along with new ones.
Send logfile to
You can send the IXClient.log file to different applications or to mail
recipients. Click Send logfile to to select your destination.

CL220400-IGD-EN-01 Installation and Administration Guide 35


Chapter 8 Troubleshooting

Note: Be aware that the content of the log file itself is sent, not the
contents of the error message stack.

The registry entry for maximum number of messages is


HKCU\SOFTWARE\IXOS\IXOS_ARCHIVE\CWin\DeMoS\MaxSizeOfMsgStack.

Note: If the value of MaxSizeOfMsgStack is set to 0, the Imaging Clients


Message Box will not appear in case of an error.

8.3.2 Windows Viewer and DesktopLink log files


On every Imaging Clients workstation, log files are generated that contain the log
messages and trace messages. They use the same log files IXClient.<ext> and the
same settings for logging.

You can find the log files here:

Microsoft Windows 10, 11, Windows Server 2019, and Windows Server 2022
%AppData%\Local\OpenText\Windows Viewer\Log

Note: The AppData directory is hidden by default. Change the Microsoft


Windows settings to show it.

8.3.2.1 Setting log levels


You can change the log level statically or dynamically.

• To change the log level through a registry editor or in the OpenText Imaging
Configuration tool is static. This means that the new log level takes effect after
Windows Viewer and DesktopLink is restarted. You can change the values in the
registry. For more information, see “Log file settings” on page 37.
• To change the log level through the client's GUI is dynamic and takes effect
immediately.

Note: Do not forget to reset the log levels after troubleshooting to avoid
generating unnecessarily large log files.

Logging and The distinction between log messages and trace messages is as follows:
tracing

Log messages
Log messages are log records written to the log files and also shown to the user
in the Imaging Clients Message Box. The log messages are written in the log files
in English but are displayed in the Imaging Clients Message Box in the language
selected for Windows Viewer and DesktopLink. These log messages are
identified by identifiers.
Trace messages
Trace messages are trace records written to the log files only. They are in English
and are used for advanced troubleshooting.

36 OpenText™ Imaging Viewers and DesktopLink CL220400-IGD-EN-01


8.3. Troubleshooting Windows Viewer and DesktopLink

Log levels The available log levels are:

Normal (4) = Logging


Log messages of categories FATAL, ERROR, WARNING, and IMPNOTE are logged.
This is the default log level value.

Extended (7) = Tracing


In addition to the log messages, the trace messages of categories USER, INFO, and
DEBUG are logged.

8.3.2.2 Log file settings


Log and tracing messages are written to log files named IXClient.log, IXClient.
001, IXClient.002, and so on. You can change the location of the log files, their
number and their size.

To change log file settings:

• You can use the following:

OpenText Imaging Configuration


You find the settings in My Settings > Common Client Settings > Common
logging settings. These settings are user-specific and stored in the HKEY_
CURRENT_USER registry branch.

Registry editor
The setting LogSeverity is stored in <Registry_branch>\Software\IXOS
\IXOS_ARCHIVE\CommonClientSettings.

All other settings are stored in <Registry_branch>\Software\IXOS\IXOS_


ARCHIVE\CWin\DeMoS.

These settings cannot be seen in the registry before they have been set. By
default, predefined, hardcoded values are used. The settings may be user-
specific or user-independent. User-specific settings have priority over user-
independent settings.

User-specific settings
These settings are located in the registry branch HKEY_CURRENT_USER
(HKCU).

User-independent settings
These settings are located in the registry branch HKEY_LOCAL_MACHINE
(HKLM).

The following settings can be used:

Log level
Registry entry: LogSeverity

CL220400-IGD-EN-01 Installation and Administration Guide 37


Chapter 8 Troubleshooting

The logging has two levels: 4 (normal) and 7 (extended). 4 is the default log
level, 7 is used for troubleshooting. For more information, see “Setting log
levels” on page 36.
Location of the log file
Registry entry: LogPath
Default value:
Microsoft Windows 10, 11, Windows Server 2019, and Windows Server
2022
%AppData%\Local\Windows Viewer\Log

Note: The AppData directory is hidden by default. Change the


Microsoft Windows settings to show it.

Size of the log files in KB


Registry entry: MaxSizeOfLogFile
Default value: 6144 (KB)
Number of copies to keep
Registry entry: MaxCopiesOfLogFile
Default value: 2

38 OpenText™ Imaging Viewers and DesktopLink CL220400-IGD-EN-01

You might also like