Viewer Installation and Running > ActiveX Viewer > Viewer Installation

Viewer Installation Direction File - ActiveX Viewer

It is a file that contains installation information of each module and library file of OZ ActiveX Viewer. OZ Transfer Control compares contents of IDF file stored in the local system with IDF.

The file name of Viewer Installation Direction File is "ozrviewer.idf".

IDF file structure

IDF file contains different sections that each module and library files of OZ Viewer are grouped into. IDF file defines the version, file name and installation path of each module and file.

The file to install in each section is represented as an Entry, which has a unique Entry Version. The entry of the section that appears first is installed first as well.

Basically, lines starting with [;] are considered as comments.

Header Parameter

Header sets ActiveX Viewer installation options such as IDF file version, version check, update option, stop install option, error messages etc. Sets parameters as follows.

version

The updated version of current IDF file, which indicates Root Version of IDF file.

formatversion

When install in the format version of IDF file, installation proceeds as contents of published install files. User doesn't need to change it, and if the format of IDF file is changed, the version is changed and installed.

checkrootversion

Sets whether to check RootVersion. If set to true, check the version parameter first, and check and update each entryversion parameter in the case of upper version. If set to false, regardless of version parameter, compare each entryversion parameter and update if only it is the upper version. The default value is false.

stoponerror

Defines whether to continue or discontinue the installation process when an error occurs during the installation of specific file. If set to true, stop the installation. If set to false, ignore the file that occurs the problem and continue installation. The default value is false.

msgonerror

Define whether to show error messages or not when errors occurred. If set to true, display error messages. If set to false, do not display error messages. The default value is false.

assureall

Sets update options of the file. If set to true, update all files. If set to false, if failed to update, update the rest files that are not updated. The default value is false.

messagefile

Sets message files that contain explanations for each section. Message file is used to display the installation process of each module when Viewer is installed in the system. To distinguish message files for each country, real file name is set to "ParameterValue_languagecode_countrycode.message". If messagefile parameter value is "ozrviewer.message" and languagecode is "en" and countrycode is "us", message file name is set to "ozrviewer_en_us.message".

Body Parameter

Body is consisted of sections containing information of files to be installed. Each section includes Entry information as follows, and defines only necessary information for each file.

[Section Name]

Each section starts with "[Section name]". Section name is generally defined as the title of a module. Section name should be unique. If there is duplicated section name, it would be applied to the latest setting value.

entryversion

Defines the Entry version of each file to be installed.

file

Defines the name of file to be installed.

compress

Defines compression format if the file to be installed is compressed. Currently only zip file format is supported. If the file is compressed, decompress the file first and install.

destdir

Defines the directory in the local system to install the file in. Comma (,) as the separator, if you can list multiple paths to set. You can use the following reserved words when you set the path.

•<THIS> : combined path install.base and install.namespace, Viewer installation default path

•<PROGRAMS> : Windows Program Files path

•<SYSTEM> : Windows System path

•<FONTS> : Windows Fonts path

•<IE> : Internet Explorer installation path

AutoRunEnable

Defines whether to use auto link function when a file is extended. If set to true, use the auto link function. If set to false, do not use the auto link function.

AutoRunExtension

Defines the extension type of the file that is connected.

AutoRunFileName

Defines program name when the file contains an extension that is set in AutoRunExtension runs.

entry

Defines real module name if the file to be installed is an executable file or performs commands by itself. When the file is not compressed, it's named the same as the file name, in other cases, it is named the same as the name of a file that executes a command among original files.

command

If the file to be installed is an executable entry parameter, it defines commands to be performed after installation. The available commands are listed below.

•RegisterServer : Registered in the Registry

•UnRegisterServer : Unregistered in the Registry

•Execute : Automatically run

•ExecuteAtDownload : Automatically run only if the file has been updated

•Delete : Delete file

clsid

Sets the class ID for the file to be registered.

param

Defines parameters to be passed when executing the command set in the command parameter.

SleepAfterExecute

Sets the waiting time to wait for the execution of ZTransfer during user-designated time after executing the module set in the entry parameter. This parameter can be used when the command option value of IDF file is set to "Execute, ExecuteAtDownload". If the program execution has been finished before the designated time in the "SleepAfterExecute" parameter, the pause of the execution of ZTransfer is finished and executed promptly. If set to 0, do not wait. If set to 1, wait until the process is finished. If set to a value greater than 1, wait for the designated time(Unit : ms). The default value is 0.

comparefile

Defines file name that can be compared with the file name in the client system if the file already exists.

compareoption

Check whether the file name that can be compared with the file name set in comparefile exists. If the file exists, do not copy the file. If set to exist, do not copy and install if the file already exists. If set to a value that does not exist, copy and install even though the file already exists. The default value is exist.

destOS

Sets whether or not to install the file according to the OS type of user PC that the viewer is installed. If installed to a specific OS and its lower version set "-OS Name" format, and if installed to a specific OS and its upper version set "OS Name-". For example, to install from the version of Windows 7 including the lower version, it is set to "-6.1" and to install from the version of Windows 7 including the upper version, it is set to "6.1-". For the OS version number, please refer to the following URL. https://msdn.microsoft.com/en-us/library/windows/desktop/ms724832(v=vs.85).aspx

shortcutfilename

Defines the file name for registering as a shortcut. Filename should follow the relative path that is defined in the destdir parameter.

shortcutdisplayname

Create a shortcut on the wallpaper and set the name of the shortcut.

startprogramname

Set the directory and name for the startup menu in Windows.

shortcuticonname

Defines icon file on wallpaper.