Button Parameters

Prev Next

About the button

  • The wizard adds the Send to JuicedSign button to your table. It's a formula field that opens JuicedSign with a set of parameters.

  • The Preview Agreement button uses the same parameters. If you change one button, change the other the same way.

  • The parameters are inside Base64Encode(...) after request=. Keep that structure, and add any new parameter inside it as & "&name=" & value.

  • Don't change the values the wizard set for clientid, appid, dbid, field IDs, or field names. If they're wrong, JuicedSign can't find your account, record, or tables. To change your setup, run the wizard again. See Set up JuicedSign.

  • Most values come from fields on your table, like Agreement Doc Fids or Signed Document Info. Usually you change the field, not the button.

  • Don't use & in a value, for example in a file name or document type. JuicedSign reads it as the start of a new parameter.

Parameters

Parameter

What it is

Required

clientid, appid

Your Quickbase Extensions account and app. Set by the wizard. Don't change.

Yes

dbid, recid

The table and record to send. The wizard uses Dbid() and [Record ID#].

Yes

docfids

Where the document comes from, and which document template's tags to use. See The document.

Yes

recipientfid

Field ID of the Recipient String field. See Send an agreement.

Yes

subjectfid, msgfid

Field IDs of the fields with the email subject and message. Always include both.

Yes

signeddocinfo or signeddocfafid

Where to save the signed document and the certificate. You need one of them. See The signed document.

Yes, one of them

fn

Name of the signed document. See File name.

Yes

remdelay, remfreq, expafter, expwar

Reminder and expiration days. See Reminders and expiration.

No

jsuseremail

The JuicedSign sender. See Sender.

No

qbuseremail

The Quickbase user who created the agreement. The wizard uses UserToEmail(User()). Saved in QB User Email on the JuicedSign Management record.

No

doctype

A label for the agreement, such as Quote or Invoice. Saved in Document Type on the JuicedSign Management record. The wizard uses your table's name.

No

cloudfolder

For this agreement, use this S3 bucket or Dropbox folder instead of the one in your account's file locations.

No

draw, font

Which recipients can draw their signature, or pick a style. See Choose how recipients sign.

No

relatedfld

The name (not the ID) of the field in JuicedSign Management that links to your table, usually Related <your table>.

Yes

relatedtemplatefid

Field ID of Related Document Template in JuicedSign Recipient Tags.

Yes

relatedrecpfid

Field ID in JuicedSign Recipients. Set by the wizard. Don't change.

Yes

recpidfid

Field ID of Recipient ID in JuicedSign Recipient Tags. Set by the wizard.

No

keyfid, keyvalue

Added by the wizard only when your table's key field isn't Record ID#. The agreement is linked to your record by this key.

No

The document

docfids says where JuicedSign gets the document, and which Document Templates record has its tags. The parts are separated by colons. The last part is always the Document Templates record ID.

Document is in

Format

Example

A file attachment field on this record

file field ID:template ID or QB:file field ID:template ID

54:25

Amazon S3

S3|bucket:S3 key field ID:template ID

S3|Invoices:23:14

Dropbox

DB|folder:file name field ID:template ID

DB|Quotes:23:14

A file attachment field on a record in another table

table dbid:record ID:file field ID:template ID

bxxxxxxxx:1:7:14

S3 or Dropbox, with the key or file name on a record in another table

S3|bucket:table dbid:record ID:S3 key field ID:template ID, or the same with DB|folder

S3|Invoices:bxxxxxxxx:1:23:14

  • JuicedSign uses the S3 or Dropbox account set up for you in the wizard's file locations step. The bucket or folder after | is optional. Without it, JuicedSign uses the one from your file locations.

  • S3, DB, and QB can be upper or lower case.

  • One document per agreement. The document must be a PDF or Word (.docx) file, up to 20 MB. Word files are converted to PDF.

  • The wizard puts this value in the Agreement Doc Fids field. To change it, change that field.

The signed document

When everyone has signed, JuicedSign saves the result. You choose what to save with three positions, separated by periods:

merged document field ID.signed document field ID.certificate field ID
  • Merged: the signed document with the certificate of completion added at the end, as one file.

  • Signed: the signed document only.

  • Certificate: the certificate of completion only. It's saved together with the signed document.

Always keep both periods, even for empty positions. Use one of these:

To save

Value

One merged file

142..

The signed document only

.142.

The signed document and the certificate, as two files

.142.143

  • If the first position is filled, only the merged file is saved. The other positions are ignored.

  • A value with one period, like 142.143, fails.

Where to save: signeddocinfo

The wizard uses signeddocinfo and puts its value in the Signed Document Info field. Add a location before the positions:

Save to

Format

What goes in each field

File attachment fields on this record

142.. or QB:142..

The file

Amazon S3

S3|folder:142..

The S3 key of the file

Dropbox

DB|folder:142..

The Dropbox file ID

File attachment fields on a record in another table

table dbid:record ID:142..

The file

S3 or Dropbox, with the keys on a record in another table

S3|folder:table dbid:record ID:142.., or the same with DB

The S3 key or Dropbox file ID

  • For S3 and Dropbox, the field IDs are text fields that receive the key or file ID. The folder after | is optional.

  • The S3 bucket is the one from your file locations, or cloudfolder if the button has it.

  • For S3, JuicedSign names the files after the agreement ID. fn isn't used for S3 file names.

Older setups: signeddocfafid

  • Buttons from older setups use signeddocfafid. It saves to file attachment fields on this record only, with the same three positions, for example &signeddocfafid=.27.33.

  • If a button has both, signeddocinfo is used.

File name

  • fn is the name of the signed document saved to Quickbase and attached to the completion email. The wizard uses the Signed Doc Name field, which starts as JuicedSign Signed Agreement.

  • You can build it from fields, for example [Quote Number] & "_Signed".

  • Don't add .pdf. JuicedSign adds it. A separate certificate is named <name>_certificate.pdf.

  • Use letters, numbers, spaces, hyphens, and underscores.

Reminders and expiration

Parameter

Meaning

remdelay

Days after sending before the first reminder.

remfreq

Days between reminders after the first one.

expafter

Days until the agreement expires.

expwar

Days before expiry to send the expiration warning.

  • Use whole numbers.

  • An empty value uses your account's default from Account Settings. See Account settings and senders.

  • The wizard puts the account defaults at setup time into the reminder and expiration fields on your table. If you change Account Settings later, these fields keep the old values. Update or empty them.

  • The agreement must expire after at least one day. If expafter and your account default are both 0 or empty, JuicedSign doesn't create the agreement.

Sender

  • jsuseremail is the email address of the JuicedSign sender. The wizard uses the JuicedSign Sender Email field.

  • It must match an active sender in your account. If it doesn't, the agreement isn't created. JuicedSign doesn't fall back to the default sender.

  • If it's empty, your default sender is used.

  • Manage senders on the Users tab. See Account settings and senders.

Messages

Message (start)

What to do

Missing the required parameters…

A required parameter is missing from the button. Compare it with the table above, or run the wizard again.

Docfids parameter is not in the correct format…, Docfids field is not in the correct format…

Fix Agreement Doc Fids. See The document.

Invalid cloud type provided in docfids parameter…

Use S3, DB, or QB. Only one document per agreement.

Unable to get the document from…

The file field, S3 key, or Dropbox file name on the record is empty.

The signed document info parameter (signeddocinfo or signeddocfafid) is missing…

Add signeddocinfo to the button.

Signed doc info parameter is not properly formatted…, Invalid cloud type passed in the signed document info parameter.

Fix Signed Document Info. See Where to save.

…Please check the draw and font signature specifications in your formula query

Fix draw or font. Use *, an uppercase X, or recipient IDs like 1:2. They can't both be X.

The expiration days value cannot be zero…

Set expafter, or the default Expire After in Account Settings.

…JuicedSign sending email address is not setup…

See Sender.

…Unable to insert a record into the JuicedSign Management table…

Check that relatedfld is the exact name of the related field in JuicedSign Management.

For other messages, see Send an agreement and Messages and troubleshooting.