Installing and configuring Workflow Server with an SQL Server database server

Workflow Server provides one business process management runtime environment that can support a range of business processes for development, test, staging, or production.

Before you begin

You must create custom directories for your SQL Server Java Database Connectivity (JDBC) driver. On the Business Automation Workflow deployment manager and every managed node machine, create a custom directory for your JDBC driver and copy the required JDBC JAR file into it. For example, you could create the following custom directory for your JDBC driver:
install_root/sqljdbc

To install IBM® Business Automation Workflow using the typical installation option, you must confirm that the Process database, Performance Data Warehouse database, Common database, and Content database exist and are empty.

Be prepared to specify the following information during installation:
  • The user name and password for database authentication
  • The database server host name and port
  • The name of the Common database
  • The name of the Process database
  • The name of the Performance Data Warehouse database
  • The name of the cell-only configuration database (for IBM Business Automation Workflow Enterprise)
  • The name of the Content database
If you are installing from downloaded images from Passport Advantage, ensure that you downloaded all required images (three disk images for Linux systems on Intel; two disk images for other Linux systems). If you are installing from the DVD images, obtain the compressed files from the DVDs. In both cases, extract all of the files from the compressed files to the same location on your hard disk.
Restrictions:
  • Extract the installation files to a directory that does not contain spaces or special characters. The launchpad cannot be started from a directory path that contains spaces or special characters.
  • Linux on Power LE does not support typical installation.

About this task

From the product launchpad, the typical installation process installs the software, configures the deployment manager and managed-node profiles, and configures a single-cluster deployment environment that consists of one node and one server. It also installs IBM WebSphere SDK Java Technology Edition 8 (Java 8).

Only one IBM Installation Manager is required to install multiple instances of IBM Business Automation Workflow.

Procedure

  1. Optional: If you are connected to the Internet, the typical installation process automatically upgrades your product to the latest fix pack or refresh pack level and recommended interim fixes. If you want these upgrades to be installed from a local directory instead, or if you want to specify the fix level, you can modify a properties file to direct Installation Manager to the upgrades to install.
    Create the following file:
    • /user_home_directory/bpm_updates.properties
    Note: Ensure that you have read/write access to the folders that are specified in the bpm_updates.properties file.
    The file uses three prefixes: ifix, fixpack, and launchpad. Each prefix must be followed by a period. The name after the prefix and the period can be anything you want, which enables you to point to multiple locations for interim fixes, fix packs, and launchpad upgrades. The locations can be either local directories or URLs. The following code is an example of the prefixes and names in the properties file:
    ifix.1=/bpmUpdates
    fixpack.2=http://test/rep
    launchpad.1=/launchpad_updates
    fixpack.WAS_REP=/WAS_updates
    fixpack.BPM_REP=/BPM_updates
  2. Run launchpad.sh, which is in the root directory of the extracted files.
    You can run only one launchpad at a time.
  3. Optional: If you are prompted to update the launchpad, click Update. The updates are installed and your launchpad is restarted automatically.
    If you do not have access to the Internet and want the updates to be installed from a local directory, you can modify a properties file with the appropriate launchpad prefix as described in step 1 to direct Installation Manager to the updates to install.
  4. On the Welcome page, click Typical installation.
  5. Select Install Workflow Server and click Next.
  6. Specify Workflow Server information:
    • Host name: This field shows the name of your machine.
      Important: To use an external Content Platform Engine, the host name must have a domain name suffix, for example MyDmgrHost.ibm.com.
    • Location: Enter the installation location for Workflow Server or click Browse to select the location.
      Notes:
      • The installation location must either be an empty directory or a directory that does not exist and is created during installation.
      • The installation location cannot contain National Language Strings (NLS).
    • Environment Type: Select how the Workflow Server is used. If you have a Workflow Server Production License, set the type to Production. If you have a Workflow Server non-Production License, choose any of the other types.
      • Select Development if the server is to be used in a development capacity.
      • Select Staging if the server is to be used as a temporary location to host changes before putting them into production.
      • Select Test if the server is to be used as a testing environment, for example, for load testing.
      • Select Production if the server is to be used in a production capacity.
    • Name: Specify the name for the Workflow Server environment. This name is used to connect from a Workflow Center to this Workflow Server.
      Restriction: Do not mix production and non-production servers in the same cell.
    • Specify the User name and Password for the cell administrative account. The cell administrator is the primary WebSphere® Application Server administrator. A user who is assigned to this role can assign other administrator roles, and is responsible for the administration of the cell and topology. A user who is assigned to this role is not responsible for the administration of the IBM Business Automation Workflow to alter or delete all types of available library items and assets, including process applications and toolkits. The user in this role also administers Workflow Servers, Performance Data Warehouses, and internal users and groups. You must be a user assigned to this role to deploy process applications on the Workflow Center server.
    • Specify the User name and Password for the deployment environment account. The deployment environment administrator is the primary IBM Business Automation Workflow administrator. A user who is assigned to this role has administrative access to Process Center and Process Admin Console. Having this role provides access to all interfaces, enabling users to alter or delete all types of available library items and assets, including process applications and toolkits. The user who has this role also administers process servers, Performance Data Warehouses, and internal users and groups.
    Select Use this server offline if this Workflow Server will not be connected to a Workflow Center. Offline servers can still be used when deploying snapshots of process applications, but the method for deploying process applications to an offline process server differs from the method for deploying process applications to an online Workflow Server.
    If you did not select Use this server offline, provide the following information for the Workflow Center that this server should connect to:
    • Host name: Enter the host or virtual host that this Workflow Server will use to communicate with Workflow Center. Use a fully qualified host name. In an environment with a load balancer or proxy server between the Workflow Server and the Workflow Center services, make sure that what you designate here matches the URL that is used to access the Workflow Center.
    • Port: Enter the secure port number of the Workflow Center. In an environment with a load balancer or proxy server between the Workflow Server and the Workflow Center, make sure that what you designate here matches the URL that is used to access the Workflow Center. The installation process will import security certificates, and the two components will use an SSL connection to communicate with each other.
    • User name: Enter the name of a Workflow Center user. Workflow Server will connect to Workflow Center as this user. If you specify a user name that does not have authority to update the SSL truststore, the installation will succeed but the SSL certificates will not be imported, and you must configure the connection manually. See the related topic link for instructions.
    • Password: Enter the password for the Workflow Center user.
    To check the connection to the Workflow Center, click Test Connection. The connection attempt can fail if the user name and password combination is wrong, or if a custom context root has been set for the Workflow Center. If the custom context root has been set, you must use a custom install path instead of typical.
  7. Specify the User name and Password for the cell administrative account.
    The cell administrator is the primary WebSphere Application Server administrator. A user who is assigned to this role can assign other administrator roles, and is responsible for the administration of the cell and topology. A user who is assigned to this role is not responsible for the administration of the IBM Business Automation Workflow components. This role provides access to all interfaces, enabling users to alter or delete all types of available library items and assets, including process applications and toolkits. The user in this role also administers process servers, Performance Data Warehouses, and internal users and groups. You must be a user assigned to this role to deploy process applications on the Workflow Center server.
  8. Click Next.
  9. Select Yes to use an existing database.
  10. Specify the required database information.
    Table 1. Required database configuration fields for SQL Server
    Field Action needed
    User name

    Required only if you are not using Windows authentication.

    Enter the user name to authenticate with the database.
    Restriction: User names must not contain National Language Strings (NLS).
    Password

    Required only if you are not using Windows authentication.

    Enter a password to authenticate with the database.

    Select the Apply Windows authentication option to indicate that you will connect to your databases using your Windows authentication information. If you select this option, the previous fields become inactive.
    Host name Accept the default value of localhost or enter the correct database server host name, for example, the IP address.
    Port Accept the default value of 1433 or enter the correct server port number.
    Common database name Accept the default value of CMNDB, or enter the name for the Common database.
    Process database name Accept the default value of BPMDB, or enter the Process database name.
    Performance Data Warehouse database name Accept the default value of PDWDB, or enter the Performance Data Warehouse database name.
    Cell-only configuration database Accept the default value of CMNDB, or enter the name for the cell-scoped Common database. This database is applicable only when there is an Advanced deployment environment or AdvancedOnly deployment environment.
    Content database Accept the default value of CPEDB, or enter the name for the Content database.

    For SQL Server databases, Test Database Connection always succeeds, even if the connections to the databases are not successful. Click Next to proceed.

  11. Specify the JDBC driver path where the Java Database Connectivity (JDBC) drivers for your database are installed.
  12. Click Next to continue. For versions before V18.0.0.2, make sure that you include the required fix PI73197: Enable Java 8 Support for EJBDeploy on WebSphere Application Server. You are prompted to provide your IBMid and password to connect to the IBM service repositories. IBM Business Automation Workflow V
18.0.0.2The fix is included with WebSphere Application Server 8.5.5.14 and later.
    Note: If you are using a local properties file, you do not need to provide your IBMid and password.

    A connection to the service repositories is required to download and install fix packs and required interim fixes from the Internet, including fixes for WebSphere Application Server and IBM Business Automation Workflow. You can obtain an IBMid and password by registering at http://www.ibm.com.

    To continue installing without downloading the required fixes, click Cancel or clear the Use your support account to include updates with the installation option on the Installation summary page.

    After successfully installing the product, you can use Installation Manager to install the required fixes.

  13. On the Installation summary page, verify that the installation options and read the license agreements. If you agree to the terms of the license agreements, click I have read and accepted the license agreement and notices.
  14. Click Install Software.

Results

After a successful installation, the Quick Start console starts automatically. If the security certificates failed to import for the connection between Workflow Center and Workflow Server, you must configure the SSL communication manually.

What to do next

To learn about security for the environment and applications, see Creating a secure environment.

After the server is started, if you want to use the case management features, see the topic Configuring your system for case management.