Integrate Microsoft Flow with Rampiva Automate (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 submit a Rampiva Automate job from Microsoft Flow using the native connector.

As an example, we will submit a job with predefined settings.

This article is part of a series:

Submit a Rampiva Automate job from Microsoft Flow using the native connector: Integrate Microsoft Flow with Rampiva Automate (Native Connector) (this article)
Trigger a Microsoft Flow when an event occurs in Rampiva Automate - Integrate Rampiva Automate with Microsoft Flow (Native Connector)
Submit Rampiva Automate job using the API when a form is submitted in Microsoft Forms: Integrate Microsoft Power Apps with Rampiva Automate (API)
Trigger a Microsoft Power Apps Flow using a script when the status of a Rampiva Automate job changes: Integrate Rampiva Automate with Microsoft Power Apps (Script)

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/scheduler-for-nuix/release/msflow-business.json
2	Save the Rampiva Automate app logo file logo-square.png from https://downloads.rampiva.com/scheduler-for-nuix/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: Premium: https://downloads.rampiva.com/scheduler-for-nuix/release/msflow-premium.json Corporate: https://downloads.rampiva.com/scheduler-for-nuix/release/msflow-corporate.json

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 Instant cloud flow.
4	Name the flow Submit Rampiva Job.
5	Select the trigger Manually trigger a flow and Create the Flow.
6	Add a New step.
7	Select the Rampiva Automate - Business connector from the Custom section.
8	Select the action Resolve Multiple Names.
9	Set the clientName, for example Internal.
10	Set the matterName, for example Training.
11	Set the libraryName, for example Default Library.
12	Set the workflowName, for example Sample Processing.
13	Set the executionProfile, for example Default Profile.
14	Set the resourcePoolName, for example Pool 1.
15	Add a New step.
16	Select the Rampiva Automate - Business connector from the Custom section.
17	Select the action Add Job.
18	Fill out the executionProfileId field and select the value executionProfileId from the Dynamic content panel.
19	Fill out the libraryWorkflowId field and select the value workflowId from the Dynamic content panel.
20	Fill out the matterId field and select the value matterId from the Dynamic content panel.
21	Fill out the name, for example Sample Job From Microsoft Flow.
22	Set the priority to MEDIUM.
23	Fill out the resourcePoolId field and select the value matterId from the Dynamic content panel.
24	Inspect the workflow in Rampiva Automate and determine which parameters are required.
25	Enter the sessionParameters name {nuix_case_path}
26	Enter the sessionParameters value C:\Cases\Case 1
27	Click Add new item to add another parameter.
28	Enter the sessionParameters name {source_location}
29	Enter the sessionParameters value C:\Data\Various Files
30	Click Add new item to add another parameter.
31	Enter the sessionParameters name {source_evidence_name}
32	Enter the sessionParameters value Evidence 1.
33	Save the flow

C. Test the Flow

1	Open Microsoft Flow at
2	Select the My flows tab.
3	Click the run button corresponding to the Submit Rampiva Job flow.
4	Click Run flow.
5	Click Flow Runs Page to view the Flow execution status.
6	Open Rampiva Automate and inspect the job queue.

D. Troubleshooting

1

To inspect errors with the Microsoft 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.