Section - 3 : Installing Documaker Connector

Documaker Connector is installed using platform-specific setup wizards which place the program and supporting files on the target system and perform the initial configuration of the target system to run Documaker Connector.

For instance, on Microsoft Windows systems, this includes installation of Documaker Connector as a Windows Service and installation of a task bar notification icon which you can use to control the running of the service.

To install on Required user privileges
Windows You must log in as the Administrator to install the Windows Service. You must also have write-permission to the disk directory where Documaker Connector will be installed. A non-Administrator can run the Setup wizard, however, the installation of the Windows service will fail. The program files will be installed and you can run the program as a command-line program, but it will not be added to the Services list in the Services control panel.
UNIX (in GUI mode) You must have write-access to the target directory. No special privileges are required.
UNIX (via the command line) You must have write-access to the target directory. No special privileges are required.

Using the Setup Wizard

Running the Setup wizard is similar across all platforms. These steps are from Microsoft Windows, but should be easily used as a guideline in other environments.

Note:

On UNIX systems (Linux), to optionally run the installation in GUI mode you must have an X11 server running. You must also set the DISPLAY environment variable to point to the X11 server, otherwise it will run in a console mode. For more information, see Installing from the UNIX Command Line on page 22.

Follow these steps to run the X11 Java Swing-based GUI:

  1. Start the X11 server on your computer or use the existing X11 hosted Linux desktop environment.

  2. Set the DISPLAY environment variable to point to the X11 server. Here is an example:

    DISPLAY=IPADDRESSOFX11Server:DisplayNumber

  3. Run the Setup wizard.

From the directory into which you downloaded the Oracle Documaker Connector media pack, unzip the media pack, locate and double click on the following program:

documakerconnectorrel(version and patch number).exe

The installation wizard starts. Follow these steps to install Documaker Connector:

  1. When the Welcome window appears, click Next.

    Image represents Oracle Documaker Connector setup wizard.
    Figure 2.3.1 - Oracle Documaker Connector Setup Wizard

    The Select Destination Directory window lets you choose the installation target directory.

    Image represents selecting destination directory for installation.
    Figure 2.3.2 - Select Destination Directory

  2. Enter a directory or click Next to accept the default directory. On Windows, the default directory is under the Program Files directory. The directory you choose is referred to throughout this document as the installation target directory.

    Once you click Next, the Setup wizard begins to install Documaker Connector. As part of this process, the Setup wizard...

    • Puts a Java run-time environment (JRE) in a subdirectory of the target directory called jre. On Microsoft Windows, the Setup wizard installs the Visual C++ 2008 run time if it is not already on the machine.

    • Sets the service.path in the dm_connector.svc.properties file to the JRE that was installed.

    • (On Windows) Runs the dm_connector_svc.exe program with an install parameter to install the Windows Service. Running this program later with a parameter of uninstall removes the Windows Service.

    This window shows its progress:

    Image represents installation progress bar.
    Figure 2.3.3 - Installation Progress Bar

    When finished, this window appears:

    Image represents finished setup wizard.
    Figure 2.3.4 - Setup Finished

  3. Click Finish to complete the installation.

Installing from the UNIX Command Line

Running the installer from the UNIX command line avoids the requirement of having a windowing or GUI environment. All interaction with the installer is handled via the text console. The installer is packaged as a shell script. Here is an example:

DocumakerConnectorRel121p01b15380Linuxx86.sh

Follow these steps to install the software from a UNIX command line:

  1. Once the script is copied into your UNIX directory, it must be made executable if it is not already. Use the chmod command to set the appropriate read and executable attributes. Here is an example:

    ~> chmod 555 DocumakerConnectorRel121p01b15380Linuxx86.sh

  2. After you set the read and executable mode of the file, run the script:

    ~> ./DocumakerConnectorRel121p01b15380Linuxx86.sh

    The script takes a few seconds to start and begin unpacking the compressed files contained within it. Here is an example of the text that appears on your console:

    ~> ./DocumakerConnectorRel121p01b15380Linuxx86.sh

    Unpacking JRE ...

    Preparing JRE ...

    Starting Installer ...

    This will install Documaker Connector on your computer.

    OK [o, Enter], Cancel [c]

  3. Press Enter to continue with the installation. Here is an example of the text that appears on your console:

    Where should Documaker Connector be installed?

    [/home/example/DocumakerConnector]

  4. Enter a different location if necessary or press Enter to accept default location and continue with the installation. Here is an example of the text that appears on your console:

    Preparing to copy files...

    Extracting files...

    Downloading ...

    Extracting files...

         COPYRIGHT

         README

         THIRDPARTYLICENSEREADME.txt

         Welcome.html

         bin/

         bin/tnameserv

             ... (the complete list of installed files is omitted here)

         lib/oracle-ridc-client-11g.jar

         .install4j/

         .install4j/uninstall.png

         uninstall

         Finishing installation...

    ~> cd DocumakerConnector

    ~> ls

    total 41

    -rw-r--r-- 1 example users 2930 2011-03-08 21:37 batch-file-conn.properties

    -rw-r--r-- 1 example users 1330 2011-03-17 12:55 dm_connector_svc.properties

    -rw-r--r-- 1 example users 3746 2011-03-08 21:37 dmkr-ucm-conn.properties

    drwxr-xr-x 4 example users 232 2011-03-17 12:55 jre drwxr-xr-x 2 example users 1128 2011-03-17 12:55 lib

    -rw-r--r-- 1 example users 2888 2011-03-08 21:37 mock-file-conn.properties

    -rw-r--r-- 1 example users 3042 2011-03-08 21:37 mock-ftp-conn.properties

    -rw-r--r-- 1 example users 2758 2011-03-08 21:37 mock-mock-conn.properties

    -rw-r--r-- 1 example users 3154 2011-03-08 21:37 mock-ucm-conn.properties

    -rwx------ 1 example users 10337 2011-03-09 18:53 uninstall

Note:

During the installation on UNIX, you may see a warning message regarding the Java system preferences store at /etc/.java/.systemPrefs/com. This warning should not affect your installation.

Running the Installer with a Response File

You can run the installer in unattended mode from the command line. To do this you must create a response file to provide the information the installer needs. A response file is a text file which contains the information a user would typically provide while running the Setup wizard or responding to command-line prompts. This information is in this format:

name=value

To create a response file that contains the necessary data, first run the command-line installer in one of these ways:

  • Using default mode, with no arguments. After the installation finishes, the installer creates a response file named response.varfile.
  • Using the command-line installation with the -console parameter. This lets you specify the name you want to assign to the response file.

After the installation finishes, the installer creates the response file and stores it in the .install4j directory. This file contains name=value data captured during the installation process. You can edit this file if necessary to modify the values. Here is an example:

#install4j response file for (application/version)

#Wed Mar 16 16:53:12 EDT 2011

sys.languageId=en

sys.installationDir=d\:\\(application/version)

You can then pass the response file to the installer using the -varfile parameter. For example, to run the installer in unattended mode using a response file, include these parameters:

-q -console -c -varfile varfilename

Parameter Description
-q Runs the installer in unattended mode.
-console If the installer is executed in unattended installation mode (-q) and you include -console as the second parameter, a console is allocated on Windows that displays the output of the installer.
-c Runs the installer in the console mode.
-varfile Varfilename specifies the name of the response.varfile to use. You can include a full path.
Note:

You can use a response file on both Windows and UNIX/Linux installations. For more information about response files and install4j installations, go to this website:

http://resources.ej-technologies.com/install4j/help/doc/

Here is an example:

(application/version).exe -q -console -c -varfile

response.varfile

Here is an example of the output you will see:

Extracting files...

Downloading ...

Extracting files...

Finishing installation...