Installing the ServiceManager

The following steps will help you install the ServiceManager.

Important! Information security services, such as the TLS/SSL implementation of the ServiceManager, require features provided by the CAPKI package. You need to install CAPKI on all computers in which the Automation Engine Server Processes or the ServiceManager and any of its clients will run.

More information:

This page includes the following:

Windows

To Install the ServiceManager on Windows

Server computer or host computer.

  1. Install the Microsoft Visual C++ 2017 Redistributable Package.

    This installation step can be omitted if the required version of the package is already installed. Refer to Control Panel > Add or Remove Programs to see if the package is installed , and if so, which version.

    • Host (32 bit): install the package from the IMAGE:CRTS\WINDOWS\X86 directory.
    • Host (64 bit): install the package from the IMAGE:CRTS\WINDOWS\X64 or IMAGE:CRTS\WINDOWS\IA64 directory.

  2. Install the ServiceManager.

    • Host (32 bit)
      1. Start the program SETUP.EXE in the corresponding subdirectory of IMAGE:SERVICEMANAGER\WINDOWS\X86.
      2. Adjust the INI file of the Service Manager Service to your system environment. For more information, see Service Manager Service.
      3. Adjust the definitions file (SMD file). For more information, see Setting Up an SMD File.
    • Host (64 bit)
      1. Start the program SETUP.EXE in the corresponding subdirectory of IMAGE:SERVICEMANAGER\WINDOWS\X64 or IMAGE:SERVICEMANAGER\WINDOWS\IA64.
      2. Adjust the INI file of the Service Manager Service to your system environment, see Service Manager Service.
      3. Adjust the definitions file (SMD file), see Setting Up an SMD File.

  3. Install the Dialog and Command Line Programs of the ServiceManager.

    • Host (32 bit)
      1. Start the program SETUP.EXE in the corresponding subdirectory of IMAGE:SERVICEMANAGERDIALOG\WINDOWS\X86.
      2. Adjust the INI file of the Service Manager Dialog to your system environment, see Service Manager Dialog.
      3. These programs can also be installed on computers where no ServiceManager runs, which enables the ServiceManager to be operated from these computers.
    • Host (64 bit)
      1. Start the program SETUP.EXE in the corresponding subdirectory of IMAGE:SERVICEMANAGERDIALOG\WINDOWS\X64 or IMAGE:SERVICEMANAGERDIALOG\WINDOWS\IA64.
      2. Adjust the INI file of the Service Manager Dialog to your system environment, see Service Manager Dialog.
      3. These programs can also be installed on computers where no ServiceManager runs, thereby facilitating that the ServiceManager can be operated from these computers.

  4. Install the ServiceManager as a service.

    1. Open an MS DOS window

    2. Start the program UCYBSMGR.EXE using the command:

      UCYBSMGR[.EXE] -install Phrase [-iPath and name of the INI file]

      The ServiceManager is entered in Windows as a service. You can use a string of your choice as the phrase with a maximum of 16 characters.

    3. Verify in the Control Panel > Administrative Tools > Services that the service is correctly entered. The name displayed here is structured  - as follows: "UC4.ServiceManager [Phrase]".

    4. Set the start type to "Automatic" if needed.

    5. The phrase name is "UC4" by default. If you choose to use a different term, you must adjust the following section in the INI file UCYBSMGR.INI:

      Note: The ServiceManager phrase cannot exceed 16 characters.

      [Destination Phrase]
      deffile=Path to the SMD file
      cmdfile=Path to the SMC file

      Example

      [Destination UC4PROD]
      deffile=C:\AUTOMIC\SMgr\bin\UC4PROD.smd
      cmdfile=C:\AUTOMIC\SMgr\bin\UC4PROD.smc

    The ServiceManager can be installed as a service multiple times. This means that different ServiceManager environments can be created; one that serves as a test system and one that serves as a production system, for example. If several of these services are used, they are distinguished by the ServiceManager environment name (default name: UC4).

    Note: The ServiceManager service must be started under a Windows user with administrator rights because the ServiceManager can be used to start components that can start processes for various different users.

  5. Start the ServiceManager.

    Important! Make sure that the ODBC data source is set up as a system DSN (Data Source Name) so that the Automation Engines (program UCSRVCP.EXE and UCSRVWP.EXE) are executable as a service.

    The ODBC data source is configured in the UCSrv.INI file.

    1. Start the dialog program of the ServiceManager.
    2. Select the computer and the ServiceManager environment (phrase).
    3. All provided services are displayed (status "stopped").
    4. Right-click to start the service or to change a particular service's properties (such as starting automatically when the system starts or delaying its start).

Potential Problems

  • Not all ServiceManager environments (phrases) are displayed:
    A port number range must be specified in order for more than one ServiceManager to be selectable in the dialog program. Enter this range in the INI file of the Service Manager Dialog, keeping in mind that it is limited to 10 port numbers. For more information, see Service Manager Dialog.
  • Not all services are displayed:
    Ensure that the correct instructions are given in the definitions file (SMD file). Each service should be displayed in an extra line. Also enter the path of the SMD file in the INI file of the ServiceManager. 
  • A service cannot be started:
    Verify that the path specified in the properties is correct (to be opened via the context menu in the dialog program).

Further information can be obtained from the ServiceManager's log file (default name of the latest file: SMgr_LOGG_00.txt), which is found in the TEMP folder and which contains detailed information on all procedures.

To Uninstall the ServiceManager on Windows

In some cases it is necessary to uninstall a specific ServiceManager environment (Phrase).

  1. Open an MS DOS window.
  2. Start the program UCYBSMGR.EXE with the command:

    UCYBSMGR -remove Phrase

    Example: UCYBSMGR -remove AE

    This command uninstalls the ServiceManager environment as a service under Windows.

  3. Check the Control Panel - Administrative Tools - Services in order to verify that the service has been removed.

UNIX

Notes:

  • Because the ServiceManager for UNIX is available for different platforms, a three-figure code has been supplied for each supported UNIX platform. In this document, the specific code is replaced with the characters "???."

  • The standard libraries (libstdc++.so and libgcc_s.so) are no longer part of the Service Manager's .tar ball but can be found in the Automic Automation offering under External.Resources/unix_libraries/unix_libraries.tar.gz. Make sure that these libraries are available so that the ServiceManager can use them. To do so, first, untar the component's .tar file. Then, untar the libraries' tar file and copy the files relevant for your Operating System to the component's bin folder. Additionaly, use the ln -s ./libstdc++.so.6 command to create symbolic links for the libraries in the bin folder.

  • For AIX 64 bit, make sure you have installed/upgraded the IBM XL C++ Runtime, V16.1 system libraries (libc++, xlC, xlC.aix61) into at least 16.1.0 Fix Pack 6 ; otherwise AIX does not work. For detailed information on how to install/upgrade the package, please refer to the official IBM C and C++ compilers documentation.

    You can use the lslpp -L libc++.rte xlC.rte xlC.aix61.rte command to check which versions are installed, if any.

To Install the ServiceManager on UNIX

Important! Start the ServiceManager as the user who is the owner of the executable file ("AE" user). Do not start the ServiceManager as root. The owner of the ServiceManager files should not be root.

  1. Transfer the tar file to the Host and set up the system environment. (Host)

    1. Log on using the user ID AE.

    2. Transfer the TAR file ucsmgr??.tar.gz to a directory (such as servicemanager). Do not install the ServiceManager in the directory of a different application, such as an Agent.

    3. Navigate to the ServiceManager directory:cd servicemanager

    4. Unpack the tar file:
      gzip -d ucsmgr???.tar.gz       or gunzip ucsmgr???.tar.gz
      tar xvfo ucsmgr???.tar

    5. The files will appear in their corresponding directories. The tar file can be deleted after unpacking.

      6. Important! Be sure to note any tar messages (which can be called up by various users) and verify that all files have been correctly unpacked.

    6. Verify that all files have the correct owner and group entries. AE must be the owner. The group must correspond to the identification AE. Modifications can only be made by a privileged user, such as root.

      • chown AE* changes the owner of all files to AE

      • chgrpGroup name * changes user group for all files.

    7. Rename the supplied INI file ucybsmgr.ori.ini to ucybsmgr.ini.

    8. Rename the supplied file uc4.ori.smd to uc4.smd, see Setting Up an SMD File.

    9. Adjust the INI file of the Service Manager Service to your system environment, see Service Manager Service.

      Set the variable:

      10. AIX: export LIBPATH=Path of the system library directory

      Solaris, Linux, zLinux: export LD_LIBRARY_PATH=Path of the system library directory

  2. Start and stop services with the ServiceManager. (Host)

    Start the ServiceManager:

    Important! Start the ServiceManager always as the user (process owner and effective UID) who owns the files (here "AE"). Do not start the ServiceManager as the root user!

    nohup ./ucybsmgr [-iPath and Name of the INI file] Phrase > /dev/null 2>&1 &

    The phrase is a ServiceManager environment.

Next step: