BXMSDOC-4148 Installing and configuring DM 7.4 and PAM 7.4 on EAP, JWS, and Tomcat #173

emmurphy1 · 2019-06-24T14:37:13Z

Continuation of this pull request. Previous changed content merge for clearer reviews.

Includes:
BXMSDOC-4013 Installing and configuring DM 7.4 and PAM 7.4 on EAP (epic)
BXMSDOC-4013 Database specific troubleshooting tips missing from the RHPAM 7 documentation
BXMSDOC-4013 Installation Guides are missing section for DB setup

BXMSDOC-4015 Installing PAM/DM 7.4 on JWS

BXMSDOC-4148 Installing and configuring DM/PAM 7.4 on Tomcat 9 Server.

Note that this merge request includes stories for three platforms because of shared files, to ensure changes do not break any of the stories.

See jiras for details.

domhanak · 2019-06-26T10:27:14Z

doc-content/enterprise-only/installation/installer-jws-cli-proc.adoc

@@ -46,7 +46,7 @@ Specify the home directory of the following servers:  Red Hat JBoss EAP 7.1 or R
 [/home/user/{PRODUCT_INIT_CAP}-{PRODUCT_VERSION_LONG}/jboss-eap-7.1]


Outdated eap version in example

The file is obsolete. Removed from repo.

…nged RN Known Issues

…pdate

BXMSDOC-4148 Installing and configuring DM 7.4 and PAM 7.4 on EAP, JWS, and Tomcat

pnagesha · 2019-07-08T17:00:09Z

assemblies/assembly_install-on-jws/main.adoc

@@ -14,7 +14,7 @@ This document describes how to install {PRODUCT} {PRODUCT_VERSION} on JBoss Web

 .Prerequisites
 * You have reviewed the information in {URL_PLANNING_INSTALL}[_{PLANNING_INSTALL}_].


I am not fond of this sentence structure. Why do we not use imperative?
Prerequisites:
Review the ....
Install the.....

As a team, we adapted this format for prerequisites. We intentionally use the passive voice here. Because prerequisites are things that you should have done, they need to be in the past tense. We list it in our peer review guide.

One reason not to use the imperative in prereqs is that they would look an awful lot like the actual procedure.

pnagesha · 2019-07-08T17:57:48Z

doc-content/enterprise-only/admin-and-config/maven-settings-configuration-ref.adoc

+.Procedure
+. In the `settings.xml` file, declare the repositories that your {PRODUCT} projects use. Usually, this is either the https://maven.repository.redhat.com/ga/[online {PRODUCT} Maven repository] or the
+{PRODUCT} Maven repository that you download from the Red Hat Customer Portal and any repositories for custom artifacts that you want to use.
+. Ensure that {CENTRAL} or {KIE_SERVER} is configured to use the `settings.xml` file , for example by specifying the `kie.maven.settings.custom=<SETTINGS_FILE_PATH>` property where `<SETTINGS_FILE_PATH>` is the path to the `settings.xml` file.


can we simply not say "for example, specify kie.maven....."?

Yes, i like that. Changing.

has this been updated to "for example, specify kie.maven..."?

pnagesha · 2019-07-08T18:01:37Z

doc-content/enterprise-only/installation/controller-jws-install-proc.adoc

 ====
-Ensure the names of the {PRODUCT} deployments you are copying do not conflict with your existing deployments in the 
+Ensure the names of the {PRODUCT} deployments you are copying do not conflict with your existing deployments in the


"...you copy..." Why present continuous tense?

Good point! Changing.

pnagesha · 2019-07-08T18:04:14Z

doc-content/enterprise-only/installation/controller-jws-install-proc.adoc

 ----
 endif::DM[]
+
+In the preceding examples, replace the following variables:


Is there another example after this that is part of a sequence? If not should we just say "previous" instead of "preceding"?

Well, I confess I have a personal bias for that form for no good reason then consistency and habit. I asked Stetson about this and here is his take:
"Preceding is "correct" when it immediately follows. Previous is "correct" if it's farther away. So in the example you're giving, if I had to choose between the two, I would go with preceding. But I just don't use it at all anyway in such cases. Not an issue of correctness as much as superfluity."

So I guess I was correct but I take his point about superfluity.

pnagesha · 2019-07-08T18:58:33Z

doc-content/drools-docs/src/main/asciidoc/AuthoringAssets/test-scenarios-intro-con.adoc

@@ -5,7 +5,7 @@ Test scenarios in {PRODUCT} enable you to validate the functionality of business

 {PRODUCT} currently supports both the new *Test Scenarios* designer and the former *Test Scenarios (Legacy)* designer. The default designer is the new test scenarios designer, which supports testing of both rules and DMN models and provides an enhanced overall user experience with test scenarios. If required, you can continue to use the legacy test scenarios designer, which supports rule-based test scenarios only.

-You can run the defined test scenarios in a number of ways, for example, you can run available test scenarios at the project level or inside a specific test scenario asset. Test scenarios are independent and cannot affect or modify other test scenarios. You can run test scenarios at any time during project development in {CENTRAL}. You do not have to compile or deploy your decision service to run test scenarios. For more information about running test scenarios, see xref:test-designer-run-test-proc[].
+You can run the defined test scenarios in a number of ways, for example, you can run available test scenarios at the project level or inside a specific test scenario asset. Test scenarios are independent and cannot affect or modify other test scenarios. You can run test scenarios at any time during project development in {CENTRAL}. You do not have to compile or deploy your decision service to run test scenarios. 


"... run defined test scenarios..." or "... run the defined test..."

Wow. That's not my text :-) Stetson asked me to delete the highlighted xref as a favor when I merged this PR. There are a few issues there. I'll look at it.

pnagesha · 2019-07-08T19:00:02Z

doc-content/enterprise-only/admin-and-config/maven-settings-configuration-ref.adoc

+
+.Procedure
+. In the `settings.xml` file, declare the repositories that your {PRODUCT} projects use. Usually, this is either the https://maven.repository.redhat.com/ga/[online {PRODUCT} Maven repository] or the
+{PRODUCT} Maven repository that you download from the Red Hat Customer Portal and any repositories for custom artifacts that you want to use.


Should maven be initial capped here?

Yes. On the Apache Maven site, they treat Maven as a proper noun, which I think it is anyway. Did you have an argument for not capping?

pnagesha · 2019-07-08T19:02:23Z

doc-content/enterprise-only/installation/controller-jws-install-proc.adoc

 ifeval::["{context}" == "install-on-jws"]
 `_JWS_HOME_/tomcat/bin`
 endif::[]
 ifeval::["{context}" == "install-on-tomcat"]
 `_TOMCAT_HOME_/tomcat/bin`
 endif::[]
- directory of the instance running the {HEADLESS_CONTROLLER}, create a readable `setenv.sh` file with the following content:
+ directory of the instance running the {HEADLESS_CONTROLLER}, create a readable `setenv.sh` file with the following content where `<USERNAME>` is {KIE_SERVER} user and `<USER_PWD>` is the password for that user:


a comma after "... following content, ..."

pnagesha · 2019-07-08T19:04:44Z

doc-content/enterprise-only/installation/jws-jdbc-config_proc.adoc

@@ -136,6 +149,11 @@ The pooling data source configuration relies on additional resource that have be
 . Configure {KIE_SERVER} to use the data source:
 .. Open one of the following scripts in a text editor:
 +
+[NOTE]
+====
+The `setenv.sh` or `setenv.bat` script should already exist. However, if it does not, create it.


Why (what circumstances) would it not exist?

Excellent question. I'll ask an SME.

csherrar

Some suggestions and questions, otherwise looks good to me.

csherrar · 2019-07-08T20:15:19Z

assemblies/assembly_install-on-tomcat/main.adoc

 ifdef::PAM[]
- and then configure the Java Database Connectivity (JDBC) web server data sources on {TOMCAT}
+and then configure the Java Database Connectivity (JDBC) web server data sources on {TOMCAT}


Missing full stop after {TOMCAT}.

Actually, @csherrar the full stop isn't missing. It just looks that way because of the use of conditions. Always check the rendered doc.

csherrar · 2019-07-08T20:21:46Z

doc-content/enterprise-only/admin-and-config/maven-settings-configuration-ref.adoc

+.Procedure
+. In the `settings.xml` file, declare the repositories that your {PRODUCT} projects use. Usually, this is either the https://maven.repository.redhat.com/ga/[online {PRODUCT} Maven repository] or the
+{PRODUCT} Maven repository that you download from the Red Hat Customer Portal and any repositories for custom artifacts that you want to use.
+. Ensure that {CENTRAL} or {KIE_SERVER} is configured to use the `settings.xml` file , for example by specifying the `kie.maven.settings.custom=<SETTINGS_FILE_PATH>` property where `<SETTINGS_FILE_PATH>` is the path to the `settings.xml` file.


has this been updated to "for example, specify kie.maven..."?

csherrar · 2019-07-08T20:31:44Z

doc-content/enterprise-only/admin-and-config/maven-settings-configuration-ref.adoc

+. Ensure that {CENTRAL} or {KIE_SERVER} is configured to use the `settings.xml` file , for example by specifying the `kie.maven.settings.custom=<SETTINGS_FILE_PATH>` property where `<SETTINGS_FILE_PATH>` is the path to the `settings.xml` file.
+
+ifeval::["{context}" == "install-on-jws"]
+On {JWS}, for {KIE_SERVER} add `-Dkie.maven.settings.custom=<SETTINGS_FILE_PATH>` to the  `CATALINA_OPTS` section of the `setenv.sh` (Linux) or `setenv.bat` (Windows) file. .For standalone {CENTRAL}, enter the following command:


The below sentence needs to be moved to new line or the full stop removed from the start:

".For standalone {CENTRAL}, enter the following command:"

Yes, updated to For example...
full stop.. thanks. Good catch.

csherrar · 2019-07-08T20:34:28Z

doc-content/enterprise-only/admin-and-config/maven-settings-configuration-ref.adoc

+----
+endif::[]
+ifeval::["{context}" == "install-on-tomcat"]
+On {TOMCAT}, for {KIE_SERVER} add `-Dkie.maven.settings.custom=<SETTINGS_FILE_PATH>` to the  `CATALINA_OPTS` section of the `setenv.sh` (Linux) or `setenv.bat` (Windows) file. .For standalone {CENTRAL}, enter the following command:


The below sentence needs to be moved to new line or the full stop removed from the start:

".For standalone {CENTRAL}, enter the following command:"

csherrar · 2019-07-08T20:38:20Z

doc-content/enterprise-only/installation/controller-jws-install-proc.adoc

+
+* Replace `<CONTROLLER_USER>` and `<CONTROLLER_PWD>` with the user name and password for the `kie-server` role that you defined earlier in this procedure.
+* Replace `<KIE_SERVER_ID>` with a unique identifier.
+* Replace `<CONTROLLER_HOST>:<CONTROLLER_PORT>` with the host and port (IP address) of the controller. If you use the same server for {KIE_SERVER} and the controller, `<CONTROLLER_HOST>:<CONTROLLER_PORT>` is `localhost:8080`.


Minor suggestion - swap positions of IP address and host and port, because we are indicating that the IP address needs the port declared.
s/with the host and port (IP address) of the controller/with the IP address (host and port) of the controller/

Good suggestion, thanks.

csherrar · 2019-07-08T20:39:05Z

doc-content/enterprise-only/installation/controller-jws-install-proc.adoc

 ifeval::["{context}" == "install-on-jws"]
 `_JWS_HOME_/tomcat/bin`
 endif::[]
 ifeval::["{context}" == "install-on-tomcat"]
 `_TOMCAT_HOME_/tomcat/bin`
 endif::[]
- directory of the instance running the {HEADLESS_CONTROLLER}, create a readable `setenv.sh` file with the following content:
+ directory of the instance running the {HEADLESS_CONTROLLER}, create a readable `setenv.sh` file with the following content where `<USERNAME>` is {KIE_SERVER} user and `<USER_PWD>` is the password for that user:


s/is {KIE_SERVER} user/is the {KIE_SERVER} user

Another good catch, thanks.

csherrar · 2019-07-08T20:42:08Z

doc-content/enterprise-only/installation/eap-execution-server-download-install-proc.adoc

 endif::PAM[]
 ifdef::DM[]
-`__TEMP_DIR__/{PRODUCT_FILE}-kie-server-ee8/{PRODUCT_FILE}-kie-server-ee8/kie-server.war`
+`__TEMP_DIR__/{{PRODUCT_FILE}-kie-server-ee8/kie-server.war`


Remove duplicated "{"

BXMSDOC-4148 Installing and configuring DM 7.4 and PAM 7.4 on EAP, JWS, and Tomcat

* New fields in audit data model * SME comment * SME review

domhanak reviewed Jun 26, 2019

View reviewed changes

emmurphy1 force-pushed the BXMSDOC-4148-master branch from 368829b to 74c6e4e Compare July 8, 2019 18:06

emmurphy1 added 11 commits July 8, 2019 14:07

BXMSDOC-4148 corrected bpms ifdef to pam

b2084c6

BXMSDOC-4148 updated JWS version, removed or higher

1dfb57d

BXMSDOC-4148 updated with dhanak comments

ec28a0e

BXMSDOC-4148 removed troubleshooting and persistence files from EAP

a60dfce

BXMSDOC-4148 updated controller installation section

66f5422

BXMSDOC-4148 updated 4.3 controller installer section, accidently cha…

e2c069e

…nged RN Known Issues

BXMSDOC-4148 updated jbpm-flow-builder in three files

684eca6

BXMSDOC-4148 updated with Tristans's JWS comments. One small tomcat u…

d320101

…pdate

BXMSDOC-4148 updated with Tristan clarifications

efe7ac3

BXMSDOC-4148 updated verify section to remove JWS ref

a3d6483

BXMDOC-4148 fixed assemblies and tomcat story link

43c15fa

emmurphy1 force-pushed the BXMSDOC-4148-master branch from 74c6e4e to 43c15fa Compare July 8, 2019 18:08

emmurphy1 merged commit 91cf91e into BXMSDOC-4148-master-final Jul 8, 2019

emmurphy1 added a commit that referenced this pull request Jul 8, 2019

Merge pull request #173 from emmurphy1/BXMSDOC-4148-master

eb99050

BXMSDOC-4148 Installing and configuring DM 7.4 and PAM 7.4 on EAP, JWS, and Tomcat

pnagesha reviewed Jul 8, 2019

View reviewed changes

csherrar reviewed Jul 8, 2019

View reviewed changes

emmurphy1 added a commit that referenced this pull request Jul 10, 2019

Merge pull request #173 from emmurphy1/BXMSDOC-4148-master (apache#1723)

17a3751

BXMSDOC-4148 Installing and configuring DM 7.4 and PAM 7.4 on EAP, JWS, and Tomcat

emmurphy1 deleted the BXMSDOC-4148-master branch January 30, 2020 12:47

emmurphy1 pushed a commit that referenced this pull request Feb 4, 2021

BXMSDOC-6883 Updated GSG for PS using CR1 (#173) (apache#3242)

2c52c32

emmurphy1 pushed a commit that referenced this pull request Feb 8, 2021

BXMSDOC-6883 Updated GSG for PS using CR1 (#173) (apache#3243)

272b0dd

emmurphy1 pushed a commit that referenced this pull request Dec 1, 2021

New fields in audit data model (#173) (apache#4048)

8088c30

* New fields in audit data model * SME comment * SME review

emmurphy1 pushed a commit that referenced this pull request Dec 1, 2021

New fields in audit data model (#173) (apache#4047)

0fb3846

* New fields in audit data model * SME comment * SME review

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

BXMSDOC-4148 Installing and configuring DM 7.4 and PAM 7.4 on EAP, JWS, and Tomcat #173

BXMSDOC-4148 Installing and configuring DM 7.4 and PAM 7.4 on EAP, JWS, and Tomcat #173

emmurphy1 commented Jun 24, 2019

domhanak Jun 26, 2019

emmurphy1 Jun 26, 2019

pnagesha Jul 8, 2019

emmurphy1 Jul 8, 2019

pnagesha Jul 8, 2019

emmurphy1 Jul 8, 2019

csherrar Jul 8, 2019

pnagesha Jul 8, 2019

emmurphy1 Jul 8, 2019

pnagesha Jul 8, 2019

emmurphy1 Jul 8, 2019

pnagesha Jul 8, 2019

emmurphy1 Jul 8, 2019

pnagesha Jul 8, 2019

emmurphy1 Jul 8, 2019

pnagesha Jul 8, 2019

emmurphy1 Jul 8, 2019

pnagesha Jul 8, 2019

emmurphy1 Jul 8, 2019

csherrar left a comment

csherrar Jul 8, 2019

emmurphy1 Jul 9, 2019

csherrar Jul 8, 2019

csherrar Jul 8, 2019

emmurphy1 Jul 9, 2019

csherrar Jul 8, 2019

csherrar Jul 8, 2019

emmurphy1 Jul 9, 2019

csherrar Jul 8, 2019

emmurphy1 Jul 9, 2019

csherrar Jul 8, 2019

		@@ -46,7 +46,7 @@ Specify the home directory of the following servers: Red Hat JBoss EAP 7.1 or R
		[/home/user/{PRODUCT_INIT_CAP}-{PRODUCT_VERSION_LONG}/jboss-eap-7.1]

		@@ -14,7 +14,7 @@ This document describes how to install {PRODUCT} {PRODUCT_VERSION} on JBoss Web

		.Prerequisites
		* You have reviewed the information in {URL_PLANNING_INSTALL}[_{PLANNING_INSTALL}_].

BXMSDOC-4148 Installing and configuring DM 7.4 and PAM 7.4 on EAP, JWS, and Tomcat #173

BXMSDOC-4148 Installing and configuring DM 7.4 and PAM 7.4 on EAP, JWS, and Tomcat #173

Conversation

emmurphy1 commented Jun 24, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

csherrar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment