Installing the Agent for VMS

This topic guides you through the installation process of a VMS agent.

Notes:

This page includes the following:

Requirements

Supplied Installation Files

The files of the VMS agent are found in the subdirectory of IMAGE:AGENTS\VMS that complies with the particular VMS version.

Special Feature: Logical Name for Agent

VMS often uses global variables called logical names to transfer information. AE's VMS agent also uses such a global variable.
By default, its name is structured as follows: UC4_AE system name_Agent_name_AGENT. The names that have been defined in the INI file are used for the AE system name and agent name. Alternatively, you can define a logical name of your choice. Use the parameter uc4_logical= in the INI file for this purpose.

The global variable is automatically created when the agent starts and deleted when it ends. The value of the variable is "OK" by default. You can end the agent by changing the variable content to "TERM". Use the command file UC$STOP.COM and the agent will react within 20 seconds and end normally.

Installing the Agent for VMS

  1. Transfer the command file to the host.

    • Admin computer
    • Transfer the file UC$CRDIR.COM to the target host.
      If you use FTP to transfer the files to the target host you may consider that all text files are delivered unix-like.

  2. Determine directories and authorizations.

    • Host
    • Register with user ID AE.
    • Call command file:

      $  @UC$CRDIR

    • Delete command file:

      $DELETE UC$CRDIR.COM;*

      The command file UC UC$CRDIR.COM creates all required directories and authorizations:

      • BIN
        SYSTEM: RE, OWNER: RWED, GROUP: E, WORLD: E
      • CMD
        SYSTEM: RWE, OWNER: RWED, GROUP: R, WORLD: -
      • TEMP
        SYSTEM: RE, OWNER: RWED, GROUP: WE, WORLD: WE
      • OUT
        SYSTEM: RW, OWNER: RWD, GROUP: RW, WORLD: RWE

  3. Transfer more files to the host.

    • Admin computer
    • The files of the VMS agent (UCXJV??.EXE), for file event (UCXE???F.EXE) and the messenger program (UCXJV??M.EXE) must be transferred in binary mode. All others are text files.

  4. Set up the system environment.

    • Host
    • Change from the login directory to the BIN directory:

      $SET DEF [.BIN]

    • Adjust INI file of the VMS agent with the editor. For more information, see Agent VMS.
    • Adjust HEADER.VMS, TRAILER.VMS and RESTART.VMS if necessary. For more information, see Executing Jobs.
    • Change to the CMD directory:

      $SET DEF [-.CMD]

    • Use an editor to adjust the command file that closes the agent UC$STOP.COM.

      Adjust the name of the AE system and the agent name so that the logical name of the agent can be found. Alternatively, you can modify both files on the admin computer before you transfer the file.

      By default, the HOME directory is used for the agent start. If the agent is not installed in the HOME directory, you must adjust the command file UC$START.COM. It includes a variable in which you can specify the installation directory.

      $   rel_dir     = ""

      The user IDs under which AE jobs should run should be given TMPMBX and sometimes NETMBX privileges.

    • Admin computer or user computer
    • Adjust HEADER.VMS, TRAILER.VMS and RESTART.VMS if required. For more information, see Executing Jobs.

  5. Start the agent.

    • Server computer
    • Register by using the user AE.
    • The AE system must be running. For more information, see Multi-Server Operations.
    • Host
    • Call command file in the CMD directory:

      $  @UC$START

    • You can identify the agent's task by its process ID or process name. Obtain information about this task through:
        • The process name that is created when the agent starts: UC4_User ID.

          By default, the process name is UC4_UC4.
          $ SHOW PROC UC4_UC4

        • The process ID that is displayed when the agent starts.

          $ SHOW PROC/ID=Process ID

    • An Agent object is automatically created in system client 0000 and stored in the folder HOST.
    • Admin computer or Server computer
    • Verify that the agent is logged on.

      Start the AWI for client 0000. Refer to the Administration perspective to get information about agents. A newly installed agent is only visible in client 0000 until it is assigned to other clients. Use the agent object to assign it with the required rights. For more information, see Authorizations Page.

  6. Shut down the agent.

    • Host
    • Log on by using the user ID UC4.
    • Regular shutdown: Call the command file in the CMD directory.

      $ @UC$STOP

    • Emergency shutdown: Network connections are not closed properly in this case.

      • Stop it by using the process name:

      $  STOP UC4_UC4

      Stop it by using the process ID:

      $  STOP PROC/ID=Process-ID

Automatic Agent Start when Booting the Operating System

The command file SYS$MANAGER:SYSTARTUP_VMS.COM is executed when the operating system starts. To start the VMS agent automatically with VMS, the agent's startup script is appended to the end of this command file. The command file (1) UC4$STARTUP.COM is called in the startup script if it is available.

Example startup script

$!
$ FILE = F$SEARCH("SYS$STARTUP:UC4$STARTUP.COM")
$ IF FILE .NES. ""
$ THEN
$    @SYS$STARTUP:UC4$STARTUP.COM
$ ENDIF
$!

The following parameters must be adjusted to the system environment in the supplied command file (1) UC4$STARTUP.COM:

The command file (1) UC4$STARTUP.COM calls the command file (2) UC4$STARTUP_BAT.COM. The VMS agent then starts with the help of the command file UC$START.COM. Adjust the parameter UC4_COM if you have changed the name or directory of this supplied command file.

Comments