Install component integrators

This topic provides instructions and guidelines for installing component integrators. Select your platform to view the details.

For details on how to run component integrators after the installation, see Start and stop a component integrator.

Installation guidelines

When preparing to install a component integrator, take into account:

  • The component integrator installers are available for Windows 64-bit and UNIX/Linux.
  • Component integrators require JRE/JDK 11 or later. Before installing a component integrator, make sure you have a supported version of Java on the target machine.
  • You can install a component integrator by running the command-line installer or using a .properties file for silent installation.

Back to top

Install from command prompt on Windows

Run the Windows command-line installer and provide connection details for the component integrator and the server.

To install a component integrator from a command line:

  1. Download and extract the appropriate installation files from the Software Licensing and Downloads portal (requires login).

  2. As a local system user, run this file:

    install-component-integrator.cmd

  3. Enter the path to the directory where to install the component integrator, or accept the default location:

    C:\Program Files\OpenText\component-integrator

    If the directory doesn't exist, confirm that you want to create it.

  4. Enter the path to the directory where Java 11 is installed. This JRE/JDK will run the component integrator.

    By default, the installer uses the JRE/JDK path defined in the JAVA_HOME system environment variable.

  5. Enter the host name or IP address of the Deployment Automation server to which to connect this component integrator, for example:

    serverName

  6. Enter the port to use for JMS communication with the server. Default JMS port: 7918.

  7. Enter a name for the component integrator.

    Note: If another component integrator with the same name already exists, Deployment Automation adds a numeric suffix to the conflicting name to allow the component integrator to connect. You can then change the name in the user interface.

  8. Enter the component integrator's web URL, for example:

    https://my-ci.example.com

  9. Enter the component integrator's HTTP(S) port. Default HTTP(S) port: 8991.

  10. Specify whether the Deployment Automation server and component integrator use SSL mutual authentication (Y/N). By default, SSL mutual authentication is disabled.

  11. Specify whether you want to install the component integrator as a service (Y/N). To install as a Windows service, you need administrator permissions.

  12. If you selected to install as a Windows service, set the following properties:

    • A unique name for the service. The name cannot contain spaces. Default name: component-integrator.

    • The username, including the domain path, under which to run the service. For local accounts, put .\ before the username. Default: .\localsystem.

    • The password for the user account under which to run the service. Default: nopass.

    • Whether to start the Windows service automatically (Y/N). By default, the service is not set to start automatically.

Back to top

Install in silent mode on Windows

You can install a component integrator in silent mode using a configuration properties file.

To prepare a .properties file, edit the example.install.properties file supplied in the installation bundle.

Note: To specify file paths in a .properties file, use a forward slash (/) or two backslashes (\\) as a filename separator, for example: file.path=C:\\Program Files\\Java

To install a component integrator in silent mode:

  1. Download and extract the component integrator installation files for your platform from the Software Licensing and Downloads portal (requires login).
  2. In the directory with the installation files, open the example.install.properties file in a text editor.

  3. Edit the following properties:

    Property Description
    component-integrator/java.home

    Enter the path to the directory where Java 11 is installed. This JRE/JDK will run the component integrator.

    By default, the installer uses the JRE/JDK path defined in the JAVA_HOME system environment variable.
    locked/component-integrator.home

    Enter the path to the directory where to install the component integrator.

    If the directory doesn't exist, specify one to create, for example:

    D:\\Component-Integrator

    locked/component-integrator.name

    Enter a name for the component integrator.

    Default name: component-integrator

    Note: If another component integrator with the same name already exists, Deployment Automation adds a numeric suffix to the conflicting name to allow the component integrator to connect. You can then change the name in the user interface.
    locked/component-integrator.external.url

    Enter the component integrator's web URL, for example:

    https://my-ci.example.com

    locked/component-integrator.http.server.port

    Enter the component integrator's HTTP(S) port.

    Default HTTP(S) port: 8991
    locked/component-integrator.jms.remote.host

    Enter the host name or IP address of the Deployment Automation server to which to connect the component integrator, for example:

    serverName

    locked/component-integrator.jms.remote.port

    Enter the port to use for JMS communication with the server.

    Default JMS port: 7918
    locked/component-integrator.ssl.enabled.protocols

    By default, Deployment Automation allows the use of TLSv1.2, TLSv1.1, and TLSv1 protocols.

    To improve security, you can change the defaults to allow TLSv1.3 and TLSv1.2 only:

    TLSv1.3,TLSv1.2

    Note: All your system components must use the same protocols.
    locked/component-integrator.ssl.enabled.ciphers

    By default, Deployment Automation supports all SSL ciphers.

    To enable only specific ciphers, enter a comma-separated list of ciphers.
    locked/component-integrator.mutual_auth

    Specify whether the Deployment Automation server and component integrator use SSL mutual authentication (Y/N).

    By default, SSL mutual authentication is disabled.
    locked/component.integrator.service

    Specify whether to install the component integrator as a Windows service (Y/N).

  4. If you selected to install as a Windows service, set the following properties:

    Property Description
    locked/component.integrator.service.name

    Enter a unique name for the service. The name cannot contain spaces.

    Default: component-integrator
    locked/component.integrator.service.login

    Enter the username, including the domain path, under which to run the service.

    For local accounts, put .\ before the username.

    Default: .\localsystem
    locked/component.integrator.service.password

    Enter the password for the user account under which to run the service.

    Default: nopass
    locked/component.integrator.service.autostart

    Specify whether to start the Windows service automatically (Y/N).

    By default, the service is not set to start automatically.
  5. Save the .properties file.

  6. As a local system user, run:

    Copy code 
    install-component-integrator-from-file.cmd example.install.properties 

    Use the name of your .properties file instead of example.install.properties.

Back to top

Uninstall component integrators

To uninstall a component integrator, manually delete the installed files and folders.

If installed as a Windows service, first delete the service by running this command as a local system user:

Copy code 
sc delete <component-integrator-service-name> 

Back to top

Installation guidelines

When preparing to install a component integrator, take into account:

  • The component integrator installers are available for Windows 64-bit and UNIX/Linux.
  • Component integrators require JRE/JDK 11 or later. Before installing a component integrator, make sure you have a supported version of Java on the target machine.
  • You can install a component integrator by running the command-line installer or using a .properties file for silent installation.

Back to top

Install from command prompt on UNIX/Linux

Run the UNIX/Linux command-line installer and provide connection details for the component integrator and the server.

To install a component integrator from a command line:

  1. Download and extract the appropriate installation files from the Software Licensing and Downloads portal (requires login).

  2. As a user with full access rights to the installation location, run:

    install-component-integrator.sh

  3. Enter the path to the directory where to install the component integrator, or accept the default location:

    /opt/OpenText/component-integrator

    If the directory doesn't exist, confirm that you want to create it.

  4. Enter the path to the directory where Java 11 is installed. This JRE/JDK will run the component integrator.

    By default, the installer uses the JRE/JDK path defined in the JAVA_HOME system environment variable.

  5. Enter the host name or IP address of the Deployment Automation server to which to connect this component integrator, for example:

    serverName

  6. Enter the port to use for JMS communication with the server. Default JMS port: 7918.

  7. Enter a name for the component integrator.

    Note: If another component integrator with the same name already exists, Deployment Automation adds a numeric suffix to the conflicting name to allow the component integrator to connect. You can then change the name in the user interface.

  8. Enter the component integrator's web URL, for example:

    https://my-ci.example.com

  9. Enter the component integrator's HTTP(S) port. Default HTTP(S) port: 8991.

  10. Specify whether the Deployment Automation server and component integrator use SSL mutual authentication (Y/N). By default, SSL mutual authentication is disabled.

  11. Enter the UNIX/Linux username under which to run the component integrator.

  12. Enter the UNIX/Linux group name under which to run the component integrator.

Back to top

Install in silent mode on UNIX/Linux

You can install a component integrator in silent mode using a file with configuration properties.

To prepare a .properties file, edit the example.install.properties file supplied in the installation bundle.

To install a component integrator in silent mode:

  1. Download and extract the component integrator installation files for your platform from the Software Licensing and Downloads portal (requires login).
  2. In the directory with the installation files, open the example.install.properties file in a text editor.

  3. Edit the following properties, and save the file:

    Property Description
    component-integrator/java.home

    Enter the path to the directory where Java 11 is installed. This JRE/JDK will run the component integrator.

    By default, the installer uses the JRE/JDK path defined in the JAVA_HOME system environment variable.
    locked/component-integrator.home

    Enter the path to the directory where to install the component integrator.

    If the directory doesn't exist, specify one to create, for example:

    /opt/OpenText/component-integrator

    locked/component-integrator.name

    Enter a name for the component integrator.

    Default name: component-integrator

    Note: If another component integrator with the same name already exists, Deployment Automation adds a numeric suffix to the conflicting name to allow the component integrator to connect. You can then change the name in the user interface.
    locked/component-integrator.external.url

    Enter the component integrator's web URL, for example:

    https://my-ci.example.com

    locked/component-integrator.http.server.port

    Enter the component integrator's HTTP(S) port.

    Default HTTP(S) port: 8991
    locked/component-integrator.jms.remote.host

    Enter the host name or IP address of the Deployment Automation server to which to connect the component integrator, for example:

    serverName

    locked/component-integrator.jms.remote.port

    Enter the port to use for JMS communication with the server.

    Default JMS port: 7918
    locked/component-integrator.ssl.enabled.protocols

    By default, Deployment Automation allows the use of TLSv1.2, TLSv1.1, and TLSv1 protocols.

    To improve security, you can change the defaults to allow TLSv1.3 and TLSv1.2 only:

    TLSv1.3,TLSv1.2

    Note: All your system components must use the same protocols.
    locked/component-integrator.ssl.enabled.ciphers

    By default, Deployment Automation supports all SSL ciphers.

    To enable only specific ciphers, enter a comma-separated list of ciphers.
    locked/component-integrator.mutual_auth

    Specify whether the Deployment Automation server and component integrator use SSL mutual authentication (Y/N).

    By default, SSL mutual authentication is disabled.
    owner.user Enter the UNIX/Linux username under which to run the component integrator.
    owner.group Enter the UNIX/Linux group name under which to run the component integrator.

  4. Save the .properties file.

  5. As a user with full access rights to the installation location, run:

    Copy code 
    install-component-integrator-from-file.sh example.install.properties 

    Use the name of your .properties file instead of example.install.properties.

Back to top

Uninstall component integrators

To uninstall a component integrator, manually delete the installed files and folders. You need full access rights to the installation location.

Back to top

See also: