Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

publishing limitations in web modeler #4543

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import GHIcon from "@site/src/mdx/GitHubInlineIcon";

Forms play a key role in giving work instructions, collecting information and making decisions within human task orchestration. Forms are lightweight user interfaces, tailored for focused data input in specific steps of a process, rendering the orchestration of human tasks more efficient than simply routing users to the applications that are orchestrated.

Forms are commonly used in [user tasks](/components/modeler/bpmn/user-tasks/user-tasks.md/#user-task-forms), but also as [start forms](/components/tasklist/userguide/starting-processes.md) to start a new process instance, or even as [public forms](/components/modeler/web-modeler/advanced-modeling/publish-public-processes.md), e.g. to capture user input at scale or to allow your customers to trigger a self-service process.
Forms are commonly used in [user tasks](/components/modeler/bpmn/user-tasks/user-tasks.md/#user-task-forms), but also as [start forms](/components/tasklist/userguide/starting-processes.md) to start a new process instance.

## Camunda Forms

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import IssueLinkedFormSolution04 from './img/linked_issue04.png';
You can use one of the following approaches to link a form to a [user task](/components/modeler/bpmn/user-tasks/user-tasks.md) or a [none start event](/components/modeler/bpmn/none-events/none-events.md#none-start-events).

:::tip
By linking a Camunda Form to a start event, process instances can be started with the form's input [via a public form](/components/modeler/web-modeler/advanced-modeling/publish-public-processes.md) (SaaS only) or directly [in Tasklist](/components/tasklist/userguide/starting-processes.md).
By linking a Camunda Form to a start event, process instances can be started directly [in Tasklist](/components/tasklist/userguide/starting-processes.md).
:::

## Using the link button
Expand Down

This file was deleted.

41 changes: 4 additions & 37 deletions docs/components/modeler/web-modeler/run-or-publish-your-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,10 +98,6 @@ After the process instance has been started, you will receive a notification wit
Starting an instance from Web Modeler [deploys](#deploy-a-process) recent changes to the target cluster, which changes future runs of this process definition in case it has already been deployed and used. Existing process instances are not affected.
:::

:::tip
By [linking a Camunda Form to a start event](/components/modeler/web-modeler/advanced-modeling/form-linking.md), process instances can be started with the form's input [via a public form](#publish-via-a-public-form) (SaaS only) or directly [in Tasklist](#publish-to-tasklist).
:::

### Schedule via timer

You can also schedule a process to run at a specific time or interval using timers. Timers can be added to one or multiple start events of your process.
Expand Down Expand Up @@ -133,6 +129,10 @@ You can also define the success of your processes by setting key performance ind

## Publishing a process

:::note
As of `8.7`, publishing public processes using a public form is no longer supported. Either disable process publishing or use an alternative method for process publishing as outlined below.
:::

Publishing a process means that you make it available to other users inside and outside of Camunda 8. Once published, other users can access and start instances of the process.

You have the following options to publish a process:
Expand All @@ -148,9 +148,6 @@ You have the following options to publish a process:
- [Deploy to run programmatically](#deploy-to-run-programmatically)
- [Publish via webhook](#publish-via-webhook)
- [Publish to Tasklist](#publish-to-tasklist)
- [Publish via a public form](#publish-via-a-public-form)
- [Deploy process to the public](#deploy-process-to-the-public)
- [Get the public link and share it](#get-the-public-link-and-share-it)
- [Listen to message or signal events](#listen-to-message-or-signal-events)
- [Best practices for publishing a process](#best-practices-for-publishing-a-process)
- [Missing client credentials](#missing-client-credentials)
Expand Down Expand Up @@ -199,36 +196,6 @@ To publish a process to Tasklist, you first need to [deploy](#deploy-a-process)

To learn more about publishing processes to Tasklist, refer to our [documentation on Tasklist](../../tasklist/userguide/using-tasklist.md#processes).

### Publish via a public form

<span class="badge badge--cloud">Camunda 8 SaaS only</span>

Publishing a process via a public form allows you to share your process with external users who can start instances of the process without requiring access to Camunda 8. This feature is particularly useful when you want to gather data or initiate a process from users who are not part of your organization or do not have direct access to Camunda. It also allows you to rapidly test a process with your peers in a development environment.

<img src={PublicFormImg} alt="A public form" />

To publish a process via a public form, you first need to [link a Camunda Form](/components/modeler/web-modeler/advanced-modeling/form-linking.md#using-the-link-button) to the process' start event, then you can follow these steps:

#### Deploy process to the public

1. Open the **Publication** section in the **properties panel** (not the tab of the same name) and activate the toggle.

<img src={PublicationSectionImg} style={{width: 400}} alt="Enabling public access in the properties panel" />

2. Click **Deploy** to [deploy](#deploy-a-process) the process and to activate the public form.

Once the process is deployed, a public URL for the form is generated on the target cluster.

#### Get the public link and share it

You can access the URL in the **Publication** tab of the **properties panel**, and share it with any user via email, social media, or any other communication channel.

<img src={PublicLinkImg} style={{width: 400}} alt="Sharing a public link" />

When an external user accesses the public form URL, they can fill in the form fields and submit the data. Upon submission, a new process instance is automatically started in Camunda 8, using the submitted data as input.

For further configuration and how to unpublish a process again, refer to the [full documentation](./advanced-modeling/publish-public-processes.md).

### Listen to message or signal events

Camunda 8 supports message and signal events, which can be used to trigger a process instance when a specific event occurs. Everyone on the platform that knows the message or signal correlation keys can call such a process. To listen to a message or signal event, you need to define a [message](../bpmn/message-events/message-events.md#message-start-events) or [signal start event](../bpmn/signal-events/signal-events.md#signal-start-events) in your process model and configure it to listen for the desired event. Follow these steps to configure a message or signal start event:
Expand Down
18 changes: 2 additions & 16 deletions docs/components/tasklist/userguide/starting-processes.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,20 +44,6 @@ There could be multiple reasons why you are not seeing any process in the **Proc

For all the above scenarios, contact your administrator to understand why no processes are displayed.

## Start public processes via form
## Publishing your process
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@christinaausley We can completely remove this section that describes that process publishing via a start form is not supported on 8.7. This is already mentioned in the documentation related to process publishing in Web Modeler. That way, this document only describes how to start a process from Tasklist.
Wdyt?

For some reason this comment isn't showing up anymore -- @volodymyr-melnykc do you still feel this way?


<span class="badge badge--cloud">Camunda 8 SaaS only</span>

Tasklist offers a convenient method to start processes with a form using a public URL. This functionality relies on process configuration performed in [Web Modeler](/components/modeler/web-modeler/advanced-modeling/publish-public-processes.md), enabling users to create and manage processes.

In scenarios where processes can be triggered through a form, Tasklist hosts the form on a URL that is accessible to all users, eliminating the need for authentication. By submitting the form, the associated process is launched. This feature proves advantageous when you want to expose processes to users outside your organization, as it allows anyone to start a process.

### Usage

#### Process configuration and deployment

To enable the public exposure of a process, the first step involves configuring it to be initiated via a form. This configuration is performed during the process design phase using [Web Modeler](/components/modeler/web-modeler/advanced-modeling/publish-public-processes.md).

#### Accessing and submitting the form

Once the process has been published, a URL will be generated in Tasklist. This URL can be accessed by any user without authentication requirements. Through this endpoint a form is presented and upon submission the associated process is started with the form values being provided as inputs to the process.
As of `8.7`, publishing public processes using a form is no longer supported. Either disable process publishing or use an [alternative method for process publishing](/components/modeler/web-modeler/run-or-publish-your-process.md#publishing-a-process).
1 change: 0 additions & 1 deletion docs/guides/getting-started-orchestrate-human-tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -346,4 +346,3 @@ Don't want to build the process yourself? Click this button to create it from a
- Learn how to write powerful [expressions](/components/concepts/expressions.md) and utilize [variables](/components/concepts/variables.md) to route complex process flows.
- Get an [introduction to Operate](/components/operate/operate-introduction.md).
- Learn how to [set up Tasklist](/components/tasklist/introduction-to-tasklist.md) for efficient task management.
- Explore [start forms](/components/modeler/web-modeler/advanced-modeling/publish-public-processes.md) and attach the form directly to the start event.
6 changes: 6 additions & 0 deletions docs/reference/announcements.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ title: "Announcements"
description: "Important announcements including deprecation & removal notices"
---

## Camunda 8.7

### Process publishing limitation in Web Modeler

As of `8.7`, publishing public processes using a form is no longer supported. Either disable process publishing or use an [alternative method for process publishing](/components/modeler/web-modeler/run-or-publish-your-process.md#publishing-a-process).

## Camunda 8.6

Release date: 8th of Oct 2024
Expand Down
5 changes: 0 additions & 5 deletions optimize_sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -308,11 +308,6 @@ module.exports = {
"Form linking",
"components/modeler/web-modeler/advanced-modeling/form-linking/"
),
docsLink(
"Publish processes via a form",
"components/modeler/web-modeler/advanced-modeling/publish-public-processes/"
),

{
"AI features": [
docsLink(
Expand Down
1 change: 0 additions & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,6 @@ module.exports = {
"components/modeler/web-modeler/advanced-modeling/business-rule-task-linking",
"components/modeler/web-modeler/advanced-modeling/call-activity-linking",
"components/modeler/web-modeler/advanced-modeling/form-linking",
"components/modeler/web-modeler/advanced-modeling/publish-public-processes",
{
"AI features": [
"components/modeler/web-modeler/advanced-modeling/refactoring-suggestions",
Expand Down
5 changes: 3 additions & 2 deletions static/.htaccess
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,12 @@ RewriteRule ^docs/8.6/(.*)$ /docs/$1 [R=302,L]
RewriteRule ^optimize/3.14.0/(.*)$ /optimize/$1 [R=302,L]

# 8.7 content moves vvvv
# ----------------------
# None here yet, but please place them here when you have them.

# Move alpha features to components
RewriteRule ^docs/next/reference/alpha-features/?$ /docs/next/components/early-access/alpha/alpha-features/$1 [R=301,L]
RewriteRule ^docs/next/components/modeler/web-modeler/advanced-modeling/publish-public-processes/?$ /docs/next/components/modeler/web-modeler/run-or-publish-your-process/$1 [R=301,L]

# ----------------------

# Remove the Getting Started partials as full pages
RewriteRule ^docs/guides/react-components/sm-prerequisites/?$ /docs/guides/$1 [R=301,L]
Expand Down
Loading
Loading