Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel
Table of Contents
maxlevel2


Warning

Currently, IBM i runs Workload Automation Universal Agent 7.7.0 for IBM i does not include Universal Command (UCMD) or Universal Data Mover (UDM).   Customers who require those components should use an older version of Workload Automation for IBM i.  The latest version containing those components is 5.1.1.  These pages provide information for that version.Older versions of Workload Automation for IBM i can be installed alongside version 7.7.0.

Objective

This page provides installation requirements and summary for Workload Automation 5.1.1 Universal Agent 7.7.0 on an IBM i system.

System Requirements

The requirements for installation of Workload Automation Universal Agent for IBM i are:

  • IBM i V5R4M0 V7R3M0 or above.
  • TCP/IP.
  • User profile with *ALLOBJ, *SPLCTL, *JOBCTL, and *SECADM authorities.
  • About 360 megabytes of disk space.
  • Network-attached workstation.
  • PTF SI27629 installed on V5R4 systems.
    For additional information, see the documentation for APAR SE28859 and PTF SI27629 at both:
    • https://www\-912.ibm.com/n\_dir/nas4apar.nsf/aaf5d88f9cc2ee10862571020058635c/a2b5a3b3ac874a9d862572d8003c7457?OpenDocument&Highlight=2,QGYOLJBL
    • https://www\-912.ibm.com/a\_dir/as4ptf.nsf/c2fd98f5d2eccb83862574ce00520341/7529dd654f63941b862572eb00581099?OpenDocument

The Workload Automation 5 The Universal Agent 7.7.0 for IBM i installation process creates a product user profile, UNVUBR511 UNVUBR770, that is given *ALLOBJ special authority. UNVUBR511 UNVUBR770, with *ALLOBJ special authority, is required to successfully complete the installation.

Note
titleNote

Some organizations and companies require the removal of *ALLOBJ authority from non-administrative user profiles. Workload Automation Universal Agent may be configured to run without *ALLOBJ authority; however, to do so requires additional administrative overhead. The steps required to remove product *ALLOBJ authority are described in Universal Broker Security.

The *BASE option contains the complete installation. This includes all of the components and utilities listed above.

...

Since platform requirements may change with new releases of a product, please consult the Platform Support for Universal Controller 7.7.x and Universal Agent 7.7.x /wiki/spaces/Staging/pages/996671489 page to make sure that your platform is supported before performing an installation.

...

Under the IBM i native file system, Workload Automation Universal Agent write to product files residing in various libraries and write information to job logs.

...

Under IBM i, Universal Broker writes its messages to the UBROKER job log.

Space

Anchor11786991178699Job log file growth is dependent on use of the Workload Automation Universal Agent Servers. The disposition and size of the job log depends on the job definition as well as system variables QJOBMSGQMX (maximum job log size) and QJOBMSGQFL (action when job log is full).

...

Universal Command Server requires read access to the UNVCMDREF library files. Administrator accounts require appropriate access in order to maintain the command reference files. No general user access is required.

Universal Automation Center Agent (UAG) Logging

Under IBM i, Universal Automation Center Agent (UAG) writes some messages to the job log for the UNVSRV prestart job under which it runs.  However, messages are typically only sent to the UNVSRV job log in the case of unexpected errors.  The primary logging destination for UAG is the /var/opt/universal/log directory in the IFS file system.  The current log file is named agent.log.

Note
titleNote

The agent.log files are encoded as CCSID 037, which is EBCDIC.  These files can be viewed from an SSH terminal on the IBM i system, use the following command:

  • qsh -c "cat /var/opt/universal/uag/logs/agent.log"

The agent.log files can be viewed from the native 5250 terminal with the following command:

  • DSPF STMF('/var/opt/universal/uag/logs/agent.log')

Space

Job log file growth is dependent on use of the Universal Agent Servers. The disposition and size of the job log depends on the job definition as well as system variables QJOBMSGQMX (maximum job log size) and QJOBMSGQFL (action when job log is full).

Security

For the UAGSRV job log, no special security is required.  However, for the primary agent log file which resides in IFS, the Universal Broker user profile (UNVUBR770) requires read/write access to the log directory and read/write access to all files in the log directory. No other Universal Agent components use the log directory at this time. No general user access is required.

Trace File Location Library

Universal Broker and its server components (for example, Universal Command Server) create product trace files when configured to do so. A trace file is used by Stonebranch, Inc. Customer Support to resolve product problems.

On IBM i, Workload Automation Universal Agent trace files normally are written to *CURLIB (current library). Under Universal Broker and the associated servers, the current library is the temporary library designated at installation time (UNVTMP511UNVTMP770).

Otherwise, current library is the default current library of the user.

Space

Trace files can grow to significant size, depending on how long the trace is active and how much work the program is doing during the tracing period. Due to the information associated with IBM i pointers and fact that physical database files are fixed record lengths, trace files quickly can grow very large on a system with high Universal Broker and server activity.

...

No space is required under normal operation for trace files. Trace files are requested by Stonebranch, Inc. Customer Support only for problem resolution. When trace files are required, at least 40MB of disk space should be available.

Security

The UNVUBR511 user UNVUBR770 user profile requires at least *CHANGE authority to the UNVTMP511 library UNVTMP770 library to create and use the Universal Broker and server trace files. No general user access is required.

...

  • Execution information for Workload Automation Universal Agent components started by Universal Broker, UBR_CMP_DB.
  • Universal Command Server status, SRV_CMP_DB.
  • Redirected standard I/O files (stdin, stdout, and stderr) captured by Universal Command when run with manager fault tolerance enabled.

Spool files are stored in the UNVSPL511 UNVSPL770 library.

Space

The spool files are located in the UNVSPL511 library UNVSPL770 library. The amount of disk space required for the spool directory depends on these factors:

  1. Number of spooling user processes that will be executing simultaneously.
    A user process is created for each command requested by a Universal Command Manager. The default maximum number is 50. Once a user process ends and a Manager has received all the spool files, the spool files themselves are deleted.
  2. Average number of records of the user processes for standard input, output, and error files.
    Each record is 32764 bytes in length. Keep in mind that spooling is not intended as a feature for file transfer purposes. File transfer related processes should execute without spooling enabled.

Once these numbers are

  1. Whether or not activity monitoring is turned on.
  2. The event generation configuration
  3. The level of activity experienced by product components

Security

The UNVUBR770 user profile requires at least *CHANGE authority to the UNVSPL770 library to create and use the spool files. No general user access is required.

No other Universal Agent for IBM i components access the spool library.

UAG Cache

UAG cache is used by Universal Automation Center Agent (UAG) for storing standard I/O files.

Space

Cache files are located, by default, in directory /var/opt/universal/uag/cache.

Cache files are created for each job that is run by the Agent. They remain in the cache until they are purged by an automated purge process scheduled nightly by Universal Controller. You can configure the number of days that files remain in the cache via the Universal Controller user interface (see the Agent Cache Retention Period in Days Universal Controller system property).

The amount of disk space required for the cache directory depends on:

  1. Number of jobs you estimate will run during the cache retention period you specified.
  2. These files remain until they are purged by the automated cache purge process scheduled by the Controller daily at midnight.
  3. Average size of the user processes standard output and error files.

When these numbers have been determined, the average amount of disk space is calculated with the following formula:

(RETENTION PERIOD x MAX-PROCESSES x AVERAGE NUMBER-OF-REC0RDS x 32764 JOBS) x (AVERAGE-STDOUT-SIZE + AVERAGE-STDERR-SIZE) = required disk space.

As an example, if the maximum number simultaneous user processes is estimated at 20 and the average number of records in files is 1For example:

If the files are purged every 7 days, and you run 1200 jobs on that agent server daily, and the average size of the STDOUT + STDERR files is 3,000 bytes, the average amount of required disk space is 655MB 25MB (20 7 x 1000 1,200 x 327643000).

The Universal Command Server is configured with spooling disabled to prevent unintentional disk utilization. The feature must be turned on through the ALLOW_SPOOLING configuration settings.

Further details on the Manager Fault Tolerant feature and spooling of redirected standard I/O files can be found in the Universal Agent 7.7.x User Guide.

Security

The UNVUBR511 user profile requires at least *CHANGE authority to the UNVSPL511 library to create and use the spool filesAutomation Center Agent Server automatically redirects the standard output and standard error files to the cache directory with no required user input.

Note
titleNote

As with the agent.log files, UAG cache files are encoded in CCSID 037.  They can be viewed using the same techniques described for Universal Automation Center Agent (UAG) Logging above.

Security

Universal Automation Center Agent requires read/write access to the UAG cache directory. No other Universal Agent components access the cache directory. No general user access is required.No other Workload Automation 5 for IBM i components access the spool library

UAG Extension Directory

UAG extension directory is used by Universal Automation Center Agent (UAG) for storing deployed Universal Extensions.

Space

Extension files are located, by default, in directory /var/opt/universal/uag/extensions.

Extension files are created when the Universal Controller deploys a Universal Extension to the agent. Extension deployment can occur preemptively during agent registration, or on demand during task submission.  You can configure extension deployment with the following options:

The amount of disk space required for the extension directory depends on:

  1. Number of extensions you estimate will be deployed to the agent.
  2. Average size of the extensions.
  3. These files remain until they are manually purged.
  4. Only one extension deployment is required for all tasks of that type.

When these numbers have been determined, the average amount of disk space is calculated with the following formula:

(MAX-EXTENSIONS) x (AVERAGE-EXTENSION-SIZE) = required disk space.

For example:

If you expect to deploy 10 different extension types, and the average size of an extension is 1MB, the average amount of required disk space is 10MB (10 x 1).

The Universal Automation Center Agent Server automatically synchronizes deployed extensions with the version currently installed in the Controller with no required user actions.

Security

Universal Automation Center Agent requires read/write access to the UAG extension directory. Any user executing extension tasks must have read access to the extension directory.


Installation Summary

Warning
titleWarning

This installation procedure is intended only for default installations into simple environments. Installing into high availability environments may require a customized installation. For customized installation, parallel installation or multiple system roll out see the Installation Guide for IBM i.

...

Step 1

Download the distribution file from the Stonebranch Customer Portal to a computer running a supported version of Windows or UNIX.

Step 2

Extract the Licensed Program Save File from the distribution file.

Step 3

If transferring the installation file to the native, QSYS file system, create a save file, UNV511UNV770, on the target IBM I system in library QGPL. This step is not necessary if transferring the file to the IFS.

Step 4

FTP the Licensed Program Save File to either the save file created in step 1 or to /QSYS.LIB/QGPL.LIB/UNV511UNV770.SAVF.

Step 5

Execute the following command to install Workload Automation 5 Universal Agent 7.7.0 for IBM i to the default libraries:

Panel
 RSTLICPGM LICPGM(0UNV5110UNV770) DEV(*SAVF) SAVF(QGPL/UNV511UNV770)


Add the FRCOBJCVN parameter when installing on a version of IBMi IBM i that is greater than the version identified in the distribution file.  For example, when using the 7.73-targeted distribution file to install on IBMi IBM i 7.75, enter:

Panel
 RSTLICPGM LICPGM(0UNV5110UNV770) DEV(*SAVF) SAVF(QGPL/UNV511UNV770) FRCOBJCVN(*YES *ALL)


Step 6

Verify the correctness of the install by executing the following command:
 

Panel
CHKPRDOPT OUNV5120OUNV770


Step 7

Optionally, rename the UNVUBR511 UNVUBR770 subsystem to UBROKER for consistent operation across future installations.

...

Customization consists of editing configuration members in the UNVPRD511UNVPRD770/UNVCONF source file.