From 6d05e1ee69b4f7f17b640ff7adef1c4e6361f407 Mon Sep 17 00:00:00 2001 From: justine-mills Date: Wed, 12 Jun 2024 18:43:32 +0200 Subject: [PATCH] moving and reviewing console docs --- nav.adoc | 2 +- .../consoles.adoc | 60 +++++++++---------- workflow/workflow-techpreview.adoc | 2 +- 3 files changed, 32 insertions(+), 32 deletions(-) rename {runtime-services-modeling => workflow}/consoles.adoc (90%) diff --git a/nav.adoc b/nav.adoc index 2632058d9..0adff1adf 100644 --- a/nav.adoc +++ b/nav.adoc @@ -41,7 +41,7 @@ ** xref:workflow/workflow-with-bpmn.html[Authoring business processes with BPMN] ** xref:tools/form-generation-tool.html[Form Generation tool] ** xref:workflow/deploying-process-services.html[Components of a process service] -** xref:runtime-services-modeling/consoles.html[Interacting with processes and tasks using Consoles] +** xref:workflow/consoles.html[Interacting with processes and tasks using Consoles] //** * xref:tools/intro-tools.html[Available tools] ** xref:tools/canvas.html[Development Canvas] diff --git a/runtime-services-modeling/consoles.adoc b/workflow/consoles.adoc similarity index 90% rename from runtime-services-modeling/consoles.adoc rename to workflow/consoles.adoc index 4d8779910..ca63c6a15 100644 --- a/runtime-services-modeling/consoles.adoc +++ b/workflow/consoles.adoc @@ -1,12 +1,12 @@ = Interacting with processes and tasks using Consoles include::../partials/attributes.adoc[] -== {PRODUCT} Management Console +== Management Console -The {PRODUCT} Management Console is a user interface for viewing the state of all available {PRODUCT_SHORT} services and managing process instances: +The Management Console is a user interface for viewing the state of all available {PRODUCT_SHORT} services and managing process instances: -.{PRODUCT_SHORT} Management Console -image::runtime-services-modeling/kogito-management-console.png[Image of Kogito Management Console] +.Management Console +image::runtime-services-modeling/kogito-management-console.png[Image of Management Console] You can use the Management Console to view process, subprocess, and node instance details, abort process instances, and view domain-specific process data. @@ -24,9 +24,9 @@ To visualize the process instance execution path at the management console, add If this add-on is not enabled for your {PRODUCT_SHORT} service, the management console does not display the diagram panel. //For more information about the process SVG add-on, see xref:con-bpmn-process-svg-addon_kogito-developing-process-services[]. -=== Using the {PRODUCT_SHORT} Management Console to manage process instances +=== Using the Management Console to manage process instances -You can use the {PRODUCT_SHORT} Management Console to view and manage process instance details from your {PRODUCT_SHORT} services. +You can use the Management Console to view and manage process instance details from your {PRODUCT_SHORT} services. You can run the Management Console for local {PRODUCT_SHORT} services or add it to your {PRODUCT_SHORT} infrastructure on {OPENSHIFT}. .Prerequisites @@ -88,15 +88,15 @@ $ java \ -jar management-console-__VERSION__-runner.jar ---- -=== {PRODUCT_SHORT} Management Console application +=== Management Console application -{PRODUCT_SHORT} Management Console consists of the following tabs that allow you to interact with your process instances and data: + Management Console consists of the following tabs that allow you to interact with your process instances and data: * *Process Instances*: Use this tab to find process and subprocess instances by status or business key * *Jobs*: Use this tab to view a list of available jobs to filter jobs by status and perform actions for individual jobs, such as view details, reschedule, or cancel. -.{PRODUCT_SHORT} Management Console -image::runtime-services-modeling/kogito-management-console.png[Image of Kogito Management Console] +.Management Console +image::runtime-services-modeling/kogito-management-console.png[Image of Management Console] In this example, the Management Console displays data for the `kogito-travel-agency` extended example application in the xref:../getting-started/examples.html[list of example applications]. @@ -108,7 +108,7 @@ The *Process Instances* tab displays the list of process instances and enables y image::runtime-services-modeling/kogito-management-console-process-instance-section.png[Image of process instance list section] When you select a process instance on the *Process Instances* page, it redirects you to the *Process Details* page, providing the process instance details including interactions with the process instance. -You can access the *Process Details* page from a different {PRODUCT_SHORT} Management Console tab, displaying the instance related data and enables you to perform the available actions. +You can access the *Process Details* page from a different Management Console tab, displaying the instance related data and enables you to perform the available actions. You can also sort the results based on the column headers. .Process Details page @@ -257,15 +257,15 @@ To cancel multiple jobs, select the jobs to be canceled and click the *Cancel Se === Configuring {PRODUCT_SHORT} Management Console security -For security, the {PRODUCT_SHORT} Management Console can use an Identity Management (IdM) solution for authentication. +For security, the Management Console can use an Identity Management (IdM) solution for authentication. Once a user is authenticated, Management Console uses bearer tokens to communicate with other {PRODUCT_SHORT} services. The bearer tokens are issued using OpenID Connect and OAuth 2.0 compliant authorization servers such as https://www.keycloak.org/about.html[Keycloak], which will be used in this example. // TODO: Not sure what to say here -IMPORTANT: This procedure applies only when you are using a locally cloned copy of the https://github.com/apache/incubator-kie-kogito-apps/tree/master/management-console[{PRODUCT_SHORT} Management Console] repository in GitHub. +IMPORTANT: This procedure applies only when you are using a locally cloned copy of the https://github.com/apache/incubator-kie-kogito-apps/tree/master/management-console[Management Console] repository in GitHub. .Prerequisites -* You have cloned the https://github.com/apache/incubator-kie-kogito-apps/tree/master/management-console[{PRODUCT_SHORT} Management Console] repository from GitHub. +* You have cloned the https://github.com/apache/incubator-kie-kogito-apps/tree/master/management-console[Management Console] repository from GitHub. * An IdM solution running. IMPORTANT: Ensure that you log in to the administration console of the IdM, navigate to the respective client configuration, and add correct URLs of different applications. @@ -275,7 +275,7 @@ You can also add the origin URLs as a parameter to the *Web Origins*, which can image::runtime-services-modeling/kogito-consoles-keycloak-config.png[Image of client config in keycloak server] .Procedure -. In a command terminal, navigate to the local clone of the {PRODUCT_SHORT} Management Console repository and enter the following command to run the application with security enabled: +. In a command terminal, navigate to the local clone of the Management Console repository and enter the following command to run the application with security enabled: + -- .Run the Management Console with security enabled @@ -315,14 +315,14 @@ kogito.consoles.keycloak.config.update-token-validity=30 . In the same `application.properties` file, also configure the resources to be exposed and the required permissions for accessing the resources. + -. Stop and restart the {PRODUCT_SHORT} Management Console to ensure that the security changes are applied. +. Stop and restart the Management Console to ensure that the security changes are applied. -== {PRODUCT_SHORT} Task Console +== Task Console -The {PRODUCT_SHORT} Task Console is a user interface for viewing and interacting with user tasks in {PRODUCT_SHORT} process services. +The Task Console is a user interface for viewing and interacting with user tasks in {PRODUCT_SHORT} process services. -.{PRODUCT_SHORT} Task Console -image::runtime-services-modeling/kogito-task-console.png[Image of Kogito Task Console] +.Task Console +image::runtime-services-modeling/kogito-task-console.png[Image of Task Console] You can use the Task Console to view your list of assigned tasks, view the task details for each task, and move the task to the next phase of the task lifecycle. @@ -331,9 +331,9 @@ The Data Index Service enables the Task Console to access stored events related // TODO: Do we say PostgreSQL here? The {PRODUCT_SHORT} Data Index Service requires Infinispan or MongoDB persistence and Apache Kafka messaging for your {PRODUCT_SHORT} service. -=== Using the {PRODUCT_SHORT} Task Console to interact with user tasks +=== Using the Task Console to interact with user tasks -You can use the {PRODUCT_SHORT} Task Console to view and interact with user tasks in {PRODUCT_SHORT} process services. +You can use the Task Console to view and interact with user tasks in {PRODUCT_SHORT} process services. You can run the Task Console for local {PRODUCT_SHORT} services or add it to your {PRODUCT_SHORT} infrastructure on {OPENSHIFT}. .Prerequisites @@ -350,7 +350,7 @@ quarkus.http.cors=true ---- .Procedure -. Go to the https://repository.jboss.org/org/kie/kogito/task-console/[`task-console`] artifacts page, select the latest release of the {PRODUCT_SHORT} Task Console, and download the `task-console-__VERSION__-runner.jar` file to a local directory. +. Go to the https://repository.jboss.org/org/kie/kogito/task-console/[`task-console`] artifacts page, select the latest release of the Task Console, and download the `task-console-__VERSION__-runner.jar` file to a local directory. . In a command terminal, navigate to the directory location of the downloaded `task-console-__VERSION__-runner.jar` file and enter the following command to run the Task Console: + -- @@ -396,8 +396,8 @@ $ java \ -jar task-console-__VERSION__-runner.jar ---- -.{PRODUCT_SHORT} Task Console -image::runtime-services-modeling/kogito-task-console.png[Image of Kogito Task Console] +.Task Console +image::runtime-services-modeling/kogito-task-console.png[Image of Task Console] In this example, the Management Console displays data for the `kogito-travel-agency` extended example application in the xref:../getting-started/examples.html[list of example applications]. @@ -430,18 +430,18 @@ For additional task details, you can select *View details*. This panel lists the image::runtime-services-modeling/kogito-task-console-details-expanded.png[Image of task details panel] -- -=== Configuring {PRODUCT_SHORT} Task Console security +=== Configuring Task Console security -For security, {PRODUCT_SHORT} Task Console utilizes an IdM solution, such as Keycloak, as an authentication service. +For security, Task Console utilizes an IdM solution, such as Keycloak, as an authentication service. Once a user is authenticated, Task Console uses bearer tokens to communicate with other {PRODUCT_SHORT} services. These tokens are issued by OpenID Connect and OAuth 2.0 compliant authorization servers. In this example, we will be using Keycloak. // TODO: Not sure what to do here -IMPORTANT: This procedure applies only when you are using a locally cloned copy of the https://github.com/apache/incubator-kie-kogito-apps/tree/master/task-console[{PRODUCT_SHORT} Task Console] repository in GitHub. +IMPORTANT: This procedure applies only when you are using a locally cloned copy of the https://github.com/apache/incubator-kie-kogito-apps/tree/master/task-console[Task Console] repository in GitHub. .Prerequisites -* You have cloned the https://github.com/apache/incubator-kie-kogito-apps/tree/master/task-console[{PRODUCT_SHORT} Task Console] repository from GitHub. +* You have cloned the https://github.com/apache/incubator-kie-kogito-apps/tree/master/task-console[Task Console] repository from GitHub. * An instance of Keycloak server is running. IMPORTANT: Ensure that you log in to the administration console of the Keycloak, navigate to the respective client configuration, and add correct URLs of different applications. @@ -451,7 +451,7 @@ You can also add the origin URLs as a parameter to the *Web Origins*, which can image::runtime-services-modeling/kogito-consoles-keycloak-config.png[Image of client config in keycloak server] .Procedure -. In a command terminal, navigate to the local clone of the {PRODUCT_SHORT} Task Console repository and enter the following command to run the application with security enabled: +. In a command terminal, navigate to the local clone of the Task Console repository and enter the following command to run the application with security enabled: + -- .Run the Task Console with security enabled diff --git a/workflow/workflow-techpreview.adoc b/workflow/workflow-techpreview.adoc index fc3a93434..1aabbd0e6 100644 --- a/workflow/workflow-techpreview.adoc +++ b/workflow/workflow-techpreview.adoc @@ -16,4 +16,4 @@ This section includes all the information you need to get started with the techn * xref:deploying-process-services.html[Architecture components and deployment] - provides more detail on the architecture and components of stateful processes including how to use the components. -* xref:runtime-services-modeling/consoles.html[Interacting with processes and tasks using Consoles] - describes how the {PRODUCT_SHORT} Management Console can be used to view and manage available BAMOE services. \ No newline at end of file +* xref:consoles.html[Interacting with processes and tasks using Consoles] - describes how the {PRODUCT_SHORT} Management Console can be used to view and manage available BAMOE services. \ No newline at end of file