Installing the UserInterface (UNIX)

Installing the UserInterface

Setting up Single Sign-On

---

Installing the UserInterface (Windows)

This document guides you through the new installation of the UserInterface (Windows).

Always install the UserInterfaces on your local hard disk in order to ensure optimal performance. AE does not recommend installing them on a network, because the UserInterface can crash if the network fails.

UserInterface communication occurs exclusively using the communication processes of the AE system. Therefore, no databaseA database is an organized collection of data including relevant data structures. interfaces (ODBC, OCI or CLI) are required.

Automic strongly recommends installing the UserInterface in a separate directory (e.g. C:\AUTOMIC\USERINTERFACE).

Supplied Files

The UserInterface files can be found in the IMAGE:USERINTERFACE\WINDOWS directory.

Procedure

	1.	Installing the Java Runtime Environment (JRE)

If the required version of JRE is already installed, this step can be omitted.

• Admin computer and/or user computer
• Use the following command to check which version of the Java Virtual Machine (VM) is installed.

java -version

If several JRE or Java SDK Versions are installed on the computer, it is important that the directories indicated in the settings of %PATH% or $PATH are in the proper order. The Java Runtime Environment that is listed first in the list of directories is used.

• Download the required Java Runtime Environment from http://java.sun.com and install it. The installation process includes the automatic installation of the Java Plug-in for Web browsers. You can deactivate it in the system control. AE does not need it.

	2.	Installing the UserInterface

• Admin computer and/or user computer
• Start the program SETUP.EXE in the IMAGE:USERINTERFACE\WINDOWS directory.
  All files required for UserInterface operation are copied into the specified directory. The default directory is C:\AUTOMIC\USERINTERFACE\BIN.

	3.	Modifying the configurationA set of constituent components that make up a system. This includes information on how the components are connected including the settings applied. files

• Admin computer and/or user computer
• Most values of the configuration files are supplied by the UserInterface, but the following modifications are still necessary:
• Adapt the uc4config.xml file.
• Enter the connection name and system in the <connection name="name" system="system"> parameter.
• Enter the connection data that is required by the communication process (DNS name or TCP/IP address of the computer on which this process runs, and port number). This information is provided in the INI file of the Automation Engine (Section [PORTS]).

	4.	Using ERP Forms (optional)

• Admin computer and/or user computer

• PeopleSoft:
• In order to use PS ERP Forms, the PeopleSoft Java Object Adapter and specific Java classes (UCXJPS84.jar) are required.
• Adjust  the entry "classpath" (psjoa.jar) in the INI file of the UserInterface, as needed.

Example:

[ENVIRONMENT]
classpath=.;.\psjoa.jar;.\ucdj.jar;.\UCXJPS84.jar

	5.	Calling the DLL from a freely selected path (optional)

• Admin computer and/or user computer
• Change the path for CALLHTMLHELP.DLL with the appropriate entry in the system environment variables (system control -> system). Enter the variable JAVA_LIBRARY_PATH and the required path. The library CALLHTMLHELP.DLL will be loaded from this directory.
• Alternately, you can also use the parameter "-Djava.library.path=Path" in the INI files. Enter it in the line "cmd=" of the section [GLOBAL].

Example:

cmd="javaw" -Djava.library.path=..\libraries -jar -cp .;.\UC4LAF.jar UCDJ.jar

	6.	Starting the UserInterface

• Admin computer and/or user computer
• To execute the UserInterface, you can either use the file UCDJ.EXE or UCDJ.BAT.

Ensure that there is sufficient memory for the Java application UCDJ.JAR . Otherwise, the UserInterface might come to a standstill of the UserInterface. Automic recommends increasing the value of the Java start parameter -Xmx in the file UCDJ.INI (for calls via UCDJ.EXE) or UCDJ.BAT to 1024MB.

To run the UserInterface by using an *.EXE file, you must have installed a 32-bit Microsoft Visual C-Runtime Library.

Potential Problems

During installation:

• Insufficient disk space:
  
  Approximately 30 MB is required. Availability of disk space is checked by the installation program.

During program start:

• No connection to the AE system:

• Check the entries in the file uc4config.xml:

Enter the name of the AE system to which the UserInterface should connect. It is also important to correctly indicate the port and computer name or IP address on which the communication process runs.

• AE system is not running:
  
  Ensure the server processes are active.

Recommended parameterization for Citrix

• Java must be installed on the Citrix server.
• At least the memory that is specified for the Java call in the INI file (ucdj.ini) should be available for each UserInterface that is used.
  For example: cmd="javaw" -Xmx512m ...
• To ensure that the correct Java version is used, you can specify the absolute Java path in the INI file.
  For example: cmd="C:\Program Files\Java\jre\bin\javaw" -Xmx512m ...
• You should separate the log and trace files and the configuration files uc4config.xml and login_dat.xml user specifically (see the details below).
• You can use the following Java parameter in order to optimize the JVM's memory management:
  -XX:+UseConcMarkSweepGC

Separating the UserInterface's log and trace files user specifically

In the file uc4config.xml, you can use environment variables in order to store the log and trace files on different places depending on the OS user.

Examples of the relevant section in the file uc4config.xml (Windows):

The log and trace files are created in the Windows user's directory which stores the temporary application files. The user nameName of the Automation Engine user. is appended to the file name.

<logging count="10">%APPDATA%/temp/UCDJ_LOG_##_%USERNAME%.TXT</logging>
<trace count="10" tcp="3" xml="0">%APPDATA%/temp/UCDJ_TRC_##_%USERNAME%.TXT</trace>

The following example stores the log and trace files in the UserInterface's Temp folder. The name of the Windows user is also appended:

<logging count="10">../temp/UCDJ_LOG_##_%USERNAME%.TXT</logging>
<trace count="10" tcp="3" xml="0">../temp/UCDJ_TRC_##_%USERNAME%.TXT</trace>

Starting the UserInterface user specifically

The configuration files uc4config.xml and login_dat.xml must be available for each OS user who uses the UserInterface. Automic recommends using a descriptive name such as uc4config_TEST.xml and login_dat_TEST.xml.

Option 1:

Calling the UserInterface with the start parameters -I and -J, the user name can be appended dynamically by using environment variables.

For example, the start command for the UserInterface under Windows:
C:\AUTOMIC\UserInterface\bin\UCDJ.EXE -J"-OC:\AUTOMIC\UserInterface\bin\login_dat_%USERNAME%.xml –IC:\AUTOMIC\UserInterface\bin\uc4config_%USERNAME%.xml"

Option 2:

The UserInterface is called in the same way as described above. The user-dependent configuration files are specified in the INI file. For this purpose, you use environment variables for the Java call (cmd=...).

Example that shows the relevant INI-file section:

[GLOBAL]
cmd="javaw" -Xmx512m com.uc4.ucdf.UCDialogFactory -U%User% -I./uc4config_%USERNAME%.xml -O./login_dat_%USERNAME%.xml

When the name and the path to the XML files should be user dependent, you must define a separate environment variable for the path before you use the start command. For example:

INI file:

[GLOBAL]
cmd="javaw" -Xmx256m com.uc4.ucdf.UCDialogFactory -U%User% -I%UI_XML%/UC4CONFIG_%USERNAME%.xml -O%UI_XML%/login_dat_%USERNAME%.xml

UserInterface call:

Set UI_XML=C:\UI_XML_Files
C:\AUTOMIC\UserInterface\bin\UCDJ.EXE  -F0 -IUCDJ_individualized.ini

See also:

Configuring the Debugger for potential program failures