About the Configuration tab
Available to: all roles, when your company has the QB Courier extension.
The Configuration tab is the first tab of a configuration. Here you name it, choose how and when it runs, and pick the Quickbase data it uses. The other tabs unlock after you save this one. See Create or edit a configuration.
Settings
Setting | Required | What it does |
|---|---|---|
Configuration Name | Yes | A name you'll recognize in the Courier Configurations list. |
Description | No | Notes for yourself or your team. |
Processing Mode | Yes | How the configuration runs. See Processing modes. |
Processing Frequency | Yes, for Scheduled | Daily, Weekly, or Monthly. See Schedule a configuration. |
Schedule time | Yes, for Scheduled | When the scheduled run starts. Times are US Eastern time (EST/EDT). |
Select days | For Weekly | One or more days of the week. |
Select day of the month | Yes, for Monthly | 1–31. |
Status | Yes | Enabled, Test Mode, or Disabled. See Status. |
Tags | No | Labels to help you organize configurations. Press Enter or type a comma after each tag. |
QuickBase Application | Yes | The app the emails come from. Only apps authorized for QB Courier appear. If yours is missing, select Authorize New Application. See Authorize a new application. |
App Token | No | Enter one if your app requires app tokens. When you leave the box, the configurator checks whether the app needs a token and warns you if it does. |
Tables | Yes | The table whose records are emailed. The table icon (Link to QuickBase Table) opens it in Quickbase. |
Reports | Yes, for Scheduled and On Demand | The report that selects the records to email. The report icon (Link to QuickBase Report) opens it in Quickbase. See Choosing the report. |
Config Key | Read-only | Shown for Trigger configurations after you save. Your Quickbase email notification must include it. |
Processing modes
Mode | When emails are sent | Which records |
|---|---|---|
Scheduled | Automatically, at the Schedule time, on the days set by Processing Frequency. | Every record in the report. |
On Demand | When someone selects Execute Now in the Courier Configurations list. | Every record in the report. |
Trigger | When a Quickbase email notification on your table sends a request to Courier, for example when a record is added or changed. | The record that fired the notification. |
For a Trigger configuration, you create the Quickbase email notification after you finish the configuration. The Finish tab shows the settings to use. See Email notification setup for triggered configurations.
Schedule a configuration
For a Scheduled configuration, two settings work together:
Schedule time sets when Courier checks the configuration.
Processing Frequency decides on which days it actually runs:
Daily: every time the schedule time comes.
Weekly: only on the days you select in Select days.
Monthly: only on the day you select in Select day of the month. If the month has fewer days, it runs on the last day of the month.
Most Schedule time options start every day at that time, for example 8 AM or 6:30 PM. A few are different:
3 PM Wednesday, 10 AM Saturday, 2 AM Monday, and 2:30 AM Monday start only on that day of the week. With Weekly, make sure that day is selected in Select days, or the configuration never runs. With Monthly, it runs only when your day of the month falls on that weekday.
Every hour everyday starts every hour. With Daily, the configuration runs every hour. With Weekly or Monthly, it runs every hour on the days you chose.
Changing Processing Frequency clears the schedule settings, so choose it before you pick the time and days.
Status
Enabled: Courier sends emails to your recipients.
Test Mode: Courier sends one sample email, from the first record, to the Copy email address on the Email Options tab, instead of to your recipients. Copy email is required in Test Mode.
Disabled: Courier doesn't run the configuration.
Keep a new configuration in Test Mode while you set it up, and switch to Enabled when you're happy with the results.
Choosing the report
For Scheduled and On Demand configurations, Courier emails every record the report returns. Use the report's filters to choose which records get an email. The report must include:
Record ID# (field ID 3), even if you don't use it in the email.
Every field the configuration uses: the To, CC, BCC, and Reply to fields, the Update field, every field in the subject and message, and any file attachment fields.
If a field is missing, the run stops, and the configuration's activities show The following fields are missing in the report used to select the data for the message., followed by the missing fields.
Save
Select SAVE AND NEXT (UPDATE AND NEXT when editing). When the save succeeds, you see Configuration saved successfully, and the Email Options tab opens.
Select BACK to return to the Courier Configurations list.