Gather the information listed in the following worksheet before starting the Workflow Engine installation. Use the information in the worksheet when you install Workflow Engine on a separate server from Identity Governance.
Table 8-1 Workflow Engine Installation Worksheet
Item |
Description |
Value |
---|---|---|
Installation location |
Specify the installation path for Workflow Engine. WARNING:Spaces in the path are not supported. The default directory is:
|
|
(Conditional) Identity Reporting Installation Location |
If you are installing Identity Reporting on the same server as Workflow Engine, specify the installation path for Identity Reporting. WARNING:Spaces in the path are not supported. The default directory is:
|
|
Tomcat installation location |
Specify the path to the Apache Tomcat home directory. WARNING:Spaces in the path are not supported. The default location is:
|
|
JRE home folder |
Specify the path to the Zulu JRE directory. The Zulu JRE is installed when you install the Zulu OpenJDK. The installation process uses Java for several processes, such as to run commands and create security stores. WARNING:Spaces in the path are not supported. The default location is:
|
|
Trust store password |
If you have a trust store that contains the certificates for TLS communication, specify that password, otherwise, specify a password that is six characters or longer and has no spaces. The installer creates the trust store for you using this password. |
|
Authentication Service |
Use the following sections to gather information about your OSP deployment or your Access Manager deployment. You must use one of these services to deploy the Workflow Engine. |
|
Access Manager or OSP |
Select the appropriate authentication service for your environment. Depending on your choices, there are different options presented that you must populate with the information for the specific authentication service. The options are OSP or Access Manager. |
|
(Conditional) OSP > Application address |
If you selected Access Manager, skip the sections about OSP. Specify the URL connection information the clients use to access the Workflow Engine. |
|
OSP > Workflow Engine protocol |
Select if you want to use http or https for the Workflow Engine. If you select https, you must have configured Apache Tomcat for TLS/SSL communication. |
|
OSP > Workflow Engine host name |
WARNING:Use the fully qualified domain name (FQDN) rather than localhost or an IP address. In a non-clustered environment, specifies the DNS name of the Workflow Engine server. In a clustered environment, specifies the DNS name of the server that hosts the load balancer or the reverse proxy. |
|
OSP > Workflow Engine port |
Specify the port you want the Workflow Engine server to use for communication with client computers. The default is 8080. To use TLS/SSL, the default is 8443. When installing in a clustered environment or when using a reverse proxy, specify the port of the load balancer or the reverse proxy. |
|
(Conditional) OSP > Connect to an external OSP server |
If you have OSP installed on a separate server from the Workflow Engine, select this option and then define the protocol, host name, and port for the external OSP server. |
|
OSP > OSP authentication server protocol |
If OSP is on a separate server from the Workflow Engine select whether the clients that connect to OSP use http or https. To use https, ensure that you have configured the Apache Tomcat instance on the OSP server to use SSL/TLS. |
|
OSP > OSP authentication server host name |
WARNING:Use the fully qualified domain name (FQDN) rather than localhost or an IP address of the external OSP server. In a non-clustered environment, specifies the DNS name of the OSP server. In a clustered environment, specifies the DNS name of the server that hosts the load balancer or the reverse proxy for OSP. |
|
OSP > OSP authentication server port |
Specify the port that the clients use to access OSP. For http, the default port is 8080. For https, the default port is 8443. |
|
(Conditional) Access Manager > Application address |
If you selected OSP, skip the following sections about Access Manager. |
|
Workflow Engine protocol |
Select if you want to use http or https for the Workflow Engine. |
|
Workflow Engine host name |
WARNING:Use the fully qualified domain name (FQDN) rather than localhost or an IP address of the Apache Tomcat instance for the Workflow Engine. |
|
Workflow Engine port |
Specify the port that the Workflow Engine uses. The default port for http is 8080. The default port for https is 8443. |
|
Access Manager IDP host name |
WARNING:Use the fully qualified domain name (FQDN) rather than localhost or an IP address. Specify the DNS name of the Access Manager identity provider server. |
|
Access Manager IDP port |
Specify the port the Access Manager identity provider uses. The default port is 443. |
|
Access Manager Console host name |
Specify the DNS name of the Access Manager administration console. |
|
Access Manager Console port |
WARNING:Use the fully qualified domain name (FQDN) rather than localhost or an IP address. Specify the port of the Access Manager administration console. The default port is 443. |
|
Identity Governance details |
If you are installing the Workflow Engine after you have installed Identity Governance, you must provide information about the protocol, server, and port for Identity Governance. |
|
Identity Governance protocol |
Provide information about the communication protocol. |
|
Identity Governance server information |
Provide the Identity Governance host name. |
|
Identity Governance port number |
Provide the Identity Governance port information. |
|
Service Password |
This is an OAuth 2.0 password that allows users to single sign-on to the Workflow Engine. Specify this password and remember it for later use. You can change this password after the installation completes through the configuration utilities. |
|
(Conditional) ActiveMQ Details |
|
|
Use ActiveMQ or Do not use ActiveMQ |
Select whether you want to use ActiveMQ to guarantee email delivery. If you select Use ActiveMQ, you must install ActiveMQ on the server where you are installing the Workflow Engine. |
|
ActiveMQ host name |
Specify the DNS name of the server where you have installed ActiveMQ. |
|
ActiveMQ port |
Specify the port that ActiveMQ uses to communicate. The default port is 61616. |
|
(Conditional) Access Manager > Bootstrap Administrator Details |
|
|
Bootstrap admin DN |
Specify the DN of the LDAP bootstrap administrator for Identity Governance. You must have an LDAP bootstrap administrator to integrate with Access Manager. For more information, see Section 4.1.1, Using the Bootstrap Administrator. |
|
Bootstrap admin password |
Specify the password of the LDAP bootstrap administrator account for Identity Governance. |
|
Access Manager admin DN |
Specify the DN of an Access Manager administrator account. |
|
Access Manager admin password |
Specify the password for the Access Manager administrator account. |
|
Database Details |
Collect the following information for the database type that you have selected to use. Ensure that you install the database before starting the Workflow Engine installation. For more information, see Section 5.8, Creating the Databases before Installing Identity Governance. |
|
Database type: |
Select the type of database that you are using.
For a list of the supported database versions, see Section 2.4.2, Database Requirements. |
|
Database Configuration Details |
Select one of the following three options: |
|
Database details > Configure database now |
Select this option to have the installer create and populate the database. You select this option if you are performing an upgrade or a new installation. For more information, see Section 5.4, Using the Identity Governance Installer to Create and Populate the Databases. |
|
Database details > Generate SQL for later |
Select this option to have your database administrator create and populate the database for the Workflow Engine using the SQL scripts generated and stored by the installer in the following default directory for the Workflow Engine:
|
|
Database details > No database configuration |
Select this option to do nothing. You would select this option if you were installing the second node in a cluster. For more information, see Section 2.3.4, Ensuring High Availability or Load Balancing for Identity Governance. |
|
Host |
WARNING:Use the fully qualified domain name (FQDN) rather than localhost or an IP address. Specify the DNS name of the database server. |
|
Port |
Specify the port the database server uses to communicate. The default port is:
|
|
(Conditional) Microsoft SQL Server JDBC JAR |
If you are using the Microsoft SQL Server, specify the path to the Microsoft SQL Server JDBC JAR file. For more information, see Section 5.7, Adding the JDBC File to the Application Server. |
|
(Conditional) Oracle Database Details |
If you are using an Oracle database, gather the following information to complete the Workflow Engine installation. |
|
Oracle JDBC JAR |
Specify the path to the Oracle JDBC JAR file. For more information, see Section 5.7, Adding the JDBC File to the Application Server |
|
Oracle Database name |
Specify the name of the Oracle database where the installer will add the schema for the Workflow Engine. For example, oracleidgov |
|
Oracle User tablespace |
Specify the name of the database storage unit for storing the schema for the Workflow Engine databases. The default is USERS. |
|
Oracle Temporary tablespace |
Specify the name of the temporary database storage unit for storing the schema. The default name is TEMP. |
|
Database credentials |
Specify the credentials for accessing the various databases. |
|
(Conditional) Database Administrator user and password |
Specify the credentials of a database account that can access and modify data in the databases. This account must be able to create databases, tables, views, and other artifacts. You can test the connection to the database. |
|
(Conditional) Identity Reporting database users password |
If you install Identity Reporting with Workflow Engine, specify the name and password of the required database for Identity Reporting. The default database name is igrpt. NOTE:The database password is requested only for Microsoft SQL Server and PostgreSQL. |
|
Workflow Engine database name |
Specify the name of the required database for the Workflow Engine. The default name is igaworkflowdb. |
|
Workflow Engine database user name |
Specify the user name of the Workflow Engine database. The default name is igawfadmin. |
|
Workflow Engine database user’s password |
Specify the password of the Workflow Engine database. |
|
Update or Only use existing |
Applies only when you choose to configure the database during the installation. Select whether the installer creates the database name, creates the schema, creates users, creates roles, assigns permissions to roles, and populates the database with this information. Select this option for new installations or upgrades. Or select to use existing databases with your database name and user. |
|
Operation user database and password |
Specify the name of the operations database and the password for the operations database. The default name is igops. |
|
(Conditional) Different database vendor than Identity Governance |
Select this option if you have a different database type for the Workflow Engine database than what you used for Identity Governance. You can use the same database type for the two components or you can use separate, supported database types. |
|
Database host |
Specify the DNS name of the separate database from the database Identity Governance uses. |
|
Database port |
Specify the port the separate database server uses to communicate. The default port is:
|
|
Database type: |
Select the type of database that you are using:
For a list of the supported database versions, see Section 2.4.2, Database Requirements. |
|
(Conditional) Microsoft SQL Server JDBC JAR |
If you are using Microsoft SQL Server, specify the path to the Microsoft SQL Server JDBC JAR file. For more information, see Section 5.7, Adding the JDBC File to the Application Server. |
|
(Conditional) Oracle Database Details |
If you are using an Oracle database, gather the following information to complete the Workflow Engine installation. |
|
Oracle JDBC JAR |
Specify the path to the Oracle JDBC JAR file. For more information, see Section 5.7, Adding the JDBC File to the Application Server |
|
Oracle Database name |
Specify the name of the Oracle database where you will add the Oracle schema for the Workflow Engine. |
|
(Conditional) Additional Identity Reporting Options Identity Reporting > Target Locale |
If you install Identity Reporting with Workflow Engine, you must select the language Identity Reporting uses to generate the reports. The default is English. |
|
Email Delivery |
Gather the information for the SMTP server that delivers report notifications. |
|
Default email address |
Specify the email address that you want to use as the origin of email notifications. |
|
SMTP Server |
WARNING:Use the fully qualified domain name (FQDN) rather than localhost or an IP address. Specify the DNS name of the SMTP email host that is used for email notifications. |
|
SMTP Server Port |
Specify the port number for the SMTP server. The default value is 465. |
|
(Conditional) Use SSL for SMTP |
Select whether you want to use secure communication with the SMTP server. If you select this option, you must configure your SMTP server for TLS/SSL communication. For more information, see Section 3.8, Securing Connections with TLS/SSL. |
|
(Conditional) Require server authentication |
Select whether you want to use authentication for communication with the SMTP server. If you select this option, you must provide the SMTP server credentials. |
|
SMTP user name and password |
Specify the credentials for a login account to the SMTP server. |
|
(Conditional) Identity Reporting > Keep finished reports for |
If you install Identity Reporting with Workflow Engine, then specify the report retention time and location. For example, to specify retention time of six months, enter 6, then select Month. Identity Reporting retains completed reports for the specified time then deletes them. |
|
(Conditional) Identity Reporting > Location of report definitions |
Specify a path where you want to store the report definitions. The default directory is:
|
|
(Conditional) Auditing Details |
Gather the following information if you want to enable auditing for the Workflow Engine. |
|
Enable auditing |
Select whether you want to enable auditing. |
|
Audit server |
Specify the DNS name of the audit server. |
|
Audit port |
Specify the port the audit server uses to communicate. The default port is 6514. |
|
Audit cache location |
Specify a local directory for caching of audit events before they are sent to the audit server. The default directory is:
|
|
Secure layer |
Select if you are using TLS communication to the audit server. If you are, you can test the connection before you proceed. For more information, see Section 3.8, Securing Connections with TLS/SSL. |
|