EZ File Importer formula URL parameters

Prev Next

EZ File Importer

Formula URL parameters—the Import Generation Arguments field on the File Imports table

A formula field is used to execute EZ File Importer. The following list shows each parameter and a brief description. The field is called Import Generation Arguments, and the installation wizard creates it in the File Imports table (older apps and articles call this table Import Files). The email notification on that table sends this field's value to EZ File Importer. The parameters are separated by spaces. For the formula as the wizard builds it, see Set up the tables for EZ File Importer.

URL Parameter

Description

Sample

Basic parameters

clientid

Client identifier assigned to your account during the setup process. Required.

clientid=Q2

appid

Unique identifier for the Quickbase application. This is used to verify that your application is authorized to use EZ File Importer. Required.

appid=AppID()

dbid

Table ID of the File Imports table, the table that holds the spreadsheet. Use Dbid() to fill it in for the current table. Required.

dbid=Dbid()

recid

Record ID# of the record in the File Imports table that the process runs for. Required, unless you pass keyfid and keyfidval instead.

recid=[Record ID#]

fafid

Field ID of the file attachment field in the File Imports table. This file attachment is used to upload your spreadsheet, which can be .xlsx, .xls, .xlsm, or .csv. Required.

fafid=6

apptoken

Application token. If your Quickbase app requires application tokens, pass a token in this parameter; otherwise leave it empty.

apptoken=

Import Configuration Parameters

impconfigdbid

Table ID of the Import Configurations table. Required.

impconfigdbid=[_DBID_IMPORT_CONFIGURATIONS]

impconfiggroup

The literal name of the Configuration Group used in processing the file. Surround it with quotes to specify the exact name of the configuration group. Required.

impconfiggroup=" & "\"" & [Configuration Group] & "\""

fldmapdbid

Table ID of the Field Mappings table, which tells EZ File Importer which column name or letter goes to which field ID in the Quickbase table.

fldmapdbid=[_DBID_FIELD_MAPPINGS]

Run Details Parameters

impadbid

Table ID of the Import Run Details table, where a new record is inserted for each import configuration that runs.

impadbid=[_DBID_IMPORT_RUN_DETAILS]
or
impadbid=bq4xyz123

imparelfid

Field ID of the relationship field in Import Run Details that relates each run to its File Imports record (one-to-many). If you leave it out, EZ File Importer uses the field named Related Import File.

imparelfid=13

Optional parameters

keyfid and keyfidval

Use these two together when the record that starts the import should be found by a field other than Record ID#. keyfid is the field ID of the key field, and keyfidval is that field's value on the record.

keyfid=7 keyfidval=[Invoice Number]

relkeyval

A value to write into the field named by Target Table Field to Update (FID) on the import configuration, for every imported row. The wizard doesn't add this parameter.

relkeyval=[Related Key Value (Formula)]

Parameters added by the wizard

configid

The Config Key of the batch configuration the wizard creates for your app. Leave it in place. See Batch Config Portal overview.

configid=your Config Key

type

Identifies the extension that the email notification invokes. The wizard sets it to ezfileimportermultisheet for US accounts and ezfileimportermultisheeteu for EU accounts. The name refers to an older version that needed to know whether an import used one table or several; every import now uses this value. Leave it as the wizard created it.

type=ezfileimportermultisheet