Signatures formula URL parameters

Authorization Parameters

Indicates to Signatures the client and the application executing the extension.

clientid

Client identifier assigned to your account during the setup process.

clientid=Q2

appid

Unique identifier for the Quickbase application. This is used to verify that your application is authorized to use Signatures for Quickbase.

appid=bdht2xebx

Table and Record Parameters

Indicates what table and record to process and what fields to update.

dbid

Unique identifier for the Quickbase table. This is the table that stores the signature files once captured. You can use the function dbid() instead of the actual table dbid, and Quickbase converts it properly.

dbid=dbid()

recid

Record ID# of the record in the table to process. This indicates to Signatures the specific record to process based on the [Record ID#] value. Typically, this is the built-in key field on the table. If it has been renamed, use the renamed field label between the brackets.

recid=[Record ID#]

fafid

File attachment field ID. This is the field ID of the file attachment field in the table that is updated with the image file created by the Signatures extension.

fafid=51

fn

File name—this is the value Signatures uses when creating the image file.

Signatures also appends an underscore and the record ID# of the record being processed to the file name.

fn=Signature

If the record being processed is record ID#3, here is what the file name would look like for that record:

Example: Signature_3.gif

Note: When using the value from a text field as part of the file name, make sure you use the URLEncode function so special characters are passed into Signatures properly.

Example: URLEncode([ClientName])

fn=Signature

Miscellaneous Parameters

apptoken

Application token. If the Quickbase application requires application tokens, pass a token in this parameter.

size

This parameter controls the size of the window that appears to allow for the capturing of the signature.

S-Small

M-Medium

L-Large

Note: If you need a custom size, leave this blank and use the parameter below.

size=s

size=m

size=l

H

W

Custom size signing pad

To control the size of the signing pad, use the H and W parameters in the button formula.

H stands for the height of the signing pad.

W stands for the width of the signing pad.

Note: Don't pass a value for the size parameter to use these custom size parameters.

H=400

W=450

updatefid

Signature captured date. This is a field in the table that is updated with the date and time that Signatures for Quickbase captured the signature. It should be a date/time type field.

updateifd=15

fid1

This parameter indicates to Signatures that you want the user to enter some text as well as their signature. The data entered into this field during the signature capturing session is stored in the field specified by the field ID entered in this parameter.

This parameter is optional.

Note: To make this field optional, add a U suffix to the field ID—for example, fid1=16U.

fid1=16

fid2

Similar to fid1.

This parameter indicates to Signatures that you want the user to enter some text as well as their signature. The data entered into this field during the signature capturing session is stored in the field specified by the field ID entered in this parameter.

This parameter is optional.

Note: To make this field optional, add a U suffix to the field ID—for example, fid2=17U.

fid2=17

fatermsfid

File attachment field of a document you want to use to show the terms and conditions of the sign-off.

fatermsfid=24

titledlg

Title: To include a custom message that appears above the sign-off box, pass this parameter.

titledlg=Please sign in the box below

titlefid

Title field ID: To use a field to control the custom message that appears above the sign-off box, pass this parameter.

titlefid=72

clist

You can include up to five fields from your table to display in the signature capture form.

clist=8.67.55.17.28

rdr

Allows you to supply a URL to redirect the user to after QB Signatures is closed. Defaults to the URL of the record that QB Signatures was launched from.

Note: Use either URLEncode or Base64Encode to encode the URL passed into this parameter.

As an example: Base64Encode("https://qbtools.helpdocsonline.com/")

rdr=URLEncode("https://qbtools.helpdocsonline.com")

xid

Expire the URL—you can make the URL a single-use URL if you want.

For more information, and a sample of the formula code that can be used in this field, submit a technical support case: [QB Signatures Token]

xid=[QB Signatures Token]

submitclose

When set to true, the user isn't navigated to a success screen, and the tab or window automatically closes instead. If rdr was supplied, it redirects to the rdr address instead.

Defaults to false.

submitclose=true