Skip to content

Commit 3440483

Browse files
emmurphy1vidya-iyengar
emmurphy1
authored and
vidya-iyengar
committed
Merge pull request #12 from emmurphy1/BXMSDOC-1757-master
BXMSDOC-1757 Update user guide chapter 2 with the latest BC changes
1 parent 2fcbe09 commit 3440483

16 files changed

+281
-51
lines changed

‎docs/product-user-guide/src/main/asciidoc/business-central-con.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ Business Central integrates the following tools:
1010
* _Rules Modeler_ for designing Business Rules models and their resources (see the Red Hat JBoss BRMS documentation)
1111
* _Task client_ for managing and creating User Tasks (see <<_sect_user_tasks>>)
1212
* _Process Manager_ for managing process instances (see <<_sect_process_instances>>)
13-
* _Dashboard Builder_, the BAM component, for monitoring and reporting (see <<_chap_red_hat_jboss_dashboard_builder>>)
14-
* _Business Asset Manager_ for accessing the Knowledge Repository resources, building and deploying business assets (see xref:_assets_projects_gloss_chap-project[].)
13+
* _Dashboard Builder_, the business activity monitoring (BAM) component, for monitoring and reporting (see <<_chap_red_hat_jboss_dashboard_builder>>)
14+
* _Business Asset Manager_ for accessing the Knowledge Repository resources, building, and deploying business assets (see xref:_assets_projects_gloss_chap-project[].)
1515
endif::BPMS[]
1616

1717
ifdef::BRMS[]
1818
Business Central is the web-based user interface for both {PRODUCT_BRMS} 6 and {PRODUCT_BPMS} 6. Business Central allows business analysts, rule experts, developers, and rule administrators to manage rules in a multiuser environment and implement changes in a controlled fashion. Business Central has been combined with the core drools engine and other tools for optimal performance.
1919

2020
Business Central is most useful in the following cases:
2121

22-
* Users need to manage versions/deployment of rules.
22+
* Users need to manage versions or deployment of rules.
2323
* Multiple users of different skill levels need to access and edit rules.
2424
* You need an infrastructure to manage rules.
2525

‎docs/product-user-guide/src/main/asciidoc/business-central-home-con.adoc

Lines changed: 143 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -2,61 +2,163 @@
22
= Business Central Home
33

44
ifdef::BPMS[]
5-
The {PRODUCT} *Home* view consists of a main menu with various drop-down options or "perspectives" that you use to author and deploy business process projects, create and manage tasks and dashboards, and integrate plugins.
5+
The {PRODUCT} Home view provides links to various options, called perspectives, that you use to author and deploy business process projects, create and manage tasks and dashboards, and integrate plugins.
66

77
.{PRODUCT} Home
8-
image::6592.png[BPM Home Screen]
8+
image::user-guide-homepage.png[BPM Home Screen]
99
endif::BPMS[]
1010

1111
ifdef::BRMS[]
12-
The {PRODUCT} *Home* view consists of a main menu with various drop-down options or "perspectives" that you use to author and deploy business rule projects, create and manage tasks, and integrate plugins.
12+
The {PRODUCT} Home view provides links to various options, called perspectives, that you use to author and deploy business rule projects, create and manage tasks, and integrate plugins.
1313

1414
.{PRODUCT} Home
15-
image::3271.png[BRMS Home Screen]
15+
image::user-guide-homepage.png[BRMS Home Screen]
1616
endif::BRMS[]
1717

18-
<1> The main menu contains the links to the `Home` page and all available perspectives.
19-
<2> The perspective menu contains menus for the selected perspective.
20-
<3> The perspective area contains the perspective tools, such as views and editors.
18+
In addition, click *Menu* in the top left of the screen to display a list of all of the perspectives.
2119

22-
These perspectives contain the following options:
20+
.{PRODUCT} Home Menu
21+
image::user-guide-homemenu.png[BPM Home Menu]
2322

24-
* *Authoring* group:
25-
** *Project Authoring* perspective contains:
26-
*** The *Project Explorer* view with the overview of the repository structure, and information about available resources, such as business process definitions, form definitions, and others.
27-
*** The editor area on the right of the *Project Explorer* view, where the respective editor appears when a resource is opened.
28-
*** The *Messages* view with validation messages.
29-
** *Contributors* perspective enables you to view the number of commits sorted by the organizational unit, repository, author, and other criteria.
30-
** *Artifact Repository* perspective contains a list of jars which can be added as dependencies. The available operations in this perspective are upload/download artifact and open (view) the `pom.xml` file.
23+
Click the house icon on the top left of any screen to return to this page.
24+
25+
[NOTE]
26+
====
27+
Perspectives are displayed based on the role of the logged in user.
28+
====
29+
30+
.Design
31+
The Design group contains two perspectives:
32+
33+
* Projects
34+
+
35+
The Projects perspective enables you to import or create Business Central projects. This is where you do your process design work. It contains a number of example projects.
36+
+
37+
This perspective is visible to users with the following roles:
38+
39+
** Admin
40+
** Analyst
41+
** Developer
42+
43+
* Dashboards
44+
+
45+
The Dashboards perspective is the BAM component of {PRODUCT}. Use it to create custom perspectives for your projects. On the Dashboards perspective, you can create a new group for the *Main* menu and add the perspectives that you create to that group. This perspective is visible to users with the following roles:
46+
47+
** Admin
48+
** Analyst
49+
** Developer
50+
51+
.DevOps
52+
The DevOps group contains two perspectives:
53+
54+
* Deployments
55+
56+
[IMPORTANT]
57+
====
58+
The Deployments perspective is a Technology Preview feature only. Technology Preview features
59+
are not supported with Red Hat production service level agreements (SLAs), might
60+
not be functionally complete, and Red Hat does not recommend to use them for
61+
production. These features provide early access to upcoming product features,
62+
enabling customers to test functionality and provide feedback during the
63+
development process.
64+
For more information on Red Hat Technology Preview features support scope,
65+
see https://access.redhat.com/support/offerings/techpreview/.
66+
====
67+
68+
The Deployments perspective enables you to provision projects on OpenShift. In this release, it is hidden by default. Perform the following steps to enable it:
69+
70+
. Go to *Settings* → *Roles*.
71+
. Select the *admin* role.
72+
. In the Permissions section, click the arrow next to Perspectives.
73+
. Click the trash icon next to Deployments. The DevOps → *Deployments* link is now available on the Home page.
74+
75+
* Execution Servers
3176
+
32-
The view is available for users with the `admin` role only.
77+
The Execution Servers perspective contains a list of the deployed Intelligent Process Server templates and containers associated with the templates. This perspective is visible to users with the following roles:
78+
79+
** Admin
80+
** Developer
81+
82+
.Manage
83+
The Manage group contains five perspectives:
84+
85+
* Process Definitions
3386
+
34-
** *Administration* perspective contains:
35-
*** The *File Explorer* view with available asset repositories.
36-
*** The editor area on the right of the *File Explorer* view, where the respective editor appears when a resource is opened.
87+
The Process Definitions perspective contains a list of deployed process definitions. It enables you to instantiate and manage the deployed processes. This perspective is visible to users with the following roles:
88+
89+
** Admin
90+
** Analyst
91+
** Developer
92+
** User
93+
** Process-admin
94+
95+
* Process Instances
3796
+
38-
The *Administration* perspective enables an administrator to connect a Knowledge Store to a repository with assets and to create a new repository. For more information, see the _{ADMIN_GUIDE}_.
97+
The Process Instances perspective contains a list of the instantiated processes. It enables you to view their execution work flow and history. This perspective is visible to users with the following roles:
98+
99+
** Admin
100+
** Analyst
101+
** Developer
102+
** User
103+
** Process-admin
104+
105+
* Task Administration
39106
+
40-
The view is available only for users with the `admin` role.
41-
* *Deploy* group:
107+
The Task Administration perspective contains a list of human tasks generated from running process instances. This perspective is visible to users with the following roles:
108+
109+
** Admin
110+
** Process-admin
111+
112+
* Jobs
113+
+
114+
The Jobs perspective enables you to monitor and trigger asynchronous jobs scheduled for the Executor Service. This perspective is visible to users with the following roles:
115+
116+
** Admin
117+
** Analyst
118+
** Developer
119+
120+
* Execution Errors
121+
+
122+
The Execution Errors perspective lists any errors that occur during process instances or executor service jobs on a KIE server. Use this perspective to help troubleshoot issues. This perspective is visible to users with the following roles:
123+
124+
** Admin
125+
** Process-admin
126+
127+
128+
.Track
129+
The track group contains perspectives to help you
130+
131+
* Task Lists
132+
+
133+
The Task Lists perspective contains a list of human tasks generated from running process instances. Only tasks assigned to you and the groups that you are a member of are visible. This perspective enables you to claim tasks assigned to a group that you are a member of. It is visible to users with the following roles:
134+
135+
** Admin
136+
** Analyst
137+
** Developer
138+
** User
139+
** Process-admin
140+
42141
ifdef::BPMS[]
43-
** *Process Deployments* perspective contains a list of the deployed resources and enables you to build, deploy, and undeploy new units.
44-
** *Execution Servers* perspective contains a list of the deployed {KIE_SERVER} templates and containers associated with the templates.
45-
** *Jobs* perspective enables you to monitor and trigger asynchronous jobs scheduled for the Executor Service.
46-
* *Process Management* group:
47-
** *Process Definitions* perspective contains a list of the deployed Process definitions. It enables you to instantiate and manage the deployed Processes.
48-
** *Process Instances* perspective contains a list of the instantiated Processes. It enables you to view their execution workflow and its history.
49-
* *Tasks* group:
50-
** *Task List* perspective contains a list of Tasks produced by Human Task of the Process instances or produced manually. Only Tasks assigned to the logged-in user are visible. It enables you to claim Tasks assigned to a group you are a member of.
51-
* *Dashboards* group (the BAM component):
52-
** *Process & Task Dashboard* perspective contains a prepared dashboard with statistics on runtime data of the Execution Server
53-
** *Business Dashboards* perspective contains the full BAM component, the Dashbuilder, including administration features available for users with the `ADMIN` role.
142+
* Process & Task Reports
143+
+
144+
The Process & Task Reports perspective displays reports for {PRODUCT} runtime data. For example, which processes are being executed and the states that different tasks are in. This perspective is visible to users with the following roles:
145+
process-admin
146+
147+
** Admin
148+
** Analyst
149+
** Developer
150+
** Manager
151+
** User
54152
endif::BPMS[]
55-
ifdef::BRMS[]
56-
** *Execution Servers* perspective contains a list of the deployed {KIE_SERVER} templates and containers associated with the templates.
57-
endif::BRMS[]
58-
* *Extensions* group:
59-
** *PlugIn Management* perspective enables you to customize and create new Business Central perspectives and plugins.
60-
** *Apps* perspective enables you to browse, categorize, and open custom perspective plugins.
61-
** *Data Sets* perspective enables you to define and connect to external data sets.
62-
** *Data Sources* perspective enables you to define and connect to external data sources.
153+
154+
* Business Dashboards
155+
156+
The Business Dashboards perspective is a space used to manage and display perspectives that you create in the Dashboards perspective. This perspective is visible to users with the `admin` role.
157+
After you create a perspective, you must manually add it to the Business Dashboards perspective.
158+
159+
.Procedure
160+
161+
. Navigate to Design -> *Dashboards*.
162+
. Add a tag to the perspective that you want to add to the Business Dashboards perspective.
163+
. Navigate to Track -> *Business Dashboards*.
164+
. Create a folder with the name of the tag that you created in the Dashboards perspective. The perspective will appear in the Business Dashboards perspective.

‎docs/product-user-guide/src/main/asciidoc/business-central-login-proc.adoc

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ After you have successfully installed and configured {EAP} and {Product}, and ha
66
.Prerequisites
77
* {EAP} is installed as described in the _{EAP} Installation Guide_ in the Red Hat https://access.redhat.com/products/red-hat-jboss-enterprise-application-platform/#getstarted[Customer Portal].
88
* {PRODUCT} is installed and users are configured as described in the {URL_INSTALLATION_GUIDE}#installing_red_hat_jboss_bpm_suite[_{INSTALLATION_GUIDE}_].
9-
* The {EAP} server is running as described in the {URL_INSTALLATION_GUIDE}#running_red_hat_jboss_bpm_suite[_{INSTALLATION_GUIDE}_].
109
endif::BPMS[]
1110

1211
ifdef::BRMS[]
@@ -15,11 +14,34 @@ After you have successfully installed and configured {EAP} and {Product}, and ha
1514
.Prerequisites
1615
* {EAP} is installed as described in the _{EAP} Installation Guide_ in our https://access.redhat.com/products/red-hat-jboss-enterprise-application-platform/#getstarted[Customer Portal].
1716
* {PRODUCT} is installed and users are configured as described in the {URL_INSTALLATION_GUIDE}#installing_red_hat_jboss_brms[_{INSTALLATION_GUIDE}_].
18-
* The {EAP} server is running as described in the {URL_INSTALLATION_GUIDE}#running_red_hat_jboss_brms[_{INSTALLATION_GUIDE}_].
1917
endif::BRMS[]
2018

2119
.Procedure
22-
. Navigate to http://localhost:8080/business-central in a web browser. If the user interface has been configured to run from a domain name, substitute `localhost` for the domain name. For example http://www.example.com:8080/business-central
23-
. Enter the user credentials that you created during installation. For example: User = `helloworlduser` and password = ``Helloworld@123``.
20+
. In a terminal application, navigate to `__EAP_HOME__/bin`.
21+
. Run the standalone configuration:
22+
** On Linux or Unix-based systems:
23+
+
24+
[source,bash]
25+
----
26+
$ ./standalone.sh
27+
----
28+
** On Windows:
29+
+
30+
[source,bash]
31+
----
32+
standalone.bat
33+
----
34+
. In a web browser, open the URL `localhost:8080/business-central`. If the user interface has been configured to run from a domain name, substitute `localhost` for the domain name, for example:
35+
+
36+
http://www.example.com:8080/business-central
37+
38+
. Enter the user credentials that you created during installation. For example, enter the user name
39+
ifdef::BPMS[]
40+
`bpmsAdmin`
41+
endif::[]
42+
ifdef::BRMS[]
43+
`brmsAdmin`
44+
endif::[]
45+
and the password `password@1`.
2446

2547
If the web page is not found or fails to load, check your command line interface to ensure that the {EAP} has finished running successfully, then try to log in again. If the problem persists, ensure that the login credentials match those that you created during installation.

‎docs/product-user-guide/src/main/asciidoc/business-central-settings-proc.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
[[_business_central_settings_proc]]
2+
= Business Central Settings
3+
4+
You can customize several {PRODUCT} settings.
5+
6+
.Procedure
7+
Click the gear icon in the upper right of the screen to display the Settings perspective.

‎docs/product-user-guide/src/main/asciidoc/business-central-settings-security-proc.adoc

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
[[_business_central_settings_security_proc]]
2+
= Security Settings
3+
4+
You can manage roles, groups, and users on the Security perspective.
5+
6+
.Procedure
7+
To access the Security perspective, click *Roles*, *Groups*, or *Users* on the Settings perspective. Depending on which icon you click, the Security perspective opens on the Roles, Groups, or Users tab.
8+
9+
* Roles
10+
+
11+
There are seven predefined roles available in {PRODUCT}. You can customize the privileges and settings for each role. Any changes apply to all users with the affected role.
12+
+
13+
* Groups
14+
+
15+
Groups are similar to roles. However, you can create as many groups as you require and customize their privileges and settings. You can customize the settings for each group. Any changes apply to all users with the affected group.
16+
+
17+
* Users
18+
+
19+
You can create as many users as you require. Click *New user*, enter a user name, then follow the prompts to grant the user roles and add the user to groups.

‎docs/product-user-guide/src/main/asciidoc/chap-business-central.adoc

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,22 @@ include::business-central-login-proc.adoc[leveloffset=+1]
66

77
include::business-central-home-con.adoc[leveloffset=+1]
88

9+
include::business-central-settings-proc.adoc[leveloffset=+1]
10+
11+
include::business-central-settings-security-proc.adoc[leveloffset=+2]
12+
13+
include::proc-business-central-settings-artifacts.adoc[leveloffset=+2]
14+
15+
include::proc-business-central-settings-data-sources.adoc[leveloffset=+2]
16+
17+
include::con-business-central-settings-data-sets.adoc[leveloffset=+2]
18+
19+
include::con-business-central-settings-project.adoc[leveloffset=+2]
20+
21+
include::con-business-central-settings-library.adoc[leveloffset=+2]
22+
23+
include::con-business-central-settings-artifact-repo.adoc[leveloffset=+2]
24+
25+
include::con-business-central-settings-lanuage.adoc[leveloffset=+2]
26+
927
include::business-central-embedding-proc.adoc[leveloffset=+1]

‎docs/product-user-guide/src/main/asciidoc/chap-data-sets.adoc

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
include::data-sets-con.adoc[]
3-
41
include::data-sets-add-proc.adoc[leveloffset=+1]
52

63
include::data-sets-edit-proc.adoc[leveloffset=+1]

‎docs/product-user-guide/src/main/asciidoc/con-business-central-settings-artifact-repo.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[[con-business-central-settings-artifact-repo]]
2+
= Artifact Repository
3+
4+
Use the Artifact Repository perspective to specify Maven Artifact repository preferences.

‎docs/product-user-guide/src/main/asciidoc/con-business-central-settings-data-sets.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[[business_central_settings_data_sets]]
2+
= Data Sets
3+
4+
Use this perspective to specify what data will be used in the dashboards.

‎docs/product-user-guide/src/main/asciidoc/con-business-central-settings-lanuage.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[[con-business-central-settings-language]]
2+
= Languages
3+
4+
Click Languages to choose the language for the {PRODUCT} user interface.

‎docs/product-user-guide/src/main/asciidoc/con-business-central-settings-library.adoc

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
[[con-business-central-settings-library]]
2+
= Library
3+
4+
The settings in the Library section determine the behavior of the Projects perspective, which is available from the *Main* menu.
5+
6+
The Library Preferences section enables you to specify a URL for the examples repository. Example projects will be fetched from this repository and will be displayed on Library Import Examples perspective. If you do not specify a URL, the default examples will be displayed. The Library Preferences section has the following subsections:
7+
8+
.File Exporting
9+
10+
This section enables you to set the orientation, units, and page format for exporting PDF files.
11+
12+
.Organizational Units
13+
14+
In this section, you can specify the following default values:
15+
16+
* The default team name, which will be used to create the initial team if no team has been created yet
17+
* The default team owner, which will be used to create the initial team owner if no team has been created
18+
* The default team group ID, which will be used to create the initial group ID, if no group ID has been created
19+
* A singular alias that will be used instead of team name
20+
* A plural alias that will be used instead of team name
21+
22+
23+
.Repositories
24+
25+
In this section, you can specify the name of the repository that will be created automatically if no repository exists inside of the selected team. The repository scheme is set to `git` and cannot be changed.
26+
27+
.Projects
28+
29+
You can set the following Projects properties:
30+
31+
* The default version that will be used when creating a project using the *Quick setup* option
32+
* The default description that will be used when creating a project using the *Quick setup* option
33+
* The branch that will be used when a repository is opened

‎docs/product-user-guide/src/main/asciidoc/con-business-central-settings-project.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
[[con-business-central-settings-project]]
2+
= Projects
3+
4+
Use the Project perspective to enable or disable the `GroupId`, `ArtifactId`, and `Version` (GAV) conflict check and allow or forbid child GAV editions.
5+
6+
When enabled, this check verifies that the artifact with a specific GAV does not already exists in maven repositories managed by Business Central. If the artifact does exist, a dialog box appears asking whether to override this artifact or cancel the deployment of the artifact to the maven repository.
7+
8+
When disabled, there is no check and artifacts are always overwritten, even when artifacts with a specific GAV already exists in the repository.
9+
10+
If you access the Project perspective from the Settings menu, any changes you make will apply to all projects, with the exception noted in the following paragraph.
11+
12+
The Project perspective is also available from each project through the *Preferences* button. If you access the Project perspective from within a project, the changes that you make apply only to that project and they override any changes that you make to the Project perspective accessed from the Settings menu.

‎docs/product-user-guide/src/main/asciidoc/proc-business-central-settings-artifacts.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[[business_central_settings_artifacts]]
2+
= Artifacts
3+
4+
In the Artifacts perspective, you can manage the content of the Maven repository. The artifacts that you build from your projects are listed here, along with their `GroupId`, `ArtifactId`, and `Version` (GAV). You can view the contents an artifact, as well as upload and download artifacts.

0 commit comments

Comments
 (0)