Use the Quickbase channel – Quickbase Help

ZenTarget.4.log-793756680.zip
4 KB Download

Quickbase provides a low-code application development platform that helps businesses improve the processes that make them unique, across a variety of industries.

Please note that terms used in the Quickbase channel are Quickbase specific terminology.

Note: If you encounter issues with address fields that contain spaces in the name, please use a jinja expressions using the python key accessor method, for example:{{a.address['Subfield With Spaces']}}

See Limits in Quickbase for information about Pipeline system and product limits.

See Bulk Record Sets to learn how to more efficiently transfer a large numbers of records.

How to connect

On the My pipelines page, click Create a pipeline.
Click Quickbase in the list of channels on the right side of the page and click Connect to Quickbase. Choose either simplified authentication (authenticate with my user) or user token authentication:
When finished, click Connect to Quickbase.

How to reconnect the Quickbase channel

You may need to reconnect your account to a channel. Reasons may be (but not limited to):

If you need to connect a different account.
Authorization updates, such as a changed password.
Editing the access rights that Pipelines has to the channel.

To reconnect:

Select a pipeline that already has Quickbase in it.
Open a step containing Quickbase.
Under account, select Connect (or reconnect) and follow the process above, How to connect.

Create and assign a user token

You can create a user token and assign it to an app at the same time. The token is also available to assign to other apps.

To create a new user token:

On the user drop-down on the global bar, choose Profile.
Under My User Information, click the link for Manage my user tokens for[subdomain] realm ...
Click the New user token button.
Click OK.
In the Basics section, enter a Name and a Description for your token.
In the Assign token to apps section, click the drop-down arrows to select which apps you want to assign this token to. You can assign a token to as many as 20 apps.
Click Save. The new token appears in the list of user tokens. API calls containing this token can now interact with the application. The new token is also available for assignment to other applications. For more details about managing user tokens, see Creating and using user tokens.

Simplified authentication

You can use simplified authentication with the Quickbase channel. This capability streamlines and further secures the process of connecting to Quickbase apps as it will enable the usage of a default pre-provisioned user account for the realm that respects the user access level, instead of creating and managing user tokens for the apps they want to automate and integrate with. Any existing pipelines will continue to run using the tokens they were assigned originally unless manually changed.

For more information, see Simplified authentication for the Quickbase channel.

Steps

The steps you can use with Quickbase fall into a five categories: Records, Quickbase Apis, Attachments, Bulk Record Sets, Automation Admins.

Note: You cannot use jinja expressions in trigger conditions unless explicitly specified as possible.

Step	Type	Name	Description
Records	Trigger	Record Created	Triggers when a new record is created in the selected account. Note: You must have admin rights on the Quickbase app for this trigger to operate.
	Trigger	Record Updated	Triggers when a record is updated in the selected account. The default is "modify" for "on any event." You can access a previous record value by dragging-and-dropping the field value you want to access. For example, If you have something like this:`{{a.status}}` - it will return the new value. When using Jinja, you should add `$prev` and it will be fetched with the old (changed) data. For example: `{{a.$prev.status}}`.This is relevant when you have 'on modify', in case of "on add", this will be null. It is advisable to use very specific filters and queries. Note: You must have admin rights on the Quickbase app for this trigger to operate.
	Trigger	Record Deleted	Triggers when a record is deleted in the selected account. Note: You must have admin rights on the Quickbase app for this trigger to operate.
	Trigger	On New Event	Triggers on any new event on specified table in the selected account. You can select which type of event this step should trigger (on add, update, delete) and you can select one or all of these events. You can access a previous record value by dragging-and-dropping the field value you want to access. For example, If you have something like this:`{{a.status}}` - it will return the new value. When using Jinja, you should add `$prev` and it will be fetched with the old (changed) data. For example: `{{a.$prev.status}}`. This is relevant when you have 'on modify', in case of "on add", this will be null. It is advisable to use very specific filters and queries. Note: You must have admin rights on the Quickbase app for this trigger to operate.
	Trigger	On New Bulk Event	Triggers on multiple record changes at once when they're bundled together. Learn more
	Action	Create Record	Creates a new record.
	Action	Update Record	Updates an existing record.
	Action	Delete Record	Deletes a record.
	Query	Search Records	Searches all records in the selected account and returns a list of results. If you want to narrow the search to one specific date, use Is Between and use the same date value on both lines.
	Action	Fetch a Linked Record	Fetches a linked record. For more information on linking, see Linking items.
	Action	Look Up Record	Searches for a single record by Record ID or by key fields.
Quickbase Apis	Action	Make request	Makes an HTTP or REST API request. The default value is the Quickbase Account dropdown, but you could still authenticate using the user token method by implicitly calling the Quickbase APIs using your Quickbase authentication (QB-USER-TOKEN). An example of usage would be a table-to-table import.
Attachments	Action	Upload a File	Uploads a file from a URL to a specific field in a record. Note: A maximum of 71 MB File attachment can be uploaded.
Bulk Record Sets	Action	Prepare Bulk Record Upsert	Prepares records for bulk upsert to a specific account and table.
	Action	Add a Bulk Upsert Row	Adds or updates rows in a target bulk record set.
	Action	Commit Upsert	Commits a batched upsert into a Quickbase table.
	Action	Import with CSV	Imports data into the specified table with the given CSV resource. Import from CSV -- use if you don't need a data transformation needed, and you have a publicly-accessible URL to fetch the CSV from (or a file_transfer_handle from another channel) -- major benefit here is that it is a single step, but it is limited to 10,000 records.
	Action	Remove Record(s)	Removes records in a Quickbase table based on an advanced query.
	Action	Copy Records	Copies records in a Quickbase table based on an advanced query. Note: This step does not copy file attachments. Copy Records cannot run for more than 1 hour Copy Record cannot transfer file attachments
	Action	Export Records to CSV	Exports records from the specified table in the CSV format.
Automation Admins	Query	Search Automations	Lists Automations metadata including any migrations done within the realm/all realms. Note: This step is only available for Realm Admin and CSR users.
	Query	Get Migrations	Lists all migrations done within the realm. Note: This step is only available for Realm Admin and CSR users.
	Action	Look Up Automation	Finds an automation.

Advanced Query

You can filter criteria for your pipeline with query string comparison operators. Query string comparison operators must be in uppercase. You can create queries that find records where the matching value is a certain value that you specify. To create a query that finds a specific matching value, you enter the value in single quotes in the query string, except for placeholder names which use double quotes.

For example:

{'7'.EX.'Ragnar Lodbrok'}AND{9.CT.'Erich'}

For more information about operators see Query string comparison operators, and to learn about the API Query Language, see API_DoQuery, and to learn about using these queries in Pipelines, see API_DoQuery in Pipelines.

Migration Data

If you are a realm administrator, you can use this resource to get automation migration data to manage the migration statuses of all automations across all apps within the realm.

Filtering on system user fields

Here's how to filter on the system user fields, such as Record Owner and Last Modified By by email. For example, Record Owner >> Email equals ...

If you are filtering by the email property and your filter is equals, not equals, set, not set, the filter will be applied to the webhook on creation, when you turn on your pipeline. This helps reduce the amount of traffic going to pipelines. If you want to use this new behavior you must recreate your webhooks.

Limits

You cannot use more than 250 fields in a Quickbase step.

Resource details

These are the column details returned when pipeline is triggered or run. The trigger_type can be either webhook or schedule.

Type	Name	Description
Status	PENDING	Not yet analysed.
	ANALYSING	Currently in progress, analysing.
	ANALYSED	The automation was analysed.
	ANALYSED_FAILURE	Analysed, but with failure.
	MIGRATING	Currently in progress, migrating.
	MIGRATED_INACTIVE	The automation is migrated, but the pipeline is not yet enabled.
	MIGRATED_ACTIVE	The automation is migrated and enabled.
	MIGRATION_FAILURE	Migration stopped with errors.
Action Name	QB_ADD_RECORD	This is the Add a record action step.
	QB_QUERY_AND_EDIT	This is the Filter and edit records action step.
	QB_QUERY_AND_DELETE	This is the Filter and delete records action step.
	QB_TABLE_IMPORT	This is the Table to Table Import action step.
	QB_COPY_RECORDS	This is the Copy records from one table to another one action step.

Use Cases

Here are some use-case examples to help you understand how to use the Quuickbase channel.

Build pipelines between two different realms of Quickbase

Add a user token for each realm and you can pick which realm (account) when you add a step.

Using pipelines to delete file attachments

In this use case, we want to use pipelines to delete file attachments after moving them to something like SharePoint. After other processing, in the last step, we use a Make Request step using the DELETE method:

qb.delete.uuse.case.png