Robomotion

https://docs.robomotion.io/
Admin
Robomotion is a cloud-native Robotic Process Automation (RPA) platform powered by AI Agents,...
Tokens:40,007
Snippets:692
Trust Score:8.5
Update:3 months ago
Show doc for...
Tokens:
Raw
### Define Bot Setup Schema

Source: https://docs.robomotion.io/blog/tags/personalized

Use this JSON object in the Bot Setup popup to define the required input fields and UI layout for the bot configuration screen.

```json
{
  "schema": {
    "type": "object",
    "required": [
      "outreachVideoURL",
      "outreachCompaniesCSV"
    ],
    "properties": {
      "outreachVideoURL": {
        "type": "string"
      },
      "outreachCompaniesCSV": {
        "type": "string"
      },
      "loomCookie": {
        "type": "string"
      }
    }
  },
  "ui_schema": {
    "type": "VerticalLayout",
    "elements": [
      {
        "type": "HorizontalLayout",
        "elements": [
          {
            "type": "Control",
            "scope": "#/properties/outreachVideoURL"
          }
        ]
      },
      {
        "type": "HorizontalLayout",
        "elements": [
          {
            "type": "Control",
            "scope": "#/properties/outreachCompaniesCSV"
          }
        ]
      },
      {
        "type": "HorizontalLayout",
        "elements": [
          {
            "type": "Control",
            "scope": "#/properties/loomCookie"
          }
        ]
      }
    ]
  }
}
```

--------------------------------

### Example Home Directory Paths

Source: https://docs.robomotion.io/blog/scale-personalized-outreach-videos-with-cloud-run

Provides valid path formats for different operating systems to be used in the configuration node.

```text
For Windows, it is "C:/Users/John/Outreach"  
For Linux, it is "/home/john/outreach"  
For Mac, it is "/Users/john/outreach"  
```

--------------------------------

### Set Home Directory Path

Source: https://docs.robomotion.io/blog/tags/video

Example of assigning a specific directory path to the msg.home variable for Windows.

```javascript
msg.home = "C:/Users/John/Outreach"
```

--------------------------------

### Define Bot Setup Schema

Source: https://docs.robomotion.io/blog/scale-personalized-outreach-videos-with-cloud-run

JSON configuration defining the required input fields for the Outreach Video Creator bot, including video URL, CSV data, and optional authentication cookies.

```json
{
  "schema": {  
    "type": "object",  
    "required": [  
      "outreachVideoURL",  
      "outreachCompaniesCSV"  
    ],  
    "properties": {  
      "outreachVideoURL": {  
        "type": "string"  
      },  
      "outreachCompaniesCSV": {  
        "type": "string"  
      },  
      "loomCookie": {  
        "type": "string"  
      }  
    }  
  },  
  "ui_schema": {  
    "type": "VerticalLayout",  
    "elements": [  
      {  
        "type": "HorizontalLayout",  
        "elements": [  
          {  
            "type": "Control",  
            "scope": "#/properties/outreachVideoURL"  
          }  
        ]  
      },  
      {  
        "type": "HorizontalLayout",  
        "elements": [  
          {  
            "type": "Control",  
            "scope": "#/properties/outreachCompaniesCSV"  
          }  
        ]  
      },  
      {  
        "type": "HorizontalLayout",  
        "elements": [  
          {  
            "type": "Control",  
            "scope": "#/properties/loomCookie"  
          }  
        ]  
      }  
    ]  
  }  
}
```

--------------------------------

### Define Assistant variables in a Function node

Source: https://docs.robomotion.io/blog/how-to-make-a-simple-interface-with-assistant-nodes

Use this JavaScript code within a Function node named 'Setups' to initialize the assistant's header, message, and labels.

```javascript
msg.header = "Robomotion Assistant"; // Enter a name for your assistant.  
msg.message = "How can I help you ?"; // Enter the message your assistant wants to send.  
  
msg.labels = ["Start"]; // The message you want to send to the assistant.  
  
msg.message_ = ""; // Enter the message your assistant wants to send.  
  
return msg;  
```

--------------------------------

### GET /v1/jobs.list

Source: https://docs.robomotion.io/reference/api

Retrieves a list of jobs available in the workspace.

```APIDOC
## GET /v1/jobs.list

### Description
Retrieves a list of jobs available in the workspace.

### Method
GET

### Endpoint
/v1/jobs.list
```

--------------------------------

### GET /v1/schedules.list

Source: https://docs.robomotion.io/reference/api

Retrieves a list of schedules available in the workspace.

```APIDOC
## GET /v1/schedules.list

### Description
Retrieves a list of schedules available in the workspace.

### Method
GET

### Endpoint
/v1/schedules.list
```

--------------------------------

### GET /v1/users.list

Source: https://docs.robomotion.io/reference/api

Retrieves a list of users available in the workspace.

```APIDOC
## GET /v1/users.list

### Description
Retrieves a list of users available in the workspace.

### Method
GET

### Endpoint
/v1/users.list
```

--------------------------------

### GET /v1/robots.list

Source: https://docs.robomotion.io/reference/api

Retrieves a list of robots available in the workspace.

```APIDOC
## GET /v1/robots.list

### Description
Retrieves a list of robots available in the workspace.

### Method
GET

### Endpoint
/v1/robots.list
```

--------------------------------

### GET /v1/flows.list

Source: https://docs.robomotion.io/reference/api

Retrieves a list of flows available in the workspace.

```APIDOC
## GET /v1/flows.list

### Description
Retrieves a list of flows available in the workspace.

### Method
GET

### Endpoint
/v1/flows.list
```

--------------------------------

### Configure Home Directory Path

Source: https://docs.robomotion.io/blog/scale-personalized-outreach-videos-with-cloud-run

Sets the target directory for generated videos and output files on Windows systems.

```javascript
msg.home = "C:/Users/John/Outreach"  
```

--------------------------------

### Initialize website URL variable

Source: https://docs.robomotion.io/blog/tags/cap-monster-package

Sets the target URL for the automation flow within a Function node.

```javascript
msg.website_url = "https://www.google.com/recaptcha/api2/demo"; //The website_url variable use to aceess website.  
return msg;   
```

--------------------------------

### List available capture devices via FFmpeg

Source: https://docs.robomotion.io/blog/tags/video

Run this command in the macOS Terminal to list available capture devices and their corresponding index numbers.

```bash
$HOME/.config/robomotion/packages/bin/Robomotion/FFmpeg/0.2.3/ffmpeg -f avfoundation -list_devices true -i ""
```

--------------------------------

### Accessing Variables in Function Nodes

Source: https://docs.robomotion.io/reference/products/designer/variables

Retrieve values from Global, Flow, or Local scopes within a Function node using the get method.

```javascript
var gVar1 = global.get("var1"); // This is how you get a Global scoped variable value  
  
var fVar2 = flow.get("var2"); // This is how you get a Flow scoped variable value  
  
var lVar3 = local.get("var3"); // This is how you get a Function scoped local variable value  
```

--------------------------------

### List available AVFoundation capture devices

Source: https://docs.robomotion.io/blog/scale-personalized-outreach-videos-with-cloud-run

Execute this command in the terminal to identify the correct capture device index for your Mac.

```bash
$HOME/.config/robomotion/packages/bin/Robomotion/FFmpeg/0.2.3/ffmpeg -f avfoundation -list_devices true -i ""  
```

--------------------------------

### Configure file download variables

Source: https://docs.robomotion.io/blog/how-download-a-file-from-the-web

Define the source file path and the destination save path within a function node.

```javascript
msg.FilePath = ""; // [Required] Path to the file you want to download  
msg.FileDownloadPath = ""; // [Required] The path to will save the document you want to download  
  
return msg;  
```

--------------------------------

### XPath Selector for Currency Value

Source: https://docs.robomotion.io/tutorials/browser-automation

Use this XPath expression in the Get Value node to target the converted currency amount on the search results page.

```xpath
//*[@data-value]
```

--------------------------------

### Configure PDF download paths and URL

Source: https://docs.robomotion.io/blog/how-to-auto-pdf-download-in-chrome-browser

Defines the user directory, download path, and target PDF URL within a Robomotion function node.

```javascript
//User Directory Path to save Chrome settings   
msg.user_directory_path = "YourUserDataDirFolderPath";  
//Download Path to save PDF files  
msg.download_path = "YourDownloadFolderPath";  
//Give a url for the pdf file to download  
msg.url = "https://www.fedex.com/content/dam/fedex/us-united-states/services/Fees_Shipping_Information.pdf";  
return msg;
```

--------------------------------

### Initialize Data Table and CSV Path

Source: https://docs.robomotion.io/blog/how-to-update-data-table-rows

Defines the CSV output path and the initial structure of the data table within a Function node.

```javascript
msg.csv_path = "C:\\Robomotion\\Templates\\myCSV.csv"; //The path to the CSV file where the output will be saved.  
  
msg.table = {  
  columns: ["Name", "Surname", "Age"],  
  rows: [{  
      Name: 'Jack',  
      Surname: 'Smith',  
      Age: 21  
    },  
    {  
      Name: 'Harry',  
      Surname: '',  
      Age: 30  
    },  
    {  
      Name: 'Charlie',  
      Surname: '',  
      Age: 50  
    }  
  ]  
};  
  
return msg;
```

--------------------------------

### For Each Loop Flow Configuration

Source: https://docs.robomotion.io/reference/products/designer/for-each

Copy this JSON structure and paste it into your flow board to test the For Each loop implementation.

```json
{"nodes":[{"id":"0533a62b-2dd4-42b5-a095-84bdeb58da3b","type":"simple","selected":true,"x":480,"y":390,"extras":{"inPayload":{"scope":"JS","name":"Date.now()"},"outPayload":{"scope":"Message","name":"payload"},"optRepeat":1,"optOnce":true,"optOnceDelay":0.1},"ports":[{"id":"5c3d76d2-1de3-4a4d-92fc-0344c87f07f8","type":"default","selected":false,"name":"out_5c3d76d2-1de3-4a4d-92fc-0344c87f07f8","parentNode":"0533a62b-2dd4-42b5-a095-84bdeb58da3b","links":["9bf51ff1-6aff-41a8-a024-cb201d3dbccc"],"in":false,"label":"simple","position":"out"}],"model":{"id":"0533a62b-2dd4-42b5-a095-84bdeb58da3b","name":"Start","icon":"M10,9A1,1 0 0,1 11,8A1,1 0 0,1 12,9V13.47L13.21,13.6L18.15,15.79C18.68,16.03 19,16.56 19,17.14V21.5C18.97,22.32 18.32,22.97 17.5,23H11C10.62,23 10.26,22.85 10,22.57L5.1,18.37L5.84,17.6C6.03,17.39 6.3,17.28 6.58,17.28H6.8L10,19V9M11,5A4,4 0 0,1 15,9C15,10.5 14.2,11.77 13,12.46V11.24C13.61,10.69 14,9.89 14,9A3,3 0 0,0 11,6A3,3 0 0,0 8,9C8,9.89 8.39,10.69 9,11.24V12.46C7.8,11.77 7,10.5 7,9A4,4 0 0,1 11,5Z","color":"#FDD835","namespace":"Core.Trigger.Inject","version":"0.0.0","abc":[{"name":"Start","color":"#FDD835","version":"0.0.0"},{"inPayload":{"scope":"JS","name":"Date.now()"}},{"outPayload":{"scope":"Message","name":"payload"}},{"optRepeat":1,"optOnce":true,"optOnceDelay":0.1}],"xyz":[{"schema":{"title":"Input","type":"object","properties":{"inPayload":{"type":"object","title":"Payload","variableType":"String","customScope":true,"jsScope":true,"argsScope":true,"properties":{"scope":{"type":"string"},"name":{"type":"string"}}}}},"uiSchema":{"inPayload":{"ui:field":"variable"}},"formData":{"inPayload":{"scope":"JS","name":"Date.now()"}}},{"schema":{"title":"Output","type":"object","properties":{"outPayload":{"type":"object","title":"Payload","variableType":"String","messageOnly":true,"properties":{"scope":{"type":"string"},"name":{"type":"string"}}}}},"uiSchema":{"outPayload":{"ui:field":"variable"}},"formData":{"outPayload":{"scope":"Message","name":"payload"}}},{"schema":{"title":"Options","type":"object","properties":{"optRepeat":{"title":"Repeat Interval (sec)","type":"number"},"optOnce":{"title":"Once","type":"boolean"},"optOnceDelay":{"title":"Once Delay (sec)","type":"number"}}},"uiSchema":{"ui:order":["optRepeat","optOnceDelay","optOnce"],"optRepeat":{"ui:field":"input"},"optOnce":{"ui:field":"input"},"optOnceDelay":{"ui:field":"input"}},"formData":{"optRepeat":1,"optOnce":true,"optOnceDelay":0.1}}],"outputs":1,"inputs":0}},{"id":"298aaf7e-4dc5-49f3-a9aa-a7c049f60093","type":"simple","selected":true,"x":750,"y":390,"extras":{"outputs":1,"func":"msg.fruits=[\"Apple\", \"Orange\", \"Banana\"];\nreturn msg;\n","optTimeout":30,"variables":[]},"ports":[{"id":"b5806375-74ad-41fc-b682-8c33bceab9d1","type":"default","selected":false,"name":"out_b5806375-74ad-41fc-b682-8c33bceab9d1","parentNode":"298aaf7e-4dc5-49f3-a9aa-a7c049f60093","links":["4d1d03c6-6a44-4b60-97a6-e90d3ac02973"],"in":false,"label":"simple","position":"out"},{"id":"7dc5839a-3b96-48c8-add3-8f26938d55a4","type":"default","selected":false,"name":"in","parentNode":"298aaf7e-4dc5-49f3-a9aa-a7c049f60093","links":["9bf51ff1-6aff-41a8-a024-cb201d3dbccc"],"in":true,"label":"simple","position":"in"}],"model":{"id":"298aaf7e-4dc5-49f3-a9aa-a7c049f60093","name":"Prepare Array","icon":"M15.6,5.29C14.5,5.19 13.53,6 13.43,7.11L13.18,10H16V12H13L12.56,17.07C12.37,19.27 10.43,20.9 8.23,20.7C6.92,20.59 5.82,19.86 5.17,18.83L6.67,17.33C6.91,18.07 7.57,18.64 8.4,18.71C9.5,18.81 10.47,18 10.57,16.89L11,12H8V10H11.17L11.44,6.93C11.63,4.73 13.57,3.1 15.77,3.3C17.08,3.41 18.18,4.14 18.83,5.17L17.33,6.67C17.09,5.93 16.43,5.36 15.6,5.29Z","color":"#F27925","editor":"javascript","namespace":"Core.Programming.Function","version":"0.0.0","abc":[{"name":"Prepare Array","version":"0.0.0","color":"#F27925","delayBefore":0,"delayAfter":0,"continueOnError":false},{"outputs":1,"func":"msg.fruits=[\"Apple\", \"Orange\", \"Banana\"];\nreturn 
```

--------------------------------

### Create SQLite Table

Source: https://docs.robomotion.io/blog/how-to-insert-date-time-into-sqlite

Defines a table schema with TEXT and DATETIME column types.

```sql
CREATE TABLE IF NOT EXISTS 'products'  
(  
   'productTitle' TEXT, -- Column Type TEXT,  
   'orderDate' DATETIME,  
   'deliveryDate' DATETIME  
);  
```

--------------------------------

### Configure Blog Post Variables in JavaScript

Source: https://docs.robomotion.io/blog/how-to-write-automaticbog-posts-using-openai

Defines the necessary variables for blog topic, prompts, and WordPress integration within a Robomotion function node.

```javascript
msg.title = "Climate change jeopardizes sustainable development."; //[Required] Topic of the blog post.  
msg.prompt = "Write a blog post covering this topic, not exceeding 4 paragraphs: " + msg.title;  
msg.prompt_ = "Natural events caused by climate change."; //[Required] Converts typed text into a realistic image.  
msg.negative_prompt = "Drought, flood, global warming, thirst."; //[Required] Converts typed text into a realistic image.  
msg.image_path = ""; //[Required] File path from which the image was downloaded.  
msg.wordpress_url = ""; //[Required] Your WordPress link.  
return msg;
```

--------------------------------

### Define Input Values

Source: https://docs.robomotion.io/blog/how-to-insert-date-time-into-sqlite

Assigns product and date values to the message object for database insertion.

```javascript
msg.productTitle = "Pencil";  
msg.orderDate = "2023-07-01";  
msg.deliveryDate = "03.07.2023";  
return msg;  
```
Tokens:
Raw