rework RPA docs #5307
rework RPA docs #5307
Conversation
christinaausley
added
component:docs
|
👋 🤖 🤔 Hello, @marstamm! Did you make your changes in all the right places? These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.6/.
You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines. |
|
[FYI] we now have the Library documentation on Github: https://camunda.github.io/rpa-python-libraries/ and may link to this in this PR. |
|
Thank you for the rework @christinaausley ! I'll review this tomorrow. I have some wip for variable handling in RPA, I'll merge it to this branch as well so we can review everything in a single place |
|
For simplicity, I added commits to the branch instead of leaving comments. I added 2 new sections ( Since we now also support BPMN errors in the worker, I removed the FAQ and moved Incident handling to Interacting with the process, and scaling the bots to the production page. I tried to structure my commits by topic, happy to hear your feedback on my suggestions 😄 |
| In the `rpa-worker.properties`, add `camunda.rpa.zeebe.worker-tags=accounting-system`. This worker will now only take up jobs | ||
| which are labeled `accounting-system`. If you also want the worker to work on unlabeled tasks, use `camunda.rpa.zeebe.worker-tags=default,accounting-system` instead. | ||
| Each worker can have multiple labels and will pick up waiting jobs from all scripts. | ||
|
|
||
| You can add labels to your script when configuring the RPA task in your diagram. Note that a script can only have a single label. | ||
|
|
||
| Labels describe capabilities. If you want your worker to only pick up a specific script, you will need to use a unique label on both the worker and the RPA task. A worker can have multiple labels and will pick up any script that matches one of the given tags. For example, your worker might have access to the SAP application, but if you also want it to pick up browser automation tasks, add `SAP,BROWSER_AUTOMATION` to your worker tags. This will pick up tasks tagged as `SAP` and tasks tagged as `BROWSER_AUTOMATION`. |
There was a problem hiding this comment.
SAP,BROWSER_AUTOMATION
This is intentionally a comma, yes? @marstamm
There was a problem hiding this comment.
Yes. On the Worker, we have a comma-separated list of Labels
|
Nice collaboration here @marstamm. I made some minor grammar changes but this looks good for review. |
|
I am also going to loop in this issue, so this PR will also close #5225. As such, I am going to add a few comments I may have as a beginner to RPA @marstamm @natanielstrack |
|
|
||
| <!-- TODO(marstamm): The modeler flag is only required in the alpha releases. Remove this caution for 8.7 minor relase --> | ||
|
|
||
| :::caution | ||
| In Camunda Modeler 5.33.1, the RPA editor is enabled only if the `--no-disable-rpa` flag is set. Visit the [Modeler documentation](/components/modeler/desktop-modeler/flags/flags.md) to learn about setting flags. | ||
| ::: | ||
|
|
||
| To get started with RPA, you first need to write an RPA script. [Camunda Modeler](/components/modeler/about-modeler.md) offers an interface for editing and testing your scripts: | ||
|
|
||
| 1. **Download Camunda Modeler**: Download the latest version of Camunda Modeler from the [Camunda website](https://camunda.com/download/modeler/). As RPA scripts are run locally on your machine, the RPA editor is only available in [Desktop Modeler](/components/modeler/desktop-modeler/index.md). | ||
| 2. **Open the RPA script editor**: Open Desktop Modeler and navigate to the RPA script editor under **Testing**. | ||
|  | ||
| 3. **Start writing your RPA script using Robot Framework**: Use the interface provided to write your first RPA script. Scripts use the [Robot Framework](https://robotframework.org/) syntax. |
There was a problem hiding this comment.
What would be an example script if I am also a beginner to Robot Framework, or something I could just plug in to see how this works in Desktop Modeler?
There was a problem hiding this comment.
There is an example script when you open a new RPA script in the Modeler. It will do browser automation an solve https://www.rpachallenge.com/
| To get started with RPA, you first need to write an RPA script. [Camunda Modeler](/components/modeler/about-modeler.md) offers an interface for editing and testing your scripts: | ||
|
|
||
| 1. **Download Camunda Modeler**: Download the latest version of Camunda Modeler from the [Camunda website](https://camunda.com/download/modeler/). As RPA scripts are run locally on your machine, the RPA editor is only available in [Desktop Modeler](/components/modeler/desktop-modeler/index.md). | ||
| 2. **Open the RPA script editor**: Open Desktop Modeler and navigate to the RPA script editor under **Testing**. | ||
|  | ||
| 3. **Start writing your RPA script using Robot Framework**: Use the interface provided to write your first RPA script. Scripts use the [Robot Framework](https://robotframework.org/) syntax. | ||
|
|
||
| ### Test your script | ||
| ## Test your script | ||
|
|
||
| Once you have written your script, you can test it on a local RPA worker. | ||
|
|
There was a problem hiding this comment.
Below we say "4. Start the worker by running the executable." -- what do we mean by this? Is this a particular line everyone uses in the terminal or is this unique to every user?
There was a problem hiding this comment.
I adjusted the wording to make it clearer what to execute. The filename and how to start it depends on your operating system
| @@ -40,11 +43,11 @@ Once you have written your script, you can test it on a local RPA worker. | |||
| 2. Review the execution log and the variables created during the script execution within Modeler. | |||
There was a problem hiding this comment.
Check Desktop Modeler: Ensure the RPA worker is now connected to Desktop Modeler. The worker should automatically connect. If not, ensure the connection URL is correct.
How do you ensure the connection URL is correct? Is this under a particular UI component?
There was a problem hiding this comment.
Yes, this is a UI component. Maybe we can make it clearer how to get to the config view:
- Check Desktop Modeler: Ensure the RPA worker is now connected to Desktop Modeler. The worker should automatically connect. If not, click on the connection status to display additional configuration options.
| @@ -65,7 +68,7 @@ Once you are happy with your script and have tested it locally, you can start au | |||
| 1. Deploy the BPMN model with the configured RPA task. | |||
There was a problem hiding this comment.
- Deploy the BPMN model with the configured RPA task.
We should probably note how to deploy here, same with starting an instance.
There was a problem hiding this comment.
The pattern is the same as the RPA file (🚀 icon). We can align the wording
| 1. Deploy the BPMN model with the configured RPA task. | |
| 1. Deploy the BPMN model with the configured RPA task by clicking on the rocket (🚀) icon in Modeler. |
| @@ -12,3 +12,5 @@ Camunda uses RPA to facilitate the integration of legacy applications without ac | |||
| Camunda's RPA functionality is built around a standalone RPA worker and [Robot Framework](https://robotframework.org/)-based RPA scripts. This setup allows users to develop and execute RPA scripts that integrate seamlessly with existing Camunda stacks. | |||
There was a problem hiding this comment.
Robotic Process Automation (RPA) allows you to automate manual, repetitive tasks by interacting with applications directly. Camunda uses RPA to facilitate the integration of legacy applications without accessible APIs into your process orchestration.
What types of applications, for example, are we talking about here?
There was a problem hiding this comment.
There is a wide range of Applications, such as Legacy Mainframe Applications, Desktop Applications such as ERP systems, or Websites without exposed APIs.
|
The preview environment relating to the commit 39b946d has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-5307/index.html |
Description
Closes #5256 -- adding feedback from @bastiankoerber courtesy of notes from @marstamm.
Perhaps we can create a separate issue for an architecture diagram?
When should this change go live?
bugorsupportlabel)available & undocumentedlabel)holdlabel)low priolabel)PR Checklist
/docsdirectory (version 8.8)./versioned_docs/version-8.7/directory (version 8.7)./versioned_docsdirectory.@camunda/tech-writersunless working with an embedded writer.