This document guides you through the new installation of a UserInterfaceThis is the Automation Engine's graphical user interface. [Formerly called the "Rich Client", "RichGUI" and "Dialog Client."].
The Automation EngineThis component drives an Automation Engine system and consists of different types of server processes. UserInterface is programmed in Java. Therefore, Java 2 JRE (Java Runtime Environment) is a prerequisite for installing the UserInterface.
Always install the UserInterfaces on your local hard disk in order to ensure optimal performance. We do not recommend installing them on a network as this can result in a UserInterface crash if the network fails.
UserInterface communication happens exclusively through the communication processes of the AE system. Therefore, no databaseA database is an organized collection of data including relevant data structures. interfaces are necessary.
Automic strongly recommends installing the UserInterface in a separate directory.
The UserInterface files are found in the directory IMAGE:USERINTERFACE\UNIX. Single files are combined in the ucdj.tar.gz file.
File name |
Description |
---|---|
UCDJ.SH | Start scriptA particular Automation Engine object type. for calling the UserInterface |
UCDJ.INI | Call options for the start program |
UCDJ.BAT | Batch file for calling the UserInterface |
UCDJ.JAR | UserInterface in Java |
UC4CONFIG.XML | Configuration file for connecting to the AE systems |
LOGIN_DAT.XML | Configuration file for user loginAn Automation Engine object type that stores account credentials used by agents on target systems. to the AE system |
UC.MSL |
Message library |
CALLHTMLHELP.DLL, CALLHTMLHELPIA64.DLL, CALLHTMLHELPX64.DLL, UC4DOCREF.PROPERTIES, UC4MSGREF.PROPERTIES |
Files for calling help with the F1 key |
CONFIGREF.CLASS |
Configuration class |
SYNTHETICA.JAR, SYNTHETICAADDONS.JAR, UC4LOOKANDFEEL.JAR, ATTACHLAYOUT.JAR, SWINGX.JAR, SWING-WORKER-1.2.JAR | Interface layout |
UC4.WAV |
WAV file that is processed when the UserInterface (Display Splash Screen) is started |
UCXJPS84.JAR | File with specific Java classes for the PeopleSoft forms |
AE-RA.JAR | RA Framework |
INTELLISENSE.JAR | File for the script editor's auto-completion functionPre-defined run book template in the Automation Engine. One single step only, e.g. Start Windows Service, Copy file,… |
![]() |
1. | Installing the Java Runtime Environment (JRE) |
---|
If the required version of JRE is already available, this step of the installation process can be ignored.
java -version
If several JRE or Java SDK Versions are installed on the computer, make sure that the directories are in the appropriate order in %PATH% or $PATH. The Java Runtime Environment that is found first in the listShows entities in a grid view will be used.
![]() |
2. | Installing the UserInterface |
---|
![]() |
3. | Adapting 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 |
---|
![]() |
4. | Using ERP Forms (optional) |
---|
Example:
[ENVIRONMENT]
classpath=.;.\psjoa.jar;.\ucdj.jar;.\UCXJPS84.jar
![]() |
5. | Starting the UserInterface |
---|
During installation:
During program start:
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 processA communication process is part of the component Automation Engine. It is responsible for connecting the components. runs.
In the file uc4config.xml, you can use environmentAn Environment consists of Deployment Targets which represent your endpoints. Different environments are used for different phases in the software delivery cycle, for example Development, QA, Staging, Production. An environment is typically set up once and used by several applications. 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 applicationAn application is a software which helps a user to fulfill specific tasks. In the context of ARA see also: Application entity. 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 folderTop level entities such as Environment, Deployment Target, Activity, … are stored in folders. The permissions a user has on an entity depend on the permissions that are set on the folder for the entities.. 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>
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 variableIt stores or retrieves values dynamically at runtime. An individual Automation Engine object type. 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
Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support |
Copyright © 2016 Automic Software GmbH |