Integrate Rampiva Automate with Microsoft Flow (Native Connector)

The material in this document is for informational purposes only. The products it describes are subject to change without prior notice, due to the manufacturer’s continuous development program. Rampiva makes no representations or warranties with respect to this document or with respect to the products described herein. Rampiva shall not be liable for any damages, losses, costs or expenses, direct, indirect or incidental, consequential or special, arising out of, or related to the use of this material or the products described herein.

Introduction

This article describes how to trigger the execution of a Microsoft Flow when an action occurs in Rampiva Automate using the native connector.

As an example, we will set up a Flow that automatically create a new matter when a client is created in Automate.

 

This article is part of a series:

Prerequisites 

  • Rampiva Workflow 5.4.0 or later

  • Rampiva Scheduler 5.4.0 or later

  • Rampiva Premium Edition or higher

  • Microsoft Flow


Instructions

A. Register the Rampiva Automate Connectors in Microsoft Flow

1

Save the Rampiva Automate app definition file msflow-business.json from https://downloads.rampiva.com/automate/release/msflow-business.json

 

2

Save the Rampiva Automate app logo file logo-square.png from https://downloads.rampiva.com/automate/release/logo-square.png

3

Open Microsoft Flow at https://flow.microsoft.com/

4

Select the Data Custom connectors tab.

5

Create a New custom connector, with the option to Import an OpenAPI file.

6

Name the connector Rampiva Automate - Business.

7

Import the msflow-business.json file previously saved.

8

Upload the previously saved logo-square.png file as the connector icon.

 

9

Set the Icon background color to #023c3c

10

Set the Host to the publicly accessible DNS name under which Rampiva Automate is accessible.

If the Rampiva Automate deployment is not Internet-facing, you can publish it over the Internet for testing using a service such as https://ngrok.com/

11

Create the connector using the Create connector link.

 

12

Open the 5. Test section.

 

13

Create a New connection.

To create a new connection, we need to provide an API Key. This key is defined in Rampiva Automate.

14

Open Rampiva Automate in a new tab.

 

15

Navigate to Settings API Keys.

16

Add a new API Key.

17

Name the key Microsoft Flow.

18

After the key is added copy the key secret to clipboard using the Copy Header button.

19

Return to the Microsoft Flow page, and paste the API Key to create the connection with this key.

 

20

In the 5. Test section, on the Connections panel, click the refresh button to show the recently created connections.

 

21

Click Test operation.

 

22

Click Close to close the connector definition.

 

23

Due to a limit of how many operations can be added to a Microsoft Flow connector, the operations specific to the Premium and Corporate editions of Automate are available in separate files. If applicable, repeat steps 1-23 for the Premium and Corporate editions app definitions, using the following links:

 

B. Create the Flow

1

Open Microsoft Flow at https://flow.microsoft.com/

 

2

Select the My flows tab.

3

Create a New flow of the type Automate cloud flow.

4

Name the flow Rampiva Client Management.

5

Leave the trigger blank, and click Skip.

6

Select the Rampiva Automate - Business connector from the Custom section.

7

Select the trigger On Client Added.

 

8

Add a New step and select the Rampiva Automate - Business connector from the Custom section.

9

Select the step Add Matter.

10

Click on the clientId field and select the value id (Client ID) from the Dynamic content.

 

11

Set the description Created using Microsoft Flow.

12

Set the name Default Matter for , and select the value name (Client Name) from the Dynamic content.

13

Save the flow.

14

Optionally, return to Rampiva Automate and confirm that a new webhook was created corresponding to this Microsoft Flow, by navigating to the Settings Webhooks section.

 

C. Test the Flow

1

Open Rampiva Automate in a new tab.

 

2

Navigate to the Clients section.

3

Add a new Client.

4

Enter the name Flow Test.

5

After the client is added, wait a few seconds, and confirm that a matter appears under the client, with the name Default Matter for Flow Test, and the description Created using Microsoft Flow.

 

D. Troubleshooting

1

To inspect the status of the webhook which triggers the Microsoft Flow execution, navigate to the Settings Webhooks section in Rampiva Automate.

 

2

To inspect errors with the Microsof Flow execution, open the flow in Microsoft Flow, and click on the records in the Run history section to see the status of each step.