Configuration app

Prev Next

This Text My Quickbase Configuration App is what controls how outbound and inbound texts are sent and received.

If you don't have access to the Configuration App, submit a technical support case for access.

Some tabs in the configuration table are shown or hidden based on values in other fields, such as the Outbound, Inbound, Activity Log Details, Search, and Registration tabs.

Blue tabs only show up for Outbound configurations. Yellow tabs only show up for Inbound configurations. Green tabs show up for both Outbound and Inbound configurations.

The fields highlighted below are required for the types of configurations based on their color.

Client Info

Has the basic information about the configuration and the client.

  • Config Name - Name of the configuration to help users identify each config.

  • AppID - Unique identifier for the Quickbase app. This is used to verify that your app is authorized to use Text My Quickbase.

  • App Token - If your app requires app tokens, fill this in with an app token from the app that Text My Quickbase is running from.

  • Config Key Inclusion - Check this to have the Config Key be required in an email notification to add more security.
    If the config id is greater than 768, the key is automatically filled in and required.

  • Config Key - Unique Key for this config. When the Inclusion checkbox is checked, this is filled out and required to be in the email notification.
    If the config id is greater than 768, this is automatically filled in and required.

Processing Details

Determines if this configuration is outbound or inbound. It also determines when it runs.

  • Text Type - Used to determine if the configuration is for Outbound or Inbound messages.

  • Status - Used to determine if the configuration is active or not.

    If Enabled, the text is sent. If it is Disabled, the text won't be sent.

  • Processing Mode - Determines when a text is sent.

    If Triggered, a text is sent when an email notification is sent to the correct email address.

    If On Demand, a text is sent when the "Execute On Demand" button is clicked.

    If Scheduled, a text is sent regularly based on the Processing Group.

    On Demand and Scheduled use the Report Query ID field on the Outbound tab to determine what records to send from.

    An email notification can still be used with this by just removing the "recid=123" from the email notification.

  • Processing Group - Use this field to specify which time of the day to send out the message. This time is in Eastern Time.

    If the time you need the scheduled configuration to run isn't an option, submit a technical support case and we can add that time for you.

  • Processing Frequency - When Scheduled, this field determines how often the texts are sent out

    The options are Daily, Weekly, and Monthly.

  • Day Of Week - Specifies which days of the week to send the messages on.

    This field only shows up when the Processing Frequency is set to Weekly.

  • Day Of Month - Specifies which day of the month to send the messages on.

    This field only shows up when the Processing Frequency is set to Monthly.

  • Run Today - Shows you if the scheduled configuration runs today or not. If it is checked, the configuration runs today.

  • Execute on Demand - Select this button to trigger your Scheduled or On Demand configuration manually.

    This doesn't prevent your scheduled configuration from running that day.

EsendEx

Stores the EsendEx info used to run this configuration.

  • EsendEx License Key - The License Key that is used to run this configuration. You get this from your own EsendEx account.

    You can find your License Keys in your EsendEx account under Manage Services -> SMS Notify.

  • EsendEx Phone Number - The DID that is connected to the License Key in your EsendEx account.

    You can find your DIDs in your EsendEx account by selecting the DID link beside the license key you're using.

  • Is International DID? - Check this box if the EsendEx DID belongs to a country other than the U.S. or Canada.

    For example, check this box if the DID belongs to Australia or India.

Outbound

Controls how the outbound message is sent.

  • Outbound Table Name - The name of the table you want to send texts from.

  • Table DBID - The DBID of the table you want to send texts from.

  • Report Query ID - If the configuration is Scheduled or On Demand, this qid determines the report in the Outbound table that has the list of records to send the text to.

    This report must show all of the fields that you are using to send texts out. It must also include the Record ID# even if it isn't being used.

  • Message Field - Field ID of the message that is sent. This is the message that is sent out. This field is only required if Static Message is blank.

  • Static Message - If you are not using a field from Quickbase, you can use this field to send a static message. This field is only required if Message Field is blank.

  • ToPhoneNumberFID - The field id that stores the phone number that receives the text.

  • Update Field - The field id that is filled in with the date and time of when the text was sent.

  • Status Field - The field id that is filled in with a message based on if the text was sent successfully or not.

  • Record Key FID - The field id of the key field in this table. This field only needs to be filled in if the Record ID# is not the key field.

  • Unique Message ID FID - The field id that is filled in with the unique message id given by EsendEx.

    This value can be used to relate Inbound records to the Outbound it originally received.

  • Files to Send FID - Please provide the FID of the fields that hold the files to send. These fields can be either file attachment fields, or fields that have links to files.

    We can send multiple attachments, and we need to add field ids separated by "." in here.

    Files cannot exceed 2MB. This size may be smaller depending on your cell carrier.

  • Send Text Even If File Can't Be Sent - When this is checked: If a file can't be sent (either it is a bad link, too large, or any other reason) the text is still sent.

    The files that did not fail are sent with that text.
    When this is unchecked, The text isn't sent if any file fails.

    Fields that are blank do not count as failed to send files.

  • Handle Special Characters - Check this box if you want to send special characters (accent marks such as é or ñ) in the Text message.

  • Verify Phone Number - Check this box to verify whether the Phone Number is valid or not. To enable this feature, subscribe to the Phone Verify API from EsendEx and provide us with the license key.

  • Use MMS - Check this box to force the message to be sent as an MMS message instead of SMS.

Activity Log Details

Controls the records that are added when a text is sent out.

  • Add Local Activity Log - If checked, Text My Quickbase uses the information below to add a record into your app to keep track of all the texts that are sent out.

  • Activity Table DBID - The DBID that you want Text My Quickbase to add activity logs into.

  • EsendEx Phone Num FID - The field id that stores the phone number the text was sent to.

  • To:Phone Number FID - The field id that stores the phone number that sent the text. (This is just the EsendEx DID)

  • Related FID - The field id that stores the key value of the master record the text was sent from. This relates the activity log back to the master record.

  • Message FID - The field id that stores the message that was sent out.

  • Delivery Status FID - The field id that stores the message delivery status. This says whether the message was sent successfully or not.

  • Error Checkbox FID - The field id that shows if an error occurred or not for this message.

  • Date/Time FID - The field id that stores the date and time that the text was sent.

  • Unique Message ID FID - The field id that stores the Unique Message ID that is given by EsendEx. This can be used for connecting this log to an inbound log.

  • Config ID FID - The field id that stores the ID of this configuration.

  • Config Name FID - The field id that stores the Name of this configuration.

  • Activity File Size FID - The field id that stores the total file size that was sent.

Validates the data to see if it is in a correct format, and that can be used in other processes.

  • Delimiter - The value that is used to split the received message into different parts.

  • Key Part - The index of the part of the message that stores the key value for the search. The first part is at index 1.

  • Data Part - The index of the part of the message that stores the data you want retrieved. The first part is at index 1.

  • Validate Data ? - If this is checked, Text My Quickbase checks to make sure the Data Part is in a correct format.

  • Validate By - Determines how to validate the data. Either by the data type, or by a regular expression.

  • Select Data Type - Determines what to validate the data as. Date, Email, Phone Number, or Numeric are possible to be validated this way.

    Only used when Validate By is "Data Type"

  • Regular Expression - Determines if the data is valid or not.

    Only used when Validate By is "Regular Expression"

  • Validation Error Message - Message that is texted back if the message fails to validate.

  • Optional Msg to Skip - Message that is ignored for the registration process.

  • Keywords Search - If checked, uses the Key Part for the Keyword Search instead of the whole message.

  • Insert into Registrations - If checked, registered messages are stored in the registrations table, and the Registration tab is shown.

Registration

Determines where the registration data is stored. This tab is shown when Insert into Registrations is checked.

  • Registrations DBID - The value that is used to split the received message into different parts.

  • Key Part - The index of the part of the message that stores the key value for the search. The first part is at index 1.

  • Data Part - The index of the part of the message that stores the data you want retrieved. The first part is at index 1.

  • Validate Data ? - If this is checked, Text My Quickbase checks to make sure the Data Part is in a correct format.

  • Validate By - Determines how to validate the data. Either by the data type, or by a regular expression.

Inbound

Determines where the received message is stored, and if an automated reply is sent.

  • Insert into Messages Received - If checked, the text that was received is stored in the table specified below.

  • Messages Received DBID - The DBID of the table you want to store the received texts in.

  • From Phone Number FID - The field id that stores the phone number that sent the text.

  • Message FID - The field id that stores the message that was sent.

  • Replies Message ID FID - The field id that is filled in with the unique message id given by EsendEx.

    This value can be used to relate Inbound records to the Outbound it originally received.

  • Validation FID - Please provide the Field ID of the Validation field that needs to be updated in the Messages Received table.

  • Attachment FID - The field ids that store the different attachments that were received.

    You can store these in multiple fields, you just have to separate each field id with a "."

  • Zip (Attachments/Pictures) - If this is checked, the attachments that were received are compressed into a zip file and stored in Quickbase.

  • Keywords DBID - The table that stores the different automated responses you want to send out.

  • Keyword FID - The field id that holds the value that the user sends to you. If this value matches, this record is used for the automatic response.

  • Message to Send FID - The field id that is sent out if the keyword sent matches.

  • Do not Send FID - If this check box field is checked, the automated response isn't sent.

  • chk Reg Keyword FID - If Insert into Registrations is checked, the message contains a "@", and the email is valid, then an automated reply is sent using a record that has that checkbox checked, instead of using the keyword fid.

EsendEx Phone Number Info

Determines where to save the EsendEx Phone number into Quickbase.

  • EsendEx Phone Number FID - For outbound configurations, this is the field in the master record that stores the EsendEx Phone Number.

    For inbound configurations, this is the field in the activities table that stores the EsendEx Phone Number.

Activity History

Shows the activity of this configuration.

  • Message Details - Shows your activity from this configuration and gives information such as what the message was and the status of those messages.