Installing the TIBCO iProcess® Web Services Server Plug-in

This section describes how to install the TIBCO iProcess® Web Services Server Plug-in.

Task A - Start the Installation Procedure

To install the TIBCO iProcess® Web Services Server Plug-in:

1.

Log in to the system on which you want to install TIBCO iProcess® Web Services Server Plug-in (for more information, see About the Installer Account).

2.

Run the TIBCO iProcess® Web Services Server Plug-in setup program. Use the following table to see the command to run for your platform:

Platform	Setup Program	Run this command
Windows		setupwin64.exe –is:javahome java_path
Linux	setupLinux.bin	setupLinux.bin –is:javahome java_path For example: setupLinux.bin –is:javahome /usr/java/jdk-11

These are referred to as the setup program in this procedure.

3.

If you’re installing from:

—

physical media: Run the setup program from the root directory.

—

a network server: Ask your network administrator for the location of the setup program and run it from there.

Note

The setup program checks for a suitable JVM on your machine before installation can begin. If the installer does not find a suitable JVM, it allows you to browse for one. If you have not installed a JVM, an error message is displayed. Refer to System Requirements for details about the version of JVM you require.

Task B - Complete the Preliminary Details

1. Review the information in the Welcome dialog and click Next.

2. The License Agreement dialog is displayed.

—

Review the terms of the license agreement and, if you agree to them, click I accept the terms of the license agreement to continue with the installation and click Next.

—

If you do not agree to the terms of the license agreement, click I do not accept the terms of the license agreement and exit from the installation process.

Task C - Specify the Installation Details

1. The Configure Destination dialog is displayed. Specify the Directory Name where you want to install the TIBCO iProcess® Web Services Server Plug-in. Either enter the path directly or use the Browse button.

Click Next to continue.

2. The Configure Installation Type dialog box is displayed. Choose one of the following:

—

Full: This is recommended for most users as this installs all system features. If you choose Full, click Next and go to Task D - Specify TIBCO iProcess® Engine/High Availability Details.

—

JMX Container (only): This enables you to install the JMX Container only. This is useful if you want your JMX Container to be installed on a different machine from your iProcess® Engine or you want to install multiple instances of the JMX Container to create a high availability configuration. If you choose JMX Container, click Next and go to Task E - Specify the Database Connection Details.

—

IPE Interface (only): This enables you to install the iProcess® Engine Interface only. The iProcess® Engine Interface must be installed on the same machine as your iProcess® Engine. If you choose IPE Interface, click Next and go to Task D - Specify TIBCO iProcess® Engine/High Availability Details.

—

Custom: This enables you to choose what product features to install. This is intended only for advanced users and should only be used if you have been instructed to do so by TIBCO Technical Support. If you choose Custom, click Next and go to (Optional, if a Custom install was selected) The Select Features dialog is displayed. This dialog enables you to select which product features you want to install. You can select:.

3. (Optional, if a Custom install was selected) The Select Features dialog is displayed. This dialog enables you to select which product features you want to install. You can select:

—

JMX Container. The server engine that holds the Web Services Java components.

Inbound. This component enables inbound calls to the iProcess Web Services Plug-in from external applications, using SOAP or XML text.

Outbound. This component enables the iProcess Web Services Plug-in to send outbound calls to external applications. This can be over HTTP or JMS.

—

IPE Interface. This component enables the iProcess Background process to communicate with the JMX Container.

a.

Click Next to continue.

b.

If you chose JMX Container (only), go to Task E - Specify the Database Connection Details.

c.

If you chose iPE Interface, go to Task D - Specify TIBCO iProcess® Engine/High Availability Details.

Task D - Specify TIBCO iProcess® Engine/High Availability Details

1. The Configure iPE Server Information dialog is displayed. Specify the iPE Server Location. The drop-down list displays the iProcess Engine nodes detected on the system. Either select a node, or select Alternate location from the list and click Browse to set the location. You must select a directory where you have already installed the iProcess® Engine (SWDIR) and the installer displays an error message if the directory you specify does not contain an iProcess® Engine installation.

2. By default the system is configured to connect to the localhost on port 10000. If you are using a Jetty server that is not on your local machine, or if you need to configure several Jetty servers for a High Availability environment, do the following:

—

If you want to use the High Availability feature of the TIBCO iProcess® Web Services Server Plug-in, select the Configure iPE Component... check box. Then enter a new Host for Socket Proxy and Port for Socket Proxy for a Jetty Server that you want to use in your high-availability configuration and click Add Server. Do this for each host that you want to configure. If necessary, click Delete Server to remove a server from the list.

—

If you are not using High Availability, but have a non-local Jetty server, click Delete Server to remove the entry for localhost. Then, enter a new Host for Socket Proxy and Port for Socket Proxy for the Jetty Server that you want to use.

When you have finished configuring the iProcess interface, click Next. If you are performing an iPE Interface (only) installation, click Next and continue with Task I - Complete the Installation.

Task E - Specify the Database Connection Details

1. The Configure Database Provider dialog is displayed. Select the Database Type (either SQL, Oracle, or DB2).

Once you have selected the database type, the JDBC Driver Class field is automatically completed with the driver class for the JDBC driver you are using. To modify this, click Override and type in a new driver class. This should be modified only if you are told to do so by TIBCO Support.

2. Browse to the directory where the Jar files are located by clicking Browse from the Specify JDBC Driver Directory field. This directory must include both the Java 11 compliant libraries. Click Next.

3. The Configure the Database Connection dialog box is displayed. Enter the Database Details:

—

In the DB Host box, enter the IP address or machine name of the system that is hosting the database you are connecting to. For example, 10.10.41.28.

—

In the DB Port box, enter the port number for the database.

—

Optional - (this is not necessary if you have the default database set up correctly) In the DB Name box (DB2 & SQL), enter the database name you want to connect to. For Oracle, in the Instance box enter the name of the instance you want to connect to.

—

In the Audit User ID box, enter the user name that you want recorded in the log file for Web Services database actions (by default, this is swadmin).

—

In the User ID box, enter the iProcess database username. By default, this is swpro.

—

In the Password box, enter the password for the iProcess database username.

—

If the schema owner is different than the iProcess database username, select the Override check box, and enter the Schema Owner and Password.

—

The installation procedure constructs the JDBC Connection URL and displays it. To specify a different value, select the Override check box and modify the URL as necessary.

Click Next to test the database connection details that you entered. You can only do this if your database is currently running, and you cannot proceed past this point in the installation without entering valid database configuration details.

Task F - Configure the Server

1. The Configure Server (1) dialog is displayed. This dialog allows you to configure Java and web services security:

—

The installation procedure detects the location of the Java executable on your system. However, you can click browse to manually select a different location.

—

If you are using SOAP security, you must enter the keystore location and keystore password of keystores that you created as a pre-installation task. Browse to select the keystore location for SOAP security, and enter the password that will be used to access the keystore.

—

If you are using SSL security, you must enter the keystore location and keystore password of the keystore that you will use for Jetty HTTPS connections. Browse to select the keystore location, and enter the password that will be used to access the keystore.

Note	The keystores that you specify are standard Java keystores (with the file extension .jks) The keystore for SSL encryption requires only one entry, and the alias must be jetty.

Click Next.

2. The Configure Server (2) dialog is displayed. The details on this dialog enable you to configure the following:

—

JMX Console - Defines the port to use for the JMX Console

—

HTTP Admin - Defines the port to use for the Admin tool

—

RMI Connector - Defines the port to use for the management of URL Aliases and Security Profiles

—

Socket Proxy - Defines the port that the TIBCO iProcess® Web Services Server Plug-in uses to communicate with the iProcess Engine.

—

HTTP Server - Defines the port to use for the Jetty web server if you are not using SSL encryption

—

HTTPS Server - Defines the port to use for the Jetty web server if you are using SSL encryption. If you select this option, also specify the Alias Password associated with the SSL certificate that you are planning to use for encryption.

Note

Generate the certificate using your preferred tool. The Java Development Kit (JDK) provides a tool for this purpose called keytool located in the JAVA_HOME/bin directory of the JDK. For more information, for Java 11, see https://docs.oracle.com/en/java/javase/11/security/java-security-overview1.html

—

If you use a Proxy server to connect to the Internet for HTTP requests, you need to specify the Proxy server details so that Internet connections can be made. To specify your Proxy server details, select the Enable HTTP Proxy box and enter the Proxy Host and Proxy Port.

You can manually configure the HTTP Proxy settings any time after running the installer as described in TIBCO iProcess Web Services Plug-in User Guide.

—

JMS Queue Name for Proxy (out) - Not applicable in this release. Reserved for future use.

—

Delayed Release Audit Message - The message you want to display in the audit trail when a delayed release occurs. See the TIBCO iProcess Workspace (Windows) User Guide for more information about case administration.

Click Next.

Task G - Configure JMS Queue Aliases

1. The Configure JMS Aliases dialog box is displayed:

Configure the JMS Queue Aliases that you are going to use as follows. The actual queues must already be set up on your system.

2. Enter the Queue Alias that you want to create.

3. Enter the JNDI Queue Name.

4. Enter an identifier for the JMS Provider. In the next dialog, any identifiers you entered as a JMS Provider will be configured against a provider type (either EMS, WebSphere, WebLogic, or JBOSS).

5. You can designate an alias to use for inbound web services by selecting the Use this alias for Inbound Web Services check box. Selecting this check box also allows you to specify that the alias is for a Topic rather than a Queue as the Topic radio button is enabled.

6. Click Add Alias to add the alias you have configured, or if you are editing an existing alias, click Modify Alias to make any changes. You can also click Delete Alias to remove an alias (unless it is an alias that is used internally).

When you are done configuring Aliases, click Next.

Task H - Configure the JMS Provider

1. The Configure JMS Providers dialog is displayed. Select a JMS Provider to configure. These are listed in the Select Provider to Configure drop-down list, which is populated with the Providers you specified in the previous dialog.

2. Select the corresponding Provider Type.

Note: The default values on this dialog box change according to the Provider Type you select.

3. Specify JAR files that you want to add to the classpath using one of the following methods:

   Note: For EMS, specify both the tibjms.jar and the tibjmsadmin.jar files which can be located in the EMS installation. The tibjmsadmin.jar file is necessary to interrogate and configure EMS destinations as appropriate.

   •

   Click Browse, locate a specific JAR file and click Add Jar.

   •

   Specify a directory and click Add all Jars in this directory.

   The Current Provider Classpath is displayed and you can delete this by clicking Delete Classpath Entry.

4. Configure the Provider details as follows:

   •

   Enter the JNDI username and password that is required for the JMS provider you have chosen.

   Note: If authentication is enabled, the username and password of the user you have specified must have permission to publish and subscribe to the JMS topic called topic.IPE.

   •

   Context URL - The URL should be a JNDI URL such as tcp://localhost:7222.

   •

   Context Factory - Each JMS jar file contains a class name appropriate to the JMS Connection Factory that is provided by the third-party provider. Connection factories are objects that enable JMS clients to create JMS connections. Select the Factory Class for your JMS provider.

   •

   Extra Environments - If you selected WebSphere as a Provider Type, this field displays the additional configuration information necessary to obtain an initial context. For other provider types, you can use this field to specify any additional details required to establish an initial context. For more information, see the documentation for your JMS provider.

5. Ensure your JMS provider is running, and click Next. If you are using EMS, the required queues can be created automatically if they do not already exist. If you entered any queue information incorrectly, an error message will be displayed. The JMS configuration details you entered are used to test if your JMS connection works. The result is displayed in the dialog. If the test fails, a dialog is displayed listing the providers that have not been successfully tested, and prompting to confirm whether to proceed. Please see JMS Connection Test Returns Fail for help.

Task I - Complete the Installation

1. The Install Summary dialog box is displayed. Review the information and if it is correct, click Install to install the files. If you need to change something, use the Back button to go back.

2. Click Install to continue.

The Installing Files dialog box is displayed as the files are copied to your computer.

The Post-Install Summary dialog box is displayed.

3. Click Finish to complete the installation.

The TIBCO iProcess® Web Services Server Plug-in is now installed.