Oracle® Retail Bulk Data Integration Installation Guide Release 16.0.027 E94814-01 |
|
Previous |
Next |
The Process Flow application has the same tech stack requirements mentioned in the beginning of this document for JDK, WebLogic domain, and database. Before installing the Process Flow application install the following infrastructure components for the application.
A WebLogic domain with JRF for the application
A database schema for the Process Flow application
The recommended java VM memory setting for the Process Flow application domain is:
-Xms1024m -Xmx2048m
Perform the following procedure to install the Process Flow application:
Download the process flow archive BdiProcessFlow16.0.027ForAll16.x.xApps_eng_ga.zip
Unzip the downloaded archive. The Process Home directory will be created under the current directory.
unzip BdiProcessFlow16.0.027ForAll16.x.xApps_eng_ga.zip
This command extracts the archive. The relevant directories for the installation are shown below (There are more directories than what is shown).
Modify process flow configuration file(conf/bdi-process-flow-admin-deployment-env-info.json) to match the deployment environment. While you can change many values to match your requirements, here is a table of a minimum set of configuration values that you need to modify for process flow application.
Note: The alias names in the configuration files should not be changed. |
Configuration Field | Description |
---|---|
ProcessFlowAdminDataSource ->jdbcUrl |
JDBC URL for the process flow schema. Change this value to match the environment |
ProcessFlowAdminAppServer ->weblogicDomainName |
Name of the WebLogic domain where the process flow application is deployed |
ProcessFlowAdminAppServer ->weblogicDomainHome |
WebLogic Domain home directory |
ProcessFlowAdminAppServer- > weblogicDomainProtocol |
WebLogic admin server protocol is by default t3, if SSL configured then update to t3s. |
ProcessFlowAdminAppServer ->weblogicDomainAdminServerUrl |
WebLogic Admin server URL |
ProcessFlowAdminAppServer ->weblogicDomainAdminServerHost |
Host name of WebLogic Admin Server |
ProcessFlowAdminAppServer ->weblogicDomainAdminServerPort |
WebLogic admin server port |
ProcessFlowAdminAppServer ->weblogicDomainTargetManagedServerName |
Managed Server name where Process Flow is hosted |
ProcessFlowAdminAppServer ->processFlowAdminUiUrl |
Process Flow admin app URL. Update only the host and port |
RmsJobAdminAppServer-->jobAdminUiUrl |
BDI RMS job admin URL |
SimJobAdminAppServer-->jobAdminUiUrl |
BDI SIM job admin URL |
RxmJobAdminAppServer-->jobAdminUiUrl |
BDI RXM job admin URL |
ReimJobAdminAppServer-> jobAdminUiUrl |
BDI REIM job admin URL |
RfiJobAdminAppServer-> jobAdminUiUrl |
BDI RFI job admin URL |
RmsAppJobAdminAppServer -> jobAdminUiUrl |
RMSAPP job admin URL |
RxmAppJobAdminAppServer -> jobAdminUiUrl |
RXMAPP job admin URL |
SimAppJobAdminAppServer -> jobAdminUiUrl |
SIMAPP job admin URL |
ReimAppJobAdminAppServer-> jobAdminUiUrl |
REIMAPP job admin URL |
RfiAppJobAdminAppServer-> jobAdminUiUrl |
RFIAPP job admin URL |
SystemOptions |
Optional. Allows users to provide system options as name value pairs. |
Optional – Users can configure system options in the deployment env info json file. Users have to add the system options as part of the configuration in the json file with name value pairs. After the application starts, the system option tables should have a=b and c=d values in system options table. After the deploying process, verify that values are getting added to the system option table properly.
Example:
ProcessFlow JSON Snippet:
"ProcessFlowAdminApplication":{ "ProcessFlowAdminAppUses":[ "ProcessFlowAdminDataSource", "ProcessFlowAdminAppServer", { "RemoteJobAdminAppServers":[ "RmsJobAdminAppServer" ] } ], "SystemOptions":[ {"name":"a", "value":"b"}, {"name":"c", "value":"d"} ] }
Determine which flows are in scope for your deployment. Copy the flows from bdi-process-home/setup-data/dsl/available_process_flow_options to bdi-process-home/setup-data/dsl/flows-in-scope.
For example, for integration between only RMS and RXM, the rms_rxm-no_split_flows files would be copied:
cp bdi-process-home/setup-data/dsl/available_process_flow_options/rms_rxm-no-split-flows/* bdi-process-home/setup-data/dsl/flows-in-scope/.
If you are migrating from previous version to a new version, run the migration script provided in "setup-data/ddl/migration" folder. For example, the script "migrate-schema-from-16.0.025-to-16.0.027.sql" is provided to migrate database Schema from 16.0.025 to 16.0.027. For migrating from older version, the user needs to run the migration scripts incrementally.
Run the deployer. Make sure that the WebLogic server is running before issuing the following command.
cd bin bdi-process-flow-admin-deployer.sh -setup-credentials -deploy-process-flow-admin-app
The process flow deployer will prompt for username and password for the following credential aliases:
Alias | Description |
---|---|
bdiAppServerAdminServerUserAlias |
WebLogic admin server credentials |
processFlowAdminBaseUrlUserAlias |
Credentials for Admin Role user for Process Flow Admin app |
processFlowOperatorBaseUrlUserAlias |
Credentials for Operator Role user for Process Flow Admin app |
processFlowMonitorBaseUrlUserAlias |
Credentials for Monitor Role user for Process Flow Admin app |
bdiProcessFlowAdminDataSourceUserAlias |
Credentials for the Data Source of the Process Flow Schema |
rmsJobAdminBaseUrlUserAlias |
BDI RMS job admin app credentials |
rxmJobAdminBaseUrlUserAlias |
BDI RXM job admin app credentials |
simJobAdminBaseUrlUserAlias |
BDI SIM job admin app credentials |
reimJobAdminBaseUrlUserAlias |
BDI REIM job admin app credentials |
rfiJobAdminBaseUrlUserAlias |
BDI RFI job admin app credentials |
rmsappJobAdminBaseUrlUserAlias |
RMS APP job admin credentials |
rxmappJobAdminBaseUrlUserAlias |
RXM APP job admin credentials |
simappJobAdminBaseUrlUserAlias |
SIM APP job admin credentials |
reimappJobAdminBaseUrlUserAlias |
REIMAPP job admin credentials |
rfiappJobAdminBaseUrlUserAlias |
RFIAPP job admin credentials |
Note: If you have already configured various credentials required for process flow, you can run the deployer with the following syntax. It will not ask the credentials again for the deployment.bdi-process-flow-admin-deployer.sh -use-existing-credentials -deploy-process-flow-admin-app |
Make sure the deployment step shows deployment success message at the end.
Restrict access to the bdi-process-home folder:
cd bdi-process-home chmod -R 700 .
If the process flow app is successfully deployed, you should be able to access the application at the URL http://<host>:<port>/bdi-process-flow/. The following is a sample screenshot of the process flow application. Make sure all the tabs of the application are properly displayed.
See the Oracle Retail Bulk Data Integration Implementation Guide for the operation details of the Process Flow application.
Process Flow can send email alerts upon success or failure of process executions as specified in the process definitions. The following configuration is required for process email notification.
Mail Session configuration in WebLogic, for process email notification:
Go to the WebLogic Admin console of the environment where the process app is deployed.
Navigate to Services -> Mail Sessions.
Select New to create a new mail session.
Enter the following details:
Name: BdiProcessMailSession
JNDI name: mail/BdiProcessMailSession
Session Username: A valid email id, preferably email-id of an administrator.
Session password: The password for the above email id.
Enter the following in the JavaMail properties:
mail.smtp.ssl.enable=true
mail.smtp.auth=true
mail.smtp.ssl.trust=<company's smtp mail server host name>
mail.smtp.port=<mail server smtps port, typically is 465>
mail.transport.protocol=smtps
mail.smtp.host=<company's smtp mail server host name>
mail.from=<A valid email-id for 'from email address' when email is sent>
mail.to(Optional)=<List of valid recipients email-ids>
Web Session Mail.to property is used if processFlowNotification.<scope>.recipients is not set in Process Notification Configuration.
Click Next. In the Mail Session Targets, select the managed server where the process application is deployed.
Finish creating the mail session.
Note: For more information on configuring Mail sessions on WebLogic, see the Oracle® WebLogic Administrator's Guide 12c Release. |
Stop the Process Flow managed server.
Download the BdiProcessFlow16.0.027ForAll16.x.xApps_eng_ga.zip from RTG Wiki and extract
Login to the box. Go to the bdi-process-home directory where migration scripts present. (Example: /bdi-process-home/setup-data/ddl/migration)
Using SqlPlus login to the Process Flow schema configured to BdiProcessFlowAdminDataSource. (Note: Make sure ORACLE_HOME is set.)
Run the following migration script. (Example: SQL> @migrate-schema-from-16.0.025-to-16.0.027.sql )
Make sure there is no error occurred after running the migration script.
Start the Process Flow managed server.
Login to the Process Flow App. (Example: http://host:17011/bdi-process-flow)
Go to Manage Configurations -> System Options and make following changes: LOADPROCESSDEF = TRUE and LOADSEEDDATA = TRUE
Login to the WLS Console and delete the existing ProcessFlow App.
Before redeployment, for every install/upgrade, one needs to look at flows-in-scope i.e. /bdi-process-home/setup-data/dsl/flows-in-scope, to ensure they have the correct set of flows for that installation, each release would bring in functional changes and flows files define the primary functional definition of a BDI integration flow.
Please do the following, delete what was in scope before, copy the latest flows for what we are trying to integrate. Deploy the app
>cd /bdi-process-home/setup-data/dsl/flows-in-scope >rm -rf *.flo >cp ../available_process_flow_options/<PICK_THE_APPS_IN_SCOPE_FOLDER>/*.flo .
Deploy the Process Flow application. See Install the Process Flow Application.
Bounce the managed server.
Login to Process Flow and make sure no errors are displayed in any of the pages.