Integrate Quickbase with Rampiva Automate

Owned by Daniel Boteanu (Unlicensed), created
Mar 17, 2022
7 min read

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 build a Quickbase Application and Pipeline that will connect to Rampiva Automate using the API to submit a job when a new record is created in Quickbase.

For a guide on how to update Quickbase when the status of a Rampiva Automate job changes, see https://rampiva.atlassian.net/wiki/spaces/KB/pages/1060929553.

When creating a Quickbase Pipeline that performs other tasks, it can be useful to first manually perform the tasks in the Rampiva Automate web interface and to monitor the endpoints called and the responses received in the browser network tab. Additionally, the Rampiva API documentation is available at http://localhost/openapi, where localhost is the server where Automate is installed.

Prerequisites 

Instructions

A. Create a Quickbase Application to Host the Job Requests

1

In Quickbase, open the My Apps tab.

2

Select Create new app.

3

Select Start from scratch.

4

Name the application Rampiva Integration.

5

Add a Job Requests table.

The Job Requests table will be used as a trigger. Whenever a new record is created in this table, a pipeline will connect to Rampiva Automate and submit a job with the Name and Source Data parameters defined in the Job Requests table. The fields we will use in the table in this guide are an example, and can be adjusted to correspond to the required parameters of the Rampiva workflow used.

6

Add following fields to the Jobs table:

  • Name - Text

  • Source Location - Text

  • Rampiva ID - Text

The Rampiva ID field will be populated with the identifier of the job in Rampiva Automate, after the job was submitted. Populating this field is not strictly required but can be used for troubleshooting.

7

Click Create app to save the current settings.

B. Create a Quickbase Application Access Token

1

In Quickbase, open the My Apps tab.

2

Click on the user dropdown and then click My Preferences

3

Under the My User Information section, click on Manage my user tokens for …

4

Click New user token

5

Name the token Rampiva Integration Token

6

Assign the token to the Rampiva Integration app. This is the name of the application that was created in the previous section.

7

Click Save and take note of the token value.

C. Create the Quickbase pipeline

1

In Quickbase, open the Pipelines tab.

2

Create a new pipeline named Submit Rampiva Job

3

Select the type of pipeline Triggered

4

Set the Select your trigger as Quickbase - Record Created

5

Set the Continue with JSON Handler - Fetch JSON and click Next.

 

6

Expand card for step A Record Created by clicking on the top right arrow icon

7

If this is the first time you are connecting Pipeline to Quickbase, when selecting an Account, you will need to provide the company subdomain and User Token, created at step 3.

8
9

Select the Account Rampiva Integration Token, the Table Rampiva Integrations: Job Requests, and the Fields:

  • Name

  • Source Location

  • Rampiva ID

10

Expand the card for the step B Fetch JSON.

11

Set the Authentication Schema to No Authentication

12

Set the Json URL to:

https://automate.rampivalab.com/api/v1/scheduler/jobs
13

Expand the settings of the step the using the More link.

14

Set the Outgoing request’s method type to POST.

15

Set the Headers to:

Content-Type: application/json Authorization: Bearer 8fe0a872-f1d2-430a-931f-8aa61172fc19:Nx1f9JeKajeezt2BE6xO0AbvCq8RHNsr
16

Set the Request Body to:

{ "executionProfileId": "7316db8a-d99f-43c7-9336-689e259dd38c", "resourcePoolId": "46764eac-f366-4499-b4fe-a75cc3daabce", "libraryWorkflowId": "a4101e0c-1e90-4371-9085-52df58e484fd", "matterId": "16b27a96-6e03-4c01-979b-417ac4e32e1f", "name": "{{a.name}}", "notes": "", "priority": "MEDIUM", "sessionParameters": [ { "name": "{nuix_case_location}", "value": "Case 1" }, { "name": "{source_data_location}", "value": "{{a.source_location}}" }, { "name": "{docid_prefix}", "value": "DOC-" } ] }
17

From the JSON Handler channel, from the JSON Objects section, add the Iterate over JSON records step.

18

In the JSON Schema Sample, add the following sample JSON:

19

Set the Limit value to 1.

20

In the Do branch of the For each step, add the Update Record step from the Quickbase channel, from the Records section.

21

Select the record A Quickbase ≡ Record

22

Add the field Rampiva ID and set its value to {{c.id}}.

23

Turn on the pipeline by switching the On toggle in the top bar.

D. Test the Pipeline

1

Open the My apps tab.

2

Open the Rampiva Integration app.

3

Open the Job Requests table.

4

Create a New Job Request record with a sample Name and Source Location, and leave the Rampiva ID blank.

5

Return to Quickbase and inspect the Running pipeline tab. This tab should show the execution status of the various steps that we added to the pipeline.

6

Wait for the pipeline execution to complete.

7

Open Rampiva Automate.

8

Return to Quickbase, to the Rampiva Integrations app.

E. Troubleshooting

1

If a job is not created in Rampiva Automate, inspect the Quickbase pipeline activity for operations in progress and errors.

 

2

If needed, compare the your pipeline export code, with the export code of the pipeline created in this guide.