Skip to content

Commit

Permalink
resolve comments
Browse files Browse the repository at this point in the history
  • Loading branch information
christinaausley committed Oct 11, 2024
1 parent 1030e6f commit 1aeb3c5
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 22 deletions.
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
id: camunda-rpa-framework-library
title: Camunda RPA framework library
id: rpa-framework-library
title: RPA framework library
description: "Learn how Camunda offers a custom library for the RPA framework, providing out-of-the-box functionality to manipulate Camunda variables within RPA scripts."
---

Camunda offers a custom library for the **robotic process automation (RPA)** framework, providing out-of-the-box functionality to manipulate [Camunda variables](/components/concepts/variables.md) within RPA scripts.

## Including the Camunda library

To use Camunda-provided keywords, add the Camunda library in the [Camunda RPA runtime documentation](/components/experimental/rpa/rpa-integration-with-camunda.md) to your Robot file:
To use Camunda-provided keywords, import the Camunda library into your Robot file. The Camunda library is only available within the [Camunda RPA runtime](/components/experimental/rpa/rpa-integration-with-camunda.md).

```powershell
```robot
*** Settings ***
Library Camunda
Expand All @@ -23,8 +23,8 @@ To set a process variable in Camunda from within an RPA script, use the keyword

### Syntax

```powershell
Set Output Variable {variable_name} {value}
```robot
Set Output Variable {variableName} {value}
```

### Parameters
Expand All @@ -34,7 +34,7 @@ Set Output Variable {variable_name} {value}

### Example

```powershell
```robot
Set Output Variable customerName John Doe
```

Expand All @@ -44,7 +44,7 @@ This command sets a variable named `customerName` with the value `John Doe` in t

The following example demonstrates a script that solves the first challenge at [rpachallenge.com](https://rpachallenge.com/) and returns the result message to Camunda:

```powershell
```robot
*** Settings ***
Documentation Robot to solve the first challenge at rpachallenge.com,
... which consists of filling a form that randomly rearranges
Expand Down
19 changes: 9 additions & 10 deletions docs/components/experimental/rpa/rpa-integration-with-camunda.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
---
id: rpa-integration-with-camunda
title: RPA integration with Camunda
id: rpa-integration
title: RPA integration
description: "Learn how Camunda enables orchestration of simple robotic process automation (RPA) tasks within Camunda 8 based on the RPA Framework."
---

Camunda enables orchestration of simple **robotic process automation (RPA)** tasks within Camunda 8 based on the [RPA Framework](https://rpaframework.org/). The RPA integration consists of two primary components: RPA runtime and the Camunda Desktop Modeler plugin.
Camunda enables orchestration of simple **robotic process automation (RPA)** tasks within Camunda 8 based on the [RPA Framework](https://rpaframework.org/). The RPA integration consists of two primary components: RPA runtime and the [Camunda Desktop Modeler](/components/modeler/about-modeler.md) plugin.

## RPA runtime

The RPA runtime facilitates the execution of your RPA scripts and is suitable for both local testing and script execution from your Camunda SaaS cluster.
The RPA runtime facilitates the execution of your RPA scripts and is suitable for both local testing and script execution from your Camunda SaaS [cluster](//guides/create-cluster.md).

- **For a full development setup**: Visit the [Camunda Prototype RPA Worker GitHub repository](https://github.com/camunda/rpa-runtime).
- **For a Windows setup without Python**: Take the following steps:

1. Download the [RPA runner repository](https://github.com/camunda/rpa-runtime/archive/refs/heads/main.zip) from GitHub.
2. Unzip the file and navigate to the `rpa-runtime-main` repository folder.
3. Execute `setup.ps1` using PowerShell. If permission issues arise, alter your Execution Policy with the command `Set-ExecutionPolicy RemoteSigned`.
4. Enter your credentials into the .env file. Refer to [the documentation on how to create credentials](/components/console/manage-clusters/manage-api-clients.md#create-a-client).
5. Start the RPA worker locally by running `start.ps1` in PowerShell. To stop the worker, close the PowerShell terminal.
1. Download the [RPA runner repository](https://github.com/camunda/rpa-runtime/archive/refs/heads/main.zip) from GitHub.
2. Unzip the file and navigate to the `rpa-runtime-main` repository folder.
3. Execute `setup.ps1` using PowerShell. If permission issues arise, alter your Execution Policy with the command `Set-ExecutionPolicy RemoteSigned`.
4. Enter your credentials into the .env file. Refer to [the documentation on how to create credentials](/components/console/manage-clusters/manage-api-clients.md#create-a-client).
5. Start the RPA worker locally by running `start.ps1` in PowerShell. To stop the worker, close the PowerShell terminal.

### Directories

Expand Down
9 changes: 5 additions & 4 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -700,10 +700,11 @@ module.exports = {
{
type: "category",
label: "Robotic Process Automation (RPA)",
items: [
"components/experimental/rpa/rpa-integration-with-camunda",
"components/experimental/rpa/camunda-rpa-framework-library",
],
link: {
type: "doc",
id: "components/experimental/rpa/rpa-integration",
},
items: ["components/experimental/rpa/rpa-framework-library"],
},
],
},
Expand Down

0 comments on commit 1aeb3c5

Please sign in to comment.