Hey Rainbird Community members,

Our founders @James Duez and @Ben Taylor are holding a free online training session on Tuesday 7 December, 3–4pm GMT. 

In it, you'll learn how to scale and accelerate your RPA in a matter of hours, by separating process and decision logic. 

One Rainbird user found that an RPA process (that would normally take them 2–3 weeks to build) only took them an hour using Rainbird to encode decision logic.

In this free online training session, our founders will show you how you can take advantage of the technique. They'll share with you:

• How to create a sensible RPA system architecture, by separating process and decision logic, using Rainbird
• A real-life use case build-along
• Tips to get you started

Register:

To join the session free, sign up here.

This is the training material for Workflow, Rainbird's embedded integration tool.

The three workflows references are:

• Training workflow 1
• Training workflow 2
• Training workflow 3

See also the Workflow Training content.

This workflow collects information in a form, and injects it into a Rainbird query. If Rainbird can get a result with the information provided it will email it, otherwise it will email an agent link so that the query can be completed manually.

To use this workflow, first download and import the attached Hello World for Workflow.rbird file into your Rainbird platform.

Forms > FormTrigger component

This component collects a name, country of residence and email address from the user.

• Form Title – Enter the name of the form (optional)
• Form description – Enter a description for the form (optional)
• Form fields (1)
  • Label – Enter Name
  • Description – Enter The person’s name (optional)
  • Type – Select Text
  • Default Value – Enter Name (optional)
  • Index – Leave blank
• Form fields (2)
  • Label – Enter Country
  • Description – Enter The person’s country of residence (optional)
  • Type – Select Text
  • Default Value – Enter Country of residence (optional)
  • Index – Leave blank
• Form fields (3)
  • Label – Enter Email address
  • Description – Enter Your email address (optional)
  • Type – Select Email
  • Default Value – Enter Email address (optional)
  • Index – Leave blank
• Call to action – Enter Submit (or other button label)
• Thanks Message – Enter Check your emails for the answer, or a link if more info is needed. (optional)
• Thanks Image URL – Leave blank (optional)
• Script – Leave blank
• Stylesheet – Leave blank.

Rainbird > Start component

This component links the workflow to a specific Rainbird map.

• Base URL – Community (or other environment if applicable)
• API key – Enter your Rainbird API key
• Knowledge Map ID – Enter the ID for the knowledge map you want to query

Rainbird > Inject component

This component will take the data from the form and inject it as facts into Rainbird.

• Base URL – Click on the menu icon and select Start: Base URL
• Session ID – Click on the menu icon and select Start: Session ID
• Data – Here you have to specify the facts to be injected into Rainbird:
• Click on the menu and select Name.
• Add a comma , (make sure there are no spaces either side of it)
• Type lives in (the name of the relationship you are creating facts for)
• Add a comma , (make sure there are no spaces either side of it)
• Click on the menu and select Country.

Rainbird > Query component

This component will query the Rainbird map using the data collected in the form.

• Base URL – Click on the menu and select Start: Base URL
• Session ID – Click on the menu and select Start: Session ID
• Subject – Click on the menu and select Name
• Relationship – Enter might speak
• Object – Leave blank

Filter > Contains component

This will look at the results of the Rainbird query, and filter the result depending on whether or not the query has been answered. It has two out ports, corresponding to whether the data contains or does not contain the specified text. This component effectively carries our an ‘OR’ action.

• Data – Click on the menu and select Raw Output
• Contains – type prompt (if Rainbird cannot calculate an answer the output will contain this)

Rainbird > Agent Action component

This component will create a Rainbird agent so the user can interact with the tool and get a result.

There are two Out ports: ‘Agent’ Provides the URL for the agent, and Out sends the result of the query, if required (it will not be used In this flow as the result will just be displayed in the agent screen).

NOTE: Connect this component to the “contains” out port on the Filter > Contains component.

• Base URL - Community (or other environment if applicable)
• Session ID – Select Start: Session ID
• Subject – Select Name
• Relationship – might speak (i.e. the name of the relationship being queried in the Rainbird map – this cannot be selected, so should ideally be copied and pasted from the map)
• Object – Leave blank (as this will be provided by the Rainbird map)

Email > SendEmail component

This will send an email with the Rainbird agent link to the email address collected in the form. The user will be able to click on the link and interact with Rainbird.

NOTE: Connect this component to the “agent” out port on the Rainbird > Agent Action component.

• To – Click on the menu icon and select Email address
• From – leave blank
• Reply to – leave blank
• Subject – Agent link (or whatever else you want the email’s title to be)
• Attachment file – leave blank
• Text – Click on the menu and select Web link. You can add any other explanatory text you wish too.
• HTML – Leave blank

Email > SendEmail component

This will send an email with the result of the query to the email address collected in the form

NOTE: Connect this component to the “agent” out port on the Rainbird > Agent Action component.

• To – Click on the menu icon and select Email address
• From – leave blank
• Reply to – leave blank
• Subject – Agent link (or whatever else you want the email’s title to be)
• Attachment file – leave blank
• Text:
  • Click on the menu and select Name
  • Type speaks (with a space each side)
  • Click on the menu and select Query: Results
    • Click on Query: Results
    • Click on Add modifier and select JSON Path
    • In path type [0].object

• HTML – Leave blank

Running your workflow

Your flow is now ready to be run. Click the Start Flow button, then go to the Form Trigger component and copy the Form URL. 

Paste this into your browser and complete the form:

• If Rainbird can get an answer using the information provided it will be emailed to you.
• If Rainbird can’t reach an answer using the information provided It will email you a link to an agent so you can complete the query manually.

See also the Workflow Training content.

This workflow reads the data from rows in a CSV file in Google Drive, injects it into Rainbird, and outputs the results to a Google sheet.

To use this workflow:

• Download and import the attached Hello World for Workflow.rbird file into your Rainbird platform.
• Upload the attached Data for workflow demo.csv file to Google Drive
• Create a new Google sheet with two columns labelled “Name” and “Result”.

Controls > OnStart component

This component starts the workflow.

Google Drive > ExportFile component

This component will get a specific file from Google Drive (‘export’ refers to exporting the file from Google Drive).

• Google account - click the Connect new account button and follow the instructions for logging into your Google account
• File – Now your Google account is connected you will be able to select the Data for workflow demo.csv file in your Google Drive

CSV > GetRows

This component will extract the information in the CSV file, row by row.
Note: Make sure you use GetRows, not GetRow!

• Use column names – True
• Filter Rows – False
• File ID – Click on the Menu icon and select File ID from the ExportFile component
• Delimiter – Enter a comma ,
• Row format – Object
• All rows in one message – False

Rainbird > Start component

This component links the workflow to a specific Rainbird map.

• Base URL – Community (or other environment if applicable)
• API key – Enter your Rainbird API key
• Knowledge Map ID – Enter the ID for the knowledge map you want to query

Rainbird > Inject component

This component will take the data from the CSV file and inject it as facts into Rainbird.

• Base URL – Click on the menu icon and select Start: Base URLI
• Session ID – Click on the menu icon and select Start: Session ID
• Data – Here you have to specify the facts to be injected into Rainbird:
  • Click on the menu and select Rows.
  • Click on the Rows and in ‘Add modifier’ select JSON Path
    • Path – type Person

•  
  • Add a comma , (make sure there are no spaces either side of it)
    • Type lives in (the name of the relationship you are creating facts for)
    • Add a comma , (make sure there are no spaces either side of it)
    • Click on the menu and select Rows.
      • Click on the Rows and in ‘Add modifier’ select JSON Path
      • Path – type Country

Rainbird > Query component

This component will query the Rainbird map, once for each row in the CSV file.

• Base URL – Click on the menu and select Start: Base URL
• Session ID – Click on the menu and select Start: Session ID
• Subject – Click on the menu and select Rows
  • Click on the Rows and in ‘Add modifier’ select JSON Path
  • Path – Enter Person

• Relationship – Enter might speak
• Object – Leave blank

Google Sheets > CreateRow component

This will take the person’s name and the answer of each query and write it to a new row in the Google sheet.

• Google account – this should already be linked
• Spreadsheet – Click and select the results spreadsheet you created
• Worksheet – Click and select Sheet1 (or whichever sheet you want the answers to be written to)
• Name – Click on the menu and select Rows
  • Click on the Rows and in ‘Add modifier’ select JSON Path
  • Path – Enter Person

• Result - Click on the menu and select Query: Results
  • Click on the Rows and in ‘Add modifier’ select JSON Path
  • Path – Enter [0].object

Running your workflow

Your flow is now ready to be run. Click the Start Flow button. The workflow should automatically add new rows with the person’s name and the language they speak in the results spreadsheet.

See also the Workflow Training content.

This workflow gathers a name and email address via an online form, then sends a link to the Rainbird agent via email.

The settings shown blowe are designed for use with the attached "Hello World for Workflow.rbird" file - to use it, download the file and import it into your Rainbird platform. However you can easily adjust the settings for any other Rainbird map.

Form > FormTrigger component

This trigger component starts the flow, collecting the user’s name and email address.

• Form URL – This is the link to the form – once the flow is working, copy and paste this into your browser to start the process.
• Form Title – Collect email and name
• Form Description – You can enter a description here if you wish
• Form fields (1)
  • Label – Name
  • Description - The person's name
  • Type – Select Text
  • Default value – Name
  • Index – Leave as 0
• Form fields (2)
  • Label – Email address
  • Description – The user’s email address
  • Type – Select Email
  • Default value – Email
  • Index – Leave as 0
• Call to Action – Submit
• Thanks Message - Please check your emails for the link
• Thanks Image URL – Leave blank
• Script – Leave blank
• Stylesheet – Leave blank

Rainbird > Start component

This component links the workflow to a specific Rainbird map.

• Base URL – Community (or other environment if applicable)
• API key – Enter your Rainbird API key
• Knowledge Map ID – Enter the ID for the knowledge map you want to query

Rainbird > Agent Action component

This component creates a rainbird ‘agent’, i.e. a way of running queries in the Rainbird map.

There are two Out ports: ‘Agent’ Provides the URL for the agent, and 'Out' sends the result of the query, if required (it will not be used In this flow as the result will just be displayed in the agent screen).

• Base URL - Community (or other environment if applicable)
• Session ID – Select Start: Session ID
• Subject – Select Name
• Relationship – might speak (i.e. the name of the relationship being queried in the Rainbird map – this cannot be selected, so should ideally be copied and pasted from the map)
• Object – Leave blank (as this will be provided by the Rainbird map)

Email > SendEmail component

This will send an email with any information you specify. In this flow it will send the Rainbird agent link to the email address collected in the form. The user will be able to click on the link and interact with Rainbird.

• To – Click on the menu icon and select Email address
• From – leave blank
• Reply to – leave blank
• Subject – Agent link (or whatever else you want the email’s title to be)
• Attachment file – leave blank
• Text – Click on the menu and select Web link. You can add any other explanatory text you wish too.
• HTML – Leave blank

Running your workflow

Your flow is now ready to be run. Click the Start Flow button, then go to the Form Trigger component and copy the Form URL. 

Paste this into your browser and complete the form. You should receive the agent link via email.

When you connect a workflow to a Rainbird map, you will be asked for the Knowledge Map ID. This is the unique identifier for your knowledge map.

You can find it by clicking on the knowledge map's name and selecting Knowledge Map ID in the menu, like this:

When creating a Workflow which queries a Rainbird map, you need to know the Rainbird API key. This is a unique security code which allows other programs and apps to connect to your Rainbird account.

You can find the API key by clicking on the Account button at the bottom left of the screen.

When running a query in Rainbird you can exclude results which have a certainty percentage lower than the Minimum Rule Certainty. 

The Minimum Rule Certainty is set at 20 by default, but can be set from 1 to 100.

You can build multiple rules on a single relationship. 

Each rule is capable of creating facts for that relationship, using different rule conditions and/or with differing levels of certainty.

Rainbird will try and get the most complete answer possible for a query. Sometimes this means it asks questions about facts for which it already has some information, either from the knowledge map, via an external datasource, or which have been created using a rule.

To create a smoother user experience you should turn off questions for all relationships where you do not expect the user to provide an answer, as long as you are confident in your facts, datasources and rules.